vdr 2.7.3
cSkinCursesDisplayMenu Class Reference

Public Member Functions

 cSkinCursesDisplayMenu (void)
 
virtual ~cSkinCursesDisplayMenu ()
 
virtual void Scroll (bool Up, bool Page)
 
virtual int MaxItems (void)
 
virtual void Clear (void)
 
virtual void SetTitle (const char *Title)
 
virtual void SetButtons (const char *Red, const char *Green=NULL, const char *Yellow=NULL, const char *Blue=NULL)
 
virtual void SetMessage (eMessageType Type, const char *Text)
 
virtual void SetItem (const char *Text, int Index, bool Current, bool Selectable)
 
virtual void SetScrollbar (int Total, int Offset)
 
virtual void SetEvent (const cEvent *Event)
 
virtual void SetRecording (const cRecording *Recording)
 
virtual void SetText (const char *Text, bool FixedFont)
 
virtual const cFontGetTextAreaFont (bool FixedFont) const
 
virtual void Flush (void)
 
- Public Member Functions inherited from cSkinDisplayMenu
 cSkinDisplayMenu (void)
 
eMenuCategory MenuCategory (void) const
 
virtual void SetMenuCategory (eMenuCategory MenuCategory)
 
virtual void SetTabs (int Tab1, int Tab2=0, int Tab3=0, int Tab4=0, int Tab5=0)
 
virtual void SetMenuSortMode (eMenuSortMode MenuSortMode)
 
virtual eMenuOrientation MenuOrientation (void)
 
virtual bool SetItemEvent (const cEvent *Event, int Index, bool Current, bool Selectable, const cChannel *Channel, bool WithDate, eTimerMatch TimerMatch, bool TimerActive)
 
virtual bool SetItemTimer (const cTimer *Timer, int Index, bool Current, bool Selectable)
 
virtual bool SetItemChannel (const cChannel *Channel, int Index, bool Current, bool Selectable, bool WithProvider)
 
virtual bool SetItemRecording (const cRecording *Recording, int Index, bool Current, bool Selectable, int Level, int Total, int New)
 
virtual int GetTextAreaWidth (void) const
 
- Public Member Functions inherited from cSkinDisplay
 cSkinDisplay (void)
 
virtual ~cSkinDisplay ()
 
int EditableWidth (void)
 
void SetEditableWidth (int Width)
 

Private Member Functions

void DrawTitle (void)
 
void DrawScrollbar (int Total, int Offset, int Shown, int Top, int Height, bool CanScrollUp, bool CanScrollDown)
 
void SetTextScrollbar (void)
 

Private Attributes

cOsdosd
 
cString title
 
int lastDiskUsageState
 

Additional Inherited Members

- Public Types inherited from cSkinDisplayMenu
enum  { MaxTabs = 6 }
 
- Static Public Member Functions inherited from cSkinDisplay
static int AvgCharWidth (void)
 
static cSkinDisplayCurrent (void)
 
- Protected Member Functions inherited from cSkinDisplayMenu
int Tab (int n)
 
const char * GetTabbedText (const char *s, int Tab)
 
- Protected Attributes inherited from cSkinDisplayMenu
cTextScroller textScroller
 

Detailed Description

Definition at line 261 of file skincurses.c.

Constructor & Destructor Documentation

◆ cSkinCursesDisplayMenu()

cSkinCursesDisplayMenu::cSkinCursesDisplayMenu ( void )

◆ ~cSkinCursesDisplayMenu()

cSkinCursesDisplayMenu::~cSkinCursesDisplayMenu ( )
virtual

Definition at line 294 of file skincurses.c.

References osd.

Member Function Documentation

◆ Clear()

void cSkinCursesDisplayMenu::Clear ( void )
virtual

Clears the entire central area of the menu.

Implements cSkinDisplayMenu.

Definition at line 332 of file skincurses.c.

References clrBackground, cOsd::DrawRectangle(), osd, cTextScroller::Reset(), ScOsdHeight, ScOsdWidth, and cSkinDisplayMenu::textScroller.

◆ DrawScrollbar()

void cSkinCursesDisplayMenu::DrawScrollbar ( int Total,
int Offset,
int Shown,
int Top,
int Height,
bool CanScrollUp,
bool CanScrollDown )
private

Definition at line 299 of file skincurses.c.

References clrCyan, clrWhite, cOsd::DrawRectangle(), max(), min(), osd, and ScOsdWidth.

Referenced by SetScrollbar(), and SetTextScrollbar().

◆ DrawTitle()

void cSkinCursesDisplayMenu::DrawTitle ( void )
private

◆ Flush()

void cSkinCursesDisplayMenu::Flush ( void )
virtual

Actually draws the OSD display to the output device.

Reimplemented from cSkinDisplay.

Definition at line 493 of file skincurses.c.

References clrBlack, clrCyan, DayDateTime(), cOsd::DrawText(), DrawTitle(), cOsd::Flush(), Font, cVideoDiskUsage::HasChanged(), lastDiskUsageState, osd, ScOsdWidth, and Utf8StrLen().

◆ GetTextAreaFont()

virtual const cFont * cSkinCursesDisplayMenu::GetTextAreaFont ( bool FixedFont) const
inlinevirtual

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 the font defined in the setup. The returned pointer is valid a long as the instance of cSkinDisplayMenu exists.

Reimplemented from cSkinDisplayMenu.

Definition at line 283 of file skincurses.c.

References Font.

◆ MaxItems()

int cSkinCursesDisplayMenu::MaxItems ( void )
virtual

Returns the maximum number of items the menu can display.

Implements cSkinDisplayMenu.

Definition at line 327 of file skincurses.c.

References ScOsdHeight.

Referenced by SetScrollbar().

◆ Scroll()

void cSkinCursesDisplayMenu::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 from cSkinDisplayMenu.

Definition at line 321 of file skincurses.c.

References cSkinDisplayMenu::Scroll(), and SetTextScrollbar().

◆ SetButtons()

void cSkinCursesDisplayMenu::SetButtons ( const char * Red,
const char * Green = NULL,
const char * Yellow = NULL,
const char * Blue = NULL )
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.

Implements cSkinDisplayMenu.

Definition at line 350 of file skincurses.c.

References clrBackground, clrBlack, clrBlue, clrGreen, clrRed, clrWhite, clrYellow, cOsd::DrawText(), Font, osd, ScOsdHeight, ScOsdWidth, and taCenter.

◆ SetEvent()

void cSkinCursesDisplayMenu::SetEvent ( const cEvent * Event)
virtual

◆ SetItem()

void cSkinCursesDisplayMenu::SetItem ( const char * Text,
int Index,
bool Current,
bool Selectable )
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.

Implements cSkinDisplayMenu.

Definition at line 373 of file skincurses.c.

References cSkinDisplay::AvgCharWidth(), clrBackground, clrBlack, clrCyan, clrWhite, cSkinDisplay::Current(), cOsd::DrawText(), Font, cSkinDisplayMenu::GetTabbedText(), cSkinDisplayMenu::MaxTabs, osd, ScOsdWidth, cSkinDisplay::SetEditableWidth(), and cSkinDisplayMenu::Tab().

◆ SetMessage()

void cSkinCursesDisplayMenu::SetMessage ( eMessageType Type,
const char * Text )
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.

Implements cSkinDisplayMenu.

Definition at line 365 of file skincurses.c.

References clrBackground, clrMessage, cOsd::DrawRectangle(), cOsd::DrawText(), Font, osd, ScOsdHeight, ScOsdWidth, and taCenter.

◆ SetRecording()

void cSkinCursesDisplayMenu::SetRecording ( const cRecording * Recording)
virtual

◆ SetScrollbar()

void cSkinCursesDisplayMenu::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 from cSkinDisplayMenu.

Definition at line 397 of file skincurses.c.

References DrawScrollbar(), and MaxItems().

◆ SetText()

void cSkinCursesDisplayMenu::SetText ( const char * Text,
bool FixedFont )
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.

Implements cSkinDisplayMenu.

Definition at line 487 of file skincurses.c.

References clrBackground, clrWhite, Font, osd, ScOsdHeight, ScOsdWidth, cTextScroller::Set(), SetTextScrollbar(), and cSkinDisplayMenu::textScroller.

◆ SetTextScrollbar()

◆ SetTitle()

void cSkinCursesDisplayMenu::SetTitle ( const char * Title)
virtual

Sets the title of this menu to Title.

Implements cSkinDisplayMenu.

Definition at line 344 of file skincurses.c.

References DrawTitle(), and title.

Member Data Documentation

◆ lastDiskUsageState

int cSkinCursesDisplayMenu::lastDiskUsageState
private

Definition at line 265 of file skincurses.c.

Referenced by cSkinCursesDisplayMenu(), and Flush().

◆ osd

◆ title

cString cSkinCursesDisplayMenu::title
private

Definition at line 264 of file skincurses.c.

Referenced by DrawTitle(), and SetTitle().


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