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