cTheme Class Reference

#include <themes.h>

List of all members.

Public Types
enum	{ MaxThemeColors = 128 }
Public Member Functions
	cTheme (void)
	Creates a new theme class.
	~cTheme ()
const char *	Name (void)
const char *	Description (void)
bool	Load (const char *FileName, bool OnlyDescriptions=false)
	Loads the theme data from the given file.
bool	Save (const char *FileName)
int	AddColor (const char *Name, tColor Color)
tColor	Color (int Subject)

---

Detailed Description

Definition at line 16 of file themes.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

MaxThemeColors

Definition at line 18 of file themes.h.

{ MaxThemeColors = 128 };

---

Constructor & Destructor Documentation

cTheme::cTheme

(

void

)

Creates a new theme class.

cTheme::~cTheme

(

)

---

Member Function Documentation

int cTheme::AddColor	(	const char *	Name,
		tColor	Color
	)

Adds a color with the given Name to this theme, initializes it with Color and returns an index into the color array that can be used in a call to Color() later. The index returned from the first call to AddColor() is 0, and subsequent calls will return values that are incremented by 1 with every call. If a color entry with the given Name already exists, its value will be overwritten with Color and the returned index will be that of the existing entry.

tColor cTheme::Color

(

int

Subject

)

Returns the color for the given Subject. Subject must be one of the values returned by a previous call to AddColor().

const char* cTheme::Description

(

void

)

Returns a user visible, single line description of this theme. The actual text shouldn't be too long, so that it can be fully displayed in the Setup/OSD menu.

bool cTheme::Load	(	const char *	FileName,
		bool	OnlyDescriptions = false
	)

Loads the theme data from the given file.

const char* cTheme::Name

(

void

)

[inline]

Definition at line 29 of file themes.h.

{ return name; }

bool cTheme::Save

(

const char *

FileName

)

Saves the theme data to the given file. FileName must be in the form "<skin>-<theme>.theme", where <skin> is the name of the skin this theme applies to, and <theme> is the actual theme name, which will be used to identify this theme in the 'setup.conf', and is normally not seen by the user. It should consist of only lowercase letters and digits.

---

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

• contrib/sasc-ng/sc/include/vdr/themes.h