Commit | Line | Data |
---|---|---|
f3845e88 | 1 | \section{\class{wxGridEditorCreatedEvent}}\label{wxgrideditorcreatedevent} |
cbc95b2c MB |
2 | |
3 | \wxheading{Derived from} | |
4 | ||
cbc95b2c MB |
5 | \helpref{wxCommandEvent}{wxcommandevent}\\ |
6 | \helpref{wxEvent}{wxevent}\\ | |
7 | \helpref{wxObject}{wxobject} | |
8 | ||
cbc95b2c MB |
9 | \wxheading{Event handling} |
10 | ||
f3845e88 VZ |
11 | The event handler for the following functions takes a |
12 | \helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter. | |
24d70590 | 13 | The ...\_CMD\_... variants also take a window identifier. |
f3845e88 VZ |
14 | |
15 | \twocolwidtha{7cm} | |
16 | \begin{twocollist}\itemsep=0pt | |
17 | \twocolitem{{\bf EVT\_GRID\_EDITOR\_CREATED(func)}}{The editor for a cell was created. Processes a wxEVT\_GRID\_EDITOR\_CREATED.} | |
24d70590 | 18 | \twocolitem{{\bf EVT\_GRID\_CMD\_EDITOR\_CREATED(id, func)}}{The editor for a cell was created; variant taking a window identifier. Processes a wxEVT\_GRID\_EDITOR\_CREATED.} |
f3845e88 | 19 | \end{twocollist}% |
cbc95b2c | 20 | |
0e10e38d VZ |
21 | \wxheading{Include files} |
22 | ||
23 | <wx/grid.h> | |
24 | ||
cbc95b2c MB |
25 | \latexignore{\rtfignore{\wxheading{Members}}} |
26 | ||
f3845e88 | 27 | \membersection{wxGridEditorCreatedEvent::wxGridEditorCreatedEvent}\label{wxgrideditorcreatedeventconstr} |
cbc95b2c | 28 | |
f3845e88 | 29 | \func{}{wxGridEditorCreatedEvent}{\void} |
cbc95b2c MB |
30 | |
31 | Default constructor. | |
32 | ||
f3845e88 VZ |
33 | \func{}{wxGridEditorCreatedEvent}{\param{int }{id}, \param{wxEventType }{type}, |
34 | \param{wxObject* }{obj}, \param{int }{row}, \param{int }{col}, \param{wxControl* }{ctrl}} | |
cbc95b2c | 35 | |
f3845e88 | 36 | \membersection{wxGridEditorCreatedEvent::GetCol}\label{wxgrideditorcreatedeventgetcol} |
cbc95b2c MB |
37 | |
38 | \func{int}{GetCol}{\void} | |
39 | ||
f3845e88 | 40 | Returns the column at which the event occurred. |
cbc95b2c | 41 | |
f3845e88 | 42 | \membersection{wxGridEditorCreatedEvent::GetControl}\label{wxgrideditorcreatedeventgetcontrol} |
cbc95b2c | 43 | |
f3845e88 | 44 | \func{wxControl*}{GetControl}{\void} |
cbc95b2c | 45 | |
f3845e88 | 46 | Returns the edit control. |
cbc95b2c | 47 | |
f3845e88 | 48 | \membersection{wxGridEditorCreatedEvent::GetRow}\label{wxgrideditorcreatedeventgetrow} |
cbc95b2c MB |
49 | |
50 | \func{int}{GetRow}{\void} | |
51 | ||
f3845e88 | 52 | Returns the row at which the event occurred. |
cbc95b2c | 53 | |
f3845e88 | 54 | \membersection{wxGridEditorCreatedEvent::SetCol}\label{wxgrideditorcreatedeventsetcol} |
cbc95b2c | 55 | |
f3845e88 | 56 | \func{void}{SetCol}{\param{int }{col}} |
cbc95b2c | 57 | |
f3845e88 | 58 | Sets the column at which the event occurred. |
cbc95b2c | 59 | |
f3845e88 | 60 | \membersection{wxGridEditorCreatedEvent::SetControl}\label{wxgrideditorcreatedeventsetcontrol} |
cbc95b2c | 61 | |
f3845e88 | 62 | \func{void}{SetControl}{\param{wxControl* }{ctrl}} |
cbc95b2c | 63 | |
f3845e88 | 64 | Sets the edit control. |
cbc95b2c | 65 | |
f3845e88 | 66 | \membersection{wxGridEditorCreatedEvent::SetRow}\label{wxgrideditorcreatedeventsetrow} |
cbc95b2c | 67 | |
f3845e88 | 68 | \func{void}{SetRow}{\param{int }{row}} |
cbc95b2c | 69 | |
f3845e88 | 70 | Sets the row at which the event occurred. |
cbc95b2c | 71 | |
f3845e88 | 72 | \section{\class{wxGridEvent}}\label{wxgridevent} |
cbc95b2c | 73 | |
f3845e88 | 74 | This event class contains information about various grid events. |
cbc95b2c MB |
75 | |
76 | \wxheading{Derived from} | |
77 | ||
78 | \helpref{wxNotifyEvent}{wxnotifyevent}\\ | |
79 | \helpref{wxCommandEvent}{wxcommandevent}\\ | |
80 | \helpref{wxEvent}{wxevent}\\ | |
81 | \helpref{wxObject}{wxobject} | |
82 | ||
83 | \wxheading{Include files} | |
84 | ||
85 | <wx/grid.h> | |
86 | ||
87 | \wxheading{Event handling} | |
88 | ||
f3845e88 | 89 | \input gridevt.inc |
cbc95b2c MB |
90 | |
91 | \latexignore{\rtfignore{\wxheading{Members}}} | |
92 | ||
f3845e88 | 93 | \membersection{wxGridEvent::wxGridEvent}\label{wxgrideventconstr} |
cbc95b2c | 94 | |
f3845e88 | 95 | \func{}{wxGridEvent}{\void} |
cbc95b2c MB |
96 | |
97 | Default constructor. | |
98 | ||
f3845e88 VZ |
99 | \func{}{wxGridEvent}{\param{int }{id}, \param{wxEventType }{type}, \param{wxObject* }{obj}, |
100 | \param{int }{row = -1}, \param{int }{col = -1}, \param{int }{x = -1}, \param{int }{y = -1}, | |
cc81d32f VS |
101 | \param{bool }{sel = true}, \param{bool }{control = false}, \param{bool }{shift = false}, |
102 | \param{bool }{alt = false}, \param{bool }{meta = false}} | |
cbc95b2c | 103 | |
f3845e88 VZ |
104 | \wxheading{Parameters} |
105 | ||
106 | \membersection{wxGridEvent::AltDown}\label{wxgrideventaltdown} | |
cbc95b2c MB |
107 | |
108 | \func{bool}{AltDown}{\void} | |
109 | ||
cc81d32f | 110 | Returns true if the Alt key was down at the time of the event. |
cbc95b2c | 111 | |
f3845e88 | 112 | \membersection{wxGridEvent::ControlDown}\label{wxgrideventcontroldown} |
cbc95b2c MB |
113 | |
114 | \func{bool}{ControlDown}{\void} | |
115 | ||
cc81d32f | 116 | Returns true if the Control key was down at the time of the event. |
cbc95b2c | 117 | |
f3845e88 VZ |
118 | \membersection{wxGridEvent::GetCol}\label{wxgrideventgetcol} |
119 | ||
120 | \func{int}{GetCol}{\void} | |
121 | ||
122 | Column at which the event occurred. | |
123 | ||
124 | \membersection{wxGridEvent::GetPosition}\label{wxgrideventgetposition} | |
cbc95b2c MB |
125 | |
126 | \func{wxPoint}{GetPosition}{\void} | |
127 | ||
128 | Position in pixels at which the event occurred. | |
129 | ||
f3845e88 | 130 | \membersection{wxGridEvent::GetRow}\label{wxgrideventgetrow} |
cbc95b2c | 131 | |
f3845e88 | 132 | \func{int}{GetRow}{\void} |
cbc95b2c | 133 | |
2edb0bde | 134 | Row at which the event occurred. |
cbc95b2c | 135 | |
f3845e88 | 136 | \membersection{wxGridEvent::MetaDown}\label{wxgrideventmetadown} |
cbc95b2c MB |
137 | |
138 | \func{bool}{MetaDown}{\void} | |
139 | ||
cc81d32f | 140 | Returns true if the Meta key was down at the time of the event. |
cbc95b2c | 141 | |
f3845e88 VZ |
142 | \membersection{wxGridEvent::Selecting}\label{wxgrideventselecting} |
143 | ||
144 | \func{bool}{Selecting}{\void} | |
145 | ||
1e969331 VZ |
146 | Returns true if the user is selecting grid cells, false -- if |
147 | deselecting. | |
f3845e88 VZ |
148 | |
149 | \membersection{wxGridEvent::ShiftDown}\label{wxgrideventshiftdown} | |
cbc95b2c MB |
150 | |
151 | \func{bool}{ShiftDown}{\void} | |
152 | ||
cc81d32f | 153 | Returns true if the Shift key was down at the time of the event. |
cbc95b2c MB |
154 | |
155 | \section{\class{wxGridRangeSelectEvent}}\label{wxgridrangeselectevent} | |
156 | ||
157 | \wxheading{Derived from} | |
158 | ||
159 | \helpref{wxNotifyEvent}{wxnotifyevent}\\ | |
160 | \helpref{wxCommandEvent}{wxcommandevent}\\ | |
161 | \helpref{wxEvent}{wxevent}\\ | |
162 | \helpref{wxObject}{wxobject} | |
163 | ||
164 | \wxheading{Event handling} | |
165 | ||
166 | The event handler for the following functions takes a | |
167 | \helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter. | |
24d70590 | 168 | The ...\_CMD\_... variants also take a window identifier. |
cbc95b2c MB |
169 | |
170 | \twocolwidtha{7cm} | |
171 | \begin{twocollist}\itemsep=0pt | |
172 | \twocolitem{{\bf EVT\_GRID\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells. Processes a wxEVT\_GRID\_RANGE\_SELECT.} | |
24d70590 | 173 | \twocolitem{{\bf EVT\_GRID\_CMD\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells; variant taking a window identifier. Processes a wxEVT\_GRID\_RANGE\_SELECT.} |
cbc95b2c MB |
174 | \end{twocollist}% |
175 | ||
0e10e38d VZ |
176 | \wxheading{Include files} |
177 | ||
178 | <wx/grid.h> | |
179 | ||
cbc95b2c MB |
180 | \latexignore{\rtfignore{\wxheading{Members}}} |
181 | ||
182 | \membersection{wxGridRangeSelectEvent::wxGridRangeSelectEvent}\label{wxgridrangeselecteventconstr} | |
183 | ||
184 | \func{}{wxGridRangeSelectEvent}{\void} | |
185 | ||
186 | Default constructor. | |
187 | ||
188 | \func{}{wxGridRangeSelectEvent}{\param{int }{id}, \param{wxEventType }{type}, | |
189 | \param{wxObject* }{obj}, \param{const wxGridCellCoords\& }{topLeft}, | |
cc81d32f VS |
190 | \param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{sel = true}, |
191 | \param{bool }{control = false}, \param{bool }{shift = false}, \param{bool }{alt = false}, | |
192 | \param{bool }{meta = false}} | |
cbc95b2c MB |
193 | |
194 | \membersection{wxGridRangeSelectEvent::AltDown}\label{wxgridrangeselecteventaltdown} | |
195 | ||
196 | \func{bool}{AltDown}{\void} | |
197 | ||
cc81d32f | 198 | Returns true if the Alt key was down at the time of the event. |
cbc95b2c MB |
199 | |
200 | \membersection{wxGridRangeSelectEvent::ControlDown}\label{wxgridrangeselecteventcontroldown} | |
201 | ||
202 | \func{bool}{ControlDown}{\void} | |
203 | ||
cc81d32f | 204 | Returns true if the Control key was down at the time of the event. |
cbc95b2c MB |
205 | |
206 | \membersection{wxGridRangeSelectEvent::GetBottomRightCoords}\label{wxgridrangeselecteventgetbottomrightcoords} | |
207 | ||
208 | \func{wxGridCellCoords}{GetBottomRightCoords}{\void} | |
209 | ||
210 | Top left corner of the rectangular area that was (de)selected. | |
211 | ||
212 | \membersection{wxGridRangeSelectEvent::GetBottomRow}\label{wxgridrangeselecteventgetbottomrow} | |
213 | ||
214 | \func{int}{GetBottomRow}{\void} | |
215 | ||
216 | Bottom row of the rectangular area that was (de)selected. | |
217 | ||
218 | \membersection{wxGridRangeSelectEvent::GetLeftCol}\label{wxgridrangeselecteventgetleftcol} | |
219 | ||
220 | \func{int}{GetLeftCol}{\void} | |
221 | ||
2edb0bde | 222 | Left column of the rectangular area that was (de)selected. |
cbc95b2c MB |
223 | |
224 | \membersection{wxGridRangeSelectEvent::GetRightCol}\label{wxgridrangeselecteventgetrightcol} | |
225 | ||
226 | \func{int}{GetRightCol}{\void} | |
227 | ||
228 | Right column of the rectangular area that was (de)selected. | |
229 | ||
230 | \membersection{wxGridRangeSelectEvent::GetTopLeftCoords}\label{wxgridrangeselecteventgettopleftcoords} | |
231 | ||
232 | \func{wxGridCellCoords}{GetTopLeftCoords}{\void} | |
233 | ||
2edb0bde | 234 | Top left corner of the rectangular area that was (de)selected. |
cbc95b2c MB |
235 | |
236 | \membersection{wxGridRangeSelectEvent::GetTopRow}\label{wxgridrangeselecteventgettoprow} | |
237 | ||
238 | \func{int}{GetTopRow}{\void} | |
239 | ||
240 | Top row of the rectangular area that was (de)selected. | |
241 | ||
242 | \membersection{wxGridRangeSelectEvent::MetaDown}\label{wxgridrangeselecteventmetadown} | |
243 | ||
244 | \func{bool}{MetaDown}{\void} | |
245 | ||
cc81d32f | 246 | Returns true if the Meta key was down at the time of the event. |
cbc95b2c MB |
247 | |
248 | \membersection{wxGridRangeSelectEvent::Selecting}\label{wxgridrangeselecteventselecting} | |
249 | ||
250 | \func{bool}{Selecting}{\void} | |
251 | ||
cc81d32f | 252 | Returns true if the area was selected, false otherwise. |
cbc95b2c MB |
253 | |
254 | \membersection{wxGridRangeSelectEvent::ShiftDown}\label{wxgridrangeselecteventshiftdown} | |
255 | ||
256 | \func{bool}{ShiftDown}{\void} | |
257 | ||
cc81d32f | 258 | Returns true if the Shift key was down at the time of the event. |
cbc95b2c | 259 | |
f3845e88 VZ |
260 | \section{\class{wxGridSizeEvent}}\label{wxgridsizeevent} |
261 | ||
262 | This event class contains information about a row/column resize event. | |
cbc95b2c MB |
263 | |
264 | \wxheading{Derived from} | |
265 | ||
f3845e88 | 266 | \helpref{wxNotifyEvent}{wxnotifyevent}\\ |
cbc95b2c MB |
267 | \helpref{wxCommandEvent}{wxcommandevent}\\ |
268 | \helpref{wxEvent}{wxevent}\\ | |
269 | \helpref{wxObject}{wxobject} | |
270 | ||
f3845e88 VZ |
271 | \wxheading{Include files} |
272 | ||
273 | <wx/grid.h> | |
274 | ||
cbc95b2c MB |
275 | \wxheading{Event handling} |
276 | ||
277 | The event handler for the following functions takes a | |
f3845e88 | 278 | \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter. |
24d70590 | 279 | The ...\_CMD\_... variants also take a window identifier. |
cbc95b2c MB |
280 | |
281 | \twocolwidtha{7cm} | |
282 | \begin{twocollist}\itemsep=0pt | |
f3845e88 VZ |
283 | \twocolitem{{\bf EVT\_GRID\_COL\_SIZE(func)}}{The user resized a column by dragging it. Processes a wxEVT\_GRID\_COL\_SIZE.} |
284 | \twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.} | |
24d70590 JS |
285 | \twocolitem{{\bf EVT\_GRID\_CMD\_COL\_SIZE(func)}}{The user resized a column by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_COL\_SIZE.} |
286 | \twocolitem{{\bf EVT\_GRID\_CMD\_ROW\_SIZE(func)}}{The user resized a row by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_ROW\_SIZE.} | |
cbc95b2c MB |
287 | \end{twocollist}% |
288 | ||
289 | \latexignore{\rtfignore{\wxheading{Members}}} | |
290 | ||
f3845e88 | 291 | \membersection{wxGridSizeEvent::wxGridSizeEvent}\label{wxgridsizeeventconstr} |
cbc95b2c | 292 | |
f3845e88 | 293 | \func{}{wxGridSizeEvent}{\void} |
cbc95b2c MB |
294 | |
295 | Default constructor. | |
296 | ||
f3845e88 VZ |
297 | \func{}{wxGridSizeEvent}{\param{int }{id}, \param{wxEventType }{type}, |
298 | \param{wxObject* }{obj}, \param{int }{rowOrCol = -1}, \param{int }{x = -1}, | |
cc81d32f VS |
299 | \param{int }{y = -1}, \param{bool }{control = false}, \param{bool }{shift = false}, |
300 | \param{bool }{alt = false}, \param{bool }{meta = false}} | |
cbc95b2c | 301 | |
f3845e88 | 302 | \membersection{wxGridSizeEvent::AltDown}\label{wxgridsizeeventaltdown} |
cbc95b2c | 303 | |
f3845e88 | 304 | \func{bool}{AltDown}{\void} |
cbc95b2c | 305 | |
cc81d32f | 306 | Returns true if the Alt key was down at the time of the event. |
cbc95b2c | 307 | |
f3845e88 | 308 | \membersection{wxGridSizeEvent::ControlDown}\label{wxgridsizeeventcontroldown} |
cbc95b2c | 309 | |
f3845e88 | 310 | \func{bool}{ControlDown}{\void} |
cbc95b2c | 311 | |
cc81d32f | 312 | Returns true if the Control key was down at the time of the event. |
cbc95b2c | 313 | |
f3845e88 | 314 | \membersection{wxGridSizeEvent::GetPosition}\label{wxgridsizeeventgetposition} |
cbc95b2c | 315 | |
f3845e88 | 316 | \func{wxPoint}{GetPosition}{\void} |
cbc95b2c | 317 | |
f3845e88 | 318 | Position in pixels at which the event occurred. |
cbc95b2c | 319 | |
f3845e88 | 320 | \membersection{wxGridSizeEvent::GetRowOrCol}\label{wxgridsizeeventgetroworcol} |
cbc95b2c | 321 | |
f3845e88 | 322 | \func{int}{GetRowOrCol}{\void} |
cbc95b2c | 323 | |
f3845e88 | 324 | Row or column at that was resized. |
cbc95b2c | 325 | |
f3845e88 | 326 | \membersection{wxGridSizeEvent::MetaDown}\label{wxgridsizeeventmetadown} |
cbc95b2c | 327 | |
f3845e88 | 328 | \func{bool}{MetaDown}{\void} |
cbc95b2c | 329 | |
cc81d32f | 330 | Returns true if the Meta key was down at the time of the event. |
cbc95b2c | 331 | |
f3845e88 | 332 | \membersection{wxGridSizeEvent::ShiftDown}\label{wxgridsizeeventshiftdown} |
cbc95b2c | 333 | |
f3845e88 | 334 | \func{bool}{ShiftDown}{\void} |
cbc95b2c | 335 | |
cc81d32f | 336 | Returns true if the Shift key was down at the time of the event. |
cbc95b2c | 337 |