.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Gtk2::Notify 3pm" .TH Gtk2::Notify 3pm "2011-11-16" "perl v5.14.2" "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::Notify \- Perl interface to libnotify .SH "HIERARCHY" .IX Header "HIERARCHY" .Vb 2 \& Glib::Object \& +\-\-\-\-Gtk2::Notify .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Gtk2::Notify \-init, "app_name"; \& \& my $notification = Gtk2::Notify\->new( \& $summary, \& $message, \& $icon, \& $attach_widget \& ); \& $notification\->show; .Ve .SH "INITIALISATION" .IX Header "INITIALISATION" .Vb 1 \& use Gtk2::Notify qw/\-init app_name/; .Ve .IP "\-init" 4 .IX Item "-init" Importing Gtk2::Notify with the \-init option requires one additional argument: the application name to use. This is equivalent to \&\f(CW\*(C`Gtk2::Notify\->init($app_name)\*(C'\fR. .SH "METHODS" .IX Header "METHODS" .ie n .SS "notify = Gtk2::Notify\->\fBnew\fP ($summary, $body=undef, $icon=undef)" .el .SS "notify = Gtk2::Notify\->\fBnew\fP ($summary, \f(CW$body\fP=undef, \f(CW$icon\fP=undef)" .IX Subsection "notify = Gtk2::Notify->new ($summary, $body=undef, $icon=undef)" .IP "\(bu" 4 \&\f(CW$summary\fR (string) .IP "\(bu" 4 \&\f(CW$body\fR (string) .IP "\(bu" 4 \&\f(CW$icon\fR (string) .ie n .SS "$notification\->\fBadd_action\fP ($action, $label, $callback, $userdata=undef)" .el .SS "\f(CW$notification\fP\->\fBadd_action\fP ($action, \f(CW$label\fP, \f(CW$callback\fP, \f(CW$userdata\fP=undef)" .IX Subsection "$notification->add_action ($action, $label, $callback, $userdata=undef)" .IP "\(bu" 4 \&\f(CW$action\fR (string) .IP "\(bu" 4 \&\f(CW$label\fR (string) .IP "\(bu" 4 \&\f(CW$callback\fR (scalar) .IP "\(bu" 4 \&\f(CW$userdata\fR (scalar) .SS "string = Gtk2::Notify\->\fBget_app_name\fP" .IX Subsection "string = Gtk2::Notify->get_app_name" .ie n .SS "$notification\->\fBset_category\fP ($category)" .el .SS "\f(CW$notification\fP\->\fBset_category\fP ($category)" .IX Subsection "$notification->set_category ($category)" .IP "\(bu" 4 \&\f(CW$category\fR (string) .ie n .SS "$notification\->\fBclear_actions\fP" .el .SS "\f(CW$notification\fP\->\fBclear_actions\fP" .IX Subsection "$notification->clear_actions" .ie n .SS "$notification\->\fBclear_hints\fP" .el .SS "\f(CW$notification\fP\->\fBclear_hints\fP" .IX Subsection "$notification->clear_hints" .ie n .SS "notify = $notification\->\fBclose\fP" .el .SS "notify = \f(CW$notification\fP\->\fBclose\fP" .IX Subsection "notify = $notification->close" .ie n .SS "$notification\->\fBset_hint_byte_array\fP ($key, $value)" .el .SS "\f(CW$notification\fP\->\fBset_hint_byte_array\fP ($key, \f(CW$value\fP)" .IX Subsection "$notification->set_hint_byte_array ($key, $value)" .IP "\(bu" 4 \&\f(CW$key\fR (string) .IP "\(bu" 4 \&\f(CW$value\fR ((unknown)) .ie n .SS "$notification\->\fBset_hint_byte\fP ($key, $value)" .el .SS "\f(CW$notification\fP\->\fBset_hint_byte\fP ($key, \f(CW$value\fP)" .IX Subsection "$notification->set_hint_byte ($key, $value)" .IP "\(bu" 4 \&\f(CW$key\fR (string) .IP "\(bu" 4 \&\f(CW$value\fR (Glib::UChar) .ie n .SS "$notification\->\fBset_hint_double\fP ($key, $value)" .el .SS "\f(CW$notification\fP\->\fBset_hint_double\fP ($key, \f(CW$value\fP)" .IX Subsection "$notification->set_hint_double ($key, $value)" .IP "\(bu" 4 \&\f(CW$key\fR (string) .IP "\(bu" 4 \&\f(CW$value\fR (double) .ie n .SS "$notification\->\fBset_hint_int32\fP ($key, $value)" .el .SS "\f(CW$notification\fP\->\fBset_hint_int32\fP ($key, \f(CW$value\fP)" .IX Subsection "$notification->set_hint_int32 ($key, $value)" .IP "\(bu" 4 \&\f(CW$key\fR (string) .IP "\(bu" 4 \&\f(CW$value\fR (integer) .ie n .SS "$notification\->\fBset_hint\fP ($key, $value)" .el .SS "\f(CW$notification\fP\->\fBset_hint\fP ($key, \f(CW$value\fP)" .IX Subsection "$notification->set_hint ($key, $value)" .IP "\(bu" 4 \&\f(CW$key\fR (string) .IP "\(bu" 4 \&\f(CW$value\fR (scalar) .ie n .SS "$notification\->\fBset_hint_string\fP ($key, $value)" .el .SS "\f(CW$notification\fP\->\fBset_hint_string\fP ($key, \f(CW$value\fP)" .IX Subsection "$notification->set_hint_string ($key, $value)" .IP "\(bu" 4 \&\f(CW$key\fR (string) .IP "\(bu" 4 \&\f(CW$value\fR (string) .ie n .SS "$notification\->\fBset_icon_from_pixbuf\fP ($icon)" .el .SS "\f(CW$notification\fP\->\fBset_icon_from_pixbuf\fP ($icon)" .IX Subsection "$notification->set_icon_from_pixbuf ($icon)" .IP "\(bu" 4 \&\f(CW$icon\fR (Gtk2::Gdk::Pixbuf) .SS "boolean = Gtk2::Notify\->\fBinit\fP ($app_name)" .IX Subsection "boolean = Gtk2::Notify->init ($app_name)" .IP "\(bu" 4 \&\f(CW$app_name\fR (string) .SS "boolean = Gtk2::Notify\->\fBis_initted\fP" .IX Subsection "boolean = Gtk2::Notify->is_initted" .SS "list = Gtk2::Notify\->\fBget_server_caps\fP" .IX Subsection "list = Gtk2::Notify->get_server_caps" .SS "(notify, name, vendor, version, spec_version) = Gtk2::Notify\->\fBget_server_info\fP" .IX Subsection "(notify, name, vendor, version, spec_version) = Gtk2::Notify->get_server_info" .ie n .SS "notify = $notification\->\fBshow\fP" .el .SS "notify = \f(CW$notification\fP\->\fBshow\fP" .IX Subsection "notify = $notification->show" .ie n .SS "$notification\->\fBset_timeout\fP ($timeout)" .el .SS "\f(CW$notification\fP\->\fBset_timeout\fP ($timeout)" .IX Subsection "$notification->set_timeout ($timeout)" .IP "\(bu" 4 \&\f(CW$timeout\fR (integer) .SS "Gtk2::Notify\->\fBuninit\fP" .IX Subsection "Gtk2::Notify->uninit" .ie n .SS "boolean = $notification\->\fBupdate\fP ($summary, $message=undef, $icon=undef)" .el .SS "boolean = \f(CW$notification\fP\->\fBupdate\fP ($summary, \f(CW$message\fP=undef, \f(CW$icon\fP=undef)" .IX Subsection "boolean = $notification->update ($summary, $message=undef, $icon=undef)" .IP "\(bu" 4 \&\f(CW$summary\fR (string) .IP "\(bu" 4 \&\f(CW$message\fR (string) .IP "\(bu" 4 \&\f(CW$icon\fR (string) .ie n .SS "$notification\->\fBset_urgency\fP ($urgency)" .el .SS "\f(CW$notification\fP\->\fBset_urgency\fP ($urgency)" .IX Subsection "$notification->set_urgency ($urgency)" .IP "\(bu" 4 \&\f(CW$urgency\fR (Gtk2::Notify::NotifyUrgency) .SH "PROPERTIES" .IX Header "PROPERTIES" .IP "'app\-name' (string : default undef : readable / writable)" 4 .IX Item "'app-name' (string : default undef : readable / writable)" The application name to use for this notification .IP "'body' (string : default undef : readable / writable / construct)" 4 .IX Item "'body' (string : default undef : readable / writable / construct)" The message body text .IP "'closed\-reason' (integer : default \-1 : readable)" 4 .IX Item "'closed-reason' (integer : default -1 : readable)" The reason code for why the notification was closed .IP "'icon\-name' (string : default undef : readable / writable / construct)" 4 .IX Item "'icon-name' (string : default undef : readable / writable / construct)" The icon filename or icon theme-compliant name .IP "'id' (integer : default 0 : readable / writable / construct)" 4 .IX Item "'id' (integer : default 0 : readable / writable / construct)" The notification \s-1ID\s0 .IP "'summary' (string : default undef : readable / writable / construct)" 4 .IX Item "'summary' (string : default undef : readable / writable / construct)" The summary text .SH "SIGNALS" .IX Header "SIGNALS" .IP "\fBclosed\fR (Gtk2::Notify)" 4 .IX Item "closed (Gtk2::Notify)" .SH "ENUMS AND FLAGS" .IX Header "ENUMS AND FLAGS" .SS "enum Gtk2::Notify::NotifyUrgency" .IX Subsection "enum Gtk2::Notify::NotifyUrgency" .PD 0 .IP "\(bu" 4 .PD \&'low' / '\s-1NOTIFY_URGENCY_LOW\s0' .IP "\(bu" 4 \&'normal' / '\s-1NOTIFY_URGENCY_NORMAL\s0' .IP "\(bu" 4 \&'critical' / '\s-1NOTIFY_URGENCY_CRITICAL\s0' .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-gtk2\-notify at rt.cpan.org\*(C'\fR, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Gtk2\-Notify . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc Gtk2::Notify .Ve .PP You can also look for information at: .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp http://annocpan.org/dist/Gtk2\-Notify .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp http://cpanratings.perl.org/d/Gtk2\-Notify .IP "\(bu" 4 \&\s-1RT:\s0 \s-1CPAN\s0's request tracker .Sp http://rt.cpan.org/NoAuth/Bugs.html?Dist=Gtk2\-Notify .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp http://search.cpan.org/dist/Gtk2\-Notify .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2::Notify, Glib::Object .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2006\-2008 by Florian Ragwitz