#include <KGameTheme>

Inheritance diagram for KGameTheme:

Properties
QString	author

QString	authorEmail

QString	bugReportUrl

QString	copyrightText

QString	description

QString	graphicsPath

QByteArray	identifier

QString	license

QString	name

QString	previewPath

QString	version

QString	website

Properties inherited from QObject
	objectName

Signals
void	readOnlyProperty ()

Public Member Functions
	KGameTheme (const QByteArray &identifier, QObject *parent=nullptr)

	~KGameTheme () override

QString	author () const

QString	authorEmail () const

QString	bugReportUrl () const

QString	copyrightText () 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	license () const

QString	name () const

QString	previewPath () const

virtual bool	readFromDesktopFile (const QString &path)

void	setAuthor (const QString &author)

void	setAuthorEmail (const QString &authorEmail)

void	setBugReportUrl (const QString &bugReportUrl)

void	setCopyrightText (const QString &copyrightText)

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

void	setDescription (const QString &description)

void	setGraphicsPath (const QString &path)

void	setLicense (const QString &license)

void	setName (const QString &name)

void	setPreviewPath (const QString &path)

void	setVersion (const QString &version)

void	setWebsite (const QString &website)

QString	version () const

QString	website () const

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

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

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

void	deleteLater ()

void	destroyed (QObject *obj)

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

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

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

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)

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

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

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

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 KGameThemeProvider.

Default file format for theme descriptions

Although KGameTheme and KGameThemeProvider 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.
License=CC-BY-SA-4.0
Copyright=1984 John Doe
Version=1.0
Website=https://theme.example
BugReportUrl=https://theme.example/newbugform
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 KGameTheme::customData() method.

Definition at line 59 of file kgametheme.h.

Property Documentation

◆ author

QString KGameTheme::author

readwrite

Definition at line 73 of file kgametheme.h.

◆ authorEmail

QString KGameTheme::authorEmail

readwrite

Definition at line 74 of file kgametheme.h.

◆ bugReportUrl

QString KGameTheme::bugReportUrl

readwrite

Definition at line 72 of file kgametheme.h.

◆ copyrightText

QString KGameTheme::copyrightText

readwrite

Definition at line 69 of file kgametheme.h.

◆ description

QString KGameTheme::description

readwrite

Definition at line 67 of file kgametheme.h.

◆ graphicsPath

QString KGameTheme::graphicsPath

readwrite

Definition at line 75 of file kgametheme.h.

◆ identifier

QByteArray KGameTheme::identifier

read

Definition at line 62 of file kgametheme.h.

◆ license

QString KGameTheme::license

readwrite

Definition at line 68 of file kgametheme.h.

◆ name

QString KGameTheme::name

readwrite

Definition at line 66 of file kgametheme.h.

◆ previewPath

QString KGameTheme::previewPath

readwrite

Definition at line 76 of file kgametheme.h.

◆ version

QString KGameTheme::version

readwrite

Definition at line 70 of file kgametheme.h.

◆ website

QString KGameTheme::website

readwrite

Definition at line 71 of file kgametheme.h.

Constructor & Destructor Documentation

◆ KGameTheme()

KGameTheme::KGameTheme	(	const QByteArray &	identifier,
		QObject *	parent = nullptr )

explicit

Constructor. The identifier must be application-unique.

Definition at line 44 of file kgametheme.cpp.

◆ ~KGameTheme()

KGameTheme::~KGameTheme ( )

overridedefault

Destructor.

Member Function Documentation

◆ author()

QString KGameTheme::author ( ) const

Returns: the name of the theme author

◆ authorEmail()

QString KGameTheme::authorEmail ( ) const

Returns: the email address of the theme author

◆ bugReportUrl()

QString KGameTheme::bugReportUrl ( ) const

Returns: the website where people can report a bug found in this theme.

◆ copyrightText()

QString KGameTheme::copyrightText ( ) const

