Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 2268

qtjambi-doc-4.3.3-3mdv2008.1.i586.rpm

<class name="QSystemTrayIcon" doc="/**
&lt;p&gt;The &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; class provides an icon for an application in the system tray.&lt;/p&gt;
&lt;p&gt;Modern operating systems usually provide a special area on the desktop, called the &lt;i&gt;system tray&lt;/i&gt; or &lt;i&gt;notification area&lt;/i&gt;, where long-running applications can display icons and short messages.&lt;/p&gt;
&lt;p align=&quot;center&quot;&gt;&lt;img src=&quot;%2E%2E/images/system-tray.png&quot; alt=&quot;The system tray on Windows XP.&quot; /&gt;&lt;/p&gt;&lt;p&gt;The &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; class can be used on the following platforms:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;All supported versions of Windows.&lt;/li&gt;
&lt;li&gt;All window managers for X11 that implement the freedesktop.org&lt;/tt&gt; system tray specification, including recent versions of KDE and GNOME.&lt;/li&gt;
&lt;li&gt;All supported version of Mac OS X. QSystemTrayIcon::showMessage() requires Growl to display messages.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;To check whether a system tray is present on the user's desktop, call the QSystemTrayIcon::isSystemTrayAvailable() static function.&lt;/p&gt;
&lt;p&gt;To add a system tray entry, create a &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; object, call &lt;a href=&quot;QSystemTrayIcon.html#setContextMenu(com.trolltech.qt.gui.QMenu)&quot;&gt;&lt;tt&gt;setContextMenu&lt;/tt&gt;&lt;/a&gt; to provide a context menu for the icon, and call &lt;a href=&quot;QSystemTrayIcon.html#show()&quot;&gt;&lt;tt&gt;show&lt;/tt&gt;&lt;/a&gt; to make it visible in the system tray. Status notification messages (&amp;quot;balloon messages&amp;quot;) can be displayed at any time using &lt;a href=&quot;QSystemTrayIcon.html#showMessage(java.lang.String, java.lang.String, com.trolltech.qt.gui.QSystemTrayIcon.MessageIcon, int)&quot;&gt;&lt;tt&gt;showMessage&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;If the system tray is unavailable when a system tray icon is constructed, but becomes available later, &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; will automatically add an entry for the application in the system tray if the icon is visible&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The &lt;a href=&quot;QSystemTrayIcon.html#activated(com.trolltech.qt.gui.QSystemTrayIcon.ActivationReason)&quot;&gt;&lt;tt&gt;activated&lt;/tt&gt;&lt;/a&gt; signal is emitted when the user activates the icon.&lt;/p&gt;
&lt;p&gt;Only on X11, when a tooltip is requested, the &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; receives a &lt;a href=&quot;QHelpEvent.html&quot;&gt;&lt;tt&gt;QHelpEvent&lt;/tt&gt;&lt;/a&gt; of type QEvent::ToolTip. Additionally, the &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; receives wheel events of type QEvent::Wheel. These are not supported on any other platform.&lt;/p&gt;

@see &lt;a href=&quot;QDesktopServices.html&quot;&gt;&lt;tt&gt;QDesktopServices&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QDesktopWidget.html&quot;&gt;&lt;tt&gt;QDesktopWidget&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;%2E%2E/desktop-integration.html&quot;&gt;Desktop Integration&lt;/tt&gt;&lt;/a&gt; */">
    <signal name="protected final void activated(com.trolltech.qt.gui.QSystemTrayIcon.ActivationReason reason)" doc="/**
&lt;p&gt;This signal is emitted when the user activates the system tray icon. &lt;tt&gt;reason&lt;/tt&gt; specifies the reason for activation. QSystemTrayIcon::ActivationReason enumerates the various reasons.&lt;/p&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;Compatible Slot Signatures:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot(com.trolltech.qt.gui.QSystemTrayIcon.ActivationReason reason)&lt;/tt&gt;&lt;/dd&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot()&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;See Also:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;QSystemTrayIcon::ActivationReason&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <signal name="protected final void messageClicked()" doc="/**
&lt;p&gt;This signal is emitted when the message displayed using &lt;a href=&quot;QSystemTrayIcon.html#showMessage(java.lang.String, java.lang.String, com.trolltech.qt.gui.QSystemTrayIcon.MessageIcon, int)&quot;&gt;&lt;tt&gt;showMessage&lt;/tt&gt;&lt;/a&gt; was clicked by the user.&lt;/p&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;Compatible Slot Signature:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot()&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;See Also:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;a href=&quot;QSystemTrayIcon.html#activated(com.trolltech.qt.gui.QSystemTrayIcon.ActivationReason)&quot;&gt;&lt;tt&gt;activated&lt;/tt&gt;&lt;/a&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <method name="public QSystemTrayIcon(com.trolltech.qt.core.QObject parent)" doc="/**
&lt;p&gt;Constructs a &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; object with the given &lt;tt&gt;parent&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The icon is initially invisible.&lt;/p&gt;

