NAME

Tk::Month - Calendar widget which shows one month at a time.

SYNOPSIS

  use Tk;
  use Tk::Month;

  $table = $parent->Tk::Month(
                -month          => 'July',
                -year           => '1997',
                -title          => '%b %y',
                -command        => \&press,
                -printformat    => '%e',
                -printcommand   => \&printMonth,
                -navigation     => [0|1],
                -close          => $widget,
                -includeall     => [0|1],
                -showall        => [0|1],
                -first          => [0|1|2|3|4|5|6],
        )->pack();

  $table->configure(
                -month          => 'July',
                -year           => '1997',
                -command        => \&press,
                -printcommand   => \&printMonth,
                -printformat    => '%e %B %Y %A',
                -navigation     => [0|1],
                -close          => $widget,
                -includeall     => [0|1],
                -showall        => [0|1],
                -first          => [0|1|2|3|4|5|6],
  );

DESCRIPTION

Tk::Month is a general purpose calendar widget which shows one month at a time and allowes user defined button actions.

OPTIONS

-month => 'month'

        Sets the required month. The default is the current month.

-year => 'year'

        Sets the required year. The default is the current year.

-title => 'strftime format'

        Sets the format for the widget title.
        The default is '%B %Y'.

-command => \&press

        Set the command to execute when a button is pressed.
        This function must accept a string
        (the title of the Month widget)
        and an array of arrays of dates.
        Each date is of the format specified by the -printformat option.
        The default is to print out the list on standard output.

-printformat => "strftime format"

        Set the default format for dates when they are passed in an
        array of arrays to the -command function.
        The default is '%e %B %Y'.

-printcommand => \&print

        Set the command to execute when the print menu option is selected.
        This function must accept the following arguments:
                <month>, <year>, <first-day-of-week>
        The default is to print out the list on standard output.

-close => $widget,

        When the close option is selected from the pull down
        menu close this widget. The default is to close the Tk::Month
        widget. Useful when you have a popup window containing
        only the Tk::Month widget.

-showall => [0|1]

        Causes the dates on buttons not actually in the month to be
        dsiplay. The default is to not show these dates.

-includeall => [0|1]

        Causes the side buttons to include all the non-month dates.
        The defaults is to include all the dates.

-first => [0|1|2|3|4|5|6]

        Sets the first day of the week.
        The default is 0 (i.e. Sunday).

-navigation => [0|1],

        Sets whether the navigation buttons and menu are included.
        The default is to show the naviagation aids.