no changes, just come cleanup and more comments

[wxWidgets.git] / docs / latex / wx / gridedit.tex

diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex
index 1ece7cec6b0c867842aa8a00762276d69618613b..eda433a9dd09b007e1e40d669f0ed0cdc181ad28 100644 (file)
--- a/docs/latex/wx/gridedit.tex
+++ b/docs/latex/wx/gridedit.tex
@@ -19,6 +19,14 @@ The editor for boolean data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
@@ -29,6 +37,25 @@ The editor for boolean data.
 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.
@@ -51,11 +78,13 @@ The editor for string data allowing to choose from a list of strings.
 
 \membersection{wxGridCellChoiceEditor::wxGridCellChoiceEditor}\label{wxgridcellchoiceeditorconstr}
 
-\func{}{wxGridCellChoiceEditor}{\param{size\_t }{count = 0}, \param{const wxString }{choices[] = NULL}, \param{bool }{allowOthers = FALSE}}
+\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.}
+\docparam{allowOthers}{If allowOthers is true, the user can type a string not in choices array.}
 
 
 \membersection{wxGridCellChoiceEditor::SetParameters}\label{wxgridcellchoiceeditorsetparameters}
@@ -84,6 +113,18 @@ wxGridCellWorker
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
@@ -198,9 +239,15 @@ The editor for floating point numbers data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>
 
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr}
 
@@ -235,9 +282,15 @@ The editor for numeric integer data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>
 
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr}
 
@@ -285,6 +338,14 @@ The editor for string/text data.
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}