Document WallpaperInterface

Change-Id: I25819a1d11fb63d3685a6fa0940e0c2f88e5cfd4
This commit is contained in:
David Edmundson 2014-12-21 21:02:39 +01:00
parent 53d694072c
commit 86e89dd309
2 changed files with 13 additions and 1 deletions

View File

@ -7,11 +7,16 @@ It should not be used directly, however some classes are exposed to Plasma as at
Namely: Namely:
- AppletInterface - AppletInterface
- ContainmentInterface - ContainmentInterface
which are exposed as "Plasmoid" for applets and containments respectively. which are exposed as "Plasmoid" for applets and containments respectively.
QML applets should import org.kde.plasma.plasmoid 2.0 in order to access this attached object QML applets should import org.kde.plasma.plasmoid 2.0 in order to access this attached object
- WallpaperInterface
which is exposed as to wallpapers as the attached propety "wallpaper".
It does not require any special imports
*/ */
// DOXYGEN_SET_PROJECT_NAME = Plasma // DOXYGEN_SET_PROJECT_NAME = Plasma

View File

@ -37,6 +37,13 @@ class ConfigPropertyMap;
class QmlObject; class QmlObject;
} }
/**
* @class WallpaperInterface
*
* @brief This class is exposed to wallpapers as the attached property "wallpaper"
*
*
*/
class WallpaperInterface : public QQuickItem class WallpaperInterface : public QQuickItem
{ {
Q_OBJECT Q_OBJECT