From 324d7a4be9437e368db84654bd97505c07f7e829 Mon Sep 17 00:00:00 2001 From: "Aaron J. Seigo" Date: Tue, 29 May 2007 07:56:58 +0000 Subject: [PATCH] better API docs so there is a bit less confusion over this svn path=/trunk/KDE/kdebase/workspace/plasma/lib/; revision=669391 --- theme.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/theme.h b/theme.h index f6e1c99a0..2b92dbdb9 100644 --- a/theme.h +++ b/theme.h @@ -51,6 +51,9 @@ class PLASMA_EXPORT Theme : public QObject **/ static Theme* self(); + /** + * Default constructor. Usually you want to use the singleton instead. + */ explicit Theme( QObject* parent = 0 ); ~Theme(); @@ -60,13 +63,19 @@ class PLASMA_EXPORT Theme : public QObject QString themeName() const; /** - * @arg name the name of the file in the theme directory (without the - * ".svg" part) + * Retrieve the path for an SVG image in the current theme. + * + * @arg name the name of the file in the theme directory (without the + * ".svg" part or a leading slash) * @return the full path to the requested file for the current theme */ QString image( const QString& name ) const; Q_SIGNALS: + /** + * Emitted when the user changes the theme. SVGs should be reloaded at + * that point + */ void changed(); private: