View on
MetaCPAN
Kevin C. Krinke > UI-Dialog > UI::Dialog::Backend::NotifySend

Download:
UI-Dialog-1.21.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
Stalled  1
View/Report Bugs
Module Version: 1.21   Source  

NAME ^

UI::Dialog::Backend::NotifySend - backend for notify-send(1).

SYNOPSIS ^

  use UI::Dialog::Backend::NotifySend;
  my $ns = new UI::Dialog::Backend::NotifySend ();
  $ns->notify_send( subject => "Subject of notification." );

ABSTRACT ^

UI::Dialog::Backend::NotifySend is an OOPerl wrapper for the notify-send(1) program.

DESCRIPTION ^

Use this module to notify end-users via the notification daemon (Desktop Notifications). Requires the notify-send(1) progam to be installed (the libnotify-bin package in Debian).

EXPORT ^

None

INHERITS ^

UI::Dialog::Backend

CONSTRUCTOR ^

new( @options )

EXAMPLE
 my $ns = new UI::Dialog::Backend::NotifySend ( );
DESCRIPTION

This is the Class Constructor method. It accepts a list of key => value pairs and uses them as the defaults when interacting with the various widgets. All methods accept the same arguments as new() except that the arguments passed to the methods are temporarily used instead of making them the default as the new() method does.

RETURNS

A blessed object reference of the UI::Dialog::Backend::NotifySend class.

OPTIONS

The (...)'s after each option indicate the default for the option. An * denotes support by all the widget methods on a per-use policy defaulting to the values decided during object creation.

expire-time = \d+ (0) *
urgency = (low|normal|critical) ('normal') *
app-name = \w+ (none) *
icon = ICON[,ICON...] (none) *
category = TYPE[,TYPE...] (none) *
hint = TYPE:NAME:VALUE (none) *

METHODS ^

notify_send( )

EXAMPLE
 $ns->notify_send( subject => "Notification subject",
                   body => "Some text to display" );
DESCRIPTION

Display a notification to the end user.

RETURNS

Nothing.

SEE ALSO ^

PERLDOC
 UI::Dialog
 UI::Dialog::Backend
MAN FILES

osd_cat(1)

BUGS ^

Please email the author with any bug reports. Include the name of the module in the subject line.

AUTHOR ^

Kevin C. Krinke, <kevin@krinke.ca>

COPYRIGHT AND LICENSE ^

 Copyright (C) 2004-2016  Kevin C. Krinke <kevin@krinke.ca>

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
syntax highlighting: