Stephen A Cavilia > Desktop-Notify-0.03 > Desktop::Notify::Notification

Download:
Desktop-Notify-0.03.tar.gz

Dependencies

Annotate this POD

CPAN RT

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

NAME ^

Desktop::Notify::Notification - a notification object for the desktop notifications framework

VERSION ^

Version 0.03

SYNOPSIS ^

    # $notify is an existing Desktop::Notify object
    my $note = $notify->create(summary => 'Rebuilding FooBar',
                               body => 'Progress: 10%');
    $note->show;
    
    ...
    
    # Update the notification later
    $note->body('Progress: 20%');
    $note->show;
    
    ...
    # Take it off the screen
    $note->close;

DESCRIPTION ^

Desktop notification objects are represented as objects of this class. They are created by a Desktop::Notify object. Displaying, closing, and modifying the notification is done by using methods in this class.

METHODS ^

new $notify, %params

This is called internally by Desktop::Notify to create a new notification object.

show

Display the notification on the screen. If this notification had previously been shown and not closed yet, it will replace the existing notification.

Show can be called multiple times on the same notification, probably with attribute changes between calls, and later show calls will cause the server to seamlessly replace the existing notification.

close

Close the notification if it is already being displayed.

ATTRIBUTES ^

The following parameters can be set when creating the object or later modified using accessors (descriptions are from the specification at http://www.galago-project.org/specs/notification/0.9/x408.html)

summary

The summary text briefly describing the notification.

body

The optional detailed body text. Can be empty.

timeout

The timeout time in milliseconds since the display of the notification at which the notification should automatically close.

If -1, the notification's expiration time is dependent on the notification server's settings, and may vary for the type of notification. If 0, never expire.

The following extra parameters are included in the specification but not supported by Desktop::Notify at this time

app_icon

The optional program icon of the calling application.

actions

Actions are sent over as a list of pairs. Each even element in the list (starting at index 0) represents the identifier for the action. Each odd element in the list is the localized string that will be displayed to the user.

hints

Optional hints that can be passed to the server from the client program.

syntax highlighting: