alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

clarify the apidox a bit

Browse Source 
svn path=/trunk/KDE/kdelibs/; revision=1104443
This commit is contained in:
Aaron J. Seigo 2010-03-17 18:15:28 +00:00
parent 3e6f6ab670
commit 34ca7fdba5
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
framesvg.h
View File

@ -161,7 +161,10 @@ class PLASMA_EXPORT FrameSvg : public Svg
* Sets the prefix (@see setElementPrefix) to 'north', 'south', 'west' and 'east' * Sets the prefix (@see setElementPrefix) to 'north', 'south', 'west' and 'east'
* when the location is TopEdge, BottomEdge, LeftEdge and RightEdge, * when the location is TopEdge, BottomEdge, LeftEdge and RightEdge,
* respectively. Clears the prefix in other cases. * respectively. Clears the prefix in other cases.
* @arg location location *
* The prefix must exist in the SVG document, which means that this can only be
* called successfully after setImagePath is called.
* @arg location location in the UI this frame will be drawn
*/ */
Q_INVOKABLE void setElementPrefix(Plasma::Location location); Q_INVOKABLE void setElementPrefix(Plasma::Location location);
@ -175,8 +178,11 @@ class PLASMA_EXPORT FrameSvg : public Svg
* (for the sake of speed, the test is present only for the 'center' element) * (for the sake of speed, the test is present only for the 'center' element)
* *
* Setting the prefix manually resets the location to Floating. * Setting the prefix manually resets the location to Floating.
* If the *
* @arg prefix prefix for the SVG element names * The prefix must exist in the SVG document, which means that this can only be
* called successfully after setImagePath is called.
*
* @arg prefix prefix for the SVG elements that make up the frame
*/ */
Q_INVOKABLE void setElementPrefix(const QString & prefix); Q_INVOKABLE void setElementPrefix(const QString & prefix);