Development/Tutorials/PortToKStatusNotifierItem - Revision history

Marten: Added note regarding "Quit", as suggested in review #102503

2012-06-19T13:15:20Z

Added note regarding "Quit", as suggested in review #102503

Agateau at 17:46, 25 February 2010

2010-02-25T17:46:39Z

Agateau: /* Initialization */

2010-02-25T17:30:01Z

‎Initialization

Agateau: Created page with 'Here is a list of changes to make to your application so that it can take advantage of the new KStatusNotifierItem (KSNI) class, available since KDE 4.4. == Initialization == *...'

2010-02-25T17:27:36Z

Created page with 'Here is a list of changes to make to your application so that it can take advantage of the new KStatusNotifierItem (KSNI) class, available since KDE 4.4. == Initialization == *...'

New page

Here is a list of changes to make to your application so that it can take advantage of the new KStatusNotifierItem (KSNI) class, available since KDE 4.4.

== Initialization ==

* KSNI constructor takes a QObject, not a QWidget
* Be sure to set your

* Signals:
* activated() becomes activateRequested(bool active, QPoint pos)

== Icons ==
Icons can be passed as a QString or as a QPixmap. Note that both must go through D-Bus, so for performance reasons, pass icons by name whenever possible.

* setIcon() becomes either setIconByName(QString) or setIconByPixmap(QPixmap)

== Tooltip ==

A KSNI tooltip is made of an icon, a title and a subtitle (which may contain some limited markup).
This means you have to replace your call to setToolTip(QString) with calls to:
* setToolTipIconByName(QString) or setToolTipIconByPixmap()
* setToolTipTitle(QString)
* setToolTipSubTitle(QString)

show() -> setStatus(KStatusNotifierItem::Active)
hide() -> setStatus(KStatusNotifierItem::Passive)

== Misc ==
* There is no equivalent for the convenience static loadIcon(QString) function. You have to replace it with KIconLoader::global()->loadIcon(name, KIconLoader::Panel)

← Older revision		Revision as of 13:15, 19 June 2012
Line 36:		Line 36:
	== Misc ==		== Misc ==
	There is no equivalent for the convenience static loadIcon(QString name) function. You have to replace it with KIconLoader::global()->loadIcon(name, KIconLoader::Panel)		There is no equivalent for the convenience static loadIcon(QString name) function. You have to replace it with KIconLoader::global()->loadIcon(name, KIconLoader::Panel)
		+
		+	The KStatusNotifierItem handles the "Quit" action in the popup menu itself, displaying a confirmation dialogue and calling qApp->quit() if the user confirms. It is not necessary for the application to handle this action itself.

@@ Line 1: / Line 1: @@
 Here is a list of changes to make to your application so that it can take advantage of the new KStatusNotifierItem (KSNI) class, available since KDE 4.4.
-== Initialization ==
+KSNI API can be found here:
 * KSNI constructor takes a QObject, not a QWidget
 * Be sure to set the category of your application with setCategory()
 == Signals ==
-* activated() becomes activateRequested(bool active, QPoint pos)
+Note: the mapping presented here is the one implemented by the Plasma Systemtray applet. Other implementations may do different choices.
-* Plasma systemtray will emit secondaryActivateRequested() when a user middle-click on the icon (other implementations may not support this though)
 == Icons ==
@@ Line 16: / Line 23: @@
 == Tooltip ==
 A KSNI tooltip is made of an icon, a title and a subtitle (which may contain some limited markup).
 This means you have to replace your call to setToolTip(QString) with calls to:
-* setToolTipIconByName(QString) or setToolTipIconByPixmap()
+* setToolTipIconByName(QString) (prefered) or setToolTipIconByPixmap(QPixmap)
 * setToolTipTitle(QString)
 * setToolTipSubTitle(QString)
-show() -> setStatus(KStatusNotifierItem::Active)
+== Status ==
-hide() -> setStatus(KStatusNotifierItem::Passive)
+An item has a status, which can be set with setStatus(). The host implementation can use this status to adjust the way it presents the item. For example, the Plasma Systemtray applet will automatically hide items with the Passive status by default, making it only visible if you click on the applet expand arrow.
 == Misc ==
-* There is no equivalent for the convenience static loadIcon(QString) function. You have to replace it with KIconLoader::global()->loadIcon(name, KIconLoader::Panel)
+There is no equivalent for the convenience static loadIcon(QString name) function. You have to replace it with KIconLoader::global()->loadIcon(name, KIconLoader::Panel)