File: classwx_p_g_validation_info.html

package info (click to toggle)
wxpython3.0 3.0.2.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 482,760 kB
  • ctags: 518,293
  • sloc: cpp: 2,127,226; python: 294,045; makefile: 51,942; ansic: 19,033; sh: 3,013; xml: 1,629; perl: 17
file content (185 lines) | stat: -rw-r--r-- 9,738 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxPGValidationInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
 <tbody>
 <tr>
  <td id="projectlogo">
    <a href="http://www.wxwidgets.org/" target="_new">
      <img alt="wxWidgets" src="logo.png"/>
    </a>
  </td>
  <td style="padding-left: 0.5em; text-align: right;">
   <span id="projectnumber">Version: 3.0.2</span>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Categories</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classwx_p_g_validation_info-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">wxPGValidationInfo Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;wx/propgrid/propgrid.h&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classwx_p_g_validation_info.html" title="wxPGValidationInfo">wxPGValidationInfo</a> </p>
<p>Used to convey validation information to and from functions that actually perform validation. Mostly used in custom property classes. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a97b2ff830dae7b2153dfdab8fb047f05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_2wx_2propgrid_2propgrid_8h.html#ae6021bf370bb7766e513f49649dee232">wxPGVFBFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_p_g_validation_info.html#a97b2ff830dae7b2153dfdab8fb047f05">GetFailureBehavior</a> ()</td></tr>
<tr class="separator:a97b2ff830dae7b2153dfdab8fb047f05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad5addc4cc99b429696f17c385e0dc54"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classwx_string.html">wxString</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_p_g_validation_info.html#aad5addc4cc99b429696f17c385e0dc54">GetFailureMessage</a> () const </td></tr>
<tr class="memdesc:aad5addc4cc99b429696f17c385e0dc54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current failure message.  <a href="#aad5addc4cc99b429696f17c385e0dc54"></a><br/></td></tr>
<tr class="separator:aad5addc4cc99b429696f17c385e0dc54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad843cd1a8a7617e204f9904966c0e2ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_variant.html">wxVariant</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_p_g_validation_info.html#ad843cd1a8a7617e204f9904966c0e2ee">GetValue</a> ()</td></tr>
<tr class="memdesc:ad843cd1a8a7617e204f9904966c0e2ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns reference to pending value.  <a href="#ad843cd1a8a7617e204f9904966c0e2ee"></a><br/></td></tr>
<tr class="separator:ad843cd1a8a7617e204f9904966c0e2ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4c043f9529a0093573447687b708cfd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_p_g_validation_info.html#af4c043f9529a0093573447687b708cfd">SetFailureBehavior</a> (<a class="el" href="interface_2wx_2propgrid_2propgrid_8h.html#ae6021bf370bb7766e513f49649dee232">wxPGVFBFlags</a> failureBehavior)</td></tr>
<tr class="memdesc:af4c043f9529a0093573447687b708cfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set validation failure behaviour.  <a href="#af4c043f9529a0093573447687b708cfd"></a><br/></td></tr>
<tr class="separator:af4c043f9529a0093573447687b708cfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacfab519e8fa07006c6e24bd62e490a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_p_g_validation_info.html#aacfab519e8fa07006c6e24bd62e490a2">SetFailureMessage</a> (const <a class="el" href="classwx_string.html">wxString</a> &amp;message)</td></tr>
<tr class="memdesc:aacfab519e8fa07006c6e24bd62e490a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set current failure message.  <a href="#aacfab519e8fa07006c6e24bd62e490a2"></a><br/></td></tr>
<tr class="separator:aacfab519e8fa07006c6e24bd62e490a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a97b2ff830dae7b2153dfdab8fb047f05"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="interface_2wx_2propgrid_2propgrid_8h.html#ae6021bf370bb7766e513f49649dee232">wxPGVFBFlags</a> wxPGValidationInfo::GetFailureBehavior </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Returns failure behaviour which is a combination of <a class="el" href="interface_2wx_2propgrid_2propgrid_8h.html#propgrid_vfbflags">wxPropertyGrid Validation Failure behaviour Flags</a>. </dd></dl>

</div>
</div>
<a class="anchor" id="aad5addc4cc99b429696f17c385e0dc54"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classwx_string.html">wxString</a>&amp; wxPGValidationInfo::GetFailureMessage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns current failure message. </p>

</div>
</div>
<a class="anchor" id="ad843cd1a8a7617e204f9904966c0e2ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classwx_variant.html">wxVariant</a>&amp; wxPGValidationInfo::GetValue </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns reference to pending value. </p>

</div>
</div>
<a class="anchor" id="af4c043f9529a0093573447687b708cfd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wxPGValidationInfo::SetFailureBehavior </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="interface_2wx_2propgrid_2propgrid_8h.html#ae6021bf370bb7766e513f49649dee232">wxPGVFBFlags</a>&#160;</td>
          <td class="paramname"><em>failureBehavior</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set validation failure behaviour. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">failureBehavior</td><td>Mixture of <a class="el" href="interface_2wx_2propgrid_2propgrid_8h.html#propgrid_vfbflags">wxPropertyGrid Validation Failure behaviour Flags</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aacfab519e8fa07006c6e24bd62e490a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wxPGValidationInfo::SetFailureMessage </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> &amp;&#160;</td>
          <td class="paramname"><em>message</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set current failure message. </p>

</div>
</div>
</div><!-- contents -->

<address class="footer">
	<small>
		Generated on Thu Nov 27 2014 13:46:52 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
	</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>