cSkin Class Reference

#include <skins.h>

Inheritance diagram for cSkin:

List of all members.

Public Member Functions
	cSkin (const char *Name, cTheme *Theme=NULL)
virtual	~cSkin ()
const char *	Name (void)
cTheme *	Theme (void)
virtual const char *	Description (void)=0
virtual cSkinDisplayChannel *	DisplayChannel (bool WithInfo)=0
virtual cSkinDisplayMenu *	DisplayMenu (void)=0
virtual cSkinDisplayReplay *	DisplayReplay (bool ModeOnly)=0
virtual cSkinDisplayVolume *	DisplayVolume (void)=0
virtual cSkinDisplayTracks *	DisplayTracks (const char *Title, int NumTracks, const char *const *Tracks)=0
virtual cSkinDisplayMessage *	DisplayMessage (void)=0

---

Detailed Description

Definition at line 256 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.

virtual cSkin::~cSkin

(

)

[virtual]

---

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.

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.

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.

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.

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.

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.

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.

const char* cSkin::Name

(

void

)

[inline]

Definition at line 275 of file skins.h.

{ return name; }

cTheme* cSkin::Theme

(

void

)

[inline]

Definition at line 276 of file skins.h.

{ return theme; }

---

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

• sc/include/vdr/skins.h