.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::StatusIcon 3"
.TH Gtk2::StatusIcon 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gtk2::StatusIcon \- wrapper for GtkStatusIcon
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Object
\&  +\-\-\-\-Gtk2::StatusIcon
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "statusicon = Gtk2::StatusIcon\->\fBnew\fP"
.IX Subsection "statusicon = Gtk2::StatusIcon->new"
.SS "statusicon = Gtk2::StatusIcon\->\fBnew_from_file\fP ($filename)"
.IX Subsection "statusicon = Gtk2::StatusIcon->new_from_file ($filename)"
.IP \(bu 4
\&\f(CW$filename\fR (localized file name)
.SS "statusicon = Gtk2::StatusIcon\->\fBnew_from_icon_name\fP ($icon_name)"
.IX Subsection "statusicon = Gtk2::StatusIcon->new_from_icon_name ($icon_name)"
.IP \(bu 4
\&\f(CW$icon_name\fR (string)
.SS "statusicon = Gtk2::StatusIcon\->\fBnew_from_pixbuf\fP ($pixbuf)"
.IX Subsection "statusicon = Gtk2::StatusIcon->new_from_pixbuf ($pixbuf)"
.IP \(bu 4
\&\f(CW$pixbuf\fR (Gtk2::Gdk::Pixbuf)
.SS "statusicon = Gtk2::StatusIcon\->\fBnew_from_stock\fP ($stock_id)"
.IX Subsection "statusicon = Gtk2::StatusIcon->new_from_stock ($stock_id)"
.IP \(bu 4
\&\f(CW$stock_id\fR (string)
.ie n .SS "boolean = $status_icon\->\fBget_blinking\fP"
.el .SS "boolean = \f(CW$status_icon\fP\->\fBget_blinking\fP"
.IX Subsection "boolean = $status_icon->get_blinking"
.ie n .SS "$status_icon\->\fBset_blinking\fP ($blinking)"
.el .SS "\f(CW$status_icon\fP\->\fBset_blinking\fP ($blinking)"
.IX Subsection "$status_icon->set_blinking ($blinking)"
.IP \(bu 4
\&\f(CW$blinking\fR (boolean)
.ie n .SS "$status_icon\->\fBset_from_file\fP ($filename)"
.el .SS "\f(CW$status_icon\fP\->\fBset_from_file\fP ($filename)"
.IX Subsection "$status_icon->set_from_file ($filename)"
.IP \(bu 4
\&\f(CW$filename\fR (localized file name)
.ie n .SS "$status_icon\->\fBset_from_icon_name\fP ($icon_name)"
.el .SS "\f(CW$status_icon\fP\->\fBset_from_icon_name\fP ($icon_name)"
.IX Subsection "$status_icon->set_from_icon_name ($icon_name)"
.IP \(bu 4
\&\f(CW$icon_name\fR (string)
.ie n .SS "$status_icon\->\fBset_from_pixbuf\fP ($pixbuf)"
.el .SS "\f(CW$status_icon\fP\->\fBset_from_pixbuf\fP ($pixbuf)"
.IX Subsection "$status_icon->set_from_pixbuf ($pixbuf)"
.IP \(bu 4
\&\f(CW$pixbuf\fR (Gtk2::Gdk::Pixbuf or undef)
.ie n .SS "$status_icon\->\fBset_from_stock\fP ($stock_id)"
.el .SS "\f(CW$status_icon\fP\->\fBset_from_stock\fP ($stock_id)"
.IX Subsection "$status_icon->set_from_stock ($stock_id)"
.IP \(bu 4
\&\f(CW$stock_id\fR (string)
.ie n .SS "list = $status_icon\->\fBget_geometry\fP"
.el .SS "list = \f(CW$status_icon\fP\->\fBget_geometry\fP"
.IX Subsection "list = $status_icon->get_geometry"
.ie n .SS "boolean = $status_icon\->\fBget_has_tooltip\fP"
.el .SS "boolean = \f(CW$status_icon\fP\->\fBget_has_tooltip\fP"
.IX Subsection "boolean = $status_icon->get_has_tooltip"
Since: gtk+ 2.16
.ie n .SS "$status_icon\->\fBset_has_tooltip\fP ($has_tooltip)"
.el .SS "\f(CW$status_icon\fP\->\fBset_has_tooltip\fP ($has_tooltip)"
.IX Subsection "$status_icon->set_has_tooltip ($has_tooltip)"
.IP \(bu 4
\&\f(CW$has_tooltip\fR (boolean)
.PP
Since: gtk+ 2.16
.ie n .SS "string or undef = $status_icon\->\fBget_icon_name\fP"
.el .SS "string or undef = \f(CW$status_icon\fP\->\fBget_icon_name\fP"
.IX Subsection "string or undef = $status_icon->get_icon_name"
.ie n .SS "boolean = $status_icon\->\fBis_embedded\fP"
.el .SS "boolean = \f(CW$status_icon\fP\->\fBis_embedded\fP"
.IX Subsection "boolean = $status_icon->is_embedded"
.ie n .SS "$status_icon\->\fBset_name\fP ($name)"
.el .SS "\f(CW$status_icon\fP\->\fBset_name\fP ($name)"
.IX Subsection "$status_icon->set_name ($name)"
.IP \(bu 4
\&\f(CW$name\fR (string)
.PP
Since: gtk+ 2.20
.ie n .SS "pixbuf or undef = $status_icon\->\fBget_pixbuf\fP"
.el .SS "pixbuf or undef = \f(CW$status_icon\fP\->\fBget_pixbuf\fP"
.IX Subsection "pixbuf or undef = $status_icon->get_pixbuf"
.SS "(x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, icon)"
.IX Subsection "(x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, icon)"
.SS "(x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, x, y, icon)"
.IX Subsection "(x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, x, y, icon)"
.IP \(bu 4
\&... (list)
.IP \(bu 4
\&\f(CW$icon\fR (Gtk2::StatusIcon)
.IP \(bu 4
\&\f(CW$y\fR (integer)
.IP \(bu 4
\&\f(CW$x\fR (integer)
.PP
This function takes four arguments so that it may be passed directly as the
menu position callback to \fBGtk2::Menu::popup()\fR, which passes in initial x and y
values for historical reasons.  Otherwise, you need only pass two arguments.
.PP
This function can be used as the \fImenu_pos_func\fR argument to
\&\fIGtk2::Menu::popup\fR.
.ie n .SS "screen = $status_icon\->\fBget_screen\fP"
.el .SS "screen = \f(CW$status_icon\fP\->\fBget_screen\fP"
.IX Subsection "screen = $status_icon->get_screen"
Since: gtk+ 2.12
.ie n .SS "$status_icon\->\fBset_screen\fP ($screen)"
.el .SS "\f(CW$status_icon\fP\->\fBset_screen\fP ($screen)"
.IX Subsection "$status_icon->set_screen ($screen)"
.IP \(bu 4
\&\f(CW$screen\fR (Gtk2::Gdk::Screen)
.PP
Since: gtk+ 2.12
.ie n .SS "integer = $status_icon\->\fBget_size\fP"
.el .SS "integer = \f(CW$status_icon\fP\->\fBget_size\fP"
.IX Subsection "integer = $status_icon->get_size"
.ie n .SS "string or undef = $status_icon\->\fBget_stock\fP"
.el .SS "string or undef = \f(CW$status_icon\fP\->\fBget_stock\fP"
.IX Subsection "string or undef = $status_icon->get_stock"
.ie n .SS "imagetype = $status_icon\->\fBget_storage_type\fP"
.el .SS "imagetype = \f(CW$status_icon\fP\->\fBget_storage_type\fP"
.IX Subsection "imagetype = $status_icon->get_storage_type"
.ie n .SS "string = $status_icon\->\fBget_title\fP"
.el .SS "string = \f(CW$status_icon\fP\->\fBget_title\fP"
.IX Subsection "string = $status_icon->get_title"
Since: gtk+ 2.18
.ie n .SS "$status_icon\->\fBset_title\fP ($title)"
.el .SS "\f(CW$status_icon\fP\->\fBset_title\fP ($title)"
.IX Subsection "$status_icon->set_title ($title)"
.IP \(bu 4
\&\f(CW$title\fR (string)
.PP
Since: gtk+ 2.18
.ie n .SS "string or undef = $status_icon\->\fBget_tooltip_markup\fP"
.el .SS "string or undef = \f(CW$status_icon\fP\->\fBget_tooltip_markup\fP"
.IX Subsection "string or undef = $status_icon->get_tooltip_markup"
Since: gtk+ 2.16
.ie n .SS "$status_icon\->\fBset_tooltip_markup\fP ($markup)"
.el .SS "\f(CW$status_icon\fP\->\fBset_tooltip_markup\fP ($markup)"
.IX Subsection "$status_icon->set_tooltip_markup ($markup)"
.IP \(bu 4
\&\f(CW$markup\fR (string or undef)
.PP
Since: gtk+ 2.16
.ie n .SS "$status_icon\->\fBset_tooltip\fP ($tooltip_text)"
.el .SS "\f(CW$status_icon\fP\->\fBset_tooltip\fP ($tooltip_text)"
.IX Subsection "$status_icon->set_tooltip ($tooltip_text)"
.IP \(bu 4
\&\f(CW$tooltip_text\fR (string or undef)
.ie n .SS "string or undef = $status_icon\->\fBget_tooltip_text\fP"
.el .SS "string or undef = \f(CW$status_icon\fP\->\fBget_tooltip_text\fP"
.IX Subsection "string or undef = $status_icon->get_tooltip_text"
Since: gtk+ 2.16
.ie n .SS "$status_icon\->\fBset_tooltip_text\fP ($text)"
.el .SS "\f(CW$status_icon\fP\->\fBset_tooltip_text\fP ($text)"
.IX Subsection "$status_icon->set_tooltip_text ($text)"
.IP \(bu 4
\&\f(CW$text\fR (string or undef)
.PP
Since: gtk+ 2.16
.ie n .SS "boolean = $status_icon\->\fBget_visible\fP"
.el .SS "boolean = \f(CW$status_icon\fP\->\fBget_visible\fP"
.IX Subsection "boolean = $status_icon->get_visible"
.ie n .SS "$status_icon\->\fBset_visible\fP ($visible)"
.el .SS "\f(CW$status_icon\fP\->\fBset_visible\fP ($visible)"
.IX Subsection "$status_icon->set_visible ($visible)"
.IP \(bu 4
\&\f(CW$visible\fR (boolean)
.ie n .SS "unsigned = $status_icon\->\fBget_x11_window_id\fP"
.el .SS "unsigned = \f(CW$status_icon\fP\->\fBget_x11_window_id\fP"
.IX Subsection "unsigned = $status_icon->get_x11_window_id"
Since: gtk+ 2.14
.SH PROPERTIES
.IX Header "PROPERTIES"
.IP "'blinking' (boolean : default false : readable / writable / private / static-nick / static-blurb / deprecated)" 4
.IX Item "'blinking' (boolean : default false : readable / writable / private / static-nick / static-blurb / deprecated)"
Whether or not the status icon is blinking
.IP "'embedded' (boolean : default false : readable / private / static-nick / static-blurb)" 4
.IX Item "'embedded' (boolean : default false : readable / private / static-nick / static-blurb)"
Whether or not the status icon is embedded
.IP "'file' (string : default undef : writable / private / static-nick / static-blurb)" 4
.IX Item "'file' (string : default undef : writable / private / static-nick / static-blurb)"
Filename to load and display
.IP "'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable / writable / private / static-nick / static-blurb)"
The GIcon being displayed
.IP "'has\-tooltip' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'has-tooltip' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
Whether this tray icon has a tooltip
.IP "'icon\-name' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'icon-name' (string : default undef : readable / writable / private / static-nick / static-blurb)"
The name of the icon from the icon theme
.IP "'orientation' (Gtk2::Orientation : default ""horizontal"" : readable / private / static-nick / static-blurb)" 4
.IX Item "'orientation' (Gtk2::Orientation : default ""horizontal"" : readable / private / static-nick / static-blurb)"
The orientation of the tray
.IP "'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb)"
A GdkPixbuf to display
.IP "'screen' (Gtk2::Gdk::Screen : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'screen' (Gtk2::Gdk::Screen : default undef : readable / writable / private / static-nick / static-blurb)"
The screen where this status icon will be displayed
.IP "'size' (integer : default 0 : readable / private / static-nick / static-blurb)" 4
.IX Item "'size' (integer : default 0 : readable / private / static-nick / static-blurb)"
The size of the icon
.IP "'stock' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'stock' (string : default undef : readable / writable / private / static-nick / static-blurb)"
Stock ID for a stock image to display
.IP "'storage\-type' (Gtk2::ImageType : default ""empty"" : readable / private / static-nick / static-blurb)" 4
.IX Item "'storage-type' (Gtk2::ImageType : default ""empty"" : readable / private / static-nick / static-blurb)"
The representation being used for image data
.IP "'title' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'title' (string : default undef : readable / writable / private / static-nick / static-blurb)"
The title of this tray icon
.IP "'tooltip\-markup' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'tooltip-markup' (string : default undef : readable / writable / private / static-nick / static-blurb)"
The contents of the tooltip for this tray icon
.IP "'tooltip\-text' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'tooltip-text' (string : default undef : readable / writable / private / static-nick / static-blurb)"
The contents of the tooltip for this widget
.IP "'visible' (boolean : default true : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'visible' (boolean : default true : readable / writable / private / static-nick / static-blurb)"
Whether or not the status icon is visible
.SH SIGNALS
.IX Header "SIGNALS"
.IP "\fBactivate\fR (Gtk2::StatusIcon)" 4
.IX Item "activate (Gtk2::StatusIcon)"
.PD 0
.IP "boolean = \fBbutton-press-event\fR (Gtk2::StatusIcon, Gtk2::Gdk::Event)" 4
.IX Item "boolean = button-press-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)"
.IP "boolean = \fBbutton-release-event\fR (Gtk2::StatusIcon, Gtk2::Gdk::Event)" 4
.IX Item "boolean = button-release-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)"
.IP "\fBpopup-menu\fR (Gtk2::StatusIcon, Glib::UInt, Glib::UInt)" 4
.IX Item "popup-menu (Gtk2::StatusIcon, Glib::UInt, Glib::UInt)"
.IP "boolean = \fBquery-tooltip\fR (Gtk2::StatusIcon, integer, integer, boolean, Gtk2::Tooltip)" 4
.IX Item "boolean = query-tooltip (Gtk2::StatusIcon, integer, integer, boolean, Gtk2::Tooltip)"
.IP "boolean = \fBscroll-event\fR (Gtk2::StatusIcon, Gtk2::Gdk::Event)" 4
.IX Item "boolean = scroll-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)"
.IP "boolean = \fBsize-changed\fR (Gtk2::StatusIcon, integer)" 4
.IX Item "boolean = size-changed (Gtk2::StatusIcon, integer)"
.PD
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::ImageType"
.IX Subsection "enum Gtk2::ImageType"
.IP \(bu 4
\&'empty' / 'GTK_IMAGE_EMPTY'
.IP \(bu 4
\&'pixmap' / 'GTK_IMAGE_PIXMAP'
.IP \(bu 4
\&'image' / 'GTK_IMAGE_IMAGE'
.IP \(bu 4
\&'pixbuf' / 'GTK_IMAGE_PIXBUF'
.IP \(bu 4
\&'stock' / 'GTK_IMAGE_STOCK'
.IP \(bu 4
\&'icon\-set' / 'GTK_IMAGE_ICON_SET'
.IP \(bu 4
\&'animation' / 'GTK_IMAGE_ANIMATION'
.IP \(bu 4
\&'icon\-name' / 'GTK_IMAGE_ICON_NAME'
.IP \(bu 4
\&'gicon' / 'GTK_IMAGE_GICON'
.SS "enum Gtk2::Orientation"
.IX Subsection "enum Gtk2::Orientation"
.IP \(bu 4
\&'horizontal' / 'GTK_ORIENTATION_HORIZONTAL'
.IP \(bu 4
\&'vertical' / 'GTK_ORIENTATION_VERTICAL'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the LGPL.  See Gtk2 for a full notice.