1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
|
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>
<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>
calendar - Create and manipulate a monthly calendar
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>calendar</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Widget <- calendar
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<B>background</B> <B>cursor</B> <B>foreground</B>
<P>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>backwardImage</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Image</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-backwardimage</B>
<P>
</DD>
</DL>
Specifies a image to be displayed on the backwards
calendar button. This image must have been created
previously with the <B>image</B> <B>create</B> command. If none is
specified, a default is provided.
<P>
<DL>
<DT>Name: <DD> <B>buttonForeground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Foreground</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-buttonforeground</B>
<P>
</DD>
</DL>
Specifies the foreground color of the forward and backward
buttons in any of the forms acceptable to
<B>Tk_GetColor</B>. The default color is blue.
<P>
<DL>
<DT>Name: <DD> <B>command</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-command</B>
<P>
</DD>
</DL>
Specifies a Tcl script to executed upon selection of a
date in the calendar. If the command script contains
any <B>%</B> characters, then the script will not be executed
directly. Instead, a new script will be generated by
replacing each <B>%</B>, and the character following it, with
information from the calendar. The replacement depends
on the character following the <B>%</B>, as defined in the
list below.
<P>
<B>%d</B> Replaced with the date selected in the format
mm/dd/yyyy.
<P>
<DL>
<DT>Name: <DD> <B>currentDateFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-currentdatefont</B>
<P>
</DD>
</DL>
Specifies the font used for the current date text in
any of the forms acceptable to <B>Tk_GetFont</B>.
<P>
<DL>
<DT>Name: <DD> <B>dateFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-datefont</B>
<P>
</DD>
</DL>
Specifies the font used for the days of the month text
in any of the forms acceptable to <B>Tk_GetFont</B>.
<P>
<DL>
<DT>Name: <DD> <B>dayFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-dayfont</B>
<P>
</DD>
</DL>
Specifies the font used for the days of the week text
in any of the forms acceptable to <B>Tk_GetFont</B>.
<P>
<DL>
<DT>Name: <DD> <B>days</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>days</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-days</B>
<P>
</DD>
</DL>
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}.
<P>
<DL>
<DT>Name: <DD> <B>forewardImage</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Image</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-forewardimage</B>
<P>
</DD>
</DL>
Specifies a image to be displayed on the forewards
calendar button. This image must have been created
previously with the <B>image</B> <B>create</B> command. If none is
specified, a default is provided.
<P>
<DL>
<DT>Name: <DD> <B>height</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Height</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-height</B>
<P>
</DD>
</DL>
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 <B>Tk_GetPixels</B>. The default height is 165 pixels.
<P>
<DL>
<DT>Name: <DD> <B>outline</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Outline</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-outline</B>
<P>
</DD>
</DL>
Specifies the outline color used to surround the days
of the month text in any of the forms acceptable to
<B>Tk_GetColor</B>. The default is the same color as the
background.
<P>
<DL>
<DT>Name: <DD> <B>selectColor</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Foreground</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-selectcolor</B>
<P>
</DD>
</DL>
Specifies the color of the ring displayed that distinguishes
the currently selected date in any of the forms
acceptable to <B>Tk_GetColor</B>. The default is red.
<P>
<DL>
<DT>Name: <DD> <B>selectThickness</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>SelectThickness</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-selectthickness</B>
<P>
</DD>
</DL>
Specifies the thickness of the ring displayed that distinguishes
the currently selected date. The default is
3 pixels.
<P>
<DL>
<DT>Name: <DD> <B>startday</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Day</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-startday</B>
<P>
</DD>
</DL>
Specifies the starting day for the week: <B>sunday</B>, <B>monday</B>,
<B>tuesday</B>, <B>wednesday</B>, <B>thursday</B>, <B>friday</B>, or <B>saturday</B>.
The default is sunday.
<P>
<DL>
<DT>Name: <DD> <B>titleFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-titlefont</B>
<P>
</DD>
</DL>
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 <B>Tk_GetFont</B>.
<P>
<DL>
<DT>Name: <DD> <B>weekdayBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-weekdaybackground</B>
<P>
</DD>
</DL>
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 <B>Tk_GetColor</B>. The default is the same as
the background.
<P>
<DL>
<DT>Name: <DD> <B>weekendBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-weekendbackground</B>
<P>
</DD>
</DL>
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 <B>Tk_GetColor</B>. The default is the same as
the background.
<P>
<DL>
<DT>Name: <DD> <B>width</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Width</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-width</B>
<P>
</DD>
</DL>
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 <B>Tk_GetPixels</B>. The default width is 200 pixels.
<P>
_________________________________________________________________
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>DESCRIPTION</B></A></H2>
The <B>calendar</B> command creates a calendar widget for the
selection 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 monitored via
the -command option or just retrieved using the get command.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>METHODS</B></A></H2>
The <B>calendar</B> command creates a new Tcl command whose name is
<I>pathName</I>. This command may be used to invoke various operations
on the widget. It has the following general form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for calendar
widgets:
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>cget</B> <I>option</I><BR>
Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>calendar</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, 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
<I>option</I> is specified). If one or more <I>option</I> - <I>value</I>
pairs are specified, then the command modifies the
<DL>
<DT>given widget option(s) to have the given value(s); <DD>in
this case the command returns an empty string. <I>Option</I>
may have any of the values accepted by the <B>calendar</B>
command.
<P>
</DD>
</DL>
<I>pathName</I> <B>get</B> ?<B>format</B>?<BR>
Returns the currently selected date in a format of
string or as an integer clock value using the <B>-string</B>
and <B>-clicks</B> format options respectively. The default
is by string. Reference the clock command for more
information on obtaining dates and their formats.
<P>
<I>pathName</I> <B>select</B> <I>date</I><BR>
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 <B>showR</B> <B>command.</B>
<P>
<I>pathName</I> <B>show</B> <I>date</I><BR>
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 command for more information on
obtaining dates and their formats.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>forward</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Button</B>
<P>
</DD>
</DL>
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 component item.
<P>
<DL>
<DT>Name: <DD> <B>page</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Canvas</B>
<P>
</DD>
</DL>
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.
<P>
<DL>
<DT>Name: <DD> <B>backward</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Button</B>
<P>
</DD>
</DL>
The backward 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 backward component item.
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>EXAMPLE</B></A></H2>
proc selectCmd {date} {<BR>
puts $date<BR>
}
<P>
calendar .c -command {selectCmd %d} -weekendbackground mistyrose \
-weekdaybackground ghostwhite -outline black \
-startday wednesday -days {We Th Fr Sa Su Mo Tu}
pack .c
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>AUTHOR</B></A></H2>
Mark L. Ulferts
<P>
Michael J. McLennan
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>KEYWORDS</B></A></H2>
calendar, widget
<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">DESCRIPTION</A></LI>
<LI><A NAME="toc7" HREF="#sect7">METHODS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">COMPONENTS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">EXAMPLE</A></LI>
<LI><A NAME="toc11" HREF="#sect11">AUTHOR</A></LI>
<LI><A NAME="toc12" HREF="#sect12">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|