better API docs so there is a bit less confusion over this

svn path=/trunk/KDE/kdebase/workspace/plasma/lib/; revision=669391
This commit is contained in:
Aaron J. Seigo 2007-05-29 07:56:58 +00:00
parent 498ce9d548
commit 324d7a4be9

11
theme.h
View File

@ -51,6 +51,9 @@ class PLASMA_EXPORT Theme : public QObject
**/ **/
static Theme* self(); static Theme* self();
/**
* Default constructor. Usually you want to use the singleton instead.
*/
explicit Theme( QObject* parent = 0 ); explicit Theme( QObject* parent = 0 );
~Theme(); ~Theme();
@ -60,13 +63,19 @@ class PLASMA_EXPORT Theme : public QObject
QString themeName() const; QString themeName() const;
/** /**
* Retrieve the path for an SVG image in the current theme.
*
* @arg name the name of the file in the theme directory (without the * @arg name the name of the file in the theme directory (without the
* ".svg" part) * ".svg" part or a leading slash)
* @return the full path to the requested file for the current theme * @return the full path to the requested file for the current theme
*/ */
QString image( const QString& name ) const; QString image( const QString& name ) const;
Q_SIGNALS: Q_SIGNALS:
/**
* Emitted when the user changes the theme. SVGs should be reloaded at
* that point
*/
void changed(); void changed();
private: private: