Tk::TOTD - Tip Of The Day dialog for Perl/Tk.


Tk-TOTD documentation  | view source Contained in the Tk-TOTD distribution.

Index


NAME

Top

Tk::TOTD - Tip Of The Day dialog for Perl/Tk.

SYNOPSIS

Top

  use Tk::TOTD;

  my $top = MainWindow->new();

  my $totd = $top->TOTD (
    -title    => 'Tip Of The Day -- MyPerlApp',
    -messages => \@messages,
  );

  $totd->Show;

DESCRIPTION

Top

Tk::TOTD provides a simple Tip of the Day dialog for Perl/Tk programs.

OPTIONS

Top

The options recognized by Show are as follows:

-title

Specify the title of the Tip Of The Day dialog. Defaults to "Tip Of The Day"

-messages

The array of tip messages. If omitted, a default 10 tips about this module will be used instead.

-slogan

Set the slogan at the top of the dialog. Default is "Did you know that..."

-image

A Tk::Photo object. If omitted, the default totd image is used. This default image is appropriate for most TOTD usages, but if you use this as something other than a Tip Of The Day you may want to use your own image. The default image's dimensions are 23x31.

-background

The main window's background color. Defaults to #BFBFBF

-leftbackground

Background color for the left panel (where the image and slide number is). Defaults to #808080

-mainbackground

The background color of the main content area. Defaults to #FFFFFF (white).

-slidecolor

The text color of the slide number (as on the left panel). Defaults to #FFFF99.

-foreground

Main foreground color of text. Defaults to #000000 (black).

-mainfont

The main font family used on most of the labels. Defaults to Arial.

-mainfontsize

Font size of the main font. Defaults to 10.

-titlefont

The font family used on the slogan text. Defaults to Times New Roman.

-titlefontsize

Font size on the slogan text. Defaults to 14.

-checklabel

The label on the checkbutton. Defaults to "Show tips at startup"

-checkvariable

The variable to store the state of the checkbutton. 1 for checked, 0 for not.

-closebutton

The text of the close button. Defaults to "Close"

-nextbutton

The text of the next button. Defaults to "Next Tip"

METHODS

Top

Show (? options ?)

Displays the Tip Of The Day dialog. The TOTD dialog is based from Tk::DialogBox and therefore will pause your main window.

configure (? options ?)

Reconfigure previously set options.

CHANGES

Top

  Version 0.2
  - The widget now behaves as a DialogBox as it should, blocking the main window
    until closed.

BUGS

Top

None known yet.

AUTHOR

Top

Cerone Kirsle kirsle "@" aichaos.com

This code is distributed under the same terms as Perl.


Tk-TOTD documentation  | view source Contained in the Tk-TOTD distribution.