docs/latex/wx/gridedit.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % grid.h at 11/May/00 18:30:18
   4 %
   5
   6 \section{\class{wxGridCellBoolEditor}}\label{wxgridcellbooleditor}
   7
   8 The editor for boolean data.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxGridCellEditor}{wxgridcelleditor}
  13
  14 \wxheading{See also}
  15
  16 \helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
  17 \helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
  18 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
  19 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
  20 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
  21
  22 \wxheading{Include files}
  23
  24 <wx/grid.h>
  25
  26 \wxheading{Library}
  27
  28 \helpref{wxAdv}{librarieslist}
  29
  30 \latexignore{\rtfignore{\wxheading{Members}}}
  31
  32
  33 \membersection{wxGridCellBoolEditor::wxGridCellBoolEditor}\label{wxgridcellbooleditorconstr}
  34
  35 \func{}{wxGridCellBoolEditor}{}
  36
  37 Default constructor.
  38
  39
  40 \membersection{wxGridCellBoolEditor::IsTrueValue}\label{wxgridcellbooleditoristruevalue}
  41
  42 \func{static bool}{IsTrueValue}{\param{const wxString\& }{value}}
  43
  44 Returns \true if the given \arg{value} is equal to the string representation of
  45 the truth value we currently use (see
  46 \helpref{UseStringValues}{wxgridcellbooleditorusestringvalues}).
  47
  48
  49 \membersection{wxGridCellBoolEditor::UseStringValues}\label{wxgridcellbooleditorusestringvalues}
  50
  51 \func{static void}{UseStringValues}{\param{const wxString\& }{valueTrue = \_T("1")}, \param{const wxString\& }{valueFalse = \_T("")}}
  52
  53 This method allows to customize the values returned by GetValue() method for
  54 the cell using this editor. By default, the default values of the arguments are
  55 used, i.e. \texttt{"1"} is returned if the cell is checked and an empty string
  56 otherwise, using this method allows to change this.
  57
  58
  59 \section{\class{wxGridCellChoiceEditor}}\label{wxgridcellchoiceeditor}
  60
  61 The editor for string data allowing to choose from a list of strings.
  62
  63 \wxheading{Derived from}
  64
  65 \helpref{wxGridCellEditor}{wxgridcelleditor}
  66
  67 \wxheading{See also}
  68
  69 \helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
  70 \helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
  71 \helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
  72 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
  73 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor}
  74
  75
  76 \latexignore{\rtfignore{\wxheading{Members}}}
  77
  78
  79 \membersection{wxGridCellChoiceEditor::wxGridCellChoiceEditor}\label{wxgridcellchoiceeditorconstr}
  80
  81 \func{}{wxGridCellChoiceEditor}{\param{size\_t }{count = 0}, \param{const wxString }{choices[] = NULL}, \param{bool }{allowOthers = false}}
  82
  83 \func{}{wxGridCellChoiceEditor}{\param{const wxArrayString\& }{choices}, \param{bool }{allowOthers = false}}
  84
  85 \docparam{count}{Number of strings from which the user can choose.}
  86 \docparam{choices}{An array of strings from which the user can choose.}
  87 \docparam{allowOthers}{If allowOthers is true, the user can type a string not in choices array.}
  88
  89
  90 \membersection{wxGridCellChoiceEditor::SetParameters}\label{wxgridcellchoiceeditorsetparameters}
  91
  92 \func{void}{SetParameters}{\param{const wxString\& }{params}}
  93
  94 Parameters string format is "item1[,item2[...,itemN]]"
  95
  96 \section{\class{wxGridCellEditor}}\label{wxgridcelleditor}
  97
  98 This class is responsible for providing and manipulating
  99 the in-place edit controls for the grid.  Instances of wxGridCellEditor
 100 (actually, instances of derived classes since it is an abstract class) can be
 101 associated with the cell attributes for individual cells, rows, columns, or
 102 even for the entire grid.
 103
 104 \wxheading{Derived from}
 105
 106 wxGridCellWorker
 107
 108 \wxheading{See also}
 109
 110 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 111 \helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
 112 \helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
 113 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 114 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 115
 116 \wxheading{Include files}
 117
 118 <wx/grid.h>
 119
 120 \wxheading{Library}
 121
 122 \helpref{wxAdv}{librarieslist}
 123
 124 \wxheading{Library}
 125
 126 \helpref{wxAdv}{librarieslist}
 127
 128 \latexignore{\rtfignore{\wxheading{Members}}}
 129
 130 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
 131
 132 \func{}{wxGridCellEditor}{\void}
 133
 134 \membersection{wxGridCellEditor::IsCreated}\label{wxgridcelleditoriscreated}
 135
 136 \func{bool}{IsCreated}{\void}
 137
 138 \membersection{wxGridCellEditor::Create}\label{wxgridcelleditorcreate}
 139
 140 \func{void}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{wxEvtHandler* }{evtHandler}}
 141
 142 Creates the actual edit control.
 143
 144 \membersection{wxGridCellEditor::SetSize}\label{wxgridcelleditorsetsize}
 145
 146 \func{void}{SetSize}{\param{const wxRect\& }{rect}}
 147
 148 Size and position the edit control.
 149
 150 \membersection{wxGridCellEditor::Show}\label{wxgridcelleditorshow}
 151
 152 \func{void}{Show}{\param{bool }{show}, \param{wxGridCellAttr* }{attr = NULL}}
 153
 154 Show or hide the edit control, use the specified attributes to set
 155 colours/fonts for it.
 156
 157 \membersection{wxGridCellEditor::PaintBackground}\label{wxgridcelleditorpaintbackground}
 158
 159 \func{void}{PaintBackground}{\param{const wxRect\& }{rectCell}, \param{wxGridCellAttr* }{attr}}
 160
 161 Draws the part of the cell not occupied by the control: the base class
 162 version just fills it with background colour from the attribute.
 163
 164 \membersection{wxGridCellEditor::BeginEdit}\label{wxgridcelleditorbeginedit}
 165
 166 \func{void}{BeginEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}}
 167
 168 Fetch the value from the table and prepare the edit control
 169 to begin editing. Set the focus to the edit control.
 170
 171 \membersection{wxGridCellEditor::EndEdit}\label{wxgridcelleditorendedit}
 172
 173 \func{bool}{EndEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}}
 174
 175 Complete the editing of the current cell. Returns true if the value has
 176 changed. If necessary, the control may be destroyed.
 177
 178 \membersection{wxGridCellEditor::Reset}\label{wxgridcelleditorreset}
 179
 180 \func{void}{Reset}{\void}
 181
 182 Reset the value in the control back to its starting value.
 183
 184 \membersection{wxGridCellEditor::StartingKey}\label{wxgridcelleditorstartingkey}
 185
 186 \func{void}{StartingKey}{\param{wxKeyEvent\& }{event}}
 187
 188 If the editor is enabled by pressing keys on the grid,
 189 this will be called to let the editor do something about
 190 that first key if desired.
 191
 192 \membersection{wxGridCellEditor::StartingClick}\label{wxgridcelleditorstartingclick}
 193
 194 \func{void}{StartingClick}{\void}
 195
 196 If the editor is enabled by clicking on the cell, this method will be
 197 called.
 198
 199 \membersection{wxGridCellEditor::HandleReturn}\label{wxgridcelleditorhandlereturn}
 200
 201 \func{void}{HandleReturn}{\param{wxKeyEvent\& }{event}}
 202
 203 Some types of controls on some platforms may need some help
 204 with the Return key.
 205
 206 \membersection{wxGridCellEditor::Destroy}\label{wxgridcelleditordestroy}
 207
 208 \func{void}{Destroy}{\void}
 209
 210 Final cleanup.
 211
 212 \membersection{wxGridCellEditor::Clone}\label{wxgridcelleditorclone}
 213
 214 \constfunc{wxGridCellEditor*}{Clone}{\void}
 215
 216 Create a new object which is the copy of this one.
 217
 218 \membersection{wxGridCellEditor::\destruct{wxGridCellEditor}}\label{wxgridcelleditordtor}
 219
 220 \func{}{\destruct{wxGridCellEditor}}{\void}
 221
 222 The dtor is private because only DecRef() can delete us.
 223
 224
 225 \section{\class{wxGridCellFloatEditor}}\label{wxgridcellfloateditor}
 226
 227 The editor for floating point numbers data.
 228
 229 \wxheading{Derived from}
 230
 231 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor}\\
 232 \helpref{wxGridCellEditor}{wxgridcelleditor}
 233
 234 \wxheading{See also}
 235
 236 \helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
 237 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 238 \helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
 239 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 240 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 241
 242 \wxheading{Include files}
 243
 244 <wx/grid.h>
 245
 246 \wxheading{Library}
 247
 248 \helpref{wxAdv}{librarieslist}
 249
 250 \latexignore{\rtfignore{\wxheading{Members}}}
 251
 252 \membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr}
 253
 254 \func{}{wxGridCellFloatEditor}{\param{int }{width = -1}, \param{int }{precision = -1}}
 255
 256 \docparam{width}{Minimum number of characters to be shown.}
 257 \docparam{precision}{Number of digits after the decimal dot.}
 258
 259
 260 \membersection{wxGridCellFloatEditor::SetParameters}\label{wxgridcellfloateditorsetparameters}
 261
 262 \func{void}{SetParameters}{\param{const wxString\& }{params}}
 263
 264 Parameters string format is "width,precision"
 265
 266
 267
 268 \section{\class{wxGridCellNumberEditor}}\label{wxgridcellnumbereditor}
 269
 270 The editor for numeric integer data.
 271
 272 \wxheading{Derived from}
 273
 274 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor}\\
 275 \helpref{wxGridCellEditor}{wxgridcelleditor}
 276
 277 \wxheading{See also}
 278
 279 \helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
 280 \helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
 281 \helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
 282 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 283 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 284
 285 \wxheading{Include files}
 286
 287 <wx/grid.h>
 288
 289 \wxheading{Library}
 290
 291 \helpref{wxAdv}{librarieslist}
 292
 293 \latexignore{\rtfignore{\wxheading{Members}}}
 294
 295 \membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr}
 296
 297 \func{}{wxGridCellNumberEditor}{\param{int }{min = -1}, \param{int }{max = -1}}
 298
 299 Allows to specify the range for acceptable data;
 300 if min == max == -1, no range checking is done
 301
 302
 303 \membersection{wxGridCellNumberEditor::GetString}\label{wxgridcellnumbereditorgetstring}
 304
 305 \constfunc{wxString}{GetString}{\void}
 306
 307 String representation of the value.
 308
 309
 310 \membersection{wxGridCellNumberEditor::HasRange}\label{wxgridcellnumbereditorhasrange}
 311
 312 \constfunc{bool}{HasRange}{\void}
 313
 314 If the return value is true, the editor uses a wxSpinCtrl to get user input,
 315 otherwise it uses a wxTextCtrl.
 316
 317
 318 \membersection{wxGridCellNumberEditor::SetParameters}\label{wxgridcellnumbereditorsetparameters}
 319
 320 \func{void}{SetParameters}{\param{const wxString\& }{params}}
 321
 322 Parameters string format is "min,max".
 323
 324
 325 \section{\class{wxGridCellTextEditor}}\label{wxgridcelltexteditor}
 326
 327 The editor for string/text data.
 328
 329 \wxheading{Derived from}
 330
 331 \helpref{wxGridCellEditor}{wxgridcelleditor}
 332
 333 \wxheading{See also}
 334
 335 \helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
 336 \helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
 337 \helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
 338 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 339 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 340
 341 \wxheading{Include files}
 342
 343 <wx/grid.h>
 344
 345 \wxheading{Library}
 346
 347 \helpref{wxAdv}{librarieslist}
 348
 349 \latexignore{\rtfignore{\wxheading{Members}}}
 350
 351
 352 \membersection{wxGridCellTextEditor::wxGridCellTextEditor}\label{wxgridcelltexteditorconstr}
 353
 354 \func{}{wxGridCellTextEditor}{\void}
 355
 356 Default constructor.
 357
 358 \membersection{wxGridCellTextEditor::SetParameters}\label{wxgridcelltexteditorsetparameters}
 359
 360 \func{void}{SetParameters}{\param{const wxString\& }{params}}
 361
 362 The parameters string format is "n" where n is a number representing the maximum width.
 363
 364