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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.intctrl
.. highlight:: python
.. _wx.lib.intctrl.IntCtrl:
==========================================================================================================================================
|phoenix_title| **wx.lib.intctrl.IntCtrl**
==========================================================================================================================================
This class provides a control that takes and returns integers as
value, and provides bounds support and optional value limiting.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>IntCtrl</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.intctrl.IntCtrl_inheritance.png" alt="Inheritance diagram of IntCtrl" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.TextCtrl.html" title="wx.TextCtrl" alt="" coords="127,392,216,421"/> <area shape="rect" id="node9" href="wx.lib.intctrl.IntCtrl.html" title="wx.lib.intctrl.IntCtrl" alt="" coords="103,469,241,499"/> <area shape="rect" id="node2" href="wx.Control.html" title="wx.Control" alt="" coords="69,315,157,344"/> <area shape="rect" id="node3" href="wx.TextEntry.html" title="wx.TextEntry" alt="" coords="182,315,281,344"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="5,5,107,35"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node7" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="53,160,173,189"/> <area shape="rect" id="node6" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node8" href="wx.Window.html" title="wx.Window" alt="" coords="69,237,157,267"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.TextCtrl`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.intctrl.IntCtrl.__init__` Default constructor
:meth:`~wx.lib.intctrl.IntCtrl.ChangeValue` Change the value without sending an EVT_TEXT event.
:meth:`~wx.lib.intctrl.IntCtrl.Cut` Override the :func:`TextCtrl.Cut` function, with our own
:meth:`~wx.lib.intctrl.IntCtrl.GetBounds` This function returns a two-tuple (min,max), indicating the
:meth:`~wx.lib.intctrl.IntCtrl.GetColors` Returns a tuple of (default_color, oob_color), indicating
:meth:`~wx.lib.intctrl.IntCtrl.GetMax` Gets the maximum value of the control. It will return the current
:meth:`~wx.lib.intctrl.IntCtrl.GetMin` Gets the minimum value of the control. It will return the current
:meth:`~wx.lib.intctrl.IntCtrl.GetValue` Returns the current integer (long) value of the control.
:meth:`~wx.lib.intctrl.IntCtrl.IsInBounds` Returns ``True`` if no value is specified and the current value
:meth:`~wx.lib.intctrl.IntCtrl.IsLimited` Returns ``True`` if the control is currently limiting the
:meth:`~wx.lib.intctrl.IntCtrl.IsLongAllowed` Is a long value allowed.
:meth:`~wx.lib.intctrl.IntCtrl.IsNoneAllowed` Is a None value allowed.
:meth:`~wx.lib.intctrl.IntCtrl.OnText` Handles an event indicating that the text control's value
:meth:`~wx.lib.intctrl.IntCtrl.Paste` Override the :func:`TextCtrl.Paste` function, with our own
:meth:`~wx.lib.intctrl.IntCtrl.SetBounds` This function is a convenience function for setting the min and max
:meth:`~wx.lib.intctrl.IntCtrl.SetColors` Tells the control what colors to use for normal and out-of-bounds
:meth:`~wx.lib.intctrl.IntCtrl.SetLimited` If called with a value of True, this function will cause the control
:meth:`~wx.lib.intctrl.IntCtrl.SetLongAllowed` Change the behavior of the validation code, allowing control
:meth:`~wx.lib.intctrl.IntCtrl.SetMax` Sets the maximum value of the control. If a value of None
:meth:`~wx.lib.intctrl.IntCtrl.SetMin` Sets the minimum value of the control. If a value of None
:meth:`~wx.lib.intctrl.IntCtrl.SetNoneAllowed` Change the behavior of the validation code, allowing control
:meth:`~wx.lib.intctrl.IntCtrl.SetValue` Sets the value of the control to the integer value specified.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: IntCtrl(wx.TextCtrl)
This class provides a control that takes and returns integers as
value, and provides bounds support and optional value limiting.
.. method:: __init__ ( self, parent, id=-1, value = 0, pos = wx.DefaultPosition, size = wx.DefaultSize, style = 0, validator = wx.DefaultValidator, name = "integer", min=None, max=None, limited = 0, allow_none = 0, allow_long = 0, default_color = wx.BLACK, oob_color = wx.RED, )
Default constructor
:param `parent`: parent window
:param int `id`: window identifier. A value of -1 indicates a
default value
:param `value`: If no initial value is set, the default will be zero,
or the minimum value, if specified. If an illegal string is
specified, a ValueError will result. (You can always later set the
initial value with ChangeValue() after instantiation of the control.)
:param tuple `pos`: the control position. A value of (-1, -1) indicates
a default position, chosen by either the windowing system or
wxPython, depending on platform
:param wx.Size `size`: the control size. A value of (-1, -1) indicates a
default size, chosen by either the windowing system or wxPython,
depending on platform
:param int `style`: the underlying :class:`TextCtrl` style
:param wx.Validator `validator`: Normally None, IntCtrl uses its own
validator to do value validation and input control. However, a
validator derived from :class:`~lib.intctrl.IntValidator` can be
supplied to override the data transfer methods for the
:class:`~lib.intctrl.IntValidator` class.
:param int `min`: The minimum value that the control should allow. This
can be adjusted with SetMin(). If the control is not limited, any
value below this bound will be colored with the current out-of-bounds
color. If min < -sys.maxsize-1 and the control is configured to not
allow long values, the minimum bound will still be set to the long
value, but the implicit bound will be -sys.maxsize-1.
:param int `max`: The maximum value that the control should allow. This
can be adjusted with SetMax(). If the control is not limited, any
value above this bound will be colored with the current out-of-bounds
color. if max > sys.maxsize and the control is configured to not
allow long values, the maximum bound will still be set to the long
value, but the implicit bound will be sys.maxsize.
:param bool `limited`: Boolean indicating whether the control
prevents values from exceeding the currently set minimum and maximum
values (bounds). If ``False`` and bounds are set, out-of-bounds values
will be colored with the current out-of-bounds color.
:param bool `allow_none`: Boolean indicating whether or not the
control is allowed to be empty, representing a value of None for the
control.
:param bool `allow_long`: Boolean indicating whether or not the
control is allowed to hold and return a long as well as an int.
:param Color `default_color`: Color value used for in-bounds values
of the control.
:param Color `oob_color`: Color value used for out-of-bounds values
of the control when the bounds are set but the control is not limited.
.. method:: ChangeValue(self, value)
Change the value without sending an EVT_TEXT event.
:param int `value`: The value to be set
.. method:: Cut( self )
Override the :func:`TextCtrl.Cut` function, with our own
that does validation. Will result in a value of 0
if entire contents of control are removed.
.. method:: GetBounds(self)
This function returns a two-tuple (min,max), indicating the
current bounds of the control. Each value can be None if
that bound is not set.
.. method:: GetColors(self)
Returns a tuple of (default_color, oob_color), indicating
the current color settings for the control.
.. method:: GetMax(self)
Gets the maximum value of the control. It will return the current
maximum integer, or None if not specified.
.. method:: GetMin(self)
Gets the minimum value of the control. It will return the current
minimum integer, or None if not specified.
.. method:: GetValue(self)
Returns the current integer (long) value of the control.
.. method:: IsInBounds(self, value=None)
Returns ``True`` if no value is specified and the current value
of the control falls within the current bounds. This function can
also be called with a value to see if that value would fall within
the current bounds of the given control.
:param int `value`: value to check or None
.. method:: IsLimited(self)
Returns ``True`` if the control is currently limiting the
value to fall within the current bounds.
.. method:: IsLongAllowed(self)
Is a long value allowed.
.. method:: IsNoneAllowed(self)
Is a None value allowed.
.. method:: OnText( self, event )
Handles an event indicating that the text control's value
has changed, and issue EVT_INT event.
NOTE: using wx.TextCtrl.SetValue() to change the control's
contents from within a wx.EVT_CHAR handler can cause double
text events. So we check for actual changes to the text
before passing the events on.
.. method:: Paste( self )
Override the :func:`TextCtrl.Paste` function, with our own
that does validation. Will raise ValueError if not a
valid integerizable value.
.. method:: SetBounds(self, min=None, max=None)
This function is a convenience function for setting the min and max
values at the same time. The function only applies the maximum bound
if setting the minimum bound is successful, and returns ``True`` only if both operations succeed.
..note::
Leaving out an argument will remove the corresponding bound.
:param int `min`: The value to be set as minimum
:param int `max`: The value to be set as maximum
.. method:: SetColors(self, default_color=wx.BLACK, oob_color=wx.RED)
Tells the control what colors to use for normal and out-of-bounds
values. If the value currently exceeds the bounds, it will be
recolored accordingly.
:param Color `default_color`: default color to be used
:param Color `oob_color`: out of bound color to be used
.. method:: SetLimited(self, limited)
If called with a value of True, this function will cause the control
to limit the value to fall within the bounds currently specified.
If the control's value currently exceeds the bounds, it will then
be limited accordingly.
If called with a value of 0, this function will disable value
limiting, but coloring of out-of-bounds values will still take
place if bounds have been set for the control.
:param bool `limited`: If ``True`` set to control to be limited.
.. method:: SetLongAllowed(self, allow_long)
Change the behavior of the validation code, allowing control
to have a long value or not, as appropriate. If the value
of the control is currently long, and allow_long is 0, the
value of the control will be adjusted to fall within the
size of an integer type, at either the sys.maxsize or -sys.maxsize-1,
for positive and negative values, respectively.
:param bool `allow_long`: If ``True`` allow long values for control
.. method:: SetMax(self, max=None)
Sets the maximum value of the control. If a value of None
is provided, then the control will have no explicit maximum value.
If the value specified is less than the current minimum value, then
the function returns 0 and the maximum will not change from its
current setting. On success, the function returns 1.
If successful and the current value is greater than the new upper
bound, if the control is limited the value will be automatically
adjusted to this maximum value; if not limited, the value in the
control will be colored with the current out-of-bounds color.
If max > sys.maxsize and the control is configured to not allow longs,
the function will return 0, and the max will not be set.
:param int `max`: The value to be set as maximum
.. method:: SetMin(self, min=None)
Sets the minimum value of the control. If a value of None
is provided, then the control will have no explicit minimum value.
If the value specified is greater than the current maximum value,
then the function returns 0 and the minimum will not change from
its current setting. On success, the function returns 1.
If successful and the current value is lower than the new lower
bound, if the control is limited, the value will be automatically
adjusted to the new minimum value; if not limited, the value in the
control will be colored with the current out-of-bounds color.
If min > -sys.maxsize-1 and the control is configured to not allow longs,
the function will return 0, and the min will not be set.
:param int `min`: The value to be set as minimum
.. method:: SetNoneAllowed(self, allow_none)
Change the behavior of the validation code, allowing control
to have a value of None or not, as appropriate. If the value
of the control is currently None, and allow_none is 0, the
value of the control will be set to the minimum value of the
control, or 0 if no lower bound is set.
:param bool `allow_none`: If ``True`` a None value is allowed
.. method:: SetValue(self, value)
Sets the value of the control to the integer value specified.
The resulting actual value of the control may be altered to
conform with the bounds set on the control if limited,
or colored if not limited but the value is out-of-bounds.
A ValueError exception will be raised if an invalid value
is specified.
:param int `value`: The value to be set
|
