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