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