Manual Pages for UNIX Darwin command on man iwidgets

Manual Pages for UNIX Darwin command on man iwidgets_calendar

iwidgets::calendar(1) [incr Widgets] iwidgets::calendar(1)

NAME

iwidgets::calendar - Create and manipulate a monthly calendar

SYNOPSIS

iiwwiiddggeettss::::ccaalleennddaarr pathName ?options? IINNHHEERRIITTAANNCCEE

itk::Widget <- iwidgets::calendar

SSTTAANNDDAARRDD OOPPTTIIOONNSS bbaacckkggrroouunndd ccuurrssoorr ffoorreeggrroouunndd See the "options" manual entry for details on the standard options. AASSSSOOCCIIAATTEEDD OOPPTTIIOONNSS iinntt See the "datefield" manual entry for details on this option. Note that this option is needed when the calendar is used in conjunction with the dateentry widget. It is necessary for support of international date formats in versions of Tk < 8.4.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS

Name: bbaacckkwwaarrddIImmaaggee Class: IImmaaggee

Command-Line Switch: -bbaacckkwwaarrddiimmaaggee

Specifies a image to be displayed on the backwards calendar but-

ton. This image must have been created previously with the

iimmaaggee ccrreeaattee command. If none is specified, a default is pro-

vided. Name: bbuuttttoonnFFoorreeggrroouunndd Class: FFoorreeggrroouunndd

Command-Line Switch: -bbuuttttoonnffoorreeggrroouunndd

Specifies the foreground color of the forward and backward but-

tons in any of the forms acceptable to TTkkGGeettCCoolloorr. The default color is blue. Name: ccoommmmaanndd Class: CCoommmmaanndd

Command-Line Switch: -ccoommmmaanndd

Specifies a Tcl script to executed upon selection of a date in

the calendar. If the command script contains any %% characters,

then the script will not be executed directly. Instead, a new

script will be generated by replacing each %%, and the character

following it, with information from the calendar. The replace-

ment depends on the character following the %%, as defined in the

list below.

%%dd Replaced with the date selected in the format mm/dd/yyyy.

Name: ccuurrrreennttDDaatteeFFoonntt Class: FFoonntt

Command-Line Switch: -ccuurrrreennttddaatteeffoonntt

Specifies the font used for the current date text in any of the forms acceptable to TTkkGGeettFFoonntt. Name: ddaatteeFFoonntt Class: FFoonntt

Command-Line Switch: -ddaatteeffoonntt

Specifies the font used for the days of the month text in any of the forms acceptable to TTkkGGeettFFoonntt. Name: ddaayyFFoonntt Class: FFoonntt

Command-Line Switch: -ddaayyffoonntt

Specifies the font used for the days of the week text in any of the forms acceptable to TTkkGGeettFFoonntt. Name: ddaayyss Class: ddaayyss

Command-Line Switch: -ddaayyss

Specifies a list of values to be used for the days of the week text to displayed above the days of the month. The default value is {Su Mo Tu We Th Fr Sa}. Name: ffoorreewwaarrddIImmaaggee Class: IImmaaggee

Command-Line Switch: -ffoorreewwaarrddiimmaaggee

Specifies a image to be displayed on the forewards calendar but-

ton. This image must have been created previously with the

iimmaaggee ccrreeaattee command. If none is specified, a default is pro-

vided. Name: hheeiigghhtt Class: HHeeiigghhtt

Command-Line Switch: -hheeiigghhtt

Specifies a desired window height that the calendar widget should request from its geometry manager. The value may be specified in any of the forms acceptable to TTkkGGeettPPiixxeellss. The default height is 165 pixels. Name: oouuttlliinnee Class: OOuuttlliinnee

Command-Line Switch: -oouuttlliinnee

Specifies the outline color used to surround the days of the month text in any of the forms acceptable to TTkkGGeettCCoolloorr. The default is the same color as the background. Name: sseelleeccttCCoolloorr Class: FFoorreeggrroouunndd

Command-Line Switch: -sseelleeccttccoolloorr

Specifies the color of the ring displayed that distinguishes the currently selected date in any of the forms acceptable to TTkkGGeettCCoolloorr. The default is red. Name: sseelleeccttTThhiicckknneessss Class: SSeelleeccttTThhiicckknneessss

Command-Line Switch: -sseelleecctttthhiicckknneessss

Specifies the thickness of the ring displayed that distinguishes the currently selected date. The default is 3 pixels. Name: ssttaarrttddaayy Class: DDaayy

Command-Line Switch: -ssttaarrttddaayy

