Updated docs for wxGrid: added events, event macros, default editors and renderers

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13174 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Mattia Barbon
2001-12-23 21:26:11 +00:00
parent a7b51bc869
commit cbc95b2cc9
7 changed files with 696 additions and 3 deletions

View File

@@ -15,7 +15,13 @@ 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}
\latexignore{\rtfignore{\wxheading{Members}}}
@@ -113,3 +119,184 @@ Create a new object which is the copy of this one.
The dtor is private because only DecRef() can delete us.
\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}
\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.
\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}
\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{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}
\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{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}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGridCellBoolEditor::wxGridCellBoolEditor}\label{wxgridcellbooleditorconstr}
\func{}{wxGridCellBoolEditor}{}
Default constructor.
\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}}
\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]]"