summaryrefslogtreecommitdiffstats
path: root/doc/html/qintvalidator.html
blob: 9b3392fc5f6bcd77a2c06e47d04c542a4a4a7eb0 (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qvalidator.cpp:181 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QIntValidator Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QIntValidator Class Reference</h1>

<p>The QIntValidator class provides a validator which ensures
that a string contains a valid integer within a specified range.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qvalidator-h.html">qvalidator.h</a>&gt;</tt>
<p>Inherits <a href="qvalidator.html">QValidator</a>.
<p><a href="qintvalidator-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QIntValidator"><b>QIntValidator</b></a> ( QObject&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn><a href="#QIntValidator-2"><b>QIntValidator</b></a> ( int&nbsp;minimum, int&nbsp;maximum, QObject&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn><a href="#~QIntValidator"><b>~QIntValidator</b></a> ()</li>
<li class=fn>virtual QValidator::State <a href="#validate"><b>validate</b></a> ( QString&nbsp;&amp;&nbsp;input, int &amp; ) const</li>
<li class=fn>void <a href="#setBottom"><b>setBottom</b></a> ( int )</li>
<li class=fn>void <a href="#setTop"><b>setTop</b></a> ( int )</li>
<li class=fn>virtual void <a href="#setRange"><b>setRange</b></a> ( int&nbsp;bottom, int&nbsp;top )</li>
<li class=fn>int <a href="#bottom"><b>bottom</b></a> () const</li>
<li class=fn>int <a href="#top"><b>top</b></a> () const</li>
</ul>
<h2>Properties</h2>
<ul>
<li class=fn>int <a href="#bottom-prop"><b>bottom</b></a>&nbsp;- the validator's lowest acceptable value</li>
<li class=fn>int <a href="#top-prop"><b>top</b></a>&nbsp;- the validator's highest acceptable value</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QIntValidator class provides a validator which ensures
that a string contains a valid integer within a specified range.
<p> 
<p> Example of use:
<p> <pre>
    <a href="qvalidator.html">QValidator</a>* validator = new QIntValidator( 100, 999, this );
    <a href="qlineedit.html">QLineEdit</a>* edit = new <a href="qlineedit.html">QLineEdit</a>( this );

    // the edit lineedit will only accept integers between 100 and 999
    edit-&gt;<a href="qlineedit.html#setValidator">setValidator</a>( validator );
    </pre>
 
<p> Below we present some examples of validators. In practice they would
normally be associated with a widget as in the example above.
<p> <pre>
    <a href="qstring.html">QString</a> str;
    int pos = 0;
    QIntValidator v( 100, 999, this );

    str = "1";
    v.<a href="#validate">validate</a>( str, pos );     // returns Intermediate
    str = "12";
    v.<a href="#validate">validate</a>( str, pos );     // returns Intermediate

    str = "123";
    v.<a href="#validate">validate</a>( str, pos );     // returns Acceptable
    str = "678";
    v.<a href="#validate">validate</a>( str, pos );     // returns Acceptable

    str = "1234";
    v.<a href="#validate">validate</a>( str, pos );     // returns Invalid
    str = "-123";
    v.<a href="#validate">validate</a>( str, pos );     // returns Invalid
    str = "abc";
    v.<a href="#validate">validate</a>( str, pos );     // returns Invalid
    str = "12cm";
    v.<a href="#validate">validate</a>( str, pos );     // returns Invalid
    </pre>
 
<p> The minimum and maximum values are set in one call with <a href="#setRange">setRange</a>()
or individually with <a href="#setBottom">setBottom</a>() and <a href="#setTop">setTop</a>().
<p> <p>See also <a href="qdoublevalidator.html">QDoubleValidator</a>, <a href="qregexpvalidator.html">QRegExpValidator</a>, and <a href="misc.html">Miscellaneous Classes</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QIntValidator"></a>QIntValidator::QIntValidator ( <a href="qobject.html">QObject</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
</h3>
Constructs a validator called <em>name</em> with parent <em>parent</em>, that
accepts all integers.

<h3 class=fn><a name="QIntValidator-2"></a>QIntValidator::QIntValidator ( int&nbsp;minimum, int&nbsp;maximum, <a href="qobject.html">QObject</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
</h3>
Constructs a validator called <em>name</em> with parent <em>parent</em>, that
accepts integers from <em>minimum</em> to <em>maximum</em> inclusive.

<h3 class=fn><a name="~QIntValidator"></a>QIntValidator::~QIntValidator ()
</h3>
Destroys the validator, freeing any resources allocated.

<h3 class=fn>int <a name="bottom"></a>QIntValidator::bottom () const
</h3><p>Returns the validator's lowest acceptable value.
See the <a href="qintvalidator.html#bottom-prop">"bottom"</a> property for details.
<h3 class=fn>void <a name="setBottom"></a>QIntValidator::setBottom ( int )
</h3><p>Sets the validator's lowest acceptable value.
See the <a href="qintvalidator.html#bottom-prop">"bottom"</a> property for details.
<h3 class=fn>void <a name="setRange"></a>QIntValidator::setRange ( int&nbsp;bottom, int&nbsp;top )<tt> [virtual]</tt>
</h3>
Sets the range of the validator to only accept integers between <em>bottom</em> and <em>top</em> inclusive.

<h3 class=fn>void <a name="setTop"></a>QIntValidator::setTop ( int )
</h3><p>Sets the validator's highest acceptable value.
See the <a href="qintvalidator.html#top-prop">"top"</a> property for details.
<h3 class=fn>int <a name="top"></a>QIntValidator::top () const
</h3><p>Returns the validator's highest acceptable value.
See the <a href="qintvalidator.html#top-prop">"top"</a> property for details.
<h3 class=fn><a href="qvalidator.html#State-enum">QValidator::State</a> <a name="validate"></a>QIntValidator::validate ( <a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;input, int &amp; ) const<tt> [virtual]</tt>
</h3>
Returns <a href="qvalidator.html#State-enum">Acceptable</a> if the <em>input</em> is an integer within the
valid range, <a href="qvalidator.html#State-enum">Intermediate</a> if the <em>input</em> is an integer outside
the valid range and <a href="qvalidator.html#State-enum">Invalid</a> if the <em>input</em> is not an integer.
<p> Note: If the valid range consists of just positive integers (e.g. 32 - 100)
and <em>input</em> is a negative integer then Invalid is returned.
<p> <pre>
    int pos = 0;
    s = "abc";
    v.validate( s, pos ); // returns Invalid

    s = "5";
    v.validate( s, pos ); // returns Intermediate

    s = "50";
    v.validate( s, pos ); // returns Valid
    </pre>
 

<p>Reimplemented from <a href="qvalidator.html#validate">QValidator</a>.
<hr><h2>Property Documentation</h2>
<h3 class=fn>int <a name="bottom-prop"></a>bottom</h3>
<p>This property holds the validator's lowest acceptable value.
<p>Set this property's value with <a href="#setBottom">setBottom</a>() and get this property's value with <a href="#bottom">bottom</a>().
<p><p>See also <a href="#setRange">setRange</a>().

<h3 class=fn>int <a name="top-prop"></a>top</h3>
<p>This property holds the validator's highest acceptable value.
<p>Set this property's value with <a href="#setTop">setTop</a>() and get this property's value with <a href="#top">top</a>().
<p><p>See also <a href="#setRange">setRange</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>