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 \latexignore{\rtfignore{\wxheading{Members}}}
  26
  27 \membersection{wxGridEditorCreatedEvent::wxGridEditorCreatedEvent}\label{wxgrideditorcreatedeventconstr}
  28
  29 \func{}{wxGridEditorCreatedEvent}{\void}
  30
  31 Default constructor.
  32
  33 \func{}{wxGridEditorCreatedEvent}{\param{int }{id}, \param{wxEventType }{type},
  34  \param{wxObject* }{obj}, \param{int }{row}, \param{int }{col}, \param{wxControl* }{ctrl}}
  35
  36 \membersection{wxGridEditorCreatedEvent::GetCol}\label{wxgrideditorcreatedeventgetcol}
  37
  38 \func{int}{GetCol}{\void}
  39
  40 Returns the column at which the event occurred.
  41
  42 \membersection{wxGridEditorCreatedEvent::GetControl}\label{wxgrideditorcreatedeventgetcontrol}
  43
  44 \func{wxControl*}{GetControl}{\void}
  45
  46 Returns the edit control.
  47
  48 \membersection{wxGridEditorCreatedEvent::GetRow}\label{wxgrideditorcreatedeventgetrow}
  49
  50 \func{int}{GetRow}{\void}
  51
  52 Returns the row at which the event occurred.
  53
  54 \membersection{wxGridEditorCreatedEvent::SetCol}\label{wxgrideditorcreatedeventsetcol}
  55
  56 \func{void}{SetCol}{\param{int }{col}}
  57
  58 Sets the column at which the event occurred.
  59
  60 \membersection{wxGridEditorCreatedEvent::SetControl}\label{wxgrideditorcreatedeventsetcontrol}
  61
  62 \func{void}{SetControl}{\param{wxControl* }{ctrl}}
  63
  64 Sets the edit control.
  65
  66 \membersection{wxGridEditorCreatedEvent::SetRow}\label{wxgrideditorcreatedeventsetrow}
  67
  68 \func{void}{SetRow}{\param{int }{row}}
  69
  70 Sets the row at which the event occurred.
  71
  72 \section{\class{wxGridEvent}}\label{wxgridevent}
  73
  74 This event class contains information about various grid events.
  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
  89 \input gridevt.inc
  90
  91 \latexignore{\rtfignore{\wxheading{Members}}}
  92
  93 \membersection{wxGridEvent::wxGridEvent}\label{wxgrideventconstr}
  94
  95 \func{}{wxGridEvent}{\void}
  96
  97 Default constructor.
  98
  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},
 101  \param{bool }{sel = true}, \param{bool }{control = false}, \param{bool }{shift = false},
 102  \param{bool }{alt = false}, \param{bool }{meta = false}}
 103
 104 \wxheading{Parameters}
 105
 106 \membersection{wxGridEvent::AltDown}\label{wxgrideventaltdown}
 107
 108 \func{bool}{AltDown}{\void}
 109
 110 Returns true if the Alt key was down at the time of the event.
 111
 112 \membersection{wxGridEvent::ControlDown}\label{wxgrideventcontroldown}
 113
 114 \func{bool}{ControlDown}{\void}
 115
 116 Returns true if the Control key was down at the time of the event.
 117
 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}
 125
 126 \func{wxPoint}{GetPosition}{\void}
 127
 128 Position in pixels at which the event occurred.
 129
 130 \membersection{wxGridEvent::GetRow}\label{wxgrideventgetrow}
 131
 132 \func{int}{GetRow}{\void}
 133
 134 Row at which the event occurred.
 135
 136 \membersection{wxGridEvent::MetaDown}\label{wxgrideventmetadown}
 137
 138 \func{bool}{MetaDown}{\void}
 139
 140 Returns true if the Meta key was down at the time of the event.
 141
 142 \membersection{wxGridEvent::Selecting}\label{wxgrideventselecting}
 143
 144 \func{bool}{Selecting}{\void}
 145
 146 Returns true if the user is selecting grid cells, false -- if
 147 deselecting.
 148
 149 \membersection{wxGridEvent::ShiftDown}\label{wxgrideventshiftdown}
 150
 151 \func{bool}{ShiftDown}{\void}
 152
 153 Returns true if the Shift key was down at the time of the event.
 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.
 168 The ...\_CMD\_... variants also take a window identifier.
 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.}
 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.}
 174 \end{twocollist}%
 175
 176 \wxheading{Include files}
 177
 178 <wx/grid.h>
 179
 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},
 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}}
 193
 194 \membersection{wxGridRangeSelectEvent::AltDown}\label{wxgridrangeselecteventaltdown}
 195
 196 \func{bool}{AltDown}{\void}
 197
 198 Returns true if the Alt key was down at the time of the event.
 199
 200 \membersection{wxGridRangeSelectEvent::ControlDown}\label{wxgridrangeselecteventcontroldown}
 201
 202 \func{bool}{ControlDown}{\void}
 203
 204 Returns true if the Control key was down at the time of the event.
 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
 222 Left column of the rectangular area that was (de)selected.
 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
 234 Top left corner of the rectangular area that was (de)selected.
 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
 246 Returns true if the Meta key was down at the time of the event.
 247
 248 \membersection{wxGridRangeSelectEvent::Selecting}\label{wxgridrangeselecteventselecting}
 249
 250 \func{bool}{Selecting}{\void}
 251
 252 Returns true if the area was selected, false otherwise.
 253
 254 \membersection{wxGridRangeSelectEvent::ShiftDown}\label{wxgridrangeselecteventshiftdown}
 255
 256 \func{bool}{ShiftDown}{\void}
 257
 258 Returns true if the Shift key was down at the time of the event.
 259
 260 \section{\class{wxGridSizeEvent}}\label{wxgridsizeevent}
 261
 262 This event class contains information about a row/column resize event.
 263
 264 \wxheading{Derived from}
 265
 266 \helpref{wxNotifyEvent}{wxnotifyevent}\\
 267 \helpref{wxCommandEvent}{wxcommandevent}\\
 268 \helpref{wxEvent}{wxevent}\\
 269 \helpref{wxObject}{wxobject}
 270
 271 \wxheading{Include files}
 272
 273 <wx/grid.h>
 274
 275 \wxheading{Event handling}
 276
 277 The event handler for the following functions takes a
 278  \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter.
 279 The ...\_CMD\_... variants also take a window identifier.
 280
 281 \twocolwidtha{7cm}
 282 \begin{twocollist}\itemsep=0pt
 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.}
 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.}
 287 \end{twocollist}%
 288
 289 \latexignore{\rtfignore{\wxheading{Members}}}
 290
 291 \membersection{wxGridSizeEvent::wxGridSizeEvent}\label{wxgridsizeeventconstr}
 292
 293 \func{}{wxGridSizeEvent}{\void}
 294
 295 Default constructor.
 296
 297 \func{}{wxGridSizeEvent}{\param{int }{id}, \param{wxEventType }{type},
 298  \param{wxObject* }{obj}, \param{int }{rowOrCol = -1}, \param{int }{x = -1},
 299  \param{int }{y = -1}, \param{bool }{control = false}, \param{bool }{shift = false},
 300  \param{bool }{alt = false}, \param{bool }{meta = false}}
 301
 302 \membersection{wxGridSizeEvent::AltDown}\label{wxgridsizeeventaltdown}
 303
 304 \func{bool}{AltDown}{\void}
 305
 306 Returns true if the Alt key was down at the time of the event.
 307
 308 \membersection{wxGridSizeEvent::ControlDown}\label{wxgridsizeeventcontroldown}
 309
 310 \func{bool}{ControlDown}{\void}
 311
 312 Returns true if the Control key was down at the time of the event.
 313
 314 \membersection{wxGridSizeEvent::GetPosition}\label{wxgridsizeeventgetposition}
 315
 316 \func{wxPoint}{GetPosition}{\void}
 317
 318 Position in pixels at which the event occurred.
 319
 320 \membersection{wxGridSizeEvent::GetRowOrCol}\label{wxgridsizeeventgetroworcol}
 321
 322 \func{int}{GetRowOrCol}{\void}
 323
 324 Row or column at that was resized.
 325
 326 \membersection{wxGridSizeEvent::MetaDown}\label{wxgridsizeeventmetadown}
 327
 328 \func{bool}{MetaDown}{\void}
 329
 330 Returns true if the Meta key was down at the time of the event.
 331
 332 \membersection{wxGridSizeEvent::ShiftDown}\label{wxgridsizeeventshiftdown}
 333
 334 \func{bool}{ShiftDown}{\void}
 335
 336 Returns true if the Shift key was down at the time of the event.
 337