Gtk2::StatusIcon(3pm)

1Gtk2::StatusIcon(3)   User Contributed Perl Documentation  Gtk2::StatusIcon(3)
2
3
4

NAME

6       Gtk2::StatusIcon - wrapper for GtkStatusIcon
7

HIERARCHY

9         Glib::Object
10         +----Gtk2::StatusIcon
11

METHODS

13   statusicon = Gtk2::StatusIcon->new
14   statusicon = Gtk2::StatusIcon->new_from_file ($filename)
15       •   $filename (localized file name)
16
17   statusicon = Gtk2::StatusIcon->new_from_icon_name ($icon_name)
18       •   $icon_name (string)
19
20   statusicon = Gtk2::StatusIcon->new_from_pixbuf ($pixbuf)
21       •   $pixbuf (Gtk2::Gdk::Pixbuf)
22
23   statusicon = Gtk2::StatusIcon->new_from_stock ($stock_id)
24       •   $stock_id (string)
25
26   boolean = $status_icon->get_blinking
27   $status_icon->set_blinking ($blinking)
28       •   $blinking (boolean)
29
30   $status_icon->set_from_file ($filename)
31       •   $filename (localized file name)
32
33   $status_icon->set_from_icon_name ($icon_name)
34       •   $icon_name (string)
35
36   $status_icon->set_from_pixbuf ($pixbuf)
37       •   $pixbuf (Gtk2::Gdk::Pixbuf or undef)
38
39   $status_icon->set_from_stock ($stock_id)
40       •   $stock_id (string)
41
42   list = $status_icon->get_geometry
43   boolean = $status_icon->get_has_tooltip
44       Since: gtk+ 2.16
45
46   $status_icon->set_has_tooltip ($has_tooltip)
47       •   $has_tooltip (boolean)
48
49       Since: gtk+ 2.16
50
51   string or undef = $status_icon->get_icon_name
52   boolean = $status_icon->is_embedded
53   $status_icon->set_name ($name)
54       •   $name (string)
55
56       Since: gtk+ 2.20
57
58   pixbuf or undef = $status_icon->get_pixbuf
59   (x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, icon)
60   (x, y, push_in) = Gtk2::StatusIcon::position_menu (menu, x, y, icon)
61       •   ... (list)
62
63       •   $icon (Gtk2::StatusIcon)
64
65       •   $y (integer)
66
67       •   $x (integer)
68
69       This function takes four arguments so that it may be passed directly as
70       the menu position callback to Gtk2::Menu::popup(), which passes in
71       initial x and y values for historical reasons.  Otherwise, you need
72       only pass two arguments.
73
74       This function can be used as the menu_pos_func argument to
75       Gtk2::Menu::popup.
76
77   screen = $status_icon->get_screen
78       Since: gtk+ 2.12
79
80   $status_icon->set_screen ($screen)
81       •   $screen (Gtk2::Gdk::Screen)
82
83       Since: gtk+ 2.12
84
85   integer = $status_icon->get_size
86   string or undef = $status_icon->get_stock
87   imagetype = $status_icon->get_storage_type
88   string = $status_icon->get_title
89       Since: gtk+ 2.18
90
91   $status_icon->set_title ($title)
92       •   $title (string)
93
94       Since: gtk+ 2.18
95
96   string or undef = $status_icon->get_tooltip_markup
97       Since: gtk+ 2.16
98
99   $status_icon->set_tooltip_markup ($markup)
100       •   $markup (string or undef)
101
102       Since: gtk+ 2.16
103
104   $status_icon->set_tooltip ($tooltip_text)
105       •   $tooltip_text (string or undef)
106
107   string or undef = $status_icon->get_tooltip_text
108       Since: gtk+ 2.16
109
110   $status_icon->set_tooltip_text ($text)
111       •   $text (string or undef)
112
113       Since: gtk+ 2.16
114
115   boolean = $status_icon->get_visible
116   $status_icon->set_visible ($visible)
117       •   $visible (boolean)
118
119   unsigned = $status_icon->get_x11_window_id
120       Since: gtk+ 2.14
121

PROPERTIES

