File: wx.lib.intctrl.IntValidator.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (134 lines) | stat: -rw-r--r-- 5,168 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
.. 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.IntValidator:

==========================================================================================================================================
|phoenix_title|  **wx.lib.intctrl.IntValidator**
==========================================================================================================================================

Validator class used with :class:`~lib.intctrl.IntCtrl` handles all validation of
input prior to changing the value of the underlying :class:`TextCtrl`.



|

|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>IntValidator</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.IntValidator_inheritance.png" alt="Inheritance diagram of IntValidator" 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.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node4" href="wx.Validator.html" title="wx.Validator" alt="" coords="55,160,153,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node5" href="wx.lib.intctrl.IntValidator.html" title="wx.lib.intctrl.IntValidator" alt="" coords="18,237,189,267"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`wx.Validator`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.intctrl.IntValidator.__init__`                                    Standard constructor
:meth:`~wx.lib.intctrl.IntValidator.Clone`                                       Standard cloner
:meth:`~wx.lib.intctrl.IntValidator.OnChar`                                      Validates keystrokes to make sure the resulting value will a legal
:meth:`~wx.lib.intctrl.IntValidator.TransferFromWindow`                          Transfer data from window to validator.
:meth:`~wx.lib.intctrl.IntValidator.TransferToWindow`                            Transfer data from validator to window.
:meth:`~wx.lib.intctrl.IntValidator.Validate`                                    Because each operation on the control is vetted as it's made,
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: IntValidator(wx.Validator)

   Validator class used with :class:`~lib.intctrl.IntCtrl` handles all validation of
   input prior to changing the value of the underlying :class:`TextCtrl`.

   .. method:: __init__(self)

      Standard constructor


   .. method:: Clone (self)

      Standard cloner
      
      ..note::
        Every validator must implement the Clone() method.


   .. method:: OnChar(self, event)

      Validates keystrokes to make sure the resulting value will a legal
      value.  Erasing the value causes it to be set to 0, with the value
      selected, so it can be replaced.  Similarly, replacing the value
      with a '-' sign causes the value to become -1, with the value
      selected.  Leading zeros are removed if introduced by selection,
      and are prevented from being inserted.


   .. method:: TransferFromWindow(self)

      Transfer data from window to validator.
      
      The default implementation returns False, indicating that an error
      occurred.  We simply return True, to indicate to e.g. :class:`Dialog`
      that all is well.
      
      If data comes e.g. from a database then you need to override this.


   .. method:: TransferToWindow(self)

      Transfer data from validator to window.
      
      The default implementation returns False, indicating that an error
      occurred.  We simply return True, to indicate to e.g. :class:`Dialog`
      that all is well.
      
      If data comes e.g. from a database then you need to override this.


   .. method:: Validate(self, window)

      Because each operation on the control is vetted as it's made,
      the value of the control is always valid.