add events API to wxHtmlWindow (patch #1504493 by Francesco Montorsi)

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

diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex
index 67a8e7080b3a82c95dc619be10d4254395ceb9dc..7d7826fd16ff96c09c9a2f4ec0b8b9ec2324768b 100644 (file)
--- a/docs/latex/wx/gridedit.tex
+++ b/docs/latex/wx/gridedit.tex
@@ -3,89 +3,171 @@
 % grid.h at 11/May/00 18:30:18
 %
 
 % grid.h at 11/May/00 18:30:18
 %
 

+\section{\class{wxGridCellBoolEditor}}\label{wxgridcellbooleditor}

 
 

-\section{\class{wxGridCellEditor}}\label{wxgridcelleditor}
+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]]"

 
 

-wxGridCellEditor:  This class is responsible for providing and manipulating
+\section{\class{wxGridCellEditor}}\label{wxgridcelleditor}
+
+This class is responsible for providing and manipulating

 the in-place edit controls for the grid.  Instances of wxGridCellEditor
 the in-place edit controls for the grid.  Instances of wxGridCellEditor

-(actually, instances of derived classes since it is an ABC) can be
+(actually, instances of derived classes since it is an abstract class) can be

 associated with the cell attributes for individual cells, rows, columns, or
 even for the entire grid.
 
 associated with the cell attributes for individual cells, rows, columns, or
 even for the entire grid.
 

-

 \wxheading{Derived from}
 
 \wxheading{Derived from}
 

-\helpref{wxGridCellWorker}{wxgridcellworker}
+wxGridCellWorker

 
 

-\wxheading{Data structures}
+\wxheading{See also}

 
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+\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}}}

 
 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
 
 \func{}{wxGridCellEditor}{\void}
 
 
 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
 
 \func{}{wxGridCellEditor}{\void}
 

-

 \membersection{wxGridCellEditor::IsCreated}\label{wxgridcelleditoriscreated}
 
 \func{bool}{IsCreated}{\void}
 
 \membersection{wxGridCellEditor::IsCreated}\label{wxgridcelleditoriscreated}
 
 \func{bool}{IsCreated}{\void}
 

-

 \membersection{wxGridCellEditor::Create}\label{wxgridcelleditorcreate}
 
 \func{void}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{wxEvtHandler* }{evtHandler}}
 
 \membersection{wxGridCellEditor::Create}\label{wxgridcelleditorcreate}
 
 \func{void}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{wxEvtHandler* }{evtHandler}}
 

-Creates the actual edit control
-
+Creates the actual edit control.

 
 \membersection{wxGridCellEditor::SetSize}\label{wxgridcelleditorsetsize}
 
 \func{void}{SetSize}{\param{const wxRect\& }{rect}}
 
 
 \membersection{wxGridCellEditor::SetSize}\label{wxgridcelleditorsetsize}
 
 \func{void}{SetSize}{\param{const wxRect\& }{rect}}
 

-Size and position the edit control
-
+Size and position the edit control.

 
 \membersection{wxGridCellEditor::Show}\label{wxgridcelleditorshow}
 
 \func{void}{Show}{\param{bool }{show}, \param{wxGridCellAttr* }{attr = NULL}}
 
 Show or hide the edit control, use the specified attributes to set
 
 \membersection{wxGridCellEditor::Show}\label{wxgridcelleditorshow}
 
 \func{void}{Show}{\param{bool }{show}, \param{wxGridCellAttr* }{attr = NULL}}
 
 Show or hide the edit control, use the specified attributes to set

-colours/fonts for it
-
+colours/fonts for it.

 
 \membersection{wxGridCellEditor::PaintBackground}\label{wxgridcelleditorpaintbackground}
 
 \func{void}{PaintBackground}{\param{const wxRect\& }{rectCell}, \param{wxGridCellAttr* }{attr}}
 
 Draws the part of the cell not occupied by the control: the base class
 
 \membersection{wxGridCellEditor::PaintBackground}\label{wxgridcelleditorpaintbackground}
 
 \func{void}{PaintBackground}{\param{const wxRect\& }{rectCell}, \param{wxGridCellAttr* }{attr}}
 
 Draws the part of the cell not occupied by the control: the base class