123       'blinking' (boolean : default false : readable / writable / private /
124       static-nick / static-blurb / deprecated)
125           Whether or not the status icon is blinking
126
127       'embedded' (boolean : default false : readable / private / static-nick
128       / static-blurb)
129           Whether or not the status icon is embedded
130
131       'file' (string : default undef : writable / private / static-nick /
132       static-blurb)
133           Filename to load and display
134
135       'gicon' (Glib::Object::_Unregistered::GIcon : default undef : readable
136       / writable / private / static-nick / static-blurb)
137           The GIcon being displayed
138
139       'has-tooltip' (boolean : default false : readable / writable / private
140       / static-nick / static-blurb)
141           Whether this tray icon has a tooltip
142
143       'icon-name' (string : default undef : readable / writable / private /
144       static-nick / static-blurb)
145           The name of the icon from the icon theme
146
147       'orientation' (Gtk2::Orientation : default "horizontal" : readable /
148       private / static-nick / static-blurb)
149           The orientation of the tray
150
151       'pixbuf' (Gtk2::Gdk::Pixbuf : default undef : readable / writable /
152       private / static-nick / static-blurb)
153           A GdkPixbuf to display
154
155       'screen' (Gtk2::Gdk::Screen : default undef : readable / writable /
156       private / static-nick / static-blurb)
157           The screen where this status icon will be displayed
158
159       'size' (integer : default 0 : readable / private / static-nick /
160       static-blurb)
161           The size of the icon
162
163       'stock' (string : default undef : readable / writable / private /
164       static-nick / static-blurb)
165           Stock ID for a stock image to display
166
167       'storage-type' (Gtk2::ImageType : default "empty" : readable / private
168       / static-nick / static-blurb)
169           The representation being used for image data
170
171       'title' (string : default undef : readable / writable / private /
172       static-nick / static-blurb)
173           The title of this tray icon
174
175       'tooltip-markup' (string : default undef : readable / writable /
176       private / static-nick / static-blurb)
177           The contents of the tooltip for this tray icon
178
179       'tooltip-text' (string : default undef : readable / writable / private
180       / static-nick / static-blurb)
181           The contents of the tooltip for this widget
182
183       'visible' (boolean : default true : readable / writable / private /
184       static-nick / static-blurb)
185           Whether or not the status icon is visible
186

SIGNALS

188       activate (Gtk2::StatusIcon)
189       boolean = button-press-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)
190       boolean = button-release-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)
191       popup-menu (Gtk2::StatusIcon, Glib::UInt, Glib::UInt)
192       boolean = query-tooltip (Gtk2::StatusIcon, integer, integer, boolean,
193       Gtk2::Tooltip)
194       boolean = scroll-event (Gtk2::StatusIcon, Gtk2::Gdk::Event)
195       boolean = size-changed (Gtk2::StatusIcon, integer)
196

ENUMS AND FLAGS

198   enum Gtk2::ImageType
199       •   'empty' / 'GTK_IMAGE_EMPTY'
200
201       •   'pixmap' / 'GTK_IMAGE_PIXMAP'
202
203       •   'image' / 'GTK_IMAGE_IMAGE'
204
205       •   'pixbuf' / 'GTK_IMAGE_PIXBUF'
206
207       •   'stock' / 'GTK_IMAGE_STOCK'
208
209       •   'icon-set' / 'GTK_IMAGE_ICON_SET'
210
211       •   'animation' / 'GTK_IMAGE_ANIMATION'
212
213       •   'icon-name' / 'GTK_IMAGE_ICON_NAME'
214
215       •   'gicon' / 'GTK_IMAGE_GICON'
216
217   enum Gtk2::Orientation
218       •   'horizontal' / 'GTK_ORIENTATION_HORIZONTAL'
219
220       •   'vertical' / 'GTK_ORIENTATION_VERTICAL'
221

COPYRIGHT

226       Copyright (C) 2003-2011 by the gtk2-perl team.
227
228       This software is licensed under the LGPL.  See Gtk2 for a full notice.
229
230
231
232perl v5.36.0                      2023-01-20               Gtk2::StatusIcon(3)