KgTheme

Search for usage in LXR

#include <KgTheme>

Inheritance diagram for KgTheme:

Properties

QString author
 
QString authorEmail
 
QString description
 
QString graphicsPath
 
QByteArray identifier
 
QString name
 
QString previewPath
 
- Properties inherited from QObject
 objectName
 

Signals

void readOnlyProperty ()
 

Public Member Functions

 KgTheme (const QByteArray &identifier, QObject *parent=nullptr)
 
 ~KgTheme () override
 
QString author () const
 
QString authorEmail () const
 
QMap< QString, QStringcustomData () 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)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () 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 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:

VersionFormat=1
Name=Example
Description=This theme serves as an example.
FileName=example.svgz
Author=John Doe
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 57 of file kgtheme.h.

Constructor & Destructor Documentation

◆ KgTheme()

KgTheme::KgTheme ( const QByteArray identifier,
QObject parent = nullptr 
)
explicit

Constructor. The identifier must be application-unique.

Definition at line 38 of file kgtheme.cpp.

◆ ~KgTheme()

KgTheme::~KgTheme ( )
overridedefault

Destructor.

Member Function Documentation

◆ author()

QString KgTheme::author ( ) const
Returns
the name of the theme author

◆ authorEmail()

QString KgTheme::authorEmail ( ) const
Returns
the email address of the theme author

◆ customData() [1/2]

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 68 of file kgtheme.cpp.

◆ customData() [2/2]

QString KgTheme::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 73 of file kgtheme.cpp.

◆ description()

QString KgTheme::description ( ) const
Returns
an additional description beyond the name()

◆ graphicsPath()

QString KgTheme::graphicsPath ( ) const
Returns
the path of the SVG file which holds the theme contents

◆ identifier()

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

◆ name()

QString KgTheme::name ( ) const
Returns
the name of this theme

◆ previewPath()

QString KgTheme::previewPath ( ) const
Returns
the path to an image file containing a preview, or an empty string if no preview file is known

◆ readFromDesktopFile()

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 83 of file kgtheme.cpp.

◆ readOnlyProperty

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.

◆ setAuthor()

void KgTheme::setAuthor ( const QString author)
See also
author()

◆ setAuthorEmail()

void KgTheme::setAuthorEmail ( const QString authorEmail)
See also
authorEmail()

◆ setCustomData()

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

Definition at line 78 of file kgtheme.cpp.

◆ setDescription()

void KgTheme::setDescription ( const QString description)
See also
description()

◆ setGraphicsPath()

void KgTheme::setGraphicsPath ( const QString path)
See also
graphicsPath()

◆ setName()

void KgTheme::setName ( const QString name)
See also
name()

◆ setPreviewPath()

void KgTheme::setPreviewPath ( const QString path)
See also
previewPath()

The documentation for this class was generated from the following files:
Class for loading theme files.
Definition: kgametheme.h:40
Description
Author
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Dec 4 2022 03:50:22 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.