Synopsis

gtk.StatusIcon display an icon in the system tray (new in PyGTK 2.10) Synopsis gtk.StatusIcon gobject.GObject gtk.StatusIcon get_storage_type get_gicon get_pixbuf get_stock get_icon_name get_size get_x11_window_id set_tooltip tooltip_text set_visible visible get_visible set_blinking blinking get_blinking is_embedded get_geometry screen area orientation get_screen set_screen screen set_from_pixbuf pixbuf set_from_file filename set_from_stock stock_id set_from_icon_name icon_name set_from_gicon gicon set_name name set_title title get_title set_has_tooltip has_tooltip get_has_tooltip set_tooltip_text text get_tooltip_text set_tooltip_markup markup get_tooltip_markup Functions gtk.status_icon_new_from_pixbuf pixbuf gtk.status_icon_new_from_file filename gtk.status_icon_new_from_gicon filename gtk.status_icon_new_from_stock stock_id gtk.status_icon_new_from_icon_name icon_name gtk.status_icon_position_menu menu statusicon Ancestry +-- gobject.GObject +-- gtk.StatusIcon gtk.StatusIcon Properties

"blinking" Read-Write if True the status icon is blinking. Default value: False. "embedded" Read-Write True if the status icon is embedded in a notification area. Default value: False. This property is available in GTK+ 2.12 and above. "file" Write Filename to load and display. Default value: None. "gicon" Read-Write The GIcon displayed in the GtkStatusIcon. For themed icons, the image will be updated automatically if the theme changes. Available from GTK+ 2.14. "icon-name" Read-Write The name of the icon from the icon theme. Default value: None. "orientation" Read-Write The orientation of the tray in which the statusicon is embedded. Default value: gtk.ORIENTATION_HORIZONTAL. This property is available in GTK+ 2.12 and above. "pixbuf" Read-Write A gtk.gdk.Pixbuf to display. "size" Read The size of the icon. Default value: 0. "stock" Read-Write Stock ID for a stock image to display. Default value: None. "storage-type" Read The representation being used for image data. Default value: gtk.IMAGE_EMPTY. "title" Read-Write The title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon. Default value: None. This property is available in GTK+ 2.18 and above. "tooltip-markup" Read-Write Sets the text of the tooltip to be the given string, which is marked up with the Pango text markup language. Default value: None. This property is available in GTK+ 2.16 and above. "tooltip-text" Read-Write Sets the text of tooltip to be the given string. Default value: None. This property is available in GTK+ 2.16 and above. "visible" Read-Write If True the status icon is visible. Default value: True.

