From 022f7f671bd5a04cfd0cda77856754ace57628fb Mon Sep 17 00:00:00 2001 From: "Aaron J. Seigo" Date: Thu, 24 May 2007 18:14:54 +0000 Subject: [PATCH] let's make this a bit more obvious. not that anyone reads this stuff apparently. svn path=/trunk/KDE/kdebase/workspace/plasma/lib/; revision=667993 --- theme.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/theme.h b/theme.h index 632eae199..f6e1c99a0 100644 --- a/theme.h +++ b/theme.h @@ -33,6 +33,13 @@ namespace Plasma * QString image = Plasma::Theme::self()->image("widgets/clock") * \endcode * + * Plasma::Theme provides access to a common and standardized set of graphic + * elements stored in SVG format. This allows artists to create single packages + * of SVGs that will affect the look and feel of all workspace components. + * + * Plasma::Svg uses Plasma::Theme internally to locate and load the appropriate + * SVG data. Alternatively, Plasma::Theme can be used directly to retrieve + * file system paths to SVGs by name. */ class PLASMA_EXPORT Theme : public QObject { @@ -48,9 +55,10 @@ class PLASMA_EXPORT Theme : public QObject ~Theme(); /** - * @return the name of the theme directory. "default" is none set. + * @return the name of the theme. "default" is none set. */ QString themeName() const; + /** * @arg name the name of the file in the theme directory (without the * ".svg" part)