X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2eebb742abc099384323c2b106fa819803202a11..5a70d3f578cdd6939616505d5a38c001a5cc7692:/docs/latex/wx/gridedit.tex

diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex
index 639a300d6e..7d7826fd16 100644
--- a/docs/latex/wx/gridedit.tex
+++ b/docs/latex/wx/gridedit.tex
@@ -3,6 +3,92 @@
 % grid.h at 11/May/00 18:30:18
 %
 
+\section{\class{wxGridCellBoolEditor}}\label{wxgridcellbooleditor}
+
+The editor for boolean data.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor}
+
+\wxheading{See also}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
+\helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
+\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
+\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
+
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxGridCellBoolEditor::wxGridCellBoolEditor}\label{wxgridcellbooleditorconstr}
+
+\func{}{wxGridCellBoolEditor}{}
+
+Default constructor.
+
+
+\membersection{wxGridCellBoolEditor::IsTrueValue}\label{wxgridcellbooleditoristruevalue}
+
+\func{static bool}{IsTrueValue}{\param{const wxString\& }{value}}
+
+Returns \true if the given \arg{value} is equal to the string representation of
+the truth value we currently use (see 
+\helpref{UseStringValues}{wxgridcellbooleditorusestringvalues}).
+
+
+\membersection{wxGridCellBoolEditor::UseStringValues}\label{wxgridcellbooleditorusestringvalues}
+
+\func{static void}{UseStringValues}{\param{const wxString\& }{valueTrue = \_T("1")}, \param{const wxString\& }{valueFalse = \_T("")}}
+
+This method allows to customize the values returned by GetValue() method for
+the cell using this editor. By default, the default values of the arguments are
+used, i.e. \texttt{"1"} is returned if the cell is checked and an empty string
+otherwise, using this method allows to change this.
+
+
+\section{\class{wxGridCellChoiceEditor}}\label{wxgridcellchoiceeditor}
+
+The editor for string data allowing to choose from a list of strings.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor}
+
+\wxheading{See also}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
+\helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
+\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
+\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor}
+
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxGridCellChoiceEditor::wxGridCellChoiceEditor}\label{wxgridcellchoiceeditorconstr}
+
+\func{}{wxGridCellChoiceEditor}{\param{size\_t }{count = 0}, \param{const wxString }{choices[] = NULL}, \param{bool }{allowOthers = false}}
+
+\func{}{wxGridCellChoiceEditor}{\param{const wxArrayString\& }{choices}, \param{bool }{allowOthers = false}}
+
+\docparam{count}{Number of strings from which the user can choose.}
+\docparam{choices}{An array of strings from which the user can choose.}
+\docparam{allowOthers}{If allowOthers if true, the user can type a string not in choices array.}
+
+
+\membersection{wxGridCellChoiceEditor::SetParameters}\label{wxgridcellchoiceeditorsetparameters}
+
+\func{void}{SetParameters}{\param{const wxString\& }{params}}
+
+Parameters string format is "item1[,item2[...,itemN]]"
+
 \section{\class{wxGridCellEditor}}\label{wxgridcelleditor}
 
 This class is responsible for providing and manipulating
@@ -15,7 +101,17 @@ even for the entire grid.
 
 wxGridCellWorker
 
-\wxheading{Data structures}
+\wxheading{See also}
+
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
+\helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
+\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
+\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
+\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
+
+\wxheading{Include files}
+
+<wx/grid.h>
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -113,3 +209,132 @@ Create a new object which is the copy of this one.
 
 The dtor is private because only DecRef() can delete us.
 
+
+\section{\class{wxGridCellFloatEditor}}\label{wxgridcellfloateditor}
+
+The editor for floating point numbers data.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor}\\
+\helpref{wxGridCellEditor}{wxgridcelleditor}
+
+\wxheading{See also}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
+\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
+\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
+\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
+
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr}
+
+\func{}{wxGridCellFloatEditor}{\param{int }{width = -1}, \param{int }{precision = -1}}
+
+\docparam{width}{Minimum number of characters to be shown.}
+\docparam{precision}{Number of digits after the decimal dot.}
+
+
+\membersection{wxGridCellFloatEditor::SetParameters}\label{wxgridcellfloateditorsetparameters}
+
+\func{void}{SetParameters}{\param{const wxString\& }{params}}
+
+Parameters string format is "width,precision"
+
+
+
+\section{\class{wxGridCellNumberEditor}}\label{wxgridcellnumbereditor}
+
+The editor for numeric integer data.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor}\\
+\helpref{wxGridCellEditor}{wxgridcelleditor}
+
+\wxheading{See also}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
+\helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
+\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
+\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
+
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr}
+
+\func{}{wxGridCellNumberEditor}{\param{int }{min = -1}, \param{int }{max = -1}}
+
+Allows to specify the range for acceptable data;
+if min == max == -1, no range checking is done
+
+
+\membersection{wxGridCellNumberEditor::GetString}\label{wxgridcellnumbereditorgetstring}
+
+\constfunc{wxString}{GetString}{\void}
+
+String representation of the value.
+
+
+\membersection{wxGridCellNumberEditor::HasRange}\label{wxgridcellnumbereditorhasrange}
+
+\constfunc{bool}{HasRange}{\void}
+
+If the return value is true, the editor uses a wxSpinCtrl to get user input,
+otherwise it uses a wxTextCtrl.
+
+
+\membersection{wxGridCellNumberEditor::SetParameters}\label{wxgridcellnumbereditorsetparameters}
+
+\func{void}{SetParameters}{\param{const wxString\& }{params}}
+
+Parameters string format is "min,max".
+
+
+\section{\class{wxGridCellTextEditor}}\label{wxgridcelltexteditor}
+
+The editor for string/text data.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor}
+
+\wxheading{See also}
+
+\helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp
+\helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp
+\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp
+\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
+\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
+
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxGridCellTextEditor::wxGridCellTextEditor}\label{wxgridcelltexteditorconstr}
+
+\func{}{wxGridCellTextEditor}{\void}
+
+Default constructor.
+
+\membersection{wxGridCellTextEditor::SetParameters}\label{wxgridcelltexteditorsetparameters}
+
+\func{void}{SetParameters}{\param{const wxString\& }{params}}
+
+The parameters string format is "n" where n is a number representing the maximum width.
+
+