-version just fills it with background colour from the attribute
-
+version just fills it with background colour from the attribute.

 
 \membersection{wxGridCellEditor::BeginEdit}\label{wxgridcelleditorbeginedit}
 
 \func{void}{BeginEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}}
 
 Fetch the value from the table and prepare the edit control
 
 \membersection{wxGridCellEditor::BeginEdit}\label{wxgridcelleditorbeginedit}
 
 \func{void}{BeginEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}}
 
 Fetch the value from the table and prepare the edit control

-to begin editing.  Set the focus to the edit control.
-
+to begin editing. Set the focus to the edit control.

 
 \membersection{wxGridCellEditor::EndEdit}\label{wxgridcelleditorendedit}
 
 \func{bool}{EndEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}}
 
 Complete the editing of the current cell. Returns true if the value has
 
 \membersection{wxGridCellEditor::EndEdit}\label{wxgridcelleditorendedit}
 
 \func{bool}{EndEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}}
 
 Complete the editing of the current cell. Returns true if the value has

-changed.  If necessary, the control may be destroyed.
-
+changed. If necessary, the control may be destroyed.

 
 \membersection{wxGridCellEditor::Reset}\label{wxgridcelleditorreset}
 
 \func{void}{Reset}{\void}
 
 
 \membersection{wxGridCellEditor::Reset}\label{wxgridcelleditorreset}
 
 \func{void}{Reset}{\void}
 

-Reset the value in the control back to its starting value
-
+Reset the value in the control back to its starting value.

 
 \membersection{wxGridCellEditor::StartingKey}\label{wxgridcelleditorstartingkey}
 
 
 \membersection{wxGridCellEditor::StartingKey}\label{wxgridcelleditorstartingkey}
 


@@ -95,14 +177,12 @@ If the editor is enabled by pressing keys on the grid,
 this will be called to let the editor do something about
 that first key if desired.
 
 this will be called to let the editor do something about
 that first key if desired.
 

-

 \membersection{wxGridCellEditor::StartingClick}\label{wxgridcelleditorstartingclick}
 
 \func{void}{StartingClick}{\void}
 
 \membersection{wxGridCellEditor::StartingClick}\label{wxgridcelleditorstartingclick}
 
 \func{void}{StartingClick}{\void}
 

-if the editor is enabled by clicking on the cell, this method will be
-called
-
+If the editor is enabled by clicking on the cell, this method will be
+called.

 
 \membersection{wxGridCellEditor::HandleReturn}\label{wxgridcelleditorhandlereturn}
 
 
 \membersection{wxGridCellEditor::HandleReturn}\label{wxgridcelleditorhandlereturn}
 


@@ -111,24 +191,150 @@ called
 Some types of controls on some platforms may need some help
 with the Return key.
 
 Some types of controls on some platforms may need some help
 with the Return key.
 

-

 \membersection{wxGridCellEditor::Destroy}\label{wxgridcelleditordestroy}
 
 \func{void}{Destroy}{\void}
 
 \membersection{wxGridCellEditor::Destroy}\label{wxgridcelleditordestroy}
 
 \func{void}{Destroy}{\void}
 

-Final cleanup
-
+Final cleanup.

 
 \membersection{wxGridCellEditor::Clone}\label{wxgridcelleditorclone}
 
 \constfunc{wxGridCellEditor*}{Clone}{\void}
 
 
 \membersection{wxGridCellEditor::Clone}\label{wxgridcelleditorclone}
 
 \constfunc{wxGridCellEditor*}{Clone}{\void}
 

-create a new object which is the copy of this one
-
+Create a new object which is the copy of this one.

 
 \membersection{wxGridCellEditor::\destruct{wxGridCellEditor}}\label{wxgridcelleditordtor}
 
 \func{}{\destruct{wxGridCellEditor}}{\void}
 
 
 \membersection{wxGridCellEditor::\destruct{wxGridCellEditor}}\label{wxgridcelleditordtor}
 
 \func{}{\destruct{wxGridCellEditor}}{\void}
 

-the dtor is private because only DecRef() can delete us
+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.
+