Jeffrey Ray Hallock > GappX-NoticeBox-0.200 > GappX::NoticeBox

Download:
GappX-NoticeBox-0.200.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.200   Source  

NAME ^

GappX::NoticeBox - NoticeBox widget

SYNOPSIS ^

  use Gapp;

  use Gapp::NoticeBox;

  $box = Gapp::NoticeBox->new;

  $n = Gapp::Notice->new(

    icon => 'gtk-info',

    text => 'Display notice to user.',

    action => sub { print "Notice clicked\n" },

  );

DECRIPTION ^

Displays a message to the user in the notification area of the desktop.

OBJECT HIERARCHY ^

Gapp::Object
+-- Gapp::Widget
....+-- Gapp::NoticeBox

PROVIDED ATTRIBUTES ^

display_duration

Length of time in milliseconds to display the notice on the screen.

is rw
isa Num
default 3000
fade_duration

Length of time in milliseconds it takes for the notice to fade in/fade out.

is rw
isa Num
default 700
fade_step

The amount to change the up or down when fading in or out. The smaller the number, the more steps required to complete the fade.

is rw
isa Num
default .07

PROVIDED METHODS ^

display $notice, $duration?

Display GappX::Notice to the user in the notification area. If no $duration is specified, the display_duration value will be used.

hide

Remove the notice box from the users screen.

start_hide_timer $duration

Sets a timer to remove the notices from the user's screen after a specified duration.

SEE ALSO ^

Gapp
GappX::Notice

AUTHORS ^

Jeffrey Ray Hallock <jeffrey.hallock at gmail dot com>

COPYRIGHT & LICENSE ^

Copyright (c) 2010-2012 Jeffrey Ray Hallock.

    This is free software, licensed under:

    The Artistic License 2.0 (GPL Compatible)
syntax highlighting: