cSkinSTTNGDisplayMenu Class Reference

Inheritance diagram for cSkinSTTNGDisplayMenu:

Inheritance graph
[legend]
Collaboration diagram for cSkinSTTNGDisplayMenu:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 cSkinSTTNGDisplayMenu (void)
virtual ~cSkinSTTNGDisplayMenu ()
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 x2
int x3
int x4
int x5
int x6
int x7
int y0
int y1
int y2
int y3
int y4
int y5
int y6
int y7
int lineHeight
tColor frameColor
int currentIndex
bool message


Detailed Description

Definition at line 327 of file skinsttng.c.


Constructor & Destructor Documentation

cSkinSTTNGDisplayMenu::cSkinSTTNGDisplayMenu ( void   ) 

Definition at line 355 of file skinsttng.c.

References cOsd::CanHandleAreas(), clrBackground, clrTransparent, cTheme::Color(), currentIndex, cOsd::DrawEllipse(), cOsd::DrawRectangle(), fontOsd, frameColor, Gap, cFont::GetFont(), cFont::Height(), lineHeight, message, cOsdProvider::NewOsd(), oeOk, osd, cSetup::OSDHeight, cSetup::OSDLeft, cSetup::OSDTop, cSetup::OSDWidth, Roundness, cOsd::SetAreas(), Setup, x0, x1, x2, x3, x4, x5, x6, x7, y0, y1, y2, y3, y4, y5, y6, and y7.

Here is the call graph for this function:

cSkinSTTNGDisplayMenu::~cSkinSTTNGDisplayMenu (  )  [virtual]

Definition at line 413 of file skinsttng.c.

References osd.


Member Function Documentation

void cSkinSTTNGDisplayMenu::SetScrollbar ( void   )  [private]

Definition at line 418 of file skinsttng.c.

References cTextScroller::CanScroll(), cTextScroller::CanScrollDown(), cTextScroller::CanScrollUp(), cTheme::Color(), cOsd::DrawBitmap(), cOsd::DrawEllipse(), cOsd::DrawRectangle(), frameColor, Gap, cBitmap::Height(), cTextScroller::Height(), lineHeight, cTextScroller::Offset(), osd, ScrollWidth, cTextScroller::Shown(), cSkinDisplayMenu::textScroller, cTextScroller::Top(), cTextScroller::Total(), cBitmap::Width(), x5, x6, and x7.

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

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::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 445 of file skinsttng.c.

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

Here is the call graph for this function:

int cSkinSTTNGDisplayMenu::MaxItems ( void   )  [virtual]

Returns the maximum number of items the menu can display.

Implements cSkinDisplayMenu.

Definition at line 451 of file skinsttng.c.

References lineHeight, Roundness, y3, and y4.

void cSkinSTTNGDisplayMenu::Clear ( void   )  [virtual]

Clears the entire central area of the menu.

Implements cSkinDisplayMenu.

Definition at line 456 of file skinsttng.c.

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

Here is the call graph for this function:

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

Sets the title of this menu to Title.

Implements cSkinDisplayMenu.

Definition at line 462 of file skinsttng.c.

References clrBlack, cTheme::Color(), cOsd::DrawText(), fontOsd, frameColor, cFont::GetFont(), osd, cFont::Width(), x3, x4, and y0.

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::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 471 of file skinsttng.c.

References clrBlack, cTheme::Color(), DayDateTime(), cOsd::DrawRectangle(), cOsd::DrawText(), cFont::GetFont(), osd, taCenter, cFont::Width(), x3, x4, y6, and y7.

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::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 493 of file skinsttng.c.

References cTheme::Color(), cOsd::DrawText(), cFont::GetFont(), message, osd, cOsd::RestoreRegion(), cOsd::SaveRegion(), taCenter, x3, x4, y6, and y7.

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::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 507 of file skinsttng.c.

References clrBackground, cTheme::Color(), currentIndex, cOsd::DrawEllipse(), cOsd::DrawRectangle(), cOsd::DrawText(), fontOsd, frameColor, cFont::GetFont(), cSkinDisplayMenu::GetTabbedText(), lineHeight, cSkinDisplayMenu::MaxTabs, osd, Roundness, cSkinDisplay::SetEditableWidth(), cSkinDisplayMenu::Tab(), x1, x2, x3, x4, and y3.

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::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 541 of file skinsttng.c.

References clrBackground, cTheme::Color(), cEvent::Description(), cOsd::DrawEllipse(), cOsd::DrawRectangle(), cOsd::DrawText(), fontOsd, frameColor, cEvent::GetDateString(), cEvent::GetEndTimeString(), cFont::GetFont(), cEvent::GetTimeString(), cEvent::GetVpsString(), cFont::Height(), cTextScroller::Height(), isempty(), osd, Roundness, cTextScroller::Set(), SetScrollbar(), cEvent::ShortText(), cEvent::StartTime(), cSkinDisplayMenu::textScroller, cEvent::Title(), cEvent::Vps(), x1, x2, x3, x4, x5, x6, x7, y3, and y4.

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::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 584 of file skinsttng.c.

