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

fix tooltip docu

Browse Source
This commit is contained in:
Lukáš Tinkl 2015-01-26 15:09:35 +01:00
parent 32c5eb77db
commit f29ba02777
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/declarativeimports/core/tooltip.h
View File

@ -35,12 +35,11 @@ class ToolTipDialog;
* @class ToolTip * @class ToolTip
* *
* An Item managing a Plasma-themed tooltip. It is rendered in its own window. * An Item managing a Plasma-themed tooltip. It is rendered in its own window.
* You can either specify iconSource, mainText and subText, or a custom Component * You can either specify icon, mainText and subText, or a custom Component
* that will be put inside the tooltip. By specifying the target property, you * that will be put inside the tooltip. By default the tooltip will be
* "attach" the ToolTip to an item in your code, by default the tooltip will be
* rendered when hovering over the parent item. * rendered when hovering over the parent item.
* *
* The item inside the ToolTip is loaded on demand and will be destroyed when the * The item inside the ToolTipArea is loaded on demand and will be destroyed when the
* tooltip is being hidden. * tooltip is being hidden.
* *
* Example usage: * Example usage:
@ -48,12 +47,12 @@ class ToolTipDialog;
* import org.kde.plasma.core 2.0 as PlasmaCore * import org.kde.plasma.core 2.0 as PlasmaCore
* *
* [...] * [...]
* PlasmaComponents.IconItem { * PlasmaCore.IconItem {
* ... * ...
* PlasmaCore.ToolTipArea { * PlasmaCore.ToolTipArea {
* mainText: "Tooltip Title" * mainText: i18n("Tooltip Title")
* subText: "Some explanation." * subText: i18n("Some explanation.")
* iconSource: "plasma" * icon: "plasma"
* // alternatively, you can specify your own component * // alternatively, you can specify your own component
* // to be loaded when the tooltip shows * // to be loaded when the tooltip shows
* mainComponent: Component { * mainComponent: Component {