KDE 4.0 API Reference libkdegames
KGameTheme Class Reference
#include <kgametheme.h>
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
Definition at line 40 of file kgametheme.h.
Public Member Functions | |
| KGameTheme (const QString &themeGroup=QLatin1String("KGameTheme")) | |
| virtual | ~KGameTheme () |
| virtual bool | loadDefault () |
| virtual bool | load (const QString &file) |
| QString | path () const |
| QString | fileName () const |
| virtual QString | graphics () const |
| QString | property (const QString &key) const |
| QPixmap | preview () const |
| virtual QString | themeProperty (const QString &key) const |
Friends | |
| class | KGameThemePrivate |
Constructor & Destructor Documentation
| KGameTheme::KGameTheme | ( | const QString & | themeGroup = QLatin1String("KGameTheme") |
) |
Definition at line 46 of file kgametheme.cpp.
| 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.
| 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.
| QString KGameTheme::path | ( | ) | const |
| QString KGameTheme::fileName | ( | ) | const |
| 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.
| QPixmap KGameTheme::preview | ( | ) | const |
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.
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:
