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