File: datefield.n.html

package info (click to toggle)
itcl3.0 3.0.1-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 10,128 kB
  • ctags: 3,519
  • sloc: tcl: 32,416; ansic: 12,683; sh: 3,917; makefile: 692; awk: 273; perl: 265
file content (296 lines) | stat: -rw-r--r-- 8,403 bytes parent folder | download | duplicates (8)
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
<!-- 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>

datefield - Create and manipulate a date field widget
<P>

<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>

<B>datefield</B> <I>pathName</I> ?<I>options</I>?
<P>

<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>

itk::Widget &lt;- LabeledWidget &lt;- datefield
<P>

<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>

<B>background</B>      <B>borderWidth</B>    <B>cursor</B>          <B>exportSelection</B>
<DL>
<DT><B>foreground</B> <DD>     <B>highlightColor</B> <B>highlightThicknessinsertBackground</B>
</DD>
</DL>
<DL>
<DT><B>justify</B> <DD>        <B>relief</B>
<P>
</DD>
</DL>
See the &quot;options&quot; manual entry for details on the standard
options.
<P>

<H2><A NAME="sect5" HREF="#toc5"><B>INHERITED</B> <B>OPTIONS</B></A></H2>

<DL>
<DT><B>disabledForeground</B> <DD>            <B>labelBitmap</B>     <B>labelFontlabelImage</B>
<B>labelMargin</B>     <B>labelPos</B>       <B>labelText</B>       <B>labelVariable</B>
<B>state</B>
<P>
</DD>
</DL>
See the &quot;labeledwidget&quot; class manual entry for details on
the inherited options.
<P>

<H2><A NAME="sect6" HREF="#toc6"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>childSitePos</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Position</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-childsitepos</B>
<P>
</DD>
</DL>
Specifies the position of the child site in the date
field: <B>n</B>, <B>s</B>, <B>e</B>, or <B>w</B>. The default is e.
<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 command to be executed upon detection
of a Return key press event.
<P>
<DL>
<DT>Name: <DD>          <B>iq</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Iq</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-iq</B>
<P>
</DD>
</DL>
Specifies the level of intelligence to be shown in the
actions taken by the datefield during the processing of
keypress events. Valid settings include <B>high</B>, <B>average</B>,
and <B>low</B>. With a high iq,the date prevents the user from
typing in an invalid date. For example, if the current
date is 05/31/1997 and the user changes the month to
04, then the day will be instantly modified for them to
be 30. In addition, leap years are fully taken into
account. With average iq, the month is limited to the
values of 01-12, but it is possible to type in an
invalid day. A setting of low iq instructs the widget
to do no validity checking at all during date entry.
With both average and low iq levels, it is assumed that
the validity will be determined at a later time using
the date's <B>isvalid</B> command.
<P>
<DL>
<DT>Name: <DD>          <B>state</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>State</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-state</B>
<P>
</DD>
</DL>
Specifies one of two states for the datefield: <B>normal</B>
or <B>disabled</B>. If the datefield is disabled then input
is not accepted. The default is normal.
<P>
<DL>
<DT>Name: <DD>          <B>textBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-textbackground</B>
<P>
</DD>
</DL>
Background color for inside textual portion of the
entry field. The value may be given in any of the
forms acceptable to <B>Tk_GetColor</B>.
<P>
<DL>
<DT>Name: <DD>          <B>textFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-textfont</B>
<P>
</DD>
</DL>
Name of font to use for display of text in datefield.
The value may be given in any of the forms acceptable
to <B>Tk_GetFont</B>.
<P>
_________________________________________________________________
<P>

<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>

The <B>datefield</B> command creates an enhanced text entry widget
for the purpose of date entry with various degrees of
built-in intelligence.
<P>

<H2><A NAME="sect8" HREF="#toc8"><B>METHODS</B></A></H2>

The <B>datefield</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 datefield
widgets:
<P>

<H2><A NAME="sect9" HREF="#toc9"><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>datefield</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 given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>datefield</B> command.
<P>
<I>pathName</I> <B>get</B> ?<B>format</B>?<BR>

Returns the current contents of the datefield 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>isvalid</B><BR>

Returns a boolean indication of the validity of the
currently displayed date value.    For example,
03/03/1960 is valid whereas 02/29/1997 is invalid.
<P>
<I>pathName</I> <B>show</B> <I>date</I><BR>

Changes the currently displayed date to be that of the
date argument. The date may be specified either as a
string, an integer clock value or the keyword &quot;now".
Reference the clock command for more information on
obtaining dates and their formats.
<P>

<H2><A NAME="sect10" HREF="#toc10"><B>COMPONENTS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>date</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Entry</B>
<P>
</DD>
</DL>
The date component provides the entry field for date
input and display. See the &quot;entry&quot; widget manual entry
for details on the date component item.
<P>

<H2><A NAME="sect11" HREF="#toc11"><B>EXAMPLE</B></A></H2>

proc returnCmd {} {<BR>

puts [.df get]<BR>

}
<P>
datefield .df -command returnCmd<BR>

pack .df -fill x -expand yes -padx 10 -pady 10
<P>

<H2><A NAME="sect12" HREF="#toc12"><B>AUTHOR</B></A></H2>

Mark L. Ulferts
<P>

<H2><A NAME="sect13" HREF="#toc13"><B>KEYWORDS</B></A></H2>

datefield, 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">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">DESCRIPTION</A></LI>
<LI><A NAME="toc8" HREF="#sect8">METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">COMPONENTS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">EXAMPLE</A></LI>
<LI><A NAME="toc12" HREF="#sect12">AUTHOR</A></LI>
<LI><A NAME="toc13" HREF="#sect13">KEYWORDS</A></LI>
</UL>
</BODY></HTML>