1=head1 NAME 2 3UI::Dialog::Backend::NotifySend - backend for notify-send(1). 4 5=head1 SYNOPSIS 6 7 use UI::Dialog::Backend::NotifySend; 8 my $ns = new UI::Dialog::Backend::NotifySend (); 9 $ns->notify_send( subject => "Subject of notification." ); 10 11=head1 ABSTRACT 12 13UI::Dialog::Backend::NotifySend is an OOPerl wrapper for the notify-send(1) 14program. 15 16=head1 DESCRIPTION 17 18Use this module to notify end-users via the notification daemon (Desktop Notifications). 19Requires the notify-send(1) progam to be installed (the libnotify-bin package in Debian). 20 21=head1 EXPORT 22 23=over 2 24 25None 26 27=back 28 29=head1 INHERITS 30 31=over 2 32 33UI::Dialog::Backend 34 35=back 36 37=head1 CONSTRUCTOR 38 39=head2 new( @options ) 40 41=over 4 42 43=item EXAMPLE 44 45=over 6 46 47 my $ns = new UI::Dialog::Backend::NotifySend ( ); 48 49=back 50 51=item DESCRIPTION 52 53=over 6 54 55This is the Class Constructor method. It accepts a list of key => value pairs 56and uses them as the defaults when interacting with the various widgets. All 57methods accept the same arguments as new() except that the arguments passed to 58the methods are temporarily used instead of making them the default as the 59new() method does. 60 61=back 62 63=item RETURNS 64 65=over 6 66 67A blessed object reference of the UI::Dialog::Backend::NotifySend class. 68 69=back 70 71=item OPTIONS 72 73The (...)'s after each option indicate the default for the option. An * denotes 74support by all the widget methods on a per-use policy defaulting to the 75values decided during object creation. 76 77=over 6 78 79=item B<expire-time = \d+> (0) * 80 81=item B<urgency = (low|normal|critical)> ('normal') * 82 83=item B<app-name = \w+> (none) * 84 85=item B<icon = ICON[,ICON...]> (none) * 86 87=item B<category = TYPE[,TYPE...]> (none) * 88 89=item B<hint = TYPE:NAME:VALUE> (none) * 90 91=back 92 93=back 94 95=head1 METHODS 96 97=head2 notify_send( ) 98 99=over 4 100 101=item EXAMPLE 102 103=over 6 104 105 $ns->notify_send( subject => "Notification subject", 106 body => "Some text to display" ); 107 108=back 109 110=item DESCRIPTION 111 112=over 6 113 114Display a notification to the end user. 115 116=back 117 118=item RETURNS 119 120=over 6 121 122Nothing. 123 124=back 125 126=back 127 128=head1 SEE ALSO 129 130=over 2 131 132=item PERLDOC 133 134 UI::Dialog 135 UI::Dialog::Backend 136 137=back 138 139=over 2 140 141=item MAN FILES 142 143osd_cat(1) 144 145=back 146 147=head1 BUGS 148 149Please email the author with any bug reports. Include the name of the 150module in the subject line. 151 152=head1 AUTHOR 153 154Kevin C. Krinke, E<lt>kevin@krinke.caE<gt> 155 156=head1 COPYRIGHT AND LICENSE 157 158 Copyright (C) 2004-2016 Kevin C. Krinke <kevin@krinke.ca> 159 160 This library is free software; you can redistribute it and/or 161 modify it under the terms of the GNU Lesser General Public 162 License as published by the Free Software Foundation; either 163 version 2.1 of the License, or (at your option) any later version. 164 165 This library is distributed in the hope that it will be useful, 166 but WITHOUT ANY WARRANTY; without even the implied warranty of 167 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 168 Lesser General Public License for more details. 169 170 You should have received a copy of the GNU Lesser General Public 171 License along with this library; if not, write to the Free Software 172 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 173 174=cut 175