File: Counter.html

package info (click to toggle)
python-pmw 0.6.2-0.1
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 1,652 kB
  • ctags: 2,716
  • sloc: python: 10,720; makefile: 44; sh: 24
file content (302 lines) | stat: -rw-r--r-- 10,813 bytes parent folder | download
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

    <html>
    <head>
    <title>Pmw.Counter reference manual</title>
    </head>

    <body bgcolor="#ffffff" text="#000000" link="#0000ee"
	vlink="551a8b" alink="ff0000">

    <center><P ALIGN="CENTER">
    <IMG SRC = transdove.gif ALT = "" WIDTH=70 HEIGHT=75>
    <IMG SRC = transdove.gif ALT = "" WIDTH=70 HEIGHT=75>
    <IMG SRC = transdove.gif ALT = "" WIDTH=70 HEIGHT=75>
    </p></center>

    <h1 ALIGN="CENTER">Pmw.Counter</h1>
    <p>
    
<dl>
<dt> <h3>Name</h3><dd>
<p>Pmw.Counter() - 
    entry field with up and down arrow buttons
</p>


<dt> <h3>Inherits</h3><dd>
<a href="MegaWidget.html">Pmw.MegaWidget</a><br>
<dt> <h3>Description</h3><dd>
<p>
    This class consists of an entry field with arrow buttons to
    increment and decrement the value in the entry field.  Built-in
    entry types include numbers, times and dates.  An external
    counting function may also be supplied.  The entry field's
    validation function is also available.  The components may be laid
    out horizontally or vertically.</p>

<p></p>


<dt> <h3>Options</h3><dd>
Options for this megawidget and its base
classes are described below.<p>
<a name=option.autorepeat></a>
<dl><dt> <strong>autorepeat
</strong><dd>
Initialisation option. If true, the counter will continue to count up or down while an
    arrow button is held pressed down. The default is <strong>1</strong>.</p>


</dt></dl>
<a name=option.buttonaspect></a>
<dl><dt> <strong>buttonaspect
</strong><dd>
Initialisation option. Specifies the width of the arrow buttons as a proportion of the
    height.  Values less than <strong>1.0</strong> will produce thin arrow buttons. 
    Values greater than <strong>1.0</strong> will produce fat arrow buttons. The default is <strong>1.0</strong>.</p>


</dt></dl>
<a name=option.datatype></a>
<dl><dt> <strong>datatype
</strong><dd>
Specifies how the counter should count up and down.  Must be one
    of the built-in datatypes or a function.  The built-in datatypes
    support the incrementing and decrementing of numbers, times
    and dates.  They are</p>
<dl><dd><pre> numeric        any integer
 integer        any integer
 real           real number
 timeN          HH:MM:SS (may be negative)
 time24         HH:MM:SS (wraps around at 23:59:59)
 date_dmy       DD/MM/YY
 date_mdy       MM/DD/YY
 date_ymd       YY/MM/DD
 date_dmy4      DD/MM/YYYY
 date_mdy4      MM/DD/YYYY
 date_y4md      YYYY/MM/DD</pre></dl>

<p>    If <strong>validate</strong> is a function, then it will be called whenever the
    counter is incremented or decremented.  The function is called
    with the arguments (<em>text</em>, <em>factor</em>, <em>increment</em>, <em>min</em>, <em>max</em>),
    where <em>text</em> is the current contents of the entry field, <em>factor</em>
    is <strong>1</strong> when incrementing or <strong>-1</strong> when decrementing, and the other
    arguments are the values of the options of the same name.</p>

<p>    The validate function should return a string representing the
    incremented or decremented value.  It should raise an error if
    <em>min</em> or <em>max</em> would be exceeded or if the <em>text</em> is invalid. The default is <strong>'numeric'</strong>.</p>



</dt></dl>
<a name=option.increment></a>
<dl><dt> <strong>increment
</strong><dd>
Specifies how many units should be added or subtracted when the
    counter is incremented or decremented.  For the number datatypes,
    the value is a number.  For the time datatypes, the value is in
    seconds.  For the date datatypes, the value is in days. The default is <strong>1</strong>.</p>


</dt></dl>
<a name=option.initwait></a>
<dl><dt> <strong>initwait
</strong><dd>
Initialisation option. Specifies the initial delay (in milliseconds) before a depressed
    arrow button automatically starts to repeat counting. The default is <strong>300</strong>.</p>


</dt></dl>
<a name=option.labelmargin></a>
<dl><dt> <strong>labelmargin
</strong><dd>
Initialisation option. If the <strong>labelpos</strong> option is not <strong>None</strong>, this specifies the
        distance between the <strong>label</strong> component and the rest of the
        megawidget. The default is <strong>0</strong>.</p>


</dt></dl>
<a name=option.labelpos></a>
<dl><dt> <strong>labelpos
</strong><dd>
Initialisation option. Specifies where to place the <strong>label</strong> component.  If not
        <strong>None</strong>, it should be a concatenation of one or two of the
        letters <strong>'n'</strong>, <strong>'s'</strong>, <strong>'e'</strong> and <strong>'w'</strong>.  The first letter
        specifies on which side of the megawidget to place the label. 
        If a second letter is specified, it indicates where on that
        side to place the label.  For example, if <strong>labelpos</strong> is <strong>'w'</strong>,
        the label is placed in the centre of the left hand side; if
        it is <strong>'wn'</strong>, the label is placed at the top of the left
        hand side; if it is <strong>'ws'</strong>, the label is placed at the
        bottom of the left hand side.</p>
<p>        If <strong>None</strong>, a label component is not created. The default is <strong>None</strong>.</p>



</dt></dl>
<a name=option.max></a>
<dl><dt> <strong>max
</strong><dd>
Specifies the maximum value.  The counter will not increment above
    this value.  For the number datatypes, the value is a number.  For
    the time datatypes, the value is a time string.  For the date
    datatypes, the value a date string.  If <strong>''</strong>, no maximum will be
    enforced. The default is <strong>''</strong>.</p>


</dt></dl>
<a name=option.min></a>
<dl><dt> <strong>min
</strong><dd>
Specifies the minimum value.  The counter will not decrement below
    this value.  For the number datatypes, the value is a number.  For
    the time datatypes, the value is a time string.  For the date
    datatypes, the value a date string.  If <strong>''</strong>, no minimum will be
    enforced. The default is <strong>''</strong>.</p>


</dt></dl>
<a name=option.orient></a>
<dl><dt> <strong>orient
</strong><dd>
Initialisation option. Specifies whether the arrow buttons should appear to the left and
    right of the entry field (<strong>'horizontal'</strong>) or above and below
    (<strong>'vertical'</strong>). The default is <strong>'horizontal'</strong>.</p>


</dt></dl>
<a name=option.padx></a>
<dl><dt> <strong>padx
</strong><dd>
Initialisation option. Specifies a padding distance to leave around the arrow buttons in
    the x direction. The default is <strong>0</strong>.</p>


</dt></dl>
<a name=option.pady></a>
<dl><dt> <strong>pady
</strong><dd>
Initialisation option. Specifies a padding distance to leave around the arrow buttons in
    the y direction. The default is <strong>0</strong>.</p>


</dt></dl>
<a name=option.repeatrate></a>
<dl><dt> <strong>repeatrate
</strong><dd>
Initialisation option. Specifies the delay (in milliseconds) between automatic counts
    while an arrow button is held pressed down. The default is <strong>50</strong>.</p>


</dt></dl>
<dt> <h3>Components</h3><dd>
Components created by this megawidget and its base
classes are described below.<p>
<a name=component.downarrow></a>
<dl><dt> <strong>downarrow
</strong><dd>
The arrow button used for decrementing the counter.  Depending on
    the value of <strong>orient</strong>, it will appear on the left or below the
    entry field. By default, this component is a Tkinter.Canvas. Its component group is <strong>Arrow</strong>.</p>


</dt></dl>
<a name=component.entryfield></a>
<dl><dt> <strong>entryfield
</strong><dd>
The entry field widget where the text is entered, displayed and
    validated. By default, this component is a <a href="EntryField.html">Pmw.EntryField</a>.</p>


</dt></dl>
<a name=component.frame></a>
<dl><dt> <strong>frame
</strong><dd>
If the <strong>label</strong> component has been created (that is, the <strong>labelpos</strong>
    option is not <strong>None</strong>), the <strong>frame</strong> component is created to act as
    the container of the entry field and arrow buttons.  If there is
    no <strong>label</strong> component, the <strong>hull</strong> component acts as the container. 
    In either case the border around the container of the entry field
    and arrow buttons will be raised (but not around the label). By default, this component is a Tkinter.Frame.</p>


</dt></dl>
<a name=component.hull></a>
<dl><dt> <strong>hull
</strong><dd>
This acts as the body for the entire megawidget.  Other components
    are created as children of the hull to further specialise the
    widget. By default, this component is a Tkinter.Frame.</p>


</dt></dl>
<a name=component.label></a>
<dl><dt> <strong>label
</strong><dd>
If the <strong>labelpos</strong> option is not <strong>None</strong>, this component is
        created as a text label for the megawidget.  See the
        <strong>labelpos</strong> option for details.  Note that to set, for example,
        the <strong>text</strong> option of the label, you need use the <strong>label_text</strong>
        component option. By default, this component is a Tkinter.Label.</p>


</dt></dl>
<a name=component.uparrow></a>
<dl><dt> <strong>uparrow
</strong><dd>
The arrow button used for incrementing the counter.  Depending on
    the value of <strong>orient</strong>, it will appear on the right or above the
    entry field. By default, this component is a Tkinter.Canvas. Its component group is <strong>Arrow</strong>.</p>


</dt></dl>
<dt> <h3>Component aliases</h3><dd>
Sub-components of components of this megawidget
may be accessed via the following aliases.<p>
<dl><dt> <strong>entry
</strong><dd>
Alias for <strong>entryfield_entry</strong>.
</dt></dl>
<a name=methods></a>
<dt> <h3>Methods</h3><dd>
Only methods specific to this megawidget are described below.
For a description of its inherited methods, see the
manuals for its base classes.
In addition, methods from
<strong><a href="EntryField.html#methods">Pmw.EntryField</a></strong> are forwarded
to this megawidget's <strong>entryfield</strong>
component.
<p>
<a name=method.decrement></a>
<dl><dt> <strong>decrement</strong>()<dd>
Decrement the counter once, as if the down arrow had been pressed.</p>


</dt></dl>
<a name=method.increment></a>
<dl><dt> <strong>increment</strong>()<dd>
Increment the counter once, as if the up arrow had been pressed.</p>


</dt></dl>
</dl>

    <center><P ALIGN="CENTER">
    <IMG SRC = blue_line.gif ALT = "" WIDTH=320 HEIGHT=5>
    </p></center>
    

    <font size=-1>
    <center><P ALIGN="CENTER">
    <a href="index.html">Home</a>. 
    Pmw 0.6.2
    Maintainer
    <a href="mailto:gregm@iname.com">gregm@iname.com</a>.
    23 Feb 1998
    </p></center>
    </font>

    </body>
    </html>