docs/latex/wx/gridevt.tex

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