Some documentation enhancements for wxRichTextCtrl

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

diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex
index 8d1dc603ded725a3770bfb8c713b17dd89ed1631..7d7826fd16ff96c09c9a2f4ec0b8b9ec2324768b 100644 (file)
--- a/docs/latex/wx/gridedit.tex
+++ b/docs/latex/wx/gridedit.tex
@@ -19,6 +19,10 @@ The editor for boolean data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 

+\wxheading{Include files}
+
+<wx/grid.h>
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 


@@ -29,6 +33,25 @@ The editor for boolean data.
 Default constructor.
 
 
 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.
 \section{\class{wxGridCellChoiceEditor}}\label{wxgridcellchoiceeditor}
 
 The editor for string data allowing to choose from a list of strings.


@@ -53,7 +76,7 @@ The editor for string data allowing to choose from a list of strings.
 
 \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}}
+\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{count}{Number of strings from which the user can choose.}
 \docparam{choices}{An array of strings from which the user can choose.}


@@ -86,6 +109,10 @@ wxGridCellWorker
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 

+\wxheading{Include files}
+
+<wx/grid.h>
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}


@@ -200,9 +227,11 @@ The editor for floating point numbers data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 

+\wxheading{Include files}

 
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>

 
 

+\latexignore{\rtfignore{\wxheading{Members}}}

 
 \membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr}
 
 
 \membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr}
 


@@ -237,9 +266,11 @@ The editor for numeric integer data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 

+\wxheading{Include files}

 
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>

 
 

+\latexignore{\rtfignore{\wxheading{Members}}}

 
 \membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr}
 
 
 \membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr}
 


@@ -287,6 +318,10 @@ The editor for string/text data.
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 

+\wxheading{Include files}
+
+<wx/grid.h>
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}