References clrBackground, cTheme::Color(), DateString(), cRecordingInfo::Description(), cOsd::DrawEllipse(), cOsd::DrawRectangle(), fontOsd, frameColor, cFont::GetFont(), cFont::Height(), cTextScroller::Height(), cRecording::Info(), isempty(), cRecording::Name(), osd, Roundness, cTextScroller::Set(), SetScrollbar(), cRecordingInfo::ShortText(), cRecording::start, cSkinDisplayMenu::textScroller, TimeString(), cRecordingInfo::Title(), x1, x2, x3, x4, y3, and y4.

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::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 621 of file skinsttng.c.

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

Here is the call graph for this function:

int cSkinSTTNGDisplayMenu::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 627 of file skinsttng.c.

References x3, and x4.

Referenced by SetText().

const cFont * cSkinSTTNGDisplayMenu::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 632 of file skinsttng.c.

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

Referenced by SetText().

Here is the call graph for this function:

void cSkinSTTNGDisplayMenu::Flush ( void   )  [virtual]

Actually draws the OSD display to the output device.

Reimplemented from cSkinDisplay.

Definition at line 639 of file skinsttng.c.

References cTheme::Color(), DayDateTime(), cOsd::DrawText(), cOsd::Flush(), frameColor, cFont::GetFont(), cFont::Height(), message, osd, cFont::Width(), x4, and y7.

Here is the call graph for this function:


Member Data Documentation

cOsd* cSkinSTTNGDisplayMenu::osd [private]

Definition at line 329 of file skinsttng.c.

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

int cSkinSTTNGDisplayMenu::x0 [private]

Definition at line 330 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu().

int cSkinSTTNGDisplayMenu::x1 [private]

Definition at line 330 of file skinsttng.c.

Referenced by Clear(), cSkinSTTNGDisplayMenu(), SetEvent(), SetItem(), and SetRecording().

int cSkinSTTNGDisplayMenu::x2 [private]

Definition at line 330 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), SetEvent(), SetItem(), and SetRecording().

int cSkinSTTNGDisplayMenu::x3 [private]

Definition at line 330 of file skinsttng.c.

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

int cSkinSTTNGDisplayMenu::x4 [private]

Definition at line 330 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), Flush(), GetTextAreaWidth(), SetButtons(), SetEvent(), SetItem(), SetMessage(), SetRecording(), and SetTitle().

int cSkinSTTNGDisplayMenu::x5 [private]

Definition at line 330 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), SetEvent(), and SetScrollbar().

int cSkinSTTNGDisplayMenu::x6 [private]

Definition at line 330 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), SetEvent(), and SetScrollbar().

int cSkinSTTNGDisplayMenu::x7 [private]

Definition at line 330 of file skinsttng.c.

Referenced by Clear(), cSkinSTTNGDisplayMenu(), SetEvent(), and SetScrollbar().

int cSkinSTTNGDisplayMenu::y0 [private]

Definition at line 331 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), and SetTitle().

int cSkinSTTNGDisplayMenu::y1 [private]

Definition at line 331 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu().

int cSkinSTTNGDisplayMenu::y2 [private]

Definition at line 331 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu().

int cSkinSTTNGDisplayMenu::y3 [private]

Definition at line 331 of file skinsttng.c.

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

int cSkinSTTNGDisplayMenu::y4 [private]

Definition at line 331 of file skinsttng.c.

Referenced by Clear(), cSkinSTTNGDisplayMenu(), MaxItems(), SetEvent(), SetRecording(), and SetText().

int cSkinSTTNGDisplayMenu::y5 [private]

Definition at line 331 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu().

int cSkinSTTNGDisplayMenu::y6 [private]

Definition at line 331 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), SetButtons(), and SetMessage().

int cSkinSTTNGDisplayMenu::y7 [private]

Definition at line 331 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), Flush(), SetButtons(), and SetMessage().

int cSkinSTTNGDisplayMenu::lineHeight [private]

Definition at line 332 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), MaxItems(), SetItem(), and SetScrollbar().

tColor cSkinSTTNGDisplayMenu::frameColor [private]

Definition at line 333 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), Flush(), SetEvent(), SetItem(), SetRecording(), SetScrollbar(), and SetTitle().

int cSkinSTTNGDisplayMenu::currentIndex [private]

Definition at line 334 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), and SetItem().

bool cSkinSTTNGDisplayMenu::message [private]

Definition at line 335 of file skinsttng.c.

Referenced by cSkinSTTNGDisplayMenu(), Flush(), and SetMessage().


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