KGameTheme Class Reference

#include <kgametheme.h>

Collaboration diagram for KGameTheme:

[legend]

List of all members.

Public Member Functions
	KGameTheme (const QString &themeGroup=QLatin1String("KGameTheme"))
virtual	~KGameTheme ()
virtual bool	loadDefault ()
	Load the default theme file.
virtual bool	load (const QString &file)
	Load a specific theme file.
QString	path () const
	Returns: the full path of the .desktop file
QString	fileName () const
	Returns: just the "*.desktop" part
virtual QString	graphics () const
	Returns: the full path of the svg file which is specified in "FileName" key
	QString (const QString &key) const
	Returns: a property directly from the .desktop file
QPixmap	preview () const
	Returns: a preview pixmap
virtual QString	themeProperty (const QString &key) const
	Possible keys: Name Author Description AuthorEmail.
Friends
class	KGameThemePrivate

---

Detailed Description

Class for loading theme files Essentially just a wrapper around a .desktop theme file. Load a file with load() and then access its properties.

For more advanced feaures like dynamic themes or custom game rules, it will likely be necessary to derive from this class

Author:

Mauricio Piacentini

Definition at line 40 of file kgametheme.h.

---

Constructor & Destructor Documentation

KGameTheme::KGameTheme

(

const QString &

themeGroup = QLatin1String("KGameTheme")

)

Definition at line 46 of file kgametheme.cpp.

References KGameThemePrivate::themeGroup.

KGameTheme::~KGameTheme

(

)

[virtual]

Definition at line 53 of file kgametheme.cpp.

---

Member Function Documentation

bool KGameTheme::loadDefault

(

)

[virtual]

Load the default theme file.

Called "default.desktop"

Returns:

true if the theme files and properties could be loaded

Definition at line 57 of file kgametheme.cpp.

References load().

Here is the call graph for this function:

bool KGameTheme::load

(

const QString &

file

)

[virtual]

Load a specific theme file.

Note that although theme could be successfully loaded, no check on the validity of theme's SVG file contents is done. Application writers will need to perform this check manually e.g. by calling KSvgRenderer::isValid()

Parameters:

file

the name of the theme file relative to the share/apps/appname directory. e.g. "themes/classic.desktop"

Returns:

true if the theme files and properties could be loaded

Definition at line 64 of file kgametheme.cpp.

References KGameThemePrivate::fileName, KGameThemePrivate::fullPath, KGameThemePrivate::graphics, kThemeVersionFormat, KGameThemePrivate::loaded, KGameThemePrivate::prefix, KGameThemePrivate::preview, QString(), KGameThemePrivate::themeGroup, and KGameThemePrivate::themeproperties.

Referenced by loadDefault(), and KGameThemeSelector::KGameThemeSelectorPrivate::setupData().

Here is the call graph for this function:

QString KGameTheme::path

(

)

const

Returns:

the full path of the .desktop file

Definition at line 138 of file kgametheme.cpp.

References KGameThemePrivate::fullPath, KGameThemePrivate::loaded, and QString().

Referenced by KGameThemeSelector::KGameThemeSelectorPrivate::_k_updatePreview().

Here is the call graph for this function:

QString KGameTheme::fileName

(

)

const

Returns:

just the "*.desktop" part

Definition at line 147 of file kgametheme.cpp.

References KGameThemePrivate::fileName, KGameThemePrivate::loaded, and QString().

Referenced by KGameThemeSelector::KGameThemeSelectorPrivate::_k_updatePreview().

Here is the call graph for this function:

QString KGameTheme::graphics

(

)

const [virtual]

Returns:

the full path of the svg file which is specified in "FileName" key

Definition at line 156 of file kgametheme.cpp.

References KGameThemePrivate::graphics, KGameThemePrivate::loaded, and QString().

Here is the call graph for this function:

KGameTheme::QString

(

const QString &

key

)

const

Returns:

a property directly from the .desktop file

Referenced by fileName(), graphics(), load(), path(), and themeProperty().

QPixmap KGameTheme::preview

(

)

const

Returns:

a preview pixmap

Definition at line 165 of file kgametheme.cpp.

References KGameThemePrivate::loaded, and KGameThemePrivate::preview.

Referenced by KGameThemeSelector::KGameThemeSelectorPrivate::_k_updatePreview().

QString KGameTheme::themeProperty

(

const QString &

key

)

const [virtual]

Possible keys:

• Name
• Author
• Description
• AuthorEmail.

Parameters:

key

the key of the wanted property

Returns:

the data related to 'key'

Definition at line 174 of file kgametheme.cpp.

References KGameThemePrivate::loaded, QString(), and KGameThemePrivate::themeproperties.

Referenced by KGameThemeSelector::KGameThemeSelectorPrivate::_k_updatePreview(), and KGameThemeSelector::KGameThemeSelectorPrivate::setupData().

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class KGameThemePrivate [friend]

Definition at line 84 of file kgametheme.h.

---

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

• kgametheme.h
• kgametheme.cpp

---