Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

desktop::notify::notification(3pm) [debian man page]

Desktop::Notify::Notification(3pm)			User Contributed Perl Documentation			Desktop::Notify::Notification(3pm)

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.

perl v5.10.1							    2009-12-25					Desktop::Notify::Notification(3pm)

Check Out this Related Man Page

SVN::Notify::HTML::ColorDiff(3pm)			User Contributed Perl Documentation			 SVN::Notify::HTML::ColorDiff(3pm)

Name
       SVN::Notify::HTML::ColorDiff - Subversion activity HTML notification with colorized diff

Synopsis
       Use svnnotify in post-commit:

	 svnnotify --repos-path "$1" --revision "$2" 
	   --to developers@example.com --handler HTML::ColorDiff [options]

       Use the class in a custom script:

	 use SVN::Notify::HTML::ColorDiff;

	 my $notifier = SVN::Notify::HTML::ColorDiff->new(%params);
	 $notifier->prepare;
	 $notifier->execute;

Description
       This subclass of SVN::Notify::HTML sends HTML formatted email messages for Subversion activity, and if the "with_diff" parameter is
       specified (but not "attach_diff"), then a pretty colorized version of the diff will be included, rather than the plain text diff output by
       SVN::Notify::HTML.

Usage
       To use SVN::Notify::HTML::ColorDiff, simply follow the instructions in SVN::Notify, but when using svnnotify, specify "--handler
       HTML::ColorDiff".

Instance Interface
   Instance Methods
       output_css

	 $notifier->output_css($file_handle);

       This method starts outputs the CSS for the HTML message.  SVN::Notify::HTML::ColorDiff adds extra CSS to its output so that it can nicely
       style the diff.

       output_diff

	 $notifier->output_diff($out_file_handle, $diff_file_handle);

       Reads the diff data from $diff_file_handle and prints it to $out_file_handle for inclusion in the notification message. The diff is output
       with nice colorized HTML markup. Each line of the diff file is escaped by "HTML::Entities::encode_entities()".

       If there are any "diff" filters, this method will do no HTML formatting, but redispatch to SVN::Notify::output_diff. See Writing Output
       Filters for details on filters.

See Also
       SVN::Notify
       SVN::Notify::HTML
       <CVSspam>

To Do
       o   Add inline emphasis just on the text that changed between two lines, like this:
	   <http://www.badgers-in-foil.co.uk/projects/cvsspam/example.html>.

       o   Add links to To Do stuff to the top of the email, as pulled in from the diff.  This might be tricky, since the diff is currently output
	   after the message body. Maybe use absolute positioning CSS?

Author
       David E. Wheeler <david@kineticode.com>

Copyright and License
       Copyright (c) 2004-2009 Kineticode, Inc. Some Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2011-03-15					 SVN::Notify::HTML::ColorDiff(3pm)
Man Page