#include <KgTheme>

Inheritance diagram for KgTheme:

Signals
void	readOnlyProperty ()

Public Member Functions
	KgTheme (const QByteArray &identifier, QObject *parent=0)

virtual	~KgTheme ()

QString	author () const

QString	authorEmail () const

QMap< QString, QString >	customData () const

QString	customData (const QString &key, const QString &defaultValue=QString()) const

QString	description () const

QString	graphicsPath () const

QByteArray	identifier () const

QString	name () const

QString	previewPath () const

virtual bool	readFromDesktopFile (const QString &path)

void	setAuthor (const QString &author)

void	setAuthorEmail (const QString &authorEmail)

void	setCustomData (const QMap< QString, QString > &customData)

void	setDescription (const QString &description)

void	setGraphicsPath (const QString &path)

void	setName (const QString &name)

void	setPreviewPath (const QString &path)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Properties
QString	author

QString	authorEmail

QString	description

QString	graphicsPath

QByteArray	identifier

QString	name

QString	previewPath

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Detailed Description

A theme describes the visual appearance of a game.

Themes in kdegames usually reference a SVGZ file which is loaded into a KGameRenderer to provide pixmaps for use on the game canvas.

Themes are usually managed (and discovered) by a KgThemeProvider.

Default file format for theme descriptions

Although KgTheme and KgThemeProvider do not need special theme description files for most basic usage, there is a format for theme description files based on the XDG Desktop File Specification. The following example shows the recognized keys:

[KGameTheme]
VersionFormat=1
Name=Example
Description=This theme serves as an example.
FileName=example.svgz
Author=John Doe
AuthorEmail=john.doe@example.com
Preview=example.png

All keys are considered optional, except perhaps for the "FileName" key: If that is not given, the theme cannot be used with KGameRenderer. The paths in "FileName" and "Preview" are resolved relative to the directory that contains the theme description file.

If the [KGameTheme] group contains any further keys, their values can be retrieved through the KgTheme::customData() method.

Definition at line 68 of file kgtheme.h.

Constructor & Destructor Documentation

KgTheme::KgTheme	(	const QByteArray &	identifier,
		QObject *	parent = `0`
	)

explicit

Constructor. The identifier must be application-unique.

Definition at line 42 of file kgtheme.cpp.

KgTheme::~KgTheme ( )

virtual

Destructor.

Definition at line 48 of file kgtheme.cpp.

Member Function Documentation

QString KgTheme::author ( ) const

Returns: the name of the theme author

QString KgTheme::authorEmail ( ) const

Returns: the email address of the theme author

QMap< QString, QString > KgTheme::customData ( ) const

Returns: custom data

This API is provided for theme description files which contain additional application-specific metadata.

Definition at line 69 of file kgtheme.cpp.

QString KgTheme::customData	(	const QString &	key,
		const QString &	defaultValue = `QString()`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 74 of file kgtheme.cpp.

QString KgTheme::description ( ) const

Returns: an additional description beyond the name()

QString KgTheme::graphicsPath ( ) const

Returns: the path of the SVG file which holds the theme contents

QByteArray KgTheme::identifier ( ) const

Returns: the internal identifier for this theme (used e.g. for finding a pixmap cache or storing a theme selection)

QString KgTheme::name ( ) const

Returns: the name of this theme

QString KgTheme::previewPath ( ) const

Returns: the path to an image file containing a preview, or an empty string if no preview file is known

bool KgTheme::readFromDesktopFile ( const QString & path )

virtual

Initializes a KgTheme instance by reading a description file.

Returns: whether path is a valid theme description file (if not, the theme instance is not changed by this method call)

Note: A non-static member function has been chosen over the more common pattern of using a static member function like "KgTheme::fromDesktopFile" to accommodate applications which want to subclass KgTheme.

Definition at line 84 of file kgtheme.cpp.

void KgTheme::readOnlyProperty ( )

signal

This signal is never emitted.

It is provided because QML likes to complain about properties without NOTIFY signals, even readonly ones.

void KgTheme::setAuthor ( const QString & author )

See also: author()

void KgTheme::setAuthorEmail ( const QString & authorEmail )

See also: authorEmail()

void KgTheme::setCustomData ( const QMap< QString, QString > & customData )

See also: customData()

Definition at line 79 of file kgtheme.cpp.

void KgTheme::setDescription ( const QString & description )

See also: description()

void KgTheme::setGraphicsPath ( const QString & path )

See also: graphicsPath()

void KgTheme::setName ( const QString & name )

See also: name()

void KgTheme::setPreviewPath ( const QString & path )

See also: previewPath()

Property Documentation

QString KgTheme::author

readwrite

Definition at line 77 of file kgtheme.h.

QString KgTheme::authorEmail

readwrite

Definition at line 78 of file kgtheme.h.

QString KgTheme::description

readwrite

Definition at line 76 of file kgtheme.h.

QString KgTheme::graphicsPath

readwrite

Definition at line 79 of file kgtheme.h.

QByteArray KgTheme::identifier

read

Definition at line 71 of file kgtheme.h.

QString KgTheme::name

readwrite

Definition at line 75 of file kgtheme.h.

QString KgTheme::previewPath

readwrite

Definition at line 80 of file kgtheme.h.

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

libkdegames

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Default file format for theme descriptions

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

libkdegames

kdegames API Reference

Search