vdr  2.7.6
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 5.3 2025/03/02 11:03:35 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 
48 class cOsdItem : public cListObject {
49 private:
50  char *text;
52  bool selectable;
53 protected:
54  bool fresh;
55 public:
56  cOsdItem(eOSState State = osUnknown);
57  cOsdItem(const char *Text, eOSState State = osUnknown, bool Selectable = true);
58  virtual ~cOsdItem() override;
59  bool Selectable(void) const { return selectable; }
60  void SetText(const char *Text, bool Copy = true);
61  void SetSelectable(bool Selectable);
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);
66  virtual eOSState ProcessKey(eKeys Key);
67  };
68 
69 class cOsdObject {
70  friend class cOsdMenu;
71 private:
72  bool isMenu;
74 protected:
76 public:
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 
85 class cOsdMenu : public cOsdObject, public cList<cOsdItem> {
86 private:
88  static int displayMenuCount;
89  static int osdState;
90  static cOsdMenu *topMenu;
92  char *title;
103  char *status;
104  int digit;
106  bool active;
107  void SetActive(bool Active);
108  void DisplayHelp(bool Force = false);
109  void DisplayNoStatus(void);
110 protected:
111  void SetDisplayMenu(void);
113  const char *hk(const char *s);
114  void SetCols(int c0, int c1 = 0, int c2 = 0, int c3 = 0, int c4 = 0);
115  void SetHasHotkeys(bool HasHotkeys = true);
116  virtual void Clear(void);
117  const char *Title(void) { return title; }
118  bool SelectableItem(int idx);
119  void SetCurrent(cOsdItem *Item);
120  void RefreshCurrent(void);
121  void DisplayCurrent(bool Current);
122  void DisplayItem(cOsdItem *Item);
123  void CursorUp(void);
124  void CursorDown(void);
125  void PageUp(void);
126  void PageDown(void);
127  void Mark(void);
128  eOSState HotKey(eKeys Key);
130  eOSState CloseSubMenu(bool ReDisplay = true);
131  bool HasSubMenu(void) { return subMenu; }
132  cOsdMenu *SubMenu(void) { return subMenu; }
133  void SetStatus(const char *s);
134  void SetTitle(const char *Title);
135  void SetHelp(const char *Red, const char *Green = NULL, const char *Yellow = NULL, const char *Blue = NULL);
136  virtual void Del(int Index);
137 public:
138  cOsdMenu(const char *Title, int c0 = 0, int c1 = 0, int c2 = 0, int c3 = 0, int c4 = 0);
139  virtual ~cOsdMenu() override;
140  virtual bool NeedsFastResponse(void) override { return subMenu ? subMenu->NeedsFastResponse() : cOsdObject::NeedsFastResponse(); }
141  void SetMenuCategory(eMenuCategory MenuCategory);
142  void SetMenuSortMode(eMenuSortMode MenuSortMode);
143  int Current(void) const { return current; }
144  void Add(cOsdItem *Item, bool Current = false, cOsdItem *After = NULL);
145  void Ins(cOsdItem *Item, bool Current = false, cOsdItem *Before = NULL);
146  virtual void Display(void);
147  virtual eOSState ProcessKey(eKeys Key) override;
148  };
149 
150 #endif //__OSDBASE_H
int Index(void) const
Definition: tools.c:2097
Definition: tools.h:631
virtual void SetMenuItem(cSkinDisplayMenu *DisplayMenu, int Index, bool Current, bool Selectable)
Definition: osdbase.c:58
bool selectable
Definition: osdbase.h:52
void SetSelectable(bool Selectable)
Definition: osdbase.c:48
virtual eOSState ProcessKey(eKeys Key)
Definition: osdbase.c:63
eOSState state
Definition: osdbase.h:51
virtual void Set(void)
Definition: osdbase.h:64
char * text
Definition: osdbase.h:50
bool fresh
Definition: osdbase.h:54
void SetFresh(bool Fresh)
Definition: osdbase.c:53
bool Selectable(void) const
Definition: osdbase.h:59
void SetText(const char *Text, bool Copy=true)
Definition: osdbase.c:42
virtual ~cOsdItem() override
Definition: osdbase.c:37
cOsdItem(eOSState State=osUnknown)
Definition: osdbase.c:20
const char * Text(void) const
Definition: osdbase.h:63
void Ins(cOsdItem *Item, bool Current=false, cOsdItem *Before=NULL)
Definition: osdbase.c:234
virtual eOSState ProcessKey(eKeys Key) override
Definition: osdbase.c:573
const char * Title(void)
Definition: osdbase.h:117
int displayMenuItems
Definition: osdbase.h:91
int marked
Definition: osdbase.h:94
eOSState HotKey(eKeys Key)
Definition: osdbase.c:533
eOSState CloseSubMenu(bool ReDisplay=true)
Definition: osdbase.c:561
void SetTitle(const char *Title)
Definition: osdbase.c:187
char * title
Definition: osdbase.h:92
static int osdState
Definition: osdbase.h:89
void PageUp(void)
Definition: osdbase.c:459
const char * helpBlue
Definition: osdbase.h:101
bool conveyStatus
Definition: osdbase.h:96
void DisplayCurrent(bool Current)
Definition: osdbase.c:326
bool helpDisplayed
Definition: osdbase.h:102
char * status
Definition: osdbase.h:103
static cOsdMenu * topMenu
Definition: osdbase.h:90
void SetActive(bool Active)
Definition: osdbase.c:135
int Current(void) const
Definition: osdbase.h:143
const char * helpYellow
Definition: osdbase.h:101
int cols[cSkinDisplayMenu::MaxTabs]
Definition: osdbase.h:93
bool SelectableItem(int idx)
Definition: osdbase.c:373
const char * hk(const char *s)
Definition: osdbase.c:149
void CursorDown(void)
Definition: osdbase.c:418
void Mark(void)
Definition: osdbase.c:525
cSkinDisplayMenu * DisplayMenu(void)
Definition: osdbase.h:112
void SetStatus(const char *s)
Definition: osdbase.c:179
void CursorUp(void)
Definition: osdbase.c:379
void DisplayHelp(bool Force=false)
Definition: osdbase.c:193
void DisplayItem(cOsdItem *Item)
Definition: osdbase.c:348
eMenuCategory menuCategory
Definition: osdbase.h:97
eOSState AddSubMenu(cOsdMenu *SubMenu)
Definition: osdbase.c:551
void SetDisplayMenu(void)
Definition: osdbase.c:140
void Add(cOsdItem *Item, bool Current=false, cOsdItem *After=NULL)
Definition: osdbase.c:227
void PageDown(void)
Definition: osdbase.c:492
void SetHasHotkeys(bool HasHotkeys=true)
Definition: osdbase.c:173
void SetCols(int c0, int c1=0, int c2=0, int c3=0, int c4=0)
Definition: osdbase.c:164
void SetCurrent(cOsdItem *Item)
Definition: osdbase.c:311
bool hasHotkeys
Definition: osdbase.h:105
int lastOffset
Definition: osdbase.h:95
eMenuOrientation menuOrientation
Definition: osdbase.h:99
void SetMenuCategory(eMenuCategory MenuCategory)
Definition: osdbase.c:125
cOsdMenu * SubMenu(void)
Definition: osdbase.h:132
void RefreshCurrent(void)
Definition: osdbase.c:319
const char * helpRed
Definition: osdbase.h:101
static cSkinDisplayMenu * displayMenu
Definition: osdbase.h:87
void SetHelp(const char *Red, const char *Green=NULL, const char *Yellow=NULL, const char *Blue=NULL)
Definition: osdbase.c:203
static int displayMenuCount
Definition: osdbase.h:88
virtual void Display(void)
Definition: osdbase.c:248
bool HasSubMenu(void)
Definition: osdbase.h:131
void DisplayNoStatus(void)
Definition: osdbase.c:241
virtual void Del(int Index)
Definition: osdbase.c:213
virtual ~cOsdMenu() override
Definition: osdbase.c:112
virtual bool NeedsFastResponse(void) override
Definition: osdbase.h:140
bool active
Definition: osdbase.h:106
virtual void Clear(void)
Definition: osdbase.c:362
void SetMenuSortMode(eMenuSortMode MenuSortMode)
Definition: osdbase.c:130
cOsdMenu * subMenu
Definition: osdbase.h:100
int current
Definition: osdbase.h:94
eMenuSortMode menuSortMode
Definition: osdbase.h:98
const char * helpGreen
Definition: osdbase.h:101
int digit
Definition: osdbase.h:104
int first
Definition: osdbase.h:94
bool needsFastResponse
Definition: osdbase.h:73
virtual bool NeedsFastResponse(void)
Definition: osdbase.h:79
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
bool isMenu
Definition: osdbase.h:72
virtual void Show(void)
Definition: osdbase.c:70
friend class cOsdMenu
Definition: osdbase.h:70
eKeys
Definition: keys.h:16
eOSState
Definition: osdbase.h:18
@ 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
eMenuOrientation
Definition: skins.h:145
eMenuCategory
Definition: skins.h:104
eMenuSortMode
Definition: skins.h:137