Specifies the starting day for the week: ssuunnddaayy, mmoonnddaayy, ttuueess-

ddaayy, wweeddnneessddaayy, tthhuurrssddaayy, ffrriiddaayy, or ssaattuurrddaayy. The default is sunday. Name: ttiittlleeFFoonntt Class: FFoonntt

Command-Line Switch: -ttiittlleeffoonntt

Specifies the font used for the title text which consists of the month and year. The font may be given in any of the forms acceptable to TTkkGGeettFFoonntt. Name: wweeeekkddaayyBBaacckkggrroouunndd Class: BBaacckkggrroouunndd

Command-Line Switch: -wweeeekkddaayybbaacckkggrroouunndd

Specifies the background color for the weekdays which allows it to be visually distinguished from the weekend. The color may be given in any of the forms acceptable to TTkkGGeettCCoolloorr. The default is the same as the background. Name: wweeeekkeennddBBaacckkggrroouunndd Class: BBaacckkggrroouunndd

Command-Line Switch: -wweeeekkeennddbbaacckkggrroouunndd

Specifies the background color for the weekends which allows it to be visually distinguished from the weekdays. The color may be given in any of the forms acceptable to TTkkGGeettCCoolloorr. The default is the same as the background. Name: wwiiddtthh Class: WWiiddtthh

Command-Line Switch: -wwiiddtthh

Specifies a desired window width that the calendar widget should request from its geometry manager. The value may be specified in any of the forms acceptable to TTkkGGeettPPiixxeellss. The default width is 200 pixels.

DESCRIPTION

The iiwwiiddggeettss::::ccaalleennddaarr command creates a calendar widget for the selec-

tion of a date, displaying a single month at a time. Buttons exist on the top to change the month in effect turning the pages of a calendar. As a page is turned, the dates for the month are modified. Selection

of a date visually marks that date. The selected value can be moni-

tored via the -command option or just retrieved using the get command.

MMEETTHHOODDSS The iiwwiiddggeettss::::ccaalleennddaarr command creates a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form: pathName option ?arg arg ...? Option and the args determine the exact behavior of the command. The following commands are possible for calendar widgets:

WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS

pathName ccggeett option Returns the current value of the configuration option given by

option. Option may have any of the values accepted by the iiwwiidd-

ggeettss::::ccaalleennddaarr command. pathName ccoonnffiigguurree ?option? ?value option value ...? Query or modify the configuration options of the widget. If no

option is specified, returns a list describing all of the avail-

able options for pathName (see TTkkCCoonnffiigguurreeIInnffoo for information on the format of this list). If option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or

more option-value pairs are specified, then the command modifies

the given widget option(s) to have the given value(s); in this case the command returns an empty string. Option may have any of the values accepted by the iiwwiiddggeettss::::ccaalleennddaarr command. pathName ggeett ?ffoorrmmaatt? Returns the currently selected date in a format of string or as

an integer clock value using the -ssttrriinngg and -cclliicckkss format

options respectively. The default is by string. Reference the clock command for more information on obtaining dates and their formats. pathName sseelleecctt date Changes the currently selected date to the value specified which must be in the form of a date string, an integer clock value or as the keyword "now". Reference the clock command for more information on obtaining dates and their formats. Note that selecting a date does not change the month being shown to that of the date given. This chore is left to the sshhooww command. pathName sshhooww date Changes the currently displayed date to be that of the date argument which must be in the form of a date string, an integer

clock value or as the keyword "now". Reference the clock com-

mand for more information on obtaining dates and their formats. CCOOMMPPOONNEENNTTSS Name: ffoorrwwaarrdd Class: BBuuttttoonn The forward component provides the button on the upper right of the calendar that changes the month to be the next. See the

"button" widget manual entry for details on the forward compo-

nent item. Name: ppaaggee Class: CCaannvvaass The page component provides the canvas on which the title, days of the week, and days of the month appear. See the "canvas" widget manual entry for details on the page component item. Name: bbaacckkwwaarrdd Class: BBuuttttoonn The backward component provides the button on the upper right of the

calendar that changes the month to be the next. See the "but-

ton" widget manual entry for details on the backward component item. EEXXAAMMPPLLEE package require Iwidgets 4.0 proc selectCmd {date} {

puts $date

}

iwidgets::calendar .c -command {selectCmd %d} \

-weekendbackground mistyrose \

-weekdaybackground ghostwhite -outline black \

-startday wednesday -days {We Th Fr Sa Su Mo Tu}

pack .c AUTHOR Mark L. Ulferts Michael J. McLennan KKEEYYWWOORRDDSS calendar, widget Tk iwidgets::calendar(1)