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