GtkStatusIcon {RGtk2}R Documentation

GtkStatusIcon

Description

Display an icon in the system tray

Methods and Functions

gtkStatusIconNew()
gtkStatusIconNewFromPixbuf(pixbuf)
gtkStatusIconNewFromFile(filename)
gtkStatusIconNewFromStock(stock.id)
gtkStatusIconNewFromIconName(icon.name)
gtkStatusIconSetFromPixbuf(object, pixbuf)
gtkStatusIconSetFromFile(object, filename)
gtkStatusIconSetFromStock(object, stock.id)
gtkStatusIconSetFromIconName(object, icon.name)
gtkStatusIconGetStorageType(object)
gtkStatusIconGetPixbuf(object)
gtkStatusIconGetStock(object)
gtkStatusIconGetIconName(object)
gtkStatusIconGetSize(object)
gtkStatusIconSetScreen(object, screen)
gtkStatusIconGetScreen(object)
gtkStatusIconSetTooltip(object, tooltip.text)
gtkStatusIconSetVisible(object, visible)
gtkStatusIconGetVisible(object)
gtkStatusIconSetBlinking(object, blinking)
gtkStatusIconGetBlinking(object)
gtkStatusIconIsEmbedded(object)
gtkStatusIconPositionMenu(menu, user.data)
gtkStatusIconGetGeometry(object)
gtkStatusIcon()

Hierarchy

  GObject
   +----GtkStatusIcon

Detailed Description

The "system tray" or notification area is normally used for transient icons that indicate some special state. For example, a system tray icon might appear to tell the user that they have new mail, or have an incoming instant message, or something along those lines. The basic idea is that creating an icon in the notification area is less annoying than popping up a dialog.

A GtkStatusIcon object can be used to display an icon in a "system tray". The icon can have a tooltip, and the user can interact with it by activating it or popping up a context menu. Critical information should not solely be displayed in a GtkStatusIcon, since it may not be visible (e.g. when the user doesn't have a notification area on his panel). This can be checked with gtkStatusIconIsEmbedded.

On X11, the implementation follows the freedesktop.org "System Tray" specification (http://www.freedesktop.org/wiki/Standards/systemtray-spec). Implementations of the "tray" side of this specification can be found e.g. in the GNOME and KDE panel applications.

Note that a GtkStatusIcon is not a widget, but just a GObject. Making it a widget would be impractical, since the system tray on Win32 doesn't allow to embed arbitrary widgets.

Structures

GtkStatusIcon
undocumented

Convenient Construction

gtkStatusIcon is the equivalent of gtkStatusIconNew.

Signals

The (status.icon, user.data)
Gets emitted when the user activates the status icon. If and how status icons can activated is platform-dependent.

Since 2.10

status.icon
[GtkStatusIcon] the object which received the signal
user.data
[R object] user data set when the signal handler was connected.

The (status.icon, button, activate.time, user.data)
Gets emitted when the user brings up the context menu of the status icon. Whether status icons can have context menus and how these are activated is platform-dependent.

The button and activate.timeout parameters should be passed as the last to arguments to gtkMenuPopup.

Since 2.10

status.icon
[GtkStatusIcon] the object which received the signal
button
[numeric] the button that was pressed, or 0 if the signal is not emitted in response to a button press event
activate.time
[numeric] the timestamp of the event that triggered the signal emission
user.data
[R object] user data set when the signal handler was connected.

The (status.icon, size, user.data)
Gets emitted when the size available for the image changes, e.g. because the notification area got resized.

Since 2.10

status.icon
[GtkStatusIcon] the object which received the signal
size
[integer] the new size
user.data
[R object] user data set when the signal handler was connected.

Returns: [logical] TRUE if the icon was updated for the new size. Otherwise, GTK+ will scale the icon as necessary.

Properties

blinking [logical : Read / Write]

Whether or not the status icon is blinking. Default value: FALSE

embedded [logical : Read]

TRUE if the statusicon is embedded in a notification area.

Default value: FALSE Since 2.12

file [character : Write]

Filename to load and display. Default value: NULL

icon-name [character : Read / Write]

The name of the icon from the icon theme. Default value: NULL

orientation [GtkOrientation : Read]

The orientation of the tray in which the statusicon is embedded.

Default value: GTK_ORIENTATION_HORIZONTAL Since 2.12

pixbuf [GdkPixbuf : Read / Write]

A GdkPixbuf to display.

screen [GdkScreen : Read / Write]

The screen where this status icon will be displayed.

size [integer : Read]

The size of the icon. Allowed values: >= 0 Default value: 0

stock [character : Read / Write]

Stock ID for a stock image to display. Default value: NULL

storage-type [GtkImageType : Read]

The representation being used for image data. Default value: GTK_IMAGE_EMPTY

visible [logical : Read / Write]

Whether or not the status icon is visible. Default value: TRUE

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://developer.gnome.org/doc/API/2.0/gtk/GtkStatusIcon.html


[Package RGtk2 version 2.12.5-3 Index]