vdr  2.2.0
Public Member Functions | Private Attributes | List of all members
cSkin Class Referenceabstract

#include <skins.h>

Public Member Functions

 cSkin (const char *Name, cTheme *Theme=NULL)
 
virtual ~cSkin ()
 
const char * Name (void)
 
cThemeTheme (void)
 
virtual const char * Description (void)=0
 
virtual cSkinDisplayChannelDisplayChannel (bool WithInfo)=0
 
virtual cSkinDisplayMenuDisplayMenu (void)=0
 
virtual cSkinDisplayReplayDisplayReplay (bool ModeOnly)=0
 
virtual cSkinDisplayVolumeDisplayVolume (void)=0
 
virtual cSkinDisplayTracksDisplayTracks (const char *Title, int NumTracks, const char *const *Tracks)=0
 
virtual cSkinDisplayMessageDisplayMessage (void)=0
 
- Public Member Functions inherited from cListObject
 cListObject (void)
 
virtual ~cListObject ()
 
virtual int Compare (const cListObject &ListObject) const
 
void Append (cListObject *Object)
 
void Insert (cListObject *Object)
 
void Unlink (void)
 
int Index (void) const
 
cListObjectPrev (void) const
 
cListObjectNext (void) const
 

Private Attributes

char * name
 
cThemetheme
 

Detailed Description

Definition at line 370 of file skins.h.

Constructor & Destructor Documentation

cSkin::cSkin ( const char *  Name,
cTheme Theme = NULL 
)

Creates a new skin class, with the given Name and Theme.

Name will be used to identify this skin in the 'setup.conf' file, and is normally not seen by the user. It should consist of only lowercase letters and digits. Theme must be a static object that survives the entire lifetime of this skin. The constructor of a derived class shall not set up any data structures yet, because whether or not this skin will actually be used is not yet known at this point. All actual work shall be done in the pure functions below. A cSkin object must be created on the heap and shall not be explicitly deleted.

Definition at line 203 of file skins.c.

References cListBase::Add(), cThemes::Save(), Skins, and Theme.

cSkin::~cSkin ( )
virtual

Definition at line 212 of file skins.c.

Member Function Documentation

virtual const char* cSkin::Description ( void  )
pure virtual

Returns a user visible, single line description of this skin, which may consist of arbitrary text and can, if the skin implementation wishes to do so, be internationalized.

The actual text shouldn't be too long, so that it can be fully displayed in the Setup/OSD menu.

Implemented in cSkinCurses, cSkinClassic, cSkinLCARS, and cSkinSTTNG.

virtual cSkinDisplayChannel* cSkin::DisplayChannel ( bool  WithInfo)
pure virtual

Creates and returns a new object for displaying the current channel.

WithInfo indicates whether it shall display only the basic channel data, or also information about the present and following EPG event. The caller must delete the object after use.

Implemented in cSkinCurses, cSkinClassic, cSkinLCARS, and cSkinSTTNG.

Referenced by cDisplayChannel::cDisplayChannel(), and cDisplayChannel::ProcessKey().

virtual cSkinDisplayMenu* cSkin::DisplayMenu ( void  )
pure virtual

Creates and returns a new object for displaying a menu.

The caller must delete the object after use.

Implemented in cSkinCurses, cSkinClassic, cSkinLCARS, and cSkinSTTNG.

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

virtual cSkinDisplayMessage* cSkin::DisplayMessage ( void  )
pure virtual

Creates and returns a new object for displaying a message.

The caller must delete the object after use.

Implemented in cSkinCurses, cSkinClassic, cSkinLCARS, and cSkinSTTNG.

virtual cSkinDisplayReplay* cSkin::DisplayReplay ( bool  ModeOnly)
pure virtual

Creates and returns a new object for displaying replay progress.

ModeOnly indicates whether this should be a full featured replay display, or just a replay mode indicator. The caller must delete the object after use.

Implemented in cSkinCurses, cSkinClassic, cSkinLCARS, and cSkinSTTNG.

Referenced by cReplayControl::ShowMode(), and cReplayControl::ShowProgress().

virtual cSkinDisplayTracks* cSkin::DisplayTracks ( const char *  Title,
int  NumTracks,
const char *const *  Tracks 
)
pure virtual

Creates and returns a new object for displaying the available tracks.

NumTracks indicates how many entries in Tracks are available. Tracks will be valid throughout the entire lifetime of the returned cSkinDisplayTrack object. The caller must delete the object after use.

Implemented in cSkinCurses, cSkinClassic, cSkinLCARS, and cSkinSTTNG.

Referenced by cDisplaySubtitleTracks::cDisplaySubtitleTracks(), and cDisplayTracks::cDisplayTracks().

virtual cSkinDisplayVolume* cSkin::DisplayVolume ( void  )
pure virtual

Creates and returns a new object for displaying the current volume.

The caller must delete the object after use.

Implemented in cSkinCurses, cSkinClassic, cSkinLCARS, and cSkinSTTNG.

Referenced by cDisplayVolume::cDisplayVolume().

const char* cSkin::Name ( void  )
inline
cTheme* cSkin::Theme ( void  )
inline

Definition at line 390 of file skins.h.

Referenced by cMenuSetupOSD::cMenuSetupOSD(), main(), and cMenuSetupOSD::ProcessKey().

Member Data Documentation

char* cSkin::name
private

Definition at line 372 of file skins.h.

cTheme* cSkin::theme
private

Definition at line 373 of file skins.h.


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