Gtk2::Notify(3pm)

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

NAME

6       Gtk2::Notify - Perl interface to libnotify
7

HIERARCHY

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

SYNOPSIS

13           use Gtk2::Notify -init, "app_name";
14
15           my $notification = Gtk2::Notify->new(
16                   $summary,
17                   $message,
18                   $icon,
19                   $attach_widget
20           );
21           $notification->show;
22

INITIALISATION

24           use Gtk2::Notify qw/-init app_name/;
25
26       -init
27           Importing Gtk2::Notify with the -init option requires one addi‐
28           tional argument: the application name to use. This is equivalent to
29           "Gtk2::Notify->init($app_name)".
30

METHODS

32       notify = Gtk2::Notify->new ($summary, $body=undef, $icon=undef,
33       $attach=undef)
34
35           * $summary (string)
36           * $body (string)
37           * $icon (string)
38           * $attach (Gtk2::Widget or undef)
39
40       notify = Gtk2::Notify->new_with_status_icon ($summary, $body=undef,
41       $icon=undef, $status_icon=undef)
42
43           * $summary (string)
44           * $body (string)
45           * $icon (string)
46           * $status_icon (Gtk2::StatusIcon)
47
48       $notification->add_action ($action, $label, $callback, $userdata=undef)
49
50           * $action (string)
51           * $label (string)
52           * $callback (scalar)
53           * $userdata (scalar)
54
55       string = Gtk2::Notify->get_app_name
56
57       $notification->attach_to_status_icon ($status_icon)
58
59           * $status_icon (Gtk2::StatusIcon)
60
61       $notification->attach_to_widget ($attach)
62
63           * $attach (Gtk2::Widget)
64
65       $notification->set_category ($category)
66
67           * $category (string)
68
69       $notification->clear_actions
70
71       $notification->clear_hints
72
73       notify = $notification->close
74
75       $notification->set_geometry_hints ($screen, $x, $y)
76
77           * $screen (Gtk2::Gdk::Screen)
78           * $x (integer)
79           * $y (integer)
80
81       $notification->set_hint_byte_array ($key, $value)
82
83           * $key (string)
84           * $value ((unknown))
85
86       $notification->set_hint_byte ($key, $value)
87
88           * $key (string)
89           * $value (Glib::UChar)
90
91       $notification->set_hint_double ($key, $value)
92
93           * $key (string)
94           * $value (double)
95
96       $notification->set_hint_int32 ($key, $value)
97
98           * $key (string)
99           * $value (integer)
100
101       $notification->set_hint ($key, $value)
102
103           * $key (string)
104           * $value (scalar)
105
106       $notification->set_hint_string ($key, $value)
107
108           * $key (string)
109           * $value (string)
110
111       $notification->set_icon_from_pixbuf ($icon)
112
113           * $icon (Gtk2::Gdk::Pixbuf)
114
115       boolean = Gtk2::Notify->init ($app_name)
116
117           * $app_name (string)
118
119       boolean = Gtk2::Notify->is_initted
120
121       list = Gtk2::Notify->get_server_caps
122
123       (notify, name, vendor, version, spec_version) =
124       Gtk2::Notify->get_server_info
125
126       notify = $notification->show
127
128       $notification->set_timeout ($timeout)
129
130           * $timeout (integer)
131
132       Gtk2::Notify->uninit
133
134       boolean = $notification->update ($summary, $message=undef, $icon=undef)
135
136           * $summary (string)
137           * $message (string)
138           * $icon (string)
139
140       $notification->set_urgency ($urgency)
141
142           * $urgency (Gtk2::Notify::NotifyUrgency)
143

PROPERTIES

145       'attach-widget' (Gtk2::Widget : readable / writable / construct)
146           The widget to attach the notification to
147
148       'body' (string : readable / writable / construct)
149           The message body text
150
151       'icon-name' (string : readable / writable / construct)
152           The icon filename or icon theme-compliant name
153
154       'status-icon' (Gtk2::StatusIcon : readable / writable / construct)
155           The status icon to attach the notification to
156
157       'summary' (string : readable / writable / construct)
158           The summary text
159

SIGNALS

161       closed (Gtk2::Notify)
162

ENUMS AND FLAGS

164       enum Gtk2::Notify::NotifyUrgency
165
166       * 'low' / 'NOTIFY_URGENCY_LOW'
167       * 'normal' / 'NOTIFY_URGENCY_NORMAL'
168       * 'critical' / 'NOTIFY_URGENCY_CRITICAL'
169

BUGS

171       Please report any bugs or feature requests to "bug-gtk2-notify at
172       rt.cpan.org", or through the web interface at
173       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Gtk2-Notify>.  I will
174       be notified, and then you'll automatically be notified of progress on
175       your bug as I make changes.
176

SUPPORT

178       You can find documentation for this module with the perldoc command.
179
180           perldoc Gtk2::Notify
181
182       You can also look for information at:
183
184       * AnnoCPAN: Annotated CPAN documentation
185           <http://annocpan.org/dist/Gtk2-Notify>
186
187       * CPAN Ratings
188           <http://cpanratings.perl.org/d/Gtk2-Notify>
189
190       * RT: CPAN's request tracker
191           <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Gtk2-Notify>
192
193       * Search CPAN
194           <http://search.cpan.org/dist/Gtk2-Notify>
195

COPYRIGHT

200       Copyright (C) 2006-2007 Florian Ragwitz
201
202       This library is free software; you can redistribute it and/or modify it
203       under the terms of the GNU Library General Public License as published
204       by the Free Software Foundation; either version 2 of the License, or
205       (at your option) any later version.
206
207       This library is distributed in the hope that it will be useful, but
208       WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
209       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library
210       General Public License for more details.
211
212       You should have received a copy of the GNU Library General Public
213       License along with this library; if not, write to the Free Software
214       Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307
215       USA.
216
217
218
219perl v5.8.8                       2007-10-04                   Gtk2::Notify(3)