NAME

Win32::TSA::Notify::PerlExe::ActiveState::PerlTray - Perltray emulation of "Tray" functions for Win32 TSA Notification System

SYNOPSIS

  use Win32::TSA::Notify::PerlExe::PerlTray;
  
  $icon = Win32::TSA::Notify::PerlExe::PerlTray->new();

  $icon->SetIcon( 'app' );
  $icon->SetIcon( 'app', 1000 );
  $icon->SetIcon( [ 'blue', 'red', 'green', 'yellow' ] , 250 );
  
  $icon->SetAnimation( 5000, 250, 'blue', 'red', 'green', 'yellow' );
  $icon->SetAnimation( 5000, 250, [ 'blue', 'red', 'green', 'yellow' ] );
  
  $icon->Balloon( 'Info1', 'Title1', 'warning', 3000 );
  $icon->Balloon( 'Info2', 'Title2', 'none', 5000 );

DESCRIPTION

Internal module.

May be used directly by user to access this class methods only.

METHODS

• $icon->SetIcon( ICON )

• $icon->SetIcon( ICON, FREQUENCY )

• $icon->SetIcon( [ ICONS ], FREQUENCY )

  The SetIcon( ICON ) function changes the tray icon to ICON. After FREQUENCY milliseconds SetIcon() will return.

  The SetIcon( [ ICONS ] ...) function animates the object icon by cycling through all icons in the ICONS list. The icon is changed every FREQUENCY milliseconds.

  ICON must be the name of one of the icons bundled with the application, but without the application prefix and ".ico" extension.

  Example:

      Application Name:   Win32-TSA-Notify.pl
      ICON            :   info
      Icon Name       :   Win32-TSA-Notify_Info.ico
      

• $icon->SetAnimation( DURATION, FREQUENCY, ICONS )

• $icon->SetAnimation( DURATION, FREQUENCY, [ ICONS ] )

  The SetAnimation() function animates the object icon by cycling through all icons in the ICONS list for DURATION milliseconds. The icon is changed every FREQUENCY milliseconds. After DURATION milliseconds the previous object icon is restored.

  ICON must be the name of one of the icons bundled with the application, but without the application prefix and ".ico" extension.

  Example:

      Application Name:   Win32-TSA-Notify.pl
      ICONS           :   201 .. 203
      Icon Name       :   Win32-TSA-Notify_201.ico
                          Win32-TSA-Notify_202.ico
                          Win32-TSA-Notify_203.ico

• $icon->Balloon( INFO, TITLE, ICON, TIMEOUT )

  The Balloon() function displays a balloon tooltip for TIMEOUT seconds. The balloon displays the INFO text and TITLE title. In addition, one of these icons can be specified: "info", "warning", "error", "none".

  Example:

      Application Name:   Win32-TSA-Notify.pl
      ICON            :   none
      Icon Name       :   Win32-TSA-Notify_None.ico

  Balloon() terminates any icon animation that may be in progress.

  [ ONLY STANDARD ALERT: Balloon will use the given timeout exactly]

      Windows limits the range of the timeout value to between 10 and 30
      seconds. For example, if you specify a value of '2', Windows displays
      the balloon for 10 seconds.
  
      Only one tooltip can display on the taskbar at any one time. If an
      application attempts to display a tooltip while another is already
      displayed, the tooltip will not display until the already-displayed
      tooltip has been visible for its miminum TIMEOUT value (10 seconds).
  
      For example, if a tooltip with a TIMEOUT value of 20 seconds is displayed,
      and another application attempts to display a tooltip 5 seconds later, the
      initial tooltip will continue to display for another 5 seconds before it
      is replaced by the second tooltip.

SEE ALSO

Win32::TSA::Notify

PerlTray, Perl Development Kit (PDK) http://www.activestate.com/Products/Perl_Dev_Kit/?mp=1

AUTHOR

<Thomas Walloschke (thw@cpan.org)>.

COPYRIGHT AND LICENSE

Copyright (c) 2006 Thomas Walloschke (thw@cpan.org).

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

DATE

Last changed $Date: 2006-09-01 02:05:08 +0200 (Fr, 01 Sep 2006) $.