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
|
.. 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
.. _wx.Validator:
==========================================================================================================================================
|phoenix_title| **wx.Validator**
==========================================================================================================================================
:ref:`wx.Validator` is the base class for a family of validator classes that mediate between a class of control, and application data.
A validator has three major roles:
- To transfer data from a C++ variable or own storage to and from a control.
- To validate data in a control, and show an appropriate error message.
- To filter events (such as keystrokes), thereby changing the behaviour of the associated control.
Validators can be plugged into controls dynamically.
To specify a default, "null" validator, use :ref:`wx.DefaultValidator`.
For more information, please see :ref:`Validator Overview <validator overview>`.
.. seealso:: :ref:`Validator Overview <validator overview>`, :ref:`TextValidator`, :ref:`GenericValidator`, :ref:`IntegerValidator`, :ref:`FloatingPointValidator`
|
|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>Validator</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.Validator_inheritance.png" alt="Inheritance diagram of Validator" 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.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Validator.html" title="wx.Validator" alt="" coords="55,160,153,189"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`GenericValidator`, :ref:`NumValidator`, :ref:`TextValidator`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Validator.__init__` Constructor.
:meth:`~wx.Validator.Clone` All validator classes must implement the :meth:`~Validator.Clone` function, which returns an identical copy of itself.
:meth:`~wx.Validator.GetWindow` Returns the window associated with the validator.
:meth:`~wx.Validator.IsSilent` Returns if the error sound is currently disabled.
:meth:`~wx.Validator.SetWindow` Associates a window with the validator.
:meth:`~wx.Validator.SuppressBellOnError` This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.
:meth:`~wx.Validator.TransferFromWindow` This overridable function is called when the value in the window must be transferred to the validator.
:meth:`~wx.Validator.TransferToWindow` This overridable function is called when the value associated with the validator must be transferred to the window.
:meth:`~wx.Validator.Validate` This overridable function is called when the value in the associated window must be validated.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Validator.Window` See :meth:`~wx.Validator.GetWindow` and :meth:`~wx.Validator.SetWindow`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Validator(EvtHandler)
**Possible constructors**::
Validator()
Validator is the base class for a family of validator classes that
mediate between a class of control, and application data.
.. method:: __init__(self)
Constructor.
.. method:: Clone(self)
All validator classes must implement the :meth:`Clone` function, which returns an identical copy of itself.
This is because validators are passed to control constructors as references which must be copied. Unlike objects such as pens and brushes, it does not make sense to have a reference counting scheme to do this cloning because all validators should have separate data.
:rtype: :ref:`wx.Object`
:returns:
This base function returns ``None``.
.. method:: GetWindow(self)
Returns the window associated with the validator.
:rtype: :ref:`wx.Window`
.. staticmethod:: IsSilent()
Returns if the error sound is currently disabled.
:rtype: `bool`
.. method:: SetWindow(self, window)
Associates a window with the validator.
This function is automatically called by wxWidgets when creating a Window-derived class instance which takes a :ref:`wx.Validator` reference.
E.g. ::
wx.TextCtrl(self, wx.ID_ANY, u'', wx.DefaultPosition, wx.DefaultSize, 0,
validator=MyValidator())
will automatically link the :ref:`TextValidator` instance with the :ref:`wx.TextCtrl` instance.
:param `window`:
:type `window`: wx.Window
.. staticmethod:: SuppressBellOnError(suppress=True)
This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.
:param `suppress`: If ``True``, error sound is not played when a validator detects an error. If ``False``, error sound is enabled.
:type `suppress`: bool
.. versionadded:: 2.9.1
.. method:: TransferFromWindow(self)
This overridable function is called when the value in the window must be transferred to the validator.
:rtype: `bool`
:returns:
``False`` if there is a problem.
.. method:: TransferToWindow(self)
This overridable function is called when the value associated with the validator must be transferred to the window.
:rtype: `bool`
:returns:
``False`` if there is a problem.
.. method:: Validate(self, parent)
This overridable function is called when the value in the associated window must be validated.
:param `parent`: The parent of the window associated with the validator.
:type `parent`: wx.Window
:rtype: `bool`
:returns:
``False`` if the value in the window is not valid; you may pop up an error dialog.
.. attribute:: Window
See :meth:`~wx.Validator.GetWindow` and :meth:`~wx.Validator.SetWindow`
|