gtk.StatusIcon Signal Prototypes gobject.GObject Signal Prototypes "activate" callback status_icon user_param1 ... "popup-menu" callback status_icon button activate_time user_param1 ... "size-changed" callback status_icon size user_param1 ... 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 gtk.StatusIcon 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 gtk.StatusIcon, 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 the gtk.StatusIcon.is_embedded() method. On X11, the implementation follows the freedesktop.org "System Tray" specification. Implementations of the "tray" side of this specification can be found e.g. in the GNOME and KDE panel applications. Note that a gtk.StatusIcon is not a widget, but just a gobject.GObject. Making it a widget would be impractical, since the system tray on Win32 doesn't allow to embed arbitrary widgets. Constructor gtk.StatusIcon gtk.StatusIcon Returns : a new gtk.StatusIcon This constructor is available in PyGTK 2.10 and above. Creates an empty status icon object. Methods gtk.StatusIcon.set_from_pixbuf set_from_pixbuf pixbuf pixbuf : a gtk.gdk.Pixbuf or None This method is available in PyGTK 2.10 and above. Makes status_icon display pixbuf. See the gtk.status_icon_new_from_pixbuf() function for details. gtk.StatusIcon.set_from_file set_from_file filename filename : a filename This method is available in PyGTK 2.10 and above. Makes status_icon display the file filename. See the gtk.status_icon_new_from_file() function for details. gtk.StatusIcon.set_from_stock set_from_stock stock_id stock_id : a stock icon id This method is available in PyGTK 2.10 and above. Makes status_icon display the stock icon with the id stock_id. See the gtk.status_icon_new_from_stock() function for details. gtk.StatusIcon.set_from_icon_name set_from_icon_name icon_name icon_name : an icon name This method is available in PyGTK 2.10 and above. Makes status_icon display the icon named icon_name from the current icon theme. See the gtk.status_icon_new_from_icon_name() function for details. gtk.StatusIcon.set_from_gicon set_from_gicon gicon gicon : a gio.Icon() This method is available in PyGTK 2.14 and above. Makes status_icon display the gio.Icon() See gtk.status_icon_new_from_gicon() for details gtk.StatusIcon.get_storage_type get_storage_type Returns : the image representation being used - one of the . This method is available in PyGTK 2.10 and above. Gets the type of representation being used by the gtk.StatusIcon to store image data. If the gtk.StatusIcon has no image data, the return value will be gtk.IMAGE_EMPTY. gtk.StatusIcon.get_gicon get_gicon Returns : the displayed icon, or None if the image is empty. This method is available in PyGTK 2.14 and above. Retrieves the gio.Icon() being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_GICON. If this method fails, icon is left unchanged; gtk.StatusIcon.get_x11_window_id get_x11_window_id Returns : An 32 bit unsigned integer identifier for the underlying X11 Window. This method is available in PyGTK 2.14 and above. This function is only useful on the X11/freedesktop.org platform. It returns a window ID for the widget in the underlying status icon implementation. This is useful for the Galago notification service, which can send a window ID in the protocol in order for the server to position notification windows pointing to a status icon reliably. This function is not intended for other use cases which are more likely to be met by one of the non-X11 specific methods, such as gtk.status_icon_position_menu(). gtk.StatusIcon.get_pixbuf get_pixbuf Returns : the displayed pixbuf, or None if the image is empty. This method is available in PyGTK 2.10 and above. Gets the gtk.gdk.Pixbuf being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_PIXBUF (see the gtk.StatusIcon.get_storage_type() method). gtk.StatusIcon.get_stock get_stock Returns : stock id of the displayed stock icon, or None if the image is empty. This method is available in PyGTK 2.10 and above. Gets the id of the stock icon being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_STOCK (see the gtk.StatusIcon.get_storage_type() method). gtk.StatusIcon.get_icon_name get_icon_name Returns : name of the displayed icon, or None if the image is empty. This method is available in PyGTK 2.10 and above. Gets the name of the icon being displayed by the gtk.StatusIcon. The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_ICON_NAME (see the gtk.StatusIcon.get_storage_type() method). gtk.StatusIcon.get_size get_size Returns : the size that is available for the image This method is available in PyGTK 2.10 and above. Gets the size in pixels that is available for the image. Stock icons and named icons adapt their size automatically if the size of the notification area changes. For other storage types, the "size-changed" signal can be used to react to size changes. gtk.StatusIcon.set_visible set_visible visible visible : if True show the status icon, if False hide it This method is available in PyGTK 2.10 and above. Shows or hides a status icon. gtk.StatusIcon.get_visible get_visible Returns : True if the status icon is visible This method is available in PyGTK 2.10 and above. Returns True if the status icon is visible. Note that being visible does not guarantee that the user can actually see the icon, see also the gtk.StatusIcon.is_embedded() method. gtk.StatusIcon.set_blinking set_blinking blinking blinking : if True turn blinking on, if False turn it off This method is available in PyGTK 2.10 and above. Makes the status icon start or stop blinking. Note that blinking user interface elements may be problematic for some users, and thus may be turned off, in which case this setting has no effect. gtk.StatusIcon.get_blinking get_blinking Returns : True if the icon is blinking This method is available in PyGTK 2.10 and above. Returns True if the icon is blinking, see the gtk.StatusIcon.set_blinking() method. gtk.StatusIcon.is_embedded is_embedded Returns : True if the status icon is embedded in a notification area. This method is available in PyGTK 2.10 and above. Returns True if the status icon is embedded in a notification area. gtk.StatusIcon.get_geometry get_geometry Returns : a 3-tuple (containing the screen, area occupied by the status icon and the panel orientation) or None. This method is available in PyGTK 2.10 and above. Returns information in a 3-tuple about the location of the status icon on screen. The 3-tuple contains the gtk.gdk.Screen, the area occupied by the status icon as a gtk.gdk.Rectangle and the orientation of the panel containing the statis icon - one of the . This information can be used to e.g. position popups like notification bubbles. See the gtk.status_icon_position_menu() function for a more convenient alternative for positioning menus. Note that some platforms do not provide this information. gtk.StatusIcon.get_screen get_screen Returns : a gtk.gdk.Screen. This method is available in PyGTK 2.12 and above. Returns the gtk.gdk.Screen associated with status_icon. gtk.StatusIcon.set_screen set_screen screen screen : a gtk.gdk.Screen. This method is available in PyGTK 2.12 and above. Sets the gtk.gdk.Screen where status_icon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen. Functions gtk.status_icon_new_from_pixbuf gtk.status_icon_new_from_pixbuf pixbuf pixbuf : Returns : a new gtk.StatusIcon Creates a status icon displaying pixbuf. The image will be scaled down to fit in the available space in the notification area, if necessary. gtk.status_icon_new_from_file gtk.status_icon_new_from_file filename filename : Returns : a new gtk.StatusIcon Creates a status icon displaying the image in the file specified by filename. The image will be scaled down to fit in the available space in the notification area, if necessary. gtk.status_icon_new_from_gicon gtk.status_icon_new_from_gicon gicon gicon : Returns : a new gtk.StatusIcon Creates a status icon displaying a gio.Icon(). If the icon is a themed icon, it will be updated when the theme changes. gtk.status_icon_new_from_stock gtk.status_icon_new_from_stock stock_id stock_id : a stock icon id Returns : a new gtk.StatusIcon Creates a status icon displaying a stock icon. Sample stock icon names are gtk.STOCK_OPEN, gtk.STOCK_QUIT. You can register your own stock icon names, see the gtk.IconFactory.add_default() and gtk.IconFactory.add() methods. gtk.status_icon_new_from_icon_name gtk.status_icon_new_from_icon_name icon_name icon_name : an icon name Returns : a new gtk.StatusIcon Creates a status icon displaying an icon from the current icon theme. If the current icon theme is changed, the icon will be updated appropriately. gtk.status_icon_position_menu gtk.status_icon_position_menu menu statusicon menu : the gtk.Menu statusicon : the gtk.StatusIcon Returns : a 3-tuple containing the x and y coordinates for the menu and a boolean indicating whether the menu should be pushed in to be completely inside the screen instead of just clamped to the size to the screen. Menu positioning function to use with the popup() method to position menu aligned to statusicon . Eample use of this function is: menu.popup(None, None, gtk.status_icon_position_menu, event.button, event.time, statusicon) gtk.StatusIcon.set_name set_name name name : the name. This method is available in PyGTK 2.22 and above. The set_name() method sets the name of this tray icon. This should be a string identifying this icon. It is may be used for sorting the icons in the tray and will not be shown to the user. gtk.StatusIcon.set_title set_title title title : the title. This method is available in PyGTK 2.22 and above. The set_title() method sets the title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon. gtk.StatusIcon.get_title get_title Returns : the title of the status icon. This method is available in PyGTK 2.22 and above. The get_title() method gets the title of this tray icon. Signals The "activate" gtk.StatusIcon Signal callback status_icon user_param1 ... status_icon : the object which received the signal user_param1 : the first user parameter (if any) specified with the connect() method ... : additional user parameters (if any) This signal is available in GTK+ 2.10 and above. Gets emitted when the user activates the status icon. If and how status icons can be activated is platform-dependent. The "size-changed" gtk.StatusIcon Signal callback status_icon size statusicon arg1 user_param1 ... status_icon : the object which received the signal size : the new size user_param1 : the first user parameter (if any) specified with the connect() method ... : additional user parameters (if any) Returns : True if the icon was updated for the new size. Otherwise, GTK+ will scale the icon as necessary. This signal is available in GTK+ 2.10 and above. Gets emitted when the size available for the image changes, e.g. because the notification area got resized.