vdr  2.4.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
cSkinDisplayMenu Class Referenceabstract

#include <skins.h>

Public Types

enum  { MaxTabs = 6 }
 

Public Member Functions

 cSkinDisplayMenu (void)
 
virtual void SetMenuCategory (eMenuCategory MenuCategory)
 
virtual void SetTabs (int Tab1, int Tab2=0, int Tab3=0, int Tab4=0, int Tab5=0)
 
virtual void Scroll (bool Up, bool Page)
 
virtual int MaxItems (void)=0
 
virtual void Clear (void)=0
 
virtual void SetTitle (const char *Title)=0
 
virtual void SetButtons (const char *Red, const char *Green=NULL, const char *Yellow=NULL, const char *Blue=NULL)=0
 
virtual void SetMessage (eMessageType Type, const char *Text)=0
 
virtual void SetItem (const char *Text, int Index, bool Current, bool Selectable)=0
 
virtual void SetScrollbar (int Total, int Offset)
 
virtual void SetEvent (const cEvent *Event)=0
 
virtual void SetRecording (const cRecording *Recording)=0
 
virtual void SetText (const char *Text, bool FixedFont)=0
 
virtual int GetTextAreaWidth (void) const
 
virtual const cFontGetTextAreaFont (bool FixedFont) const
 
- Public Member Functions inherited from cSkinDisplay
 cSkinDisplay (void)
 
virtual ~cSkinDisplay ()
 
int EditableWidth (void)
 

Protected Member Functions

const char * GetTabbedText (const char *s, int Tab)
 

Protected Attributes

cTextScroller textScroller
 

Private Attributes

eMenuCategory menuCategory
 
int tabs [MaxTabs]
 

Detailed Description

Definition at line 150 of file skins.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

< This class implements the general purpose menu display, which is used throughout the program to display information and let the user interact with items.

A menu consists of the following fields, each of which is explicitly set by calls to the member functions below:

  • Title: a single line of text, indicating what this menu displays
  • Color buttons: the red, green, yellow and blue buttons, used for various functions
  • Message: a one line message, indicating a Status, Info, Warning, or Error condition
  • Central area: the main central area of the menu, used to display one of the following:
    • Items: a list of single line items, of which the user may be able to select one
    • Event: the full information about one EPG event
    • Text: a multi line, scrollable text
Enumerator
MaxTabs 

Definition at line 168 of file skins.h.

Constructor & Destructor Documentation

◆ cSkinDisplayMenu()

cSkinDisplayMenu::cSkinDisplayMenu ( void  )

Definition at line 84 of file skins.c.

References mcUndefined, menuCategory, and SetTabs().

Member Function Documentation

◆ Clear()

virtual void cSkinDisplayMenu::Clear ( void  )
pure virtual

◆ GetTabbedText()

const char * cSkinDisplayMenu::GetTabbedText ( const char *  s,
int  Tab 
)
protected

Returns the part of the given string that follows the given Tab (where 0 indicates the beginning of the string).

If no such part can be found, NULL will be returned.

Definition at line 112 of file skins.c.

Referenced by cSkinClassicDisplayMenu::SetItem(), cSkinCursesDisplayMenu::SetItem(), cSkinSTTNGDisplayMenu::SetItem(), and cSkinLCARSDisplayMenu::SetItem().

◆ GetTextAreaFont()

const cFont * cSkinDisplayMenu::GetTextAreaFont ( bool  FixedFont) const
virtual

Returns a pointer to the font which is used to display text with SetText().

The parameter FixedFont has the same meaning as in SetText(). The default implementation returns NULL. Therefore a caller of this method must be prepared to receive NULL if the plugin doesn't implement this method. The returned pointer is valid a long as the instance of cSkinDisplayMenu exists.

Reimplemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Definition at line 142 of file skins.c.

◆ GetTextAreaWidth()

int cSkinDisplayMenu::GetTextAreaWidth ( void  ) const
virtual

Returns the width in pixel of the area which is used to display text with SetText().

The width of the area is the width of the central area minus the width of any possibly displayed scroll-bar or other decoration. The default implementation returns 0. Therefore a caller of this method must be prepared to receive 0 if the plugin doesn't implement this method.

Reimplemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, and cSkinClassicDisplayMenu.

Definition at line 137 of file skins.c.

◆ MaxItems()

virtual int cSkinDisplayMenu::MaxItems ( void  )
pure virtual

◆ Scroll()

void cSkinDisplayMenu::Scroll ( bool  Up,
bool  Page 
)
virtual

If this menu contains a text area that can be scrolled, this function will be called to actually scroll the text.

Up indicates whether the text shall be scrolled up or down, and Page is true if it shall be scrolled by a full page, rather than a single line. An object of the cTextScroller class can be used to implement the scrolling text area.

Reimplemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Definition at line 107 of file skins.c.

References cTextScroller::Scroll(), and textScroller.

Referenced by cMenuText::ProcessKey(), cMenuEvent::ProcessKey(), cMenuRecording::ProcessKey(), cSkinClassicDisplayMenu::Scroll(), cSkinCursesDisplayMenu::Scroll(), cSkinSTTNGDisplayMenu::Scroll(), and cSkinLCARSDisplayMenu::Scroll().

◆ SetButtons()

