vdr 2.6.1
osdbase.h
Go to the documentation of this file.
1/*
2 * osdbase.h: Basic interface to the On Screen Display
3 *
4 * See the main source file 'vdr.c' for copyright information and
5 * how to reach the author.
6 *
7 * $Id: osdbase.h 4.5 2018/01/25 15:09:23 kls Exp $
8 */
9
10#ifndef __OSDBASE_H
11#define __OSDBASE_H
12
13#include "config.h"
14#include "osd.h"
15#include "skins.h"
16#include "tools.h"
17
35 os_User, // the following values can be used locally
46 };
47
48class cOsdItem : public cListObject {
49private:
50 char *text;
52 bool selectable;
53protected:
54 bool fresh;
55public:
57 cOsdItem(const char *Text, eOSState State = osUnknown, bool Selectable = true);
58 virtual ~cOsdItem();
59 bool Selectable(void) const { return selectable; }
60 void SetText(const char *Text, bool Copy = true);
62 void SetFresh(bool Fresh);
63 const char *Text(void) const { return text; }
64 virtual void Set(void) {}
65 virtual void SetMenuItem(cSkinDisplayMenu *DisplayMenu, int Index, bool Current, bool Selectable);
67 };
68
69class cOsdObject {
70 friend class cOsdMenu;
71private:
72 bool isMenu;
74protected:
76public:
77 cOsdObject(bool FastResponse = false) { isMenu = false; needsFastResponse = FastResponse; }
78 virtual ~cOsdObject() {}
79 virtual bool NeedsFastResponse(void) { return needsFastResponse; }
80 bool IsMenu(void) const { return isMenu; }
81 virtual void Show(void);
82 virtual eOSState ProcessKey(eKeys Key) { return osUnknown; }
83 };
84
85class cOsdMenu : public cOsdObject, public cList<cOsdItem> {
86private:
88 static int displayMenuCount;
89 static int osdState;
91 char *title;
93 int first, current, marked;
94 int lastOffset;
99 const char *helpRed, *helpGreen, *helpYellow, *helpBlue;
100 bool helpDisplayed;
101 char *status;
102 int digit;
103 bool hasHotkeys;
104 void DisplayHelp(bool Force = false);
105protected:
106 void SetDisplayMenu(void);
108 const char *hk(const char *s);
109 void SetCols(int c0, int c1 = 0, int c2 = 0, int c3 = 0, int c4 = 0);
110 void SetHasHotkeys(bool HasHotkeys = true);
111 virtual void Clear(void);
112 const char *Title(void) { return title; }
113 bool SelectableItem(int idx);
114 void SetCurrent(cOsdItem *Item);
115 void RefreshCurrent(void);
118 void CursorUp(void);
119 void CursorDown(void);
120 void PageUp(void);
121 void PageDown(void);
122 void Mark(void);
125 eOSState CloseSubMenu(bool ReDisplay = true);
126 bool HasSubMenu(void) { return subMenu; }
127 cOsdMenu *SubMenu(void) { return subMenu; }
128 void SetStatus(const char *s);
129 void SetTitle(const char *Title);
130 void SetHelp(const char *Red, const char *Green = NULL, const char *Yellow = NULL, const char *Blue = NULL);
131 virtual void Del(int Index);
132public:
133 cOsdMenu(const char *Title, int c0 = 0, int c1 = 0, int c2 = 0, int c3 = 0, int c4 = 0);
134 virtual ~cOsdMenu();
136 void SetMenuCategory(eMenuCategory MenuCategory);
137 void SetMenuSortMode(eMenuSortMode MenuSortMode);
138 int Current(void) const { return current; }
139 void Add(cOsdItem *Item, bool Current = false, cOsdItem *After = NULL);
140 void Ins(cOsdItem *Item, bool Current = false, cOsdItem *Before = NULL);
141 virtual void Display(void);
143 };
144
145#endif //__OSDBASE_H
int Index(void) const
Definition: tools.c:2104
cOsdItem(const char *Text, eOSState State=osUnknown, bool Selectable=true)
const char * Text(void) const
virtual void SetMenuItem(cSkinDisplayMenu *DisplayMenu, int Index, bool Current, bool Selectable)
void SetSelectable(bool Selectable)
eOSState state
virtual void Set(void)
Definition: osdbase.h:64
virtual eOSState ProcessKey(eKeys Key)
void SetFresh(bool Fresh)
bool Selectable(void) const
void SetText(const char *Text, bool Copy=true)
virtual ~cOsdItem()
cOsdItem(eOSState State=osUnknown)
void Ins(cOsdItem *Item, bool Current=false, cOsdItem *Before=NULL)
virtual bool NeedsFastResponse(void)
Definition: osdbase.h:135
virtual void Display(void)
eOSState HotKey(eKeys Key)
const char * helpRed
eOSState CloseSubMenu(bool ReDisplay=true)
void SetTitle(const char *Title)
void PageUp(void)
const char * helpBlue
void DisplayCurrent(bool Current)
int Current(void) const
const char * helpYellow
bool SelectableItem(int idx)
const char * hk(const char *s)
void CursorDown(void)
void Mark(void)
void SetStatus(const char *s)
cOsdMenu * SubMenu(void)
static cSkinDisplayMenu * displayMenu
void CursorUp(void)
void DisplayHelp(bool Force=false)
void DisplayItem(cOsdItem *Item)
eMenuCategory menuCategory
virtual void Clear(void)
eOSState AddSubMenu(cOsdMenu *SubMenu)
void SetDisplayMenu(void)
void Add(cOsdItem *Item, bool Current=false, cOsdItem *After=NULL)
void PageDown(void)
void SetHasHotkeys(bool HasHotkeys=true)
int cols[cSkinDisplayMenu::MaxTabs]
void SetCols(int c0, int c1=0, int c2=0, int c3=0, int c4=0)
void SetCurrent(cOsdItem *Item)
eMenuOrientation menuOrientation
cOsdMenu(const char *Title, int c0=0, int c1=0, int c2=0, int c3=0, int c4=0)
void SetMenuCategory(eMenuCategory MenuCategory)
void RefreshCurrent(void)
static int osdState
virtual eOSState ProcessKey(eKeys Key)
void SetHelp(const char *Red, const char *Green=NULL, const char *Yellow=NULL, const char *Blue=NULL)
cSkinDisplayMenu * DisplayMenu(void)
Definition: osdbase.h:107
bool HasSubMenu(void)
Definition: osdbase.h:126
const char * Title(void)
Definition: osdbase.h:112
void SetMenuSortMode(eMenuSortMode MenuSortMode)
cOsdMenu * subMenu
eMenuSortMode menuSortMode
const char * helpGreen
virtual ~cOsdMenu()
virtual void Del(int Index)
static int displayMenuCount
virtual void Show(void)
virtual bool NeedsFastResponse(void)
virtual ~cOsdObject()
Definition: osdbase.h:78
void SetNeedsFastResponse(bool NeedsFastResponse)
Definition: osdbase.h:75
virtual eOSState ProcessKey(eKeys Key)
Definition: osdbase.h:82
cOsdObject(bool FastResponse=false)
Definition: osdbase.h:77
bool IsMenu(void) const
Definition: osdbase.h:80
eMenuOrientation
eMenuCategory
eMenuSortMode
@ os_User
Definition: osdbase.h:35
@ osUser5
Definition: osdbase.h:40
@ osRecordings
Definition: osdbase.h:23
@ osCancelEdit
Definition: osdbase.h:32
@ osPause
Definition: osdbase.h:27
@ osPlugin
Definition: osdbase.h:24
@ osChannels
Definition: osdbase.h:21
@ osStopReplay
Definition: osdbase.h:31
@ osUser1
Definition: osdbase.h:36
@ osUser8
Definition: osdbase.h:43
@ osUser10
Definition: osdbase.h:45
@ osRecord
Definition: osdbase.h:28
@ osEnd
Definition: osdbase.h:34
@ osSetup
Definition: osdbase.h:25
@ osUser4
Definition: osdbase.h:39
@ osStopRecord
Definition: osdbase.h:30
@ osContinue
Definition: osdbase.h:19
@ osUser6
Definition: osdbase.h:41
@ osTimers
Definition: osdbase.h:22
@ osReplay
Definition: osdbase.h:29
@ osUser3
Definition: osdbase.h:38
@ osUser2
Definition: osdbase.h:37
@ osUnknown
Definition: osdbase.h:18
@ osUser9
Definition: osdbase.h:44
@ osSchedule
Definition: osdbase.h:20
@ osCommands
Definition: osdbase.h:26
@ osBack
Definition: osdbase.h:33
@ osUser7
Definition: osdbase.h:42