1 |
578 |
markom |
<HTML>
|
2 |
|
|
<HEAD>
|
3 |
|
|
<TITLE>iwidgets2.2.0 User Commands - spintime</TITLE>
|
4 |
|
|
</HEAD>
|
5 |
|
|
<BODY BGCOLOR="#FFFFFF">
|
6 |
|
|
<H1>iwidgets2.2.0 User Commands - spintime</H1>
|
7 |
|
|
<HR>
|
8 |
|
|
<PRE>
|
9 |
|
|
|
10 |
|
|
</PRE>
|
11 |
|
|
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
|
12 |
|
|
|
13 |
|
|
|
14 |
|
|
</PRE>
|
15 |
|
|
<H2>NAME</H2><PRE>
|
16 |
|
|
spintime - Create and manipulate time spinner widgets
|
17 |
|
|
|
18 |
|
|
|
19 |
|
|
</PRE>
|
20 |
|
|
<H2>SYNOPSIS</H2><PRE>
|
21 |
|
|
<STRONG>spintime</STRONG> <EM>pathName</EM> ?<EM>options</EM>?
|
22 |
|
|
|
23 |
|
|
|
24 |
|
|
</PRE>
|
25 |
|
|
<H2>INHERITANCE</H2><PRE>
|
26 |
|
|
itk::Widget <- Spintime
|
27 |
|
|
|
28 |
|
|
|
29 |
|
|
|
30 |
|
|
</PRE>
|
31 |
|
|
<H2>STANDARD OPTIONS</H2><PRE>
|
32 |
|
|
<STRONG>background</STRONG> <STRONG>cursor</STRONG> <STRONG>foreground</STRONG> <STRONG>highlightColor</STRONG>
|
33 |
|
|
<STRONG>highlightThickness</STRONG> <STRONG>relief</STRONG> <STRONG>selectBackgroundselectBorderWidth</STRONG>
|
34 |
|
|
<STRONG>selectForeground</STRONG>
|
35 |
|
|
|
36 |
|
|
See the "options" manual entry for details on the standard
|
37 |
|
|
options.
|
38 |
|
|
|
39 |
|
|
|
40 |
|
|
</PRE>
|
41 |
|
|
<H2>ASSOCIATED OPTIONS</H2><PRE>
|
42 |
|
|
<STRONG>textBackground</STRONG> <STRONG>textFont</STRONG>
|
43 |
|
|
|
44 |
|
|
See the "entryfield" manual entry for details on the above
|
45 |
|
|
associated options.
|
46 |
|
|
|
47 |
|
|
<STRONG>labelFont</STRONG> <STRONG>labelMargin</STRONG>
|
48 |
|
|
|
49 |
|
|
See the "labeledwidget" manual entry for details on the
|
50 |
|
|
above associated options.
|
51 |
|
|
|
52 |
|
|
<STRONG>step</STRONG>
|
53 |
|
|
|
54 |
|
|
See the "spinint" manual entry for details on the above
|
55 |
|
|
associated options.
|
56 |
|
|
|
57 |
|
|
<STRONG>arrowOrient</STRONG> <STRONG>repeatDelay</STRONG> <STRONG>repeatInterval</STRONG>
|
58 |
|
|
|
59 |
|
|
See the "spinner" manual entry for details on the above
|
60 |
|
|
associated options.
|
61 |
|
|
|
62 |
|
|
|
63 |
|
|
|
64 |
|
|
</PRE>
|
65 |
|
|
<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>
|
66 |
|
|
Name: <STRONG>labelPos</STRONG>
|
67 |
|
|
Class: <STRONG>Position</STRONG>
|
68 |
|
|
Command-Line Switch: <STRONG>-labelpos</STRONG>
|
69 |
|
|
|
70 |
|
|
Specifies the position of the label along the sides of
|
71 |
|
|
the various spinners: <STRONG>n</STRONG>, <STRONG>e</STRONG>, <STRONG>s</STRONG>, or <STRONG>w</STRONG>. The default is w.
|
72 |
|
|
|
73 |
|
|
Name: <STRONG>hourLabel</STRONG>
|
74 |
|
|
Class: <STRONG>Text</STRONG>
|
75 |
|
|
Command-Line Switch: <STRONG>-hourlabel</STRONG>
|
76 |
|
|
|
77 |
|
|
Specifies the text of the label for the hour spinner.
|
78 |
|
|
The default is "Hour".
|
79 |
|
|
|
80 |
|
|
Name: <STRONG>hourOn</STRONG>
|
81 |
|
|
Class: <STRONG>hourOn</STRONG>
|
82 |
|
|
Command-Line Switch: <STRONG>-houron</STRONG>
|
83 |
|
|
|
84 |
|
|
Specifies whether or not to display the hour spinner in
|
85 |
|
|
any of the forms acceptable to <STRONG>Tcl_GetBoolean</STRONG>. The
|
86 |
|
|
default is true.
|
87 |
|
|
|
88 |
|
|
Name: <STRONG>hourWidth</STRONG>
|
89 |
|
|
Class: <STRONG>Width</STRONG>
|
90 |
|
|
Command-Line Switch: <STRONG>-hourwidth</STRONG>
|
91 |
|
|
|
92 |
|
|
Specifies the width of the hour spinner in any of the
|
93 |
|
|
forms acceptable to <STRONG>Tcl_GetPixels</STRONG>. The default is 3
|
94 |
|
|
pixels.
|
95 |
|
|
|
96 |
|
|
Name: <STRONG>militaryOn</STRONG>
|
97 |
|
|
Class: <STRONG>militaryOn</STRONG>
|
98 |
|
|
Command-Line Switch: <STRONG>-militaryon</STRONG>
|
99 |
|
|
|
100 |
|
|
Specifies use of a 24 hour clock for hour display in
|
101 |
|
|
any of the forms acceptable to <STRONG>Tcl_GetBoolean</STRONG>. The
|
102 |
|
|
default is true.
|
103 |
|
|
|
104 |
|
|
Name: <STRONG>minuteLabel</STRONG>
|
105 |
|
|
Class: <STRONG>Text</STRONG>
|
106 |
|
|
Command-Line Switch: <STRONG>-minutelabel</STRONG>
|
107 |
|
|
|
108 |
|
|
Specifies the text of the label for the minute spinner.
|
109 |
|
|
The default is "Minute".
|
110 |
|
|
|
111 |
|
|
Name: <STRONG>minuteOn</STRONG>
|
112 |
|
|
Class: <STRONG>minuteOn</STRONG>
|
113 |
|
|
Command-Line Switch: <STRONG>-minuteon</STRONG>
|
114 |
|
|
|
115 |
|
|
Specifies whether or not to display the minute spinner
|
116 |
|
|
in any of the forms acceptable to <STRONG>Tcl_GetBoolean</STRONG>. The
|
117 |
|
|
default is true.
|
118 |
|
|
|
119 |
|
|
Name: <STRONG>minuteWidth</STRONG>
|
120 |
|
|
Class: <STRONG>Width</STRONG>
|
121 |
|
|
Command-Line Switch: <STRONG>-minutewidth</STRONG>
|
122 |
|
|
|
123 |
|
|
Specifies the width of the minute spinner in any of the
|
124 |
|
|
forms acceptable to <STRONG>Tcl_GetPixels</STRONG>. The default is 3
|
125 |
|
|
pixels.
|
126 |
|
|
|
127 |
|
|
Name: <STRONG>orient</STRONG>
|
128 |
|
|
Class: <STRONG>Orient</STRONG>
|
129 |
|
|
Command-Line Switch: <STRONG>-orient</STRONG>
|
130 |
|
|
|
131 |
|
|
Specifies the orientation of the hour, minute, and
|
132 |
|
|
second spinners: <STRONG>vertical</STRONG> or <STRONG>horizontal</STRONG>. The default
|
133 |
|
|
is horizontal.
|
134 |
|
|
|
135 |
|
|
Name: <STRONG>secondLabel</STRONG>
|
136 |
|
|
Class: <STRONG>Text</STRONG>
|
137 |
|
|
Command-Line Switch: <STRONG>-secondlabel</STRONG>
|
138 |
|
|
|
139 |
|
|
Specifies the text of the label for the second spinner.
|
140 |
|
|
The default is "Second"
|
141 |
|
|
|
142 |
|
|
Name: <STRONG>secondOn</STRONG>
|
143 |
|
|
Class: <STRONG>secondOn</STRONG>
|
144 |
|
|
Command-Line Switch: <STRONG>-secondon</STRONG>
|
145 |
|
|
|
146 |
|
|
Specifies whether or not to display the second spinner
|
147 |
|
|
in any of the forms acceptable to <STRONG>Tcl_GetBoolean</STRONG>. The
|
148 |
|
|
default is true.
|
149 |
|
|
|
150 |
|
|
Name: <STRONG>secondWidth</STRONG>
|
151 |
|
|
Class: <STRONG>Width</STRONG>
|
152 |
|
|
Command-Line Switch: <STRONG>-secondwidth</STRONG>
|
153 |
|
|
|
154 |
|
|
Specifies the width of the second spinner in any of the
|
155 |
|
|
forms acceptable to <STRONG>Tcl_GetPixels</STRONG>. The default is 3
|
156 |
|
|
pixels.
|
157 |
|
|
|
158 |
|
|
Name: <STRONG>timeMargin</STRONG>
|
159 |
|
|
Class: <STRONG>Margin</STRONG>
|
160 |
|
|
Command-Line Switch: <STRONG>-timemargin</STRONG>
|
161 |
|
|
|
162 |
|
|
Specifies the margin space between the hour, minute,
|
163 |
|
|
and second spinners is any of the forms accpetable to
|
164 |
|
|
<STRONG>Tcl_GetPixels</STRONG>. The default is 1 pixel.
|
165 |
|
|
|
166 |
|
|
|
167 |
|
|
</PRE>
|
168 |
|
|
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
|
169 |
|
|
|
170 |
|
|
|
171 |
|
|
|
172 |
|
|
</PRE>
|
173 |
|
|
<H2>DESCRIPTION</H2><PRE>
|
174 |
|
|
The <STRONG>spintime</STRONG> command creates a set of spinners for use in
|
175 |
|
|
time value entry. The set includes an hour, minute, and
|
176 |
|
|
second spinner widget.
|
177 |
|
|
|
178 |
|
|
|
179 |
|
|
|
180 |
|
|
</PRE>
|
181 |
|
|
<H2>METHODS</H2><PRE>
|
182 |
|
|
The <STRONG>spintime</STRONG> command creates a new Tcl command whose name is
|
183 |
|
|
<EM>pathName</EM>. This command may be used to invoke various opera-
|
184 |
|
|
tions on the widget. It has the following general form:
|
185 |
|
|
<EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?
|
186 |
|
|
|
187 |
|
|
<EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-
|
188 |
|
|
mand. The following commands are possible for spintime widg-
|
189 |
|
|
ets:
|
190 |
|
|
|
191 |
|
|
|
192 |
|
|
|
193 |
|
|
</PRE>
|
194 |
|
|
<H2>WIDGET-SPECIFIC METHODS</H2><PRE>
|
195 |
|
|
<EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>
|
196 |
|
|
Returns the current value of the configuration option
|
197 |
|
|
given by <EM>option</EM>. <EM>Option</EM> may have any of the values
|
198 |
|
|
accepted by the <STRONG>spintime</STRONG> command.
|
199 |
|
|
|
200 |
|
|
<EM>pathName</EM> <STRONG>clear</STRONG>
|
201 |
|
|
Delete the contents of all spinner components.
|
202 |
|
|
|
203 |
|
|
<EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
|
204 |
|
|
Query or modify the configuration options of the
|
205 |
|
|
widget. If no <EM>option</EM> is specified, returns a list
|
206 |
|
|
describing all of the available options for <EM>pathName</EM>
|
207 |
|
|
(see <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of
|
208 |
|
|
this list). If <EM>option</EM> is specified with no <EM>value</EM>, then
|
209 |
|
|
the command returns a list describing the one named
|
210 |
|
|
option (this list will be identical to the correspond-
|
211 |
|
|
ing sublist of the value returned if no <EM>option</EM> is
|
212 |
|
|
specified). If one or more <EM>option</EM> - <EM>value</EM> pairs are
|
213 |
|
|
specified, then the command modifies the given widget
|
214 |
|
|
option(s) to have the given value(s); in this case the
|
215 |
|
|
command returns an empty string. <EM>Option</EM> may have any
|
216 |
|
|
of the values accepted by the <STRONG>spintime</STRONG> command.
|
217 |
|
|
|
218 |
|
|
<EM>pathName</EM> <STRONG>delete</STRONG> <EM>component</EM> <EM>first</EM> ?<EM>last</EM>?
|
219 |
|
|
Delete one or more characters of the specified <EM>com-</EM>
|
220 |
|
|
<EM>ponent</EM>, where <EM>component</EM> can be <STRONG>hour</STRONG>, <STRONG>minute</STRONG>, or <STRONG>second</STRONG>.
|
221 |
|
|
<EM>First</EM> is the index of the first character to delete,
|
222 |
|
|
and <EM>last</EM> is the index of the character just after the
|
223 |
|
|
last one to delete.
|
224 |
|
|
|
225 |
|
|
<EM>pathName</EM> <STRONG>get</STRONG> ?<EM>component</EM>?
|
226 |
|
|
Get returns the value for the speicifed component:
|
227 |
|
|
<STRONG>hour</STRONG>, <STRONG>minute</STRONG>, or <STRONG>second</STRONG>. Without parameters the com-
|
228 |
|
|
mand returns the all three values as a list.
|
229 |
|
|
|
230 |
|
|
<EM>pathName</EM> <STRONG>insert</STRONG> <EM>component</EM> <EM>index</EM> <EM>string</EM>
|
231 |
|
|
Inserts the characters of <EM>string</EM> just before the char-
|
232 |
|
|
acter indicated by <EM>index</EM> in the <EM>component</EM>, where <EM>com-</EM>
|
233 |
|
|
<EM>ponent</EM> can be <STRONG>hour</STRONG>, <STRONG>minute</STRONG>, or <STRONG>second</STRONG>.
|
234 |
|
|
|
235 |
|
|
|
236 |
|
|
|
237 |
|
|
</PRE>
|
238 |
|
|
<H2>COMPONENTS</H2><PRE>
|
239 |
|
|
Name: <STRONG>hour</STRONG>
|
240 |
|
|
Class: <STRONG>Spinint</STRONG>
|
241 |
|
|
The hour component is the hour spinner of the time
|
242 |
|
|
spinner. See the SpinInt widget manual entry for
|
243 |
|
|
details on the hour component item.
|
244 |
|
|
|
245 |
|
|
Name: <STRONG>minute</STRONG>
|
246 |
|
|
Class: <STRONG>Spinint</STRONG>
|
247 |
|
|
|
248 |
|
|
The minute component is the minute spinner of the time
|
249 |
|
|
spinner. See the SpinInt widget manual entry for
|
250 |
|
|
details on the minute component item.
|
251 |
|
|
|
252 |
|
|
Name: <STRONG>second</STRONG>
|
253 |
|
|
Class: <STRONG>Spinint</STRONG>
|
254 |
|
|
|
255 |
|
|
The second component is the second spinner of the time
|
256 |
|
|
spinner. See the SpinInt widget manual entry for
|
257 |
|
|
details on the second component item.
|
258 |
|
|
|
259 |
|
|
|
260 |
|
|
|
261 |
|
|
</PRE>
|
262 |
|
|
<H2>EXAMPLE</H2><PRE>
|
263 |
|
|
spintime .st
|
264 |
|
|
pack .st -padx 10 -pady 10
|
265 |
|
|
|
266 |
|
|
|
267 |
|
|
|
268 |
|
|
</PRE>
|
269 |
|
|
<H2>AUTHOR</H2><PRE>
|
270 |
|
|
Sue Yockey
|
271 |
|
|
|
272 |
|
|
Mark L. Ulferts
|
273 |
|
|
|
274 |
|
|
|
275 |
|
|
</PRE>
|
276 |
|
|
<H2>KEYWORDS</H2><PRE>
|
277 |
|
|
spintime, spinint, spinner, entryfield, entry, widget
|
278 |
|
|
|
279 |
|
|
|
280 |
|
|
|
281 |
|
|
|
282 |
|
|
|
283 |
|
|
|
284 |
|
|
|
285 |
|
|
|
286 |
|
|
|
287 |
|
|
|
288 |
|
|
|
289 |
|
|
|
290 |
|
|
|
291 |
|
|
|
292 |
|
|
|
293 |
|
|
|
294 |
|
|
|
295 |
|
|
|
296 |
|
|
|
297 |
|
|
|
298 |
|
|
|
299 |
|
|
</PRE>
|
300 |
|
|
</BODY>
|
301 |
|
|
</HTML>
|