@see visible&lt;/tt&gt; */"/>
    <method name="public QSystemTrayIcon()" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt;(0). */"/>
    <method name="public QSystemTrayIcon(com.trolltech.qt.gui.QIcon icon, com.trolltech.qt.core.QObject parent)" doc="/**
&lt;p&gt;Constructs a &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; object with the given &lt;tt&gt;icon&lt;/tt&gt; and &lt;tt&gt;parent&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The icon is initially invisible.&lt;/p&gt;

@see visible&lt;/tt&gt; */"/>
    <method name="public QSystemTrayIcon(com.trolltech.qt.gui.QIcon icon)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;icon&lt;/tt&gt;, 0). */"/>
    <method name="public final com.trolltech.qt.gui.QMenu contextMenu()" doc="/**
&lt;p&gt;Returns the current context menu for the system tray entry.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#setContextMenu(com.trolltech.qt.gui.QMenu)&quot;&gt;&lt;tt&gt;setContextMenu&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.core.QRect geometry()" doc="/**
&lt;p&gt;Returns the geometry of the system tray icon in screen coordinates.&lt;/p&gt;

@see visible&lt;/tt&gt; */"/>
    <method name="public final void hide()" doc="/**
&lt;p&gt;Hides the system tray entry.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#show()&quot;&gt;&lt;tt&gt;show&lt;/tt&gt;&lt;/a&gt;
@see visible&lt;/tt&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QIcon icon()" doc="/**
&lt;p&gt;Returns the system tray icon.&lt;/p&gt;
&lt;p&gt;On Windows, the system tray icon size is 16x16; on X11, the preferred size is 22x22. The icon will be scaled to the appropriate size as necessary.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#setIcon(com.trolltech.qt.gui.QIcon)&quot;&gt;&lt;tt&gt;setIcon&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final boolean isVisible()" doc="/**
&lt;p&gt;Returns whether the system tray entry is visible.&lt;/p&gt;
&lt;p&gt;Setting this property to true or calling &lt;a href=&quot;QSystemTrayIcon.html#show()&quot;&gt;&lt;tt&gt;show&lt;/tt&gt;&lt;/a&gt; makes the system tray icon visible; setting this property to false or calling &lt;a href=&quot;QSystemTrayIcon.html#hide()&quot;&gt;&lt;tt&gt;hide&lt;/tt&gt;&lt;/a&gt; hides it.&lt;/p&gt;
 */"/>
    <method name="public final void setContextMenu(com.trolltech.qt.gui.QMenu menu)" doc="/**
&lt;p&gt;Sets the specified &lt;tt&gt;menu&lt;/tt&gt; to be the context menu for the system tray icon.&lt;/p&gt;
&lt;p&gt;The menu will pop up when the user requests the context menu for the system tray icon by clicking the mouse button.&lt;/p&gt;
&lt;p&gt;On Mac OS X, this is currenly converted to a NSMenu, so the aboutToHide() signal is not emitted.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#contextMenu()&quot;&gt;&lt;tt&gt;contextMenu&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setIcon(com.trolltech.qt.gui.QIcon icon)" doc="/**
&lt;p&gt;Sets the system tray icon to &lt;tt&gt;icon&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;On Windows, the system tray icon size is 16x16; on X11, the preferred size is 22x22. The icon will be scaled to the appropriate size as necessary.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#icon()&quot;&gt;&lt;tt&gt;icon&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setToolTip(java.lang.String tip)" doc="/**
&lt;p&gt;Sets the tooltip for the system tray entry to &lt;tt&gt;tip&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;On some systems, the tooltip's length is limited. The tooltip will be truncated if necessary.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#toolTip()&quot;&gt;&lt;tt&gt;toolTip&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setVisible(boolean visible)" doc="/**
&lt;p&gt;Sets whether the system tray entry is visible to &lt;tt&gt;visible&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;Setting this property to true or calling &lt;a href=&quot;QSystemTrayIcon.html#show()&quot;&gt;&lt;tt&gt;show&lt;/tt&gt;&lt;/a&gt; makes the system tray icon visible; setting this property to false or calling &lt;a href=&quot;QSystemTrayIcon.html#hide()&quot;&gt;&lt;tt&gt;hide&lt;/tt&gt;&lt;/a&gt; hides it.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#isVisible()&quot;&gt;&lt;tt&gt;isVisible&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void show()" doc="/**
&lt;p&gt;Shows the icon in the system tray.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#hide()&quot;&gt;&lt;tt&gt;hide&lt;/tt&gt;&lt;/a&gt;
@see visible&lt;/tt&gt; */"/>
    <method name="public final void showMessage(java.lang.String title, java.lang.String msg, com.trolltech.qt.gui.QSystemTrayIcon.MessageIcon icon, int msecs)" doc="/**
