view release on metacpan or  search on metacpan

fulldemo/help/calendar.help  view on Meta::CPAN

</R>Purpose<!R>
The Cdk calendar widget is a simple little widget which allows a user to
play with a calendar. 

</R>Construction Options<!R>
The calendar widget is defined using the following syntax. The variable
</B>$calendarObject<!B> contains the reference to the entry object.
<C></B>$calendarObject = new Cdk::Calendar ( options );
 
The options are defined in the following table.

</U>Option      Default Value       Type       Purpose<!U>
Day         The current day     Scalar     The day of the calendar.
            of the month.
Month       The current month   Scalar     The month of the calendar.
Year        The current year    Scalar     The year of the calendar.
Dattrib     Normal              Scalar     The attribute of the days.
Mattrib     Normal              Scalar     The attribute of the month name.
Yattrib     Normal              Scalar     The attribute of the year.
Highlight   Reverse             Scalar     The highlight attribute of the cursor.
Filler      .                   Scalar     The default field character.
Xpos        Center              Scalar     This is the position of the window on the X axis.
Ypos        Center              Scalar     This is the position of the window on the Y axis.
Box         True                Scalar     This Boolean states whether the dialog box will have a box drawn around it.
Shadow      False               Scalar     This Boolean states whether the dialog box will have a shadow on the box.

</R>Available Methods<!R>
</B>activate<!B>
Activation of an object means to make the object available for use. The
following example demonstrates how to activate a entry widget.
<C></B>($day, $month, $year) = $calendarObject->activate ();

The variables </B>$day<!B>, </B>$month<!B>, </B>$year<!B> is the date
of the calendar when it exited.

</B>inject<!B>
This function injects a single character into the widget. The following
examples demonstrates how to call the inject method.
<C></B>$calendarObject->inject ( options );

The options are defined in the following table.
</U>Option      Default Value       Type       Purpose<!U>
Shadow      Required             Scalar     The character to inject into the widget.

If you are injecting a special character into the widget, then you can
use a pre-defined value to represent the key.

<C><#UL><#HL(11)><#TT><#HL(14)><#UR>
<C><#VL></U>Key         <#VL>Key Value      <!U><#VL>
<C><#VL>Left Arrow  <#VL>KEY_LEFT       <#VL>
<C><#VL>Right Arrow <#VL>KEY_RIGHT      <#VL>
<C><#VL>Up Arrow    <#VL>KEY_UP         <#VL>
<C><#VL>Down Arrow  <#VL>KEY_DOWN       <#VL>
<C><#VL>Delete      <#VL>KEY_DELETE     <#VL>
<C><#VL>Backspace   <#VL>KEY_BACKSPACE  <#VL>
<C><#VL>Page Up     <#VL>KEY_PPAGE      <#VL>
<C><#VL>Page Down   <#VL>KEY_NPAGE      <#VL>
<C><#VL>Home        <#VL>KEY_HOME       <#VL>
<C><#VL>End         <#VL>KEY_END        <#VL>
<C><#VL>Escape      <#VL>KEY_ESC        <#VL>
<C><#LL><#HL(11)><#BT><#HL(14)><#LR>

</B>setDate<!B>
Sets the current date of the calendar field.
<C></B>$calendarObject->setDate ( options );

The options are defined in the following table.

</U>Option      Default Value       Type       Purpose<!U>
Day         Required            Scalar     The day of the calendar.
Month       Required            Scalar     The month of the calendar.
Year        Required            Scalar     The year of the calendar.

</B>bind<!B>
The bind method binds keys to events. The binding is specific to the individual
objects. The following example demonstrates how to call the bind method.
<C></B>$calendarObject->bind ( options );

The options are defined in the following table.