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