&lt;p&gt;Shows a balloon message for the entry with the given &lt;tt&gt;title&lt;/tt&gt;, &lt;tt&gt;msg&lt;/tt&gt; and &lt;tt&gt;icon&lt;/tt&gt; for the time specified in &lt;tt&gt;msecs&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;Message can be clicked by the user; the &lt;a href=&quot;QSystemTrayIcon.html#messageClicked()&quot;&gt;&lt;tt&gt;messageClicked&lt;/tt&gt;&lt;/a&gt; signal will emitted when this occurs.&lt;/p&gt;
&lt;p&gt;Note that display of messages are dependent on the system configuration and user preferences, and that messages may not appear at all. Hence, it should not be relied upon as the sole means for providing critical information.&lt;/p&gt;
&lt;p&gt;On Windows, the &lt;tt&gt;msecs&lt;/tt&gt; is usually ignored by the system when the application has focus.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#show()&quot;&gt;&lt;tt&gt;show&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QSystemTrayIcon.html#supportsMessages()&quot;&gt;&lt;tt&gt;supportsMessages&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void showMessage(java.lang.String title, java.lang.String msg, com.trolltech.qt.gui.QSystemTrayIcon.MessageIcon icon)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSystemTrayIcon.html#showMessage(java.lang.String, java.lang.String, com.trolltech.qt.gui.QSystemTrayIcon.MessageIcon, int)&quot;&gt;&lt;tt&gt;showMessage&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;title&lt;/tt&gt;, &lt;tt&gt;msg&lt;/tt&gt;, &lt;tt&gt;icon&lt;/tt&gt;, 10000). */"/>
    <method name="public final void showMessage(java.lang.String title, java.lang.String msg)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QSystemTrayIcon.html#showMessage(java.lang.String, java.lang.String, com.trolltech.qt.gui.QSystemTrayIcon.MessageIcon, int)&quot;&gt;&lt;tt&gt;showMessage&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;title&lt;/tt&gt;, &lt;tt&gt;msg&lt;/tt&gt;, Information, 10000). */"/>
    <method name="public final java.lang.String toolTip()" doc="/**
&lt;p&gt;Returns the tooltip for the system tray entry.&lt;/p&gt;
&lt;p&gt;On some systems, the tooltip's length is limited. The tooltip will be truncated if necessary.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#setToolTip(java.lang.String)&quot;&gt;&lt;tt&gt;setToolTip&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public boolean event(com.trolltech.qt.core.QEvent event)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <method name="public native static boolean isSystemTrayAvailable()" doc="/**
&lt;p&gt;Returns true if the system tray is available; otherwise returns false.&lt;/p&gt;
&lt;p&gt;If the system tray is currently unavailable but becomes available later, &lt;a href=&quot;QSystemTrayIcon.html#QSystemTrayIcon(com.trolltech.qt.gui.QIcon, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QSystemTrayIcon&lt;/tt&gt;&lt;/a&gt; will automatically add an entry in the system tray if it is visible&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public native static boolean supportsMessages()" doc="/**
&lt;p&gt;Returns true if the system tray supports balloon messages; otherwise returns false.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#showMessage(java.lang.String, java.lang.String, com.trolltech.qt.gui.QSystemTrayIcon.MessageIcon, int)&quot;&gt;&lt;tt&gt;showMessage&lt;/tt&gt;&lt;/a&gt; */"/>
    <enum name="MessageIcon" doc="/**
&lt;p&gt;This enum describes the icon that is shown when a balloon message is displayed.&lt;/p&gt;

@see &lt;a href=&quot;QMessageBox.html&quot;&gt;&lt;tt&gt;QMessageBox&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="NoIcon" doc="/**
&lt;p&gt;No icon is shown.&lt;/p&gt;
 */"/>
        <enum-value name="Information" doc="/**
&lt;p&gt;An information icon is shown.&lt;/p&gt;
 */"/>
        <enum-value name="Warning" doc="/**
&lt;p&gt;A standard warning icon is shown.&lt;/p&gt;
 */"/>
        <enum-value name="Critical" doc="/**
&lt;p&gt;A critical warning icon is shown.&lt;/p&gt;
 */"/>
</enum>
    <enum name="ActivationReason" doc="/**
&lt;p&gt;This enum describes the reason the system tray was activated.&lt;/p&gt;

@see &lt;a href=&quot;QSystemTrayIcon.html#activated(com.trolltech.qt.gui.QSystemTrayIcon.ActivationReason)&quot;&gt;&lt;tt&gt;activated&lt;/tt&gt;&lt;/a&gt; */">
        <enum-value name="Unknown" doc="/**
&lt;p&gt;Unknown reason&lt;/p&gt;
 */"/>
        <enum-value name="Context" doc="/**
&lt;p&gt;The context menu for the system tray entry was requested&lt;/p&gt;
 */"/>
        <enum-value name="DoubleClick" doc="/**
&lt;p&gt;The system tray entry was double clicked&lt;/p&gt;
 */"/>
        <enum-value name="Trigger" doc="/**
&lt;p&gt;The system tray entry was clicked&lt;/p&gt;
 */"/>
        <enum-value name="MiddleClick" doc="/**
&lt;p&gt;The system tray entry was clicked with the middle mouse button&lt;/p&gt;
 */"/>
</enum>
</class>