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