Returns: a short copyright statement

◆ customData() [1/2]

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

Returns: custom data

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

Definition at line 83 of file kgametheme.cpp.

◆ customData() [2/2]

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

This is an overloaded member function that returns a single value from the customData() map.

Definition at line 90 of file kgametheme.cpp.

◆ description()

QString KGameTheme::description ( ) const

Returns: an additional description beyond the name()

◆ graphicsPath()

QString KGameTheme::graphicsPath ( ) const

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

◆ identifier()

QByteArray KGameTheme::identifier ( ) const

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

Definition at line 52 of file kgametheme.cpp.

◆ license()

QString KGameTheme::license ( ) const

Returns: the short license identifier, as SPDX expression

◆ name()

QString KGameTheme::name ( ) const

Returns: the name of this theme

◆ previewPath()

QString KGameTheme::previewPath ( ) const

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

◆ readFromDesktopFile()

bool KGameTheme::readFromDesktopFile ( const QString & path )

virtual

Initializes a KGameTheme 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 "KGameTheme::fromDesktopFile" to accommodate applications which want to subclass KGameTheme.

Definition at line 104 of file kgametheme.cpp.

◆ readOnlyProperty

void KGameTheme::readOnlyProperty ( )

signal

This signal is never emitted.

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

◆ setAuthor()

void KGameTheme::setAuthor ( const QString & author )

See also: author()

◆ setAuthorEmail()

void KGameTheme::setAuthorEmail ( const QString & authorEmail )

See also: authorEmail()

◆ setBugReportUrl()

void KGameTheme::setBugReportUrl ( const QString & bugReportUrl )

See also: bugReportUrl()

◆ setCopyrightText()

void KGameTheme::setCopyrightText ( const QString & copyrightText )

See also: copyrightText()

◆ setCustomData()

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

See also: customData()

Definition at line 97 of file kgametheme.cpp.

◆ setDescription()

void KGameTheme::setDescription ( const QString & description )

See also: description()

◆ setGraphicsPath()

void KGameTheme::setGraphicsPath ( const QString & path )

See also: graphicsPath()

◆ setLicense()

void KGameTheme::setLicense ( const QString & license )

See also: license()

◆ setName()

void KGameTheme::setName ( const QString & name )

See also: name()

◆ setPreviewPath()

void KGameTheme::setPreviewPath ( const QString & path )

See also: previewPath()

◆ setVersion()

void KGameTheme::setVersion ( const QString & version )

See also: version()

◆ setWebsite()

void KGameTheme::setWebsite ( const QString & website )

See also: website()

◆ version()

QString KGameTheme::version ( ) const

Returns: the version of the theme.

◆ website()

QString KGameTheme::website ( ) const

Returns: the website of the theme.

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

Class Picker

Quick Links

About KDEGames

KGameTheme

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Default file format for theme descriptions

Property Documentation

◆ author

◆ authorEmail

◆ bugReportUrl

◆ copyrightText

◆ description

◆ graphicsPath

◆ identifier

◆ license

◆ name

◆ previewPath

◆ version

◆ website

Constructor & Destructor Documentation

◆ KGameTheme()

◆ ~KGameTheme()

Member Function Documentation

◆ author()

◆ authorEmail()

◆ bugReportUrl()

◆ copyrightText()

◆ customData() [1/2]

◆ customData() [2/2]

◆ description()

◆ graphicsPath()

◆ identifier()

◆ license()

◆ name()

◆ previewPath()

◆ readFromDesktopFile()

◆ readOnlyProperty

◆ setAuthor()

◆ setAuthorEmail()

◆ setBugReportUrl()

◆ setCopyrightText()

◆ setCustomData()

◆ setDescription()

◆ setGraphicsPath()

◆ setLicense()

◆ setName()

◆ setPreviewPath()

◆ setVersion()

◆ setWebsite()

◆ version()

◆ website()