X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cbc95b2cc968d42445fef78b7044c411bf6e894a..180b5b4827d08f1ac13bbb5eca03f775ab35a0b1:/docs/latex/wx/gridedit.tex?ds=inline diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex index 0474225ea6..eda433a9dd 100644 --- a/docs/latex/wx/gridedit.tex +++ b/docs/latex/wx/gridedit.tex @@ -3,6 +3,96 @@ % 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} + + + +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + +\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 is 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 @@ -23,6 +113,18 @@ wxGridCellWorker \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor} +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor} @@ -120,36 +222,47 @@ 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} +\section{\class{wxGridCellFloatEditor}}\label{wxgridcellfloateditor} -The editor for string/text data. +The editor for floating point numbers 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{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp +\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\rtfsp +\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor} +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} +\membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr} -\membersection{wxGridCellTextEditor::wxGridCellTextEditor}\label{wxgridcelltexteditorconstr} +\func{}{wxGridCellFloatEditor}{\param{int }{width = -1}, \param{int }{precision = -1}} -\func{}{wxGridCellTextEditor}{\void} +\docparam{width}{Minimum number of characters to be shown.} +\docparam{precision}{Number of digits after the decimal dot.} -Default constructor. -\membersection{wxGridCellTextEditor::SetParameters}\label{wxgridcelltexteditorsetparameters} +\membersection{wxGridCellFloatEditor::SetParameters}\label{wxgridcellfloateditorsetparameters} \func{void}{SetParameters}{\param{const wxString\& }{params}} -The parameters string format is "n" where n is a number representing the maximum width. +Parameters string format is "width,precision" + \section{\class{wxGridCellNumberEditor}}\label{wxgridcellnumbereditor} @@ -169,9 +282,15 @@ The editor for numeric integer data. \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor} +\wxheading{Include files} -\latexignore{\rtfignore{\wxheading{Members}}} + +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr} @@ -203,45 +322,9 @@ otherwise it uses a wxTextCtrl. 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} +\section{\class{wxGridCellTextEditor}}\label{wxgridcelltexteditor} -The editor for boolean data. +The editor for string/text data. \wxheading{Derived from} @@ -251,52 +334,31 @@ The editor for boolean data. \helpref{wxGridCellEditor}{wxgridcelleditor},\rtfsp \helpref{wxGridCellFloatEditor}{wxgridcellfloateditor},\rtfsp +\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor},\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} +\wxheading{Include files} -\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} +\wxheading{Library} +\helpref{wxAdv}{librarieslist} \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}} +\membersection{wxGridCellTextEditor::wxGridCellTextEditor}\label{wxgridcelltexteditorconstr} -\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.} +\func{}{wxGridCellTextEditor}{\void} +Default constructor. -\membersection{wxGridCellChoiceEditor::SetParameters}\label{wxgridcellchoiceeditorsetparameters} +\membersection{wxGridCellTextEditor::SetParameters}\label{wxgridcelltexteditorsetparameters} \func{void}{SetParameters}{\param{const wxString\& }{params}} -Parameters string format is "item1[,item2[...,itemN]]" +The parameters string format is "n" where n is a number representing the maximum width. +