Reference

Gtk2::StatusIcon(3pm)

wrapper for GtkStatusIcon

NAME

Gtk2::StatusIcon - wrapper for GtkStatusIcon

HIERARCHY

  Glib::Object
  +----Gtk2::StatusIcon

METHODS

statusicon = Gtk2::StatusIcon->new

statusicon = Gtk2::StatusIcon->new_from_file ($filename)

•

$filename (localized file name)

statusicon = Gtk2::StatusIcon->new_from_icon_name ($icon_name)

•

$icon_name (string)

statusicon = Gtk2::StatusIcon->new_from_pixbuf ($pixbuf)

•

$pixbuf (Gtk2::Gdk::Pixbuf)

statusicon = Gtk2::StatusIcon->new_from_stock ($stock_id)

•

$stock_id (string)

boolean = $status_icon->get_blinking

$status_icon->set_blinking ($blinking)

•

$blinking (boolean)

$status_icon->set_from_file ($filename)

•

$filename (localized file name)

$status_icon->set_from_icon_name ($icon_name)

•

$icon_name (string)

$status_icon->set_from_pixbuf ($pixbuf)

•

$pixbuf (Gtk2::Gdk::Pixbuf or undef)

$status_icon->set_from_stock ($stock_id)

•

$stock_id (string)

list = $status_icon->get_geometry

boolean = $status_icon->get_has_tooltip

Since: gtk+ 2.16

$status_icon->set_has_tooltip ($has_tooltip)

•

$has_tooltip (boolean)

Since: gtk+ 2.16

string or undef = $status_icon->get_icon_name

boolean = $status_icon->is_embedded

$status_icon->set_name ($name)

•

$name (string)

Since: gtk+ 2.20

pixbuf or undef = $status_icon->get_pixbuf

(x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, icon)

(x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, x, y, icon)

•

... (list)

•

$icon (Gtk2::StatusIcon)

•

$y (integer)

•

$x (integer)

This function takes four arguments so that it may be passed directly as the menu position callback to Gtk2::Menu::popup(), which passes in initial x and y values for historical reasons. Otherwise, you need only pass two arguments.

This function can be used as the menu_pos_func argument to Gtk2::Menu::popup.

screen = $status_icon->get_screen

Since: gtk+ 2.12

$status_icon->set_screen ($screen)

•

$screen (Gtk2::Gdk::Screen)

Since: gtk+ 2.12

integer = $status_icon->get_size

string or undef = $status_icon->get_stock

imagetype = $status_icon->get_storage_type

string = $status_icon->get_title

Since: gtk+ 2.18

$status_icon->set_title ($title)

•

$title (string)

Since: gtk+ 2.18

string or undef = $status_icon->get_tooltip_markup

Since: gtk+ 2.16

$status_icon->set_tooltip_markup ($markup)

•

$markup (string or undef)

Since: gtk+ 2.16

$status_icon->set_tooltip ($tooltip_text)

•

$tooltip_text (string or undef)

string or undef = $status_icon->get_tooltip_text

Since: gtk+ 2.16

$status_icon->set_tooltip_text ($text)

•

$text (string or undef)

Since: gtk+ 2.16

boolean = $status_icon->get_visible

$status_icon->set_visible ($visible)

•

$visible (boolean)

unsigned = $status_icon->get_x11_window_id

Since: gtk+ 2.14

PROPERTIES

'blinking' (boolean : default false : readable / writable / private)

Whether or not the status icon is blinking

'embedded' (boolean : default false : readable / private)

Whether or not the status icon is embedded

'file' (string : default undef : writable / private)

Filename to load and display

'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private)

The GIcon being displayed

'has-tooltip' (boolean : default false : readable / writable / private)

Whether this tray icon has a tooltip

'icon-name' (string : default undef : readable / writable / private)

The name of the icon from the icon theme

'orientation' (Gtk2::Orientation : default "horizontal" : readable / private)

The orientation of the tray

'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private)

A GdkPixbuf to display

'screen' (Gtk2::Gdk::Screen : default undef : readable / writable / private)

The screen where this status icon will be displayed

'size' (integer : default 0 : readable / private)

The size of the icon

'stock' (string : default undef : readable / writable / private)

Stock ID for a stock image to display

'storage-type' (Gtk2::ImageType : default "empty" : readable / private)

The representation being used for image data

'title' (string : default undef : readable / writable / private)

The title of this tray icon

'tooltip-markup' (string : default undef : readable / writable / private)

The contents of the tooltip for this tray icon

'tooltip-text' (string : default undef : readable / writable / private)

The contents of the tooltip for this widget

'visible' (boolean : default true : readable / writable / private)

Whether or not the status icon is visible

SIGNALS

activate (Gtk2::StatusIcon)
boolean = button-press-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)
boolean = button-release-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)
popup-menu (Gtk2::StatusIcon, Glib::UInt, Glib::UInt)
boolean = query-tooltip (Gtk2::StatusIcon, integer, integer, boolean, Gtk2::Tooltip)
boolean = scroll-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)
boolean = size-changed (Gtk2::StatusIcon, integer)

ENUMS AND FLAGS

enum Gtk2::ImageType

•

'empty' / 'GTK_IMAGE_EMPTY'

•

'pixmap' / 'GTK_IMAGE_PIXMAP'

•

'image' / 'GTK_IMAGE_IMAGE'

•

'pixbuf' / 'GTK_IMAGE_PIXBUF'

•

'stock' / 'GTK_IMAGE_STOCK'

•

'icon-set' / 'GTK_IMAGE_ICON_SET'

•

'animation' / 'GTK_IMAGE_ANIMATION'

•

'icon-name' / 'GTK_IMAGE_ICON_NAME'

•

'gicon' / 'GTK_IMAGE_GICON'

enum Gtk2::Orientation

•

'horizontal' / 'GTK_ORIENTATION_HORIZONTAL'

•

'vertical' / 'GTK_ORIENTATION_VERTICAL'

SEE ALSO

Gtk2, Glib::Object

COPYRIGHT

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL. See Gtk2 for a full notice.

History