.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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" '' . 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Desktop::Notify 3pm" .TH Desktop::Notify 3pm "2018-10-29" "perl v5.26.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" Desktop::Notify \- Communicate with the Desktop Notifications framework .SH "VERSION" .IX Header "VERSION" Version 0.04 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Desktop::Notify; \& \& # Open a connection to the notification daemon \& my $notify = Desktop::Notify\->new(); \& \& # Create a notification to display \& my $notification = $notify\->create(summary => \*(AqDesktop::Notify\*(Aq, \& body => \*(AqHello, world!\*(Aq, \& timeout => 5000); \& \& # Display the notification \& $notification\->show(); \& \& # Close the notification later \& $notification\->close(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a Perl interface to the Desktop Notifications framework. .PP The framework allows applications to display pop-up notifications on an X desktop. This is implemented with two components: a daemon that displays the notifications, and a client library used by applications to send notifications to the daemon. These components communicate through the DBus message bus protocol. .PP More information is available from .PP This module serves the same purpose as \f(CW\*(C`libnotify\*(C'\fR, in an object-oriented Perl interface. It is not, however, an interface to \f(CW\*(C`libnotify\*(C'\fR itself, but a separate implementation of the specification using Net::DBus. .SH "METHODS" .IX Header "METHODS" .ie n .SS "new %opts" .el .SS "new \f(CW%opts\fP" .IX Subsection "new %opts" Connect to the notification daemon. \f(CW%opts\fR can include the following options: .IP "app_name" 4 .IX Item "app_name" The application name to use for notifications. Default is \f(CW\*(C`basename($0)\*(C'\fR .IP "app_icon" 4 .IX Item "app_icon" Path to an image to use for notification icons. .IP "bus" 4 .IX Item "bus" The Net::DBus message bus to use. Default is to call Net::DBus\->session, which is usually where notification-daemon can be reached. .IP "service" 4 .IX Item "service" The DBus service name of the daemon. Default is \&\fIorg.freedesktop.Notifications\fR. .IP "objpath" 4 .IX Item "objpath" The path to the notifications DBus object. Default is \&\fI/org/freedesktop/Notifications\fR. .IP "objiface" 4 .IX Item "objiface" The DBus interface to access the notifications object as. Default is \&\fIorg.freedesktop.Notifications\fR. .ie n .SS "create %params" .el .SS "create \f(CW%params\fP" .IX Subsection "create %params" Creates a new notification object that can be displayed later. This will return a Desktop::Notify::Notification object; see that module for information about using it. .ie n .SS "close_callback $coderef" .el .SS "close_callback \f(CW$coderef\fP" .IX Subsection "close_callback $coderef" Sets a user-specified function to be called whenever a notification is closed. It will be called with one argument, which is the Notification object that was just closed. .ie n .SS "action_callback $coderef" .el .SS "action_callback \f(CW$coderef\fP" .IX Subsection "action_callback $coderef" Sets a user-specified function to be called whenever an action is invoked. It will be called with two arguments, which are the Notification object on which an action was invoked, and the key of the action invoked. .SH "AUTHOR" .IX Header "AUTHOR" Stephen Cavilia, \f(CW\*(C`\*(C'\fR .SH "SEE ALSO" .IX Header "SEE ALSO" Net::DBus .PP .PP .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-desktop\-notify at rt.cpan.org\*(C'\fR, or through the web interface at . 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 Desktop::Notify .Ve .PP You can also look for information at: .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .IP "\(bu" 4 \&\s-1RT: CPAN\s0's request tracker .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2007 Stephen Cavilia, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.