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