1
0
mirror of https://github.com/VDR4Arch/vdr.git synced 2023-10-10 13:36:52 +02:00
vdr/osdbase.h

146 lines
4.5 KiB
C
Raw Permalink Normal View History

/*
* osdbase.h: Basic interface to the On Screen Display
*
* See the main source file 'vdr.c' for copyright information and
* how to reach the author.
*
2018-01-25 15:09:23 +01:00
* $Id: osdbase.h 4.5 2018/01/25 15:09:23 kls Exp $
*/
#ifndef __OSDBASE_H
#define __OSDBASE_H
2004-05-16 10:35:36 +02:00
#include "config.h"
#include "osd.h"
#include "skins.h"
#include "tools.h"
2004-05-16 10:35:36 +02:00
enum eOSState { osUnknown,
osContinue,
osSchedule,
osChannels,
osTimers,
osRecordings,
osPlugin,
osSetup,
osCommands,
osPause,
osRecord,
osReplay,
osStopRecord,
osStopReplay,
osCancelEdit,
osBack,
osEnd,
os_User, // the following values can be used locally
osUser1,
osUser2,
osUser3,
osUser4,
osUser5,
osUser6,
osUser7,
osUser8,
osUser9,
osUser10,
};
2004-05-16 10:35:36 +02:00
class cOsdItem : public cListObject {
private:
2004-05-16 10:35:36 +02:00
char *text;
eOSState state;
bool selectable;
protected:
2004-05-16 10:35:36 +02:00
bool fresh;
public:
2004-05-16 10:35:36 +02:00
cOsdItem(eOSState State = osUnknown);
cOsdItem(const char *Text, eOSState State = osUnknown, bool Selectable = true);
2004-05-16 10:35:36 +02:00
virtual ~cOsdItem();
2007-11-03 14:52:08 +01:00
bool Selectable(void) const { return selectable; }
2004-05-16 10:35:36 +02:00
void SetText(const char *Text, bool Copy = true);
void SetSelectable(bool Selectable);
void SetFresh(bool Fresh);
2007-11-03 14:52:08 +01:00
const char *Text(void) const { return text; }
2004-05-16 10:35:36 +02:00
virtual void Set(void) {}
virtual void SetMenuItem(cSkinDisplayMenu *DisplayMenu, int Index, bool Current, bool Selectable);
2004-05-16 10:35:36 +02:00
virtual eOSState ProcessKey(eKeys Key);
};
2004-05-16 10:35:36 +02:00
class cOsdObject {
friend class cOsdMenu;
private:
2004-05-16 10:35:36 +02:00
bool isMenu;
bool needsFastResponse;
protected:
void SetNeedsFastResponse(bool NeedsFastResponse) { needsFastResponse = NeedsFastResponse; }
public:
2004-05-16 10:35:36 +02:00
cOsdObject(bool FastResponse = false) { isMenu = false; needsFastResponse = FastResponse; }
virtual ~cOsdObject() {}
virtual bool NeedsFastResponse(void) { return needsFastResponse; }
2007-11-03 14:52:08 +01:00
bool IsMenu(void) const { return isMenu; }
virtual void Show(void);
2004-05-16 10:35:36 +02:00
virtual eOSState ProcessKey(eKeys Key) { return osUnknown; }
};
2004-05-16 10:35:36 +02:00
class cOsdMenu : public cOsdObject, public cList<cOsdItem> {
private:
2004-05-16 10:35:36 +02:00
static cSkinDisplayMenu *displayMenu;
static int displayMenuCount;
static int osdState;
int displayMenuItems;
2004-05-16 10:35:36 +02:00
char *title;
int cols[cSkinDisplayMenu::MaxTabs];
int first, current, marked;
2018-01-25 15:09:23 +01:00
int lastOffset;
eMenuCategory menuCategory;
eMenuSortMode menuSortMode;
eMenuOrientation menuOrientation;
2004-05-16 10:35:36 +02:00
cOsdMenu *subMenu;
const char *helpRed, *helpGreen, *helpYellow, *helpBlue;
bool helpDisplayed;
2004-05-16 10:35:36 +02:00
char *status;
int digit;
bool hasHotkeys;
void DisplayHelp(bool Force = false);
protected:
void SetDisplayMenu(void);
2004-05-16 10:35:36 +02:00
cSkinDisplayMenu *DisplayMenu(void) { return displayMenu; }
const char *hk(const char *s);
void SetCols(int c0, int c1 = 0, int c2 = 0, int c3 = 0, int c4 = 0);
void SetHasHotkeys(bool HasHotkeys = true);
2004-05-16 10:35:36 +02:00
virtual void Clear(void);
const char *Title(void) { return title; }
2004-05-16 10:35:36 +02:00
bool SelectableItem(int idx);
void SetCurrent(cOsdItem *Item);
void RefreshCurrent(void);
void DisplayCurrent(bool Current);
void DisplayItem(cOsdItem *Item);
2004-05-16 10:35:36 +02:00
void CursorUp(void);
void CursorDown(void);
void PageUp(void);
void PageDown(void);
void Mark(void);
eOSState HotKey(eKeys Key);
eOSState AddSubMenu(cOsdMenu *SubMenu);
eOSState CloseSubMenu(bool ReDisplay = true);
2004-05-16 10:35:36 +02:00
bool HasSubMenu(void) { return subMenu; }
cOsdMenu *SubMenu(void) { return subMenu; }
2004-05-16 10:35:36 +02:00
void SetStatus(const char *s);
void SetTitle(const char *Title);
void SetHelp(const char *Red, const char *Green = NULL, const char *Yellow = NULL, const char *Blue = NULL);
virtual void Del(int Index);
public:
2004-05-16 10:35:36 +02:00
cOsdMenu(const char *Title, int c0 = 0, int c1 = 0, int c2 = 0, int c3 = 0, int c4 = 0);
virtual ~cOsdMenu();
virtual bool NeedsFastResponse(void) { return subMenu ? subMenu->NeedsFastResponse() : cOsdObject::NeedsFastResponse(); }
void SetMenuCategory(eMenuCategory MenuCategory);
void SetMenuSortMode(eMenuSortMode MenuSortMode);
2007-11-03 14:52:08 +01:00
int Current(void) const { return current; }
2004-05-16 10:35:36 +02:00
void Add(cOsdItem *Item, bool Current = false, cOsdItem *After = NULL);
void Ins(cOsdItem *Item, bool Current = false, cOsdItem *Before = NULL);
virtual void Display(void);
virtual eOSState ProcessKey(eKeys Key);
};
#endif //__OSDBASE_H