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
|
<!DOCTYPE html>
<html>
<head>
<title>Multi-Entry Widgets for Date and Time</title>
<meta name="Author" content="Csaba Nemethi">
<meta name="Keywords" content="mentry, widget, date, time, clock">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
</head>
<body>
<div>
<h1>Multi-Entry Widgets for Date and Time</h1>
<h2>For Mentry Version 4.3</h2>
<h3>by</h3>
<h2>Csaba Nemethi</h2>
<address>
<a href="mailto:csaba.nemethi@t-online.de">csaba.nemethi@t-online.de</a>
</address>
</div>
<hr>
<h2 id="contents">Contents</h2>
<ul>
<li><a href="#dateMentry">The <code><b>mentry::dateMentry</b></code>
Command</a></li>
<li><a href="#timeMentry">The <code><b>mentry::timeMentry</b></code>
Command</a></li>
<li><a href="#dateTimeMentry">The
<code><b>mentry::dateTimeMentry</b></code> Command</a></li>
<li><a href="#putClockVal">The <code><b>mentry::putClockVal</b></code>
Command</a></li>
<li><a href="#getClockVal">The <code><b>mentry::getClockVal</b></code>
Command</a></li>
</ul>
<div>
<p><a href="index.html">Start page</a></p>
</div>
<hr>
<h2 id="dateMentry">The <code><b>mentry::dateMentry</b></code> Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>mentry::dateMentry</code> – Create and manipulate mentry
widgets for date</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>mentry::dateMentry</b> <i>pathName format separator</i> ?<i>options</i>?
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command creates a new mentry widget <code><i>pathName</i></code>
for displaying and editing a date according to the
<code><i>format</i></code> argument, which must be a string of length 3,
consisting of the letters <code><b>"d"</b></code> for the day
(<code>01</code> - <code>31</code>), <code><b>"m"</b></code> for the month
(<code>01</code> - <code>12</code>), and <code><b>"y"</b></code> or
<code><b>"Y"</b></code> for the year without century (<code>00</code> -
<code>99</code>) or with century (e.g., <code>2008</code>), in an arbitrary
order. These field descriptor characters have the same meanings as in
the <code><b>clock format</b></code> command. The
<code><i>separator</i></code> argument specifies the text to be displayed
in the labels separating the three entry components of the mentry widget
(the most common values are the <code><b>"/"</b></code>,
<code><b>"-"</b></code>, and <code><b>"."</b></code> characters). The
supported <code><i>options</i></code> are the same as in the case of the
<code><b><a href="mentryWidget.html">mentry::mentry</a></b></code>
command.</dd>
<dd class="tm">The command sets the <code><b>type</b></code> attribute of
the widget to the value <code>"Date"</code>, saves the value of
<code><i>format</i></code> in its <code><b>format</b></code> attribute, and
returns the name of the newly created widget.</dd>
<dt class="tm"><b>DEFAULT BINDINGS</b></dt>
<dd>The <code><b>mentry::dateMentry</b></code> command defines four new
keyboard bindings for the entry components of the mentry widget it
creates: The <code>Up</code> key increments the entry's value by 1 if
the latter is less than the allowed maximum for that component.
Similarly, the <code>Down</code> key decrements the entry's value by 1 if
the latter is greater than the allowed minimum for that component.
The <code>Prior</code> key increments the entry's value by at most 10 if
the latter is less than the allowed maximum for that component.
Similarly, the <code>Next</code> key decrements the entry's value by at
most 10 if the latter is greater than the allowed minimum for that
component. If the entry is empty then all of these keys insert the
component-specific minimum value into the entry.</dd>
<dd class="tm">The actions performed by the <code>Up</code> and
<code>Down</code> keys can also be triggered with the aid of the mouse
wheel or a two-finger gesture on the touchpad. In addition, on Mac OS
X/11+ Aqua, the actions performed by the <code>Prior</code> and
<code>Next</code> keys are also triggered by the
<code><b><Option-MouseWheel></b></code> event. The same holds
true on all windowing systems if the Tk version is 8.7a4 or later, where
the <code><b>Option</b></code> modifier is bound to the <code>Option</code>
key on Mac OS X/11+ and to the <code>Alt</code> key on Windows and
X11.</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>mentry, widget, date</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="timeMentry">The <code><b>mentry::timeMentry</b></code> Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>mentry::timeMentry</code> – Create and manipulate mentry
widgets for time</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>mentry::timeMentry</b> <i>pathName format separator</i> ?<i>options</i>?
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command creates a new mentry widget <code><i>pathName</i></code>
for displaying and editing a time according to the
<code><i>format</i></code> argument, which must be a string of length 2 or
3, consisting of the following field descriptor characters of the
<code><b>clock format</b></code> command: <code><b>"H"</b></code> or
<code><b>"I"</b></code>, followed by <code><b>"M"</b></code>, and
optionally the letter <code><b>"S"</b></code>. An
<code><b>"H"</b></code> as first character specifies the time format
<code><b>"%H:%M"</b></code> or <code><b>"%H:%M:%S"</b></code> (i.e., with
the hour between <code>0</code> and <code>23</code>), while the letter
<code><b>"I"</b></code> stands for <code><b>"%I:%M
%p"</b></code> or <code><b>"%I:%M:%S %p"</b></code>
(i.e., with AM/PM indicator). The <code><i>separator</i></code>
argument specifies the text to be displayed in the labels separating the
entry components of the mentry widget (this is usually the
<code><b>":"</b></code> character). The <code><i>options</i></code>
are the same as in the case of the <code><b><a href=
"mentryWidget.html">mentry::mentry</a></b></code> command.</dd>
<dd class="tm">The command sets the <code><b>type</b></code> attribute of
the widget to the value <code>"Time"</code>, saves the value of
<code><i>format</i></code> in its <code><b>format</b></code> attribute, and
returns the name of the newly created widget.</dd>
<dt class="tm"><b>DEFAULT BINDINGS</b></dt>
<dd>The <code><b>mentry::timeMentry</b></code> command defines four new
keyboard bindings for the entry components of the mentry widget it
creates: The <code>Up</code> key increments the entry's value by 1 if
the latter is less than the allowed maximum for that component.
Similarly, the <code>Down</code> key decrements the entry's value by 1 if
the latter is greater than the allowed minimum for that component.
The <code>Prior</code> key increments the entry's value by at most 10 if
the latter is less than the allowed maximum for that component.
Similarly, the <code>Next</code> key decrements the entry's value by at
most 10 if the latter is greater than the allowed minimum for that
component. If the entry is empty then all of these keys insert the
component-specific minimum value into the entry.</dd>
<dd class="tm">The actions performed by the <code>Up</code> and
<code>Down</code> keys can also be triggered with the aid of the mouse
wheel or a two-finger gesture on the touchpad. In addition, on Mac OS
X/11+ Aqua, the actions performed by the <code>Prior</code> and
<code>Next</code> keys are also triggered by the
<code><b><Option-MouseWheel></b></code> event. The same holds
true on all windowing systems if the Tk version is 8.7a4 or later, where
the <code><b>Option</b></code> modifier is bound to the <code>Option</code>
key on Mac OS X/11+ and to the <code>Alt</code> key on Windows and
X11.</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>mentry, widget, time</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="dateTimeMentry">The <code><b>mentry::dateTimeMentry</b></code>
Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>mentry::dateTimeMentry</code> – Create and manipulate
mentry widgets for date & time</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>mentry::dateTimeMentry</b> <i>pathName format dateSeparator timeSeparator</i> ?<i>options</i>?
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command creates a new mentry widget <code><i>pathName</i></code>
for displaying and editing a date & time according to the
<code><i>format</i></code> argument, which must be a string of length 5 or
6, with the first 3 characters consisting of the letters
<code><b>"d"</b></code> for the day (<code>01</code> - <code>31</code>),
<code><b>"m"</b></code> for the month (<code>01</code> - <code>12</code>),
and <code><b>"y"</b></code> or <code><b>"Y"</b></code> for the year without
century (<code>00</code> - <code>99</code>) or with century (e.g.,
<code>2008</code>), in an arbitrary order, followed by 2 or 3 further field
descriptor characters of the <code><b>clock format</b></code>
command, which must be: <code><b>"H"</b></code> or <code><b>"I"</b></code>,
then <code><b>"M"</b></code>, and optionally the letter
<code><b>"S"</b></code>. An <code><b>"H"</b></code> specifies the
time format <code><b>"%H:%M"</b></code> or <code><b>"%H:%M:%S"</b></code>
(i.e., with the hour between <code>0</code> and <code>23</code>), while the
letter <code><b>"I"</b></code> stands for <code><b>"%I:%M
%p"</b></code> or <code><b>"%I:%M:%S %p"</b></code>
(i.e., with AM/PM indicator). The <code><i>dateSeparator</i></code>
argument specifies the text to be displayed in the labels separating the
entry components in the date part of the mentry widget (the most common
values are the <code><b>"/"</b></code>, <code><b>"-"</b></code>, and
<code><b>"."</b></code> characters). Similarly, the
<code><i>timeSeparator</i></code> argument stands for the text to be
displayed in the labels separating the entry components in the time part of
mentry widget (this is usually the <code><b>":"</b></code>
character). The date and time parts in turn are separated from each
other by a space character. The supported <code><i>options</i></code>
are the same as in the case of the <code><b><a href=
"mentryWidget.html">mentry::mentry</a></b></code> command.</dd>
<dd class="tm">The command sets the <code><b>type</b></code> attribute of
the widget to the value <code>"DateTime"</code>, saves the value of
<code><i>format</i></code> in its <code><b>format</b></code> attribute, and
returns the name of the newly created widget.</dd>
<dt class="tm"><b>DEFAULT BINDINGS</b></dt>
<dd>The <code><b>mentry::dateTimeMentry</b></code> command defines four new
keyboard bindings for the entry components of the mentry widget it
creates: The <code>Up</code> key increments the entry's value by 1 if
the latter is less than the allowed maximum for that component.
Similarly, the <code>Down</code> key decrements the entry's value by 1 if
the latter is greater than the allowed minimum for that component.
The <code>Prior</code> key increments the entry's value by at most 10 if
the latter is less than the allowed maximum for that component.
Similarly, the <code>Next</code> key decrements the entry's value by at
most 10 if the latter is greater than the allowed minimum for that
component. If the entry is empty then all of these keys insert the
component-specific minimum value into the entry.</dd>
<dd class="tm">The actions performed by the <code>Up</code> and
<code>Down</code> keys can also be triggered with the aid of the mouse
wheel or a two-finger gesture on the touchpad. In addition, on Mac OS
X/11+ Aqua, the actions performed by the <code>Prior</code> and
<code>Next</code> keys are also triggered by the
<code><b><Option-MouseWheel></b></code> event. The same holds
true on all windowing systems if the Tk version is 8.7a4 or later, where
the <code><b>Option</b></code> modifier is bound to the <code>Option</code>
key on Mac OS X/11+ and to the <code>Alt</code> key on Windows and
X11.</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>mentry, widget, date, time</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="putClockVal">The <code><b>mentry::putClockVal</b></code> Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>mentry::putClockVal</code> – Output a clock value to a
date, time, or date & time mentry</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>mentry::putClockVal</b> <i>clockValue</i> <i>pathName</i> ?<b>-gmt</b> <i>boolean</i>?
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command outputs the date, time, or date & time corresponding to
the integer <code><i>clockValue</i></code> to the mentry widget
<code><i>pathName</i></code>, which must have been created with the
<code><b><a href="#dateMentry">mentry::dateMentry</a></b></code>,
<code><b><a href="#timeMentry">mentry::timeMentry</a></b></code>, or
<code><b><a href="#dateTimeMentry">mentry::dateTimeMentry</a></b></code>
command (this is checked by examining the widget's <code><b>type</b></code>
attribute, which must have the value <code>"Date"</code>,
<code>"Time"</code>, or <code>"DateTime"</code>).</dd>
<dd class="tm">Like in the case of the <code><b>clock
format</b></code> command, the optional argument pair
<code><b>-gmt</b> <i>boolean</i></code> specifies whether the clock value
is to be formatted as Greenwich Mean Time or according to the local
timezone as defined by the operating environment.</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>mentry, widget, date, time, clock</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="getClockVal">The <code><b>mentry::getClockVal</b></code> Command</h2>
<dl>
<dt><b>NAME</b></dt>
<dd><code>mentry::getClockVal</code> – Get the clock value from a
date, time, or date & time mentry</dd>
<dt class="tm"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>mentry::getClockVal</b> <i>pathName</i> ?<b>-base</b> <i>clockValue</i>? ?<b>-gmt</b> <i>boolean</i>?
</pre>
</dd>
<dt><b>DESCRIPTION</b></dt>
<dd>This command returns the clock value corresponding to the date, time,
or date & time contained in the mentry widget <code><i>pathName</i></code>,
which must have been created with the <code><b><a href=
"#dateMentry">mentry::dateMentry</a></b></code>, <code><b><a href=
"#timeMentry">mentry::timeMentry</a></b></code>, or <code><b><a href=
"#dateTimeMentry">mentry::dateTimeMentry</a></b></code> command (this is
checked by examining the widget's <code><b>type</b></code> attribute, which
must have the value <code>"Date"</code>, <code>"Time"</code>, or
<code>"DateTime"</code>).</dd>
<dd class="tm">Like in the case of the <code><b>clock
scan</b></code> command, the optional argument pair
<code><b>-base</b> <i>clockValue</i></code> specifies that the date
contained in <code><i>clockValue</i></code> is to be used when getting the
clock value from the given mentry widget, and the optional argument
pair <code><b>-gmt</b> <i>boolean</i></code> specifies whether the
clock value is to be calculated relative to Greenwich Mean Time or
according to the local timezone as defined by the operating
environment.</dd>
<dd class="tm">If an error occurs during the conversion, the command sets
the focus to the first erronous entry component, generates an error, and
returns one of the values contained in the following table:</dd>
<dd class="tm">
<table border="2" cellspacing="0" cellpadding="3">
<tr bgcolor="#FFFFE0">
<th align="left" nowrap>Return Value</th>
<th align="left">Meaning</th>
</tr>
<tr>
<td><code>"EMPTY"</code></td>
<td>Any entry component (except the one containing the seconds) is
empty.</td>
</tr>
<tr>
<td><code>"BAD"</code></td>
<td>The value of the day, month, or hour (the latter only if the
AM/PM indicator is present) is <code>0</code>.</td>
</tr>
<tr>
<td><code>"BAD_DATE"</code></td>
<td>The <year, month, day> triple is invalid (note that the
command is aware of leap years).</td>
</tr>
<tr>
<td><code>"BAD_YEAR"</code></td>
<td>The above triple is valid, but the conversion (made with the aid
of the <code><b>clock scan</b></code> command) failed
because of an unsupported year value (e.g., between <code>38</code>
and <code>70</code>).</td>
</tr>
</table>
</dd>
<dt class="tm"><b>KEYWORDS</b></dt>
<dd>mentry, widget, date, time, clock</dd>
</dl>
<div>
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
</body>
</html>
|