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
|
.. 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.propgrid.PGValidationInfo:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PGValidationInfo**
==========================================================================================================================================
Used to convey validation information to and from functions that actually perform validation.
Mostly used in custom property classes.
|
|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>PGValidationInfo</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.propgrid.PGValidationInfo_inheritance.png" alt="Inheritance diagram of PGValidationInfo" 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.propgrid.PGValidationInfo.html" title="wx.propgrid.PGValidationInfo" alt="" coords="5,5,208,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PGValidationInfo.GetFailureBehavior`
:meth:`~wx.propgrid.PGValidationInfo.GetFailureMessage` Returns current failure message.
:meth:`~wx.propgrid.PGValidationInfo.GetValue` Returns reference to pending value.
:meth:`~wx.propgrid.PGValidationInfo.SetFailureBehavior` Set validation failure behaviour.
:meth:`~wx.propgrid.PGValidationInfo.SetFailureMessage` Set current failure message.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PGValidationInfo.FailureBehavior` See :meth:`~wx.propgrid.PGValidationInfo.GetFailureBehavior` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureBehavior`
:attr:`~wx.propgrid.PGValidationInfo.FailureMessage` See :meth:`~wx.propgrid.PGValidationInfo.GetFailureMessage` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureMessage`
:attr:`~wx.propgrid.PGValidationInfo.Value` See :meth:`~wx.propgrid.PGValidationInfo.GetValue`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PGValidationInfo(object)
Used to convey validation information to and from functions that
actually perform validation.
.. method:: GetFailureBehavior(self)
:rtype: :ref:`wx.propgrid.PGVFBFlags`
:returns:
Returns failure behaviour which is a combination of :ref:`PropertyGrid Validation Failure behaviour Flags <propertygrid validation failure behaviour flags>`.
.. method:: GetFailureMessage(self)
Returns current failure message.
:rtype: `string`
.. method:: GetValue(self)
Returns reference to pending value.
:rtype: :ref:`PGVariant`
.. method:: SetFailureBehavior(self, failureBehavior)
Set validation failure behaviour.
:param `failureBehavior`: Mixture of :ref:`PropertyGrid Validation Failure behaviour Flags <propertygrid validation failure behaviour flags>`.
:type `failureBehavior`: wx.propgrid.PGVFBFlags
.. method:: SetFailureMessage(self, message)
Set current failure message.
:param `message`:
:type `message`: string
.. attribute:: FailureBehavior
See :meth:`~wx.propgrid.PGValidationInfo.GetFailureBehavior` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureBehavior`
.. attribute:: FailureMessage
See :meth:`~wx.propgrid.PGValidationInfo.GetFailureMessage` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureMessage`
.. attribute:: Value
See :meth:`~wx.propgrid.PGValidationInfo.GetValue`
|