virtual void cSkinDisplayMenu::SetButtons ( const char *  Red,
const char *  Green = NULL,
const char *  Yellow = NULL,
const char *  Blue = NULL 
)
pure virtual

Sets the color buttons to the given strings.

If any of the values is NULL, any previous text must be removed from the related button.

Implemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Referenced by cOsdMenu::DisplayHelp().

◆ SetEvent()

virtual void cSkinDisplayMenu::SetEvent ( const cEvent Event)
pure virtual

Sets the Event that shall be displayed, using the entire central area of the menu.

The Event's 'description' shall be displayed using a cTextScroller, and the Scroll() function will be called to drive scrolling that text if necessary.

Implemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Referenced by cMenuEvent::Display().

◆ SetItem()

virtual void cSkinDisplayMenu::SetItem ( const char *  Text,
int  Index,
bool  Current,
bool  Selectable 
)
pure virtual

Sets the item at the given Index to Text.

Index is between 0 and the value returned by MaxItems(), minus one. Text may contain tab characters ('\t'), which shall be used to separate the text into several columns, according to the values set by a prior call to SetTabs(). If Current is true, this item shall be drawn in a way indicating to the user that it is the currently selected one. Selectable can be used to display items differently that can't be selected by the user. Whenever the current status is moved from one item to another, this function will be first called for the old current item with Current set to false, and then for the new current item with Current set to true.

Implemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Referenced by cInterface::LearnKeys(), cInterface::QueryKeys(), cOsdItem::SetMenuItem(), cMenuChannelItem::SetMenuItem(), cMenuTimerItem::SetMenuItem(), cMenuScheduleItem::SetMenuItem(), and cMenuRecordingItem::SetMenuItem().

◆ SetMenuCategory()

void cSkinDisplayMenu::SetMenuCategory ( eMenuCategory  MenuCategory)
virtual

Sets the current menu category.

This allows skins to handle known types of menus in different ways, for instance by displaying icons or special decorations. A derived class can reimplement this function to be informed of any changes in the menu category. If it does, it shall call the base class function in order to set the members accordingly for later calls to the MenuCategory() function.

Reimplemented in cSkinLCARSDisplayMenu.

Definition at line 90 of file skins.c.

References menuCategory.

Referenced by cOsdMenu::Display(), cInterface::LearnKeys(), and cSkinLCARSDisplayMenu::SetMenuCategory().

◆ SetMessage()

virtual void cSkinDisplayMenu::SetMessage ( eMessageType  Type,
const char *  Text 
)
pure virtual

Sets a one line message Text, with the given Type.

Type can be used to determine, e.g., the colors for displaying the Text. If Text is NULL, any previously displayed message must be removed, and any previous contents overwritten by the message must be restored.

Implemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Referenced by cOsdMenu::Display(), and cOsdMenu::SetStatus().

◆ SetRecording()

virtual void cSkinDisplayMenu::SetRecording ( const cRecording Recording)
pure virtual

Sets the Recording that shall be displayed, using the entire central area of the menu.

The Recording's 'description' shall be displayed using a cTextScroller, and the Scroll() function will be called to drive scrolling that text if necessary.

Implemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Referenced by cMenuRecording::Display().

◆ SetScrollbar()

void cSkinDisplayMenu::SetScrollbar ( int  Total,
int  Offset 
)
virtual

Sets the Total number of items in the currently displayed list, and the Offset of the first item that is currently displayed (the skin knows how many items it can display at once, see MaxItems()).

This can be used to display a scrollbar.

Reimplemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Definition at line 133 of file skins.c.

Referenced by cOsdMenu::Display().

◆ SetTabs()

void cSkinDisplayMenu::SetTabs ( int  Tab1,
int  Tab2 = 0,
int  Tab3 = 0,
int  Tab4 = 0,
int  Tab5 = 0 
)
virtual

Sets the tab columns to the given values, which are the number of characters in each column.

Definition at line 95 of file skins.c.

References MaxTabs, and tabs.

Referenced by cSkinDisplayMenu(), and cOsdMenu::Display().

◆ SetText()

virtual void cSkinDisplayMenu::SetText ( const char *  Text,
bool  FixedFont 
)
pure virtual

Sets the Text that shall be displayed, using the entire central area of the menu.

The Text shall be displayed using a cTextScroller, and the Scroll() function will be called to drive scrolling that text if necessary.

Implemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Referenced by cMenuText::Display().

◆ SetTitle()

virtual void cSkinDisplayMenu::SetTitle ( const char *  Title)
pure virtual

Sets the title of this menu to Title.

Implemented in cSkinLCARSDisplayMenu, cSkinSTTNGDisplayMenu, cSkinCursesDisplayMenu, and cSkinClassicDisplayMenu.

Referenced by cOsdMenu::Display(), and cInterface::LearnKeys().

Member Data Documentation

◆ menuCategory

eMenuCategory cSkinDisplayMenu::menuCategory
private

Definition at line 170 of file skins.h.

Referenced by cSkinDisplayMenu(), and SetMenuCategory().

◆ tabs

int cSkinDisplayMenu::tabs[MaxTabs]
private

Definition at line 171 of file skins.h.

Referenced by SetTabs().

◆ textScroller

cTextScroller cSkinDisplayMenu::textScroller
protected

The documentation for this class was generated from the following files: