cSkinClassicDisplayMenu Class Reference

Inheritance diagram for cSkinClassicDisplayMenu:

Inheritance graph
[legend]
Collaboration diagram for cSkinClassicDisplayMenu:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 cSkinClassicDisplayMenu (void)
virtual ~cSkinClassicDisplayMenu ()
virtual void Scroll (bool Up, bool Page)
virtual int MaxItems (void)
 Returns the maximum number of items the menu can display.
virtual void Clear (void)
 Clears the entire central area of the menu.
virtual void SetTitle (const char *Title)
 Sets the title of this menu to 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 SetEvent (const cEvent *Event)
virtual void SetRecording (const cRecording *Recording)
virtual void SetText (const char *Text, bool FixedFont)
virtual int GetTextAreaWidth (void) const
virtual const cFontGetTextAreaFont (bool FixedFont) const
virtual void Flush (void)
 Actually draws the OSD display to the output device.

Private Member Functions

void SetScrollbar (void)

Private Attributes

cOsdosd
int x0
int x1
int y0
int y1
int y2
int y3
int y4
int y5
int lineHeight


Detailed Description

Definition at line 152 of file skinclassic.c.


Constructor & Destructor Documentation

cSkinClassicDisplayMenu::cSkinClassicDisplayMenu ( void   ) 

Definition at line 177 of file skinclassic.c.

References cOsd::CanHandleAreas(), clrBackground, cTheme::Color(), cOsd::DrawRectangle(), fontOsd, cFont::GetFont(), cFont::Height(), lineHeight, cOsdProvider::NewOsd(), oeOk, osd, cSetup::OSDHeight, cSetup::OSDLeft, cSetup::OSDTop, cSetup::OSDWidth, cOsd::SetAreas(), Setup, x0, x1, y0, y1, y2, y3, y4, and y5.

Here is the call graph for this function:

cSkinClassicDisplayMenu::~cSkinClassicDisplayMenu (  )  [virtual]

Definition at line 203 of file skinclassic.c.

References osd.


Member Function Documentation

void cSkinClassicDisplayMenu::SetScrollbar ( void   )  [private]

Definition at line 208 of file skinclassic.c.

References cTextScroller::CanScroll(), cTheme::Color(), cOsd::DrawRectangle(), cTextScroller::Height(), cTextScroller::Offset(), osd, ScrollWidth, cTextScroller::Shown(), cSkinDisplayMenu::textScroller, cTextScroller::Top(), cTextScroller::Total(), and x1.

Referenced by Scroll(), SetEvent(), SetRecording(), and SetText().

Here is the call graph for this function:

void cSkinClassicDisplayMenu::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 223 of file skinclassic.c.

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

Here is the call graph for this function:

int cSkinClassicDisplayMenu::MaxItems ( void   )  [virtual]

Returns the maximum number of items the menu can display.

Implements cSkinDisplayMenu.

Definition at line 229 of file skinclassic.c.

References lineHeight, y2, and y3.

void cSkinClassicDisplayMenu::Clear ( void   )  [virtual]

Clears the entire central area of the menu.

Implements cSkinDisplayMenu.

Definition at line 234 of file skinclassic.c.

References clrBackground, cTheme::Color(), cOsd::DrawRectangle(), osd, cTextScroller::Reset(), cSkinDisplayMenu::textScroller, x0, x1, y1, and y4.

Here is the call graph for this function:

void cSkinClassicDisplayMenu::SetTitle ( const char *  Title  )  [virtual]

Sets the title of this menu to Title.

Implements cSkinDisplayMenu.

Definition at line 240 of file skinclassic.c.

References cTheme::Color(), cOsd::DrawText(), fontOsd, cFont::GetFont(), osd, x0, x1, and y0.

Here is the call graph for this function:

void cSkinClassicDisplayMenu::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 246 of file skinclassic.c.

References clrBackground, cTheme::Color(), cOsd::DrawText(), fontOsd, cFont::GetFont(), osd, taCenter, x0, x1, and y4.

Here is the call graph for this function:

void cSkinClassicDisplayMenu::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 261 of file skinclassic.c.

References clrBackground, cTheme::Color(), cOsd::DrawRectangle(), cOsd::DrawText(), fontOsd, cFont::GetFont(), osd, taCenter, x0, x1, y3, and y4.

Here is the call graph for this function:

void cSkinClassicDisplayMenu::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 (''), 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 270 of file skinclassic.c.

References clrBackground, cTheme::Color(), cOsd::DrawText(), fontOsd, cFont::GetFont(), cSkinDisplayMenu::GetTabbedText(), lineHeight, cSkinDisplayMenu::MaxTabs, osd, cSkinDisplay::SetEditableWidth(), cSkinDisplayMenu::Tab(), x0, x1, and y2.

Here is the call graph for this function:

void cSkinClassicDisplayMenu::SetEvent ( const cEvent Event  )  [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.

Implements cSkinDisplayMenu.

Definition at line 295 of file skinclassic.c.

References clrBackground, cTheme::Color(), cEvent::Description(), cOsd::DrawText(), fontOsd, cEvent::GetDateString(), cEvent::GetEndTimeString(), cFont::GetFont(), cEvent::GetTimeString(), cEvent::GetVpsString(), cFont::Height(), cTextScroller::Height(), isempty(), osd, ScrollWidth, cTextScroller::Set(), SetScrollbar(), cEvent::ShortText(), cEvent::StartTime(), cSkinDisplayMenu::textScroller, cEvent::Title(), cEvent::Vps(), x0, x1, y2, and y3.

Here is the call graph for this function:

void cSkinClassicDisplayMenu::SetRecording ( const cRecording Recording  )  [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.

Implements cSkinDisplayMenu.

Definition at line 329 of file skinclassic.c.

References clrBackground, cTheme::Color(), DateString(), cRecordingInfo::Description(), fontOsd, cFont::GetFont(), cFont::Height(), cTextScroller::Height(), cRecording::Info(), isempty(), cRecording::Name(), osd, ScrollWidth, cTextScroller::Set(), SetScrollbar(), cRecordingInfo::ShortText(), cRecording::start, cSkinDisplayMenu::textScroller, TimeString(), cRecordingInfo::Title(), x0, x1, y2, and y3.

Here is the call graph for this function:

void cSkinClassicDisplayMenu::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 360 of file skinclassic.c.

References clrBackground, cTheme::Color(), GetTextAreaFont(), GetTextAreaWidth(), osd, cTextScroller::Set(), SetScrollbar(), cSkinDisplayMenu::textScroller, x0, y2, and y3.

Here is the call graph for this function:

int cSkinClassicDisplayMenu::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 from cSkinDisplayMenu.

Definition at line 366 of file skinclassic.c.

References ScrollWidth, x0, and x1.

Referenced by SetText().

const cFont * cSkinClassicDisplayMenu::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 from cSkinDisplayMenu.

Definition at line 371 of file skinclassic.c.

References fontFix, fontOsd, and cFont::GetFont().

Referenced by SetText().

Here is the call graph for this function:

void cSkinClassicDisplayMenu::Flush ( void   )  [virtual]

Actually draws the OSD display to the output device.

Reimplemented from cSkinDisplay.

Definition at line 376 of file skinclassic.c.

References cTheme::Color(), DayDateTime(), cOsd::DrawText(), cOsd::Flush(), fontOsd, cFont::GetFont(), osd, cFont::Width(), x1, and y0.

Here is the call graph for this function:


Member Data Documentation

cOsd* cSkinClassicDisplayMenu::osd [private]

Definition at line 154 of file skinclassic.c.

Referenced by Clear(), cSkinClassicDisplayMenu(), Flush(), SetButtons(), SetEvent(), SetItem(), SetMessage(), SetRecording(), SetScrollbar(), SetText(), SetTitle(), and ~cSkinClassicDisplayMenu().

int cSkinClassicDisplayMenu::x0 [private]

Definition at line 155 of file skinclassic.c.

Referenced by Clear(), cSkinClassicDisplayMenu(), GetTextAreaWidth(), SetButtons(), SetEvent(), SetItem(), SetMessage(), SetRecording(), SetText(), and SetTitle().

int cSkinClassicDisplayMenu::x1 [private]

Definition at line 155 of file skinclassic.c.

Referenced by Clear(), cSkinClassicDisplayMenu(), Flush(), GetTextAreaWidth(), SetButtons(), SetEvent(), SetItem(), SetMessage(), SetRecording(), SetScrollbar(), and SetTitle().

int cSkinClassicDisplayMenu::y0 [private]

Definition at line 156 of file skinclassic.c.

Referenced by cSkinClassicDisplayMenu(), Flush(), and SetTitle().

int cSkinClassicDisplayMenu::y1 [private]

Definition at line 156 of file skinclassic.c.

Referenced by Clear(), and cSkinClassicDisplayMenu().

int cSkinClassicDisplayMenu::y2 [private]

Definition at line 156 of file skinclassic.c.

Referenced by cSkinClassicDisplayMenu(), MaxItems(), SetEvent(), SetItem(), SetRecording(), and SetText().

int cSkinClassicDisplayMenu::y3 [private]

Definition at line 156 of file skinclassic.c.

Referenced by cSkinClassicDisplayMenu(), MaxItems(), SetEvent(), SetMessage(), SetRecording(), and SetText().

int cSkinClassicDisplayMenu::y4 [private]

Definition at line 156 of file skinclassic.c.

Referenced by Clear(), cSkinClassicDisplayMenu(), SetButtons(), and SetMessage().

int cSkinClassicDisplayMenu::y5 [private]

Definition at line 156 of file skinclassic.c.

Referenced by cSkinClassicDisplayMenu().

int cSkinClassicDisplayMenu::lineHeight [private]

Definition at line 157 of file skinclassic.c.

Referenced by cSkinClassicDisplayMenu(), MaxItems(), and SetItem().


The documentation for this class was generated from the following file:
Generated on Tue Nov 6 20:27:10 2007 for VDR by  doxygen 1.5.3-20071008