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
|
<!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: wxGridCellCoords 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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classwx_grid_cell_coords-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxGridCellCoords Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/grid.h></code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents coordinates of a grid cell. </p>
<p>An object of this class is simply a (row, column) pair. </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:a893fbd641ec1f3da9e33da80c20aaf1a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#a893fbd641ec1f3da9e33da80c20aaf1a">wxGridCellCoords</a> ()</td></tr>
<tr class="memdesc:a893fbd641ec1f3da9e33da80c20aaf1a"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor initializes the object to invalid state. <a href="#a893fbd641ec1f3da9e33da80c20aaf1a"></a><br/></td></tr>
<tr class="separator:a893fbd641ec1f3da9e33da80c20aaf1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1ee986fb15055b03840583bb8771c6a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#ad1ee986fb15055b03840583bb8771c6a">wxGridCellCoords</a> (int row, int col)</td></tr>
<tr class="memdesc:ad1ee986fb15055b03840583bb8771c6a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor taking a row and a column. <a href="#ad1ee986fb15055b03840583bb8771c6a"></a><br/></td></tr>
<tr class="separator:ad1ee986fb15055b03840583bb8771c6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace9a79974c326b87f326dcb61443767b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#ace9a79974c326b87f326dcb61443767b">GetRow</a> () const </td></tr>
<tr class="memdesc:ace9a79974c326b87f326dcb61443767b"><td class="mdescLeft"> </td><td class="mdescRight">Return the row of the coordinate. <a href="#ace9a79974c326b87f326dcb61443767b"></a><br/></td></tr>
<tr class="separator:ace9a79974c326b87f326dcb61443767b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca53f7cb534c4bcace3ca6a38d0daa55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#aca53f7cb534c4bcace3ca6a38d0daa55">SetRow</a> (int n)</td></tr>
<tr class="memdesc:aca53f7cb534c4bcace3ca6a38d0daa55"><td class="mdescLeft"> </td><td class="mdescRight">Set the row of the coordinate. <a href="#aca53f7cb534c4bcace3ca6a38d0daa55"></a><br/></td></tr>
<tr class="separator:aca53f7cb534c4bcace3ca6a38d0daa55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c32f8878ff7c4cbf0e58c57d6f37bb4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#a0c32f8878ff7c4cbf0e58c57d6f37bb4">GetCol</a> () const </td></tr>
<tr class="memdesc:a0c32f8878ff7c4cbf0e58c57d6f37bb4"><td class="mdescLeft"> </td><td class="mdescRight">Return the column of the coordinate. <a href="#a0c32f8878ff7c4cbf0e58c57d6f37bb4"></a><br/></td></tr>
<tr class="separator:a0c32f8878ff7c4cbf0e58c57d6f37bb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4493db750cc177c86848a1aae9d955de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#a4493db750cc177c86848a1aae9d955de">SetCol</a> (int n)</td></tr>
<tr class="memdesc:a4493db750cc177c86848a1aae9d955de"><td class="mdescLeft"> </td><td class="mdescRight">Set the column of the coordinate. <a href="#a4493db750cc177c86848a1aae9d955de"></a><br/></td></tr>
<tr class="separator:a4493db750cc177c86848a1aae9d955de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad4c0ff5617a7d97a2091c5215b2cfcf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#aad4c0ff5617a7d97a2091c5215b2cfcf">Set</a> (int row, int col)</td></tr>
<tr class="memdesc:aad4c0ff5617a7d97a2091c5215b2cfcf"><td class="mdescLeft"> </td><td class="mdescRight">Set the row and column of the coordinate. <a href="#aad4c0ff5617a7d97a2091c5215b2cfcf"></a><br/></td></tr>
<tr class="separator:aad4c0ff5617a7d97a2091c5215b2cfcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63320439f876339d02fa677a76e47a36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#a63320439f876339d02fa677a76e47a36">operator=</a> (const <a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a> &other)</td></tr>
<tr class="memdesc:a63320439f876339d02fa677a76e47a36"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator for coordinate types. <a href="#a63320439f876339d02fa677a76e47a36"></a><br/></td></tr>
<tr class="separator:a63320439f876339d02fa677a76e47a36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62cec9b96e8c2ccdd9f8b43ca826173a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#a62cec9b96e8c2ccdd9f8b43ca826173a">operator==</a> (const <a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a> &other) const </td></tr>
<tr class="memdesc:a62cec9b96e8c2ccdd9f8b43ca826173a"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#a62cec9b96e8c2ccdd9f8b43ca826173a"></a><br/></td></tr>
<tr class="separator:a62cec9b96e8c2ccdd9f8b43ca826173a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2938ea4829f756e5598d1c2a2636e646"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#a2938ea4829f756e5598d1c2a2636e646">operator!=</a> (const <a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a> &other) const </td></tr>
<tr class="memdesc:a2938ea4829f756e5598d1c2a2636e646"><td class="mdescLeft"> </td><td class="mdescRight">Inequality operator. <a href="#a2938ea4829f756e5598d1c2a2636e646"></a><br/></td></tr>
<tr class="separator:a2938ea4829f756e5598d1c2a2636e646"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72955f4a4fda295a16a2a8779e35889e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_grid_cell_coords.html#a72955f4a4fda295a16a2a8779e35889e">operator!</a> () const </td></tr>
<tr class="memdesc:a72955f4a4fda295a16a2a8779e35889e"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the coordinates are invalid. <a href="#a72955f4a4fda295a16a2a8779e35889e"></a><br/></td></tr>
<tr class="separator:a72955f4a4fda295a16a2a8779e35889e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a893fbd641ec1f3da9e33da80c20aaf1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxGridCellCoords::wxGridCellCoords </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor initializes the object to invalid state. </p>
<p>Initially the row and column are both invalid (-1) and so <a class="el" href="classwx_grid_cell_coords.html#a72955f4a4fda295a16a2a8779e35889e" title="Checks whether the coordinates are invalid.">operator!()</a> for an uninitialized <a class="el" href="classwx_grid_cell_coords.html" title="Represents coordinates of a grid cell.">wxGridCellCoords</a> returns false. </p>
</div>
</div>
<a class="anchor" id="ad1ee986fb15055b03840583bb8771c6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxGridCellCoords::wxGridCellCoords </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>col</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor taking a row and a column. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0c32f8878ff7c4cbf0e58c57d6f37bb4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wxGridCellCoords::GetCol </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the column of the coordinate. </p>
</div>
</div>
<a class="anchor" id="ace9a79974c326b87f326dcb61443767b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wxGridCellCoords::GetRow </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the row of the coordinate. </p>
</div>
</div>
<a class="anchor" id="a72955f4a4fda295a16a2a8779e35889e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxGridCellCoords::operator! </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the coordinates are invalid. </p>
<p>Returns false only if both row and column are -1. Notice that if either row or column (but not both) are -1, this method returns true even if the object is invalid. This is done because objects in such state should actually never exist, i.e. either both coordinates should be -1 or none of them should be -1. </p>
</div>
</div>
<a class="anchor" id="a2938ea4829f756e5598d1c2a2636e646"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_grid_cell_coords.html#a72955f4a4fda295a16a2a8779e35889e">wxGridCellCoords::operator!</a>= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inequality operator. </p>
</div>
</div>
<a class="anchor" id="a63320439f876339d02fa677a76e47a36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a>& wxGridCellCoords::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator for coordinate types. </p>
</div>
</div>
<a class="anchor" id="a62cec9b96e8c2ccdd9f8b43ca826173a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wxGridCellCoords::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_grid_cell_coords.html">wxGridCellCoords</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator. </p>
</div>
</div>
<a class="anchor" id="aad4c0ff5617a7d97a2091c5215b2cfcf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxGridCellCoords::Set </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>col</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the row and column of the coordinate. </p>
</div>
</div>
<a class="anchor" id="a4493db750cc177c86848a1aae9d955de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxGridCellCoords::SetCol </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the column of the coordinate. </p>
</div>
</div>
<a class="anchor" id="aca53f7cb534c4bcace3ca6a38d0daa55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxGridCellCoords::SetRow </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the row of the coordinate. </p>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:48 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>
|
