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