]> git.saurik.com Git - wxWidgets.git/commitdiff
Updated docs for wxGrid: added events, event macros, default editors and renderers
authorMattia Barbon <mbarbon@cpan.org>
Sun, 23 Dec 2001 21:26:11 +0000 (21:26 +0000)
committerMattia Barbon <mbarbon@cpan.org>
Sun, 23 Dec 2001 21:26:11 +0000 (21:26 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13174 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/classes.tex
docs/latex/wx/grid.tex
docs/latex/wx/gridedit.tex
docs/latex/wx/gridevt.inc [new file with mode: 0644]
docs/latex/wx/gridevt.tex [new file with mode: 0644]
docs/latex/wx/gridrend.tex
docs/latex/wx/noteevt.tex

index a88e48f8876def1f6ac3d5da8be75b2fb5ac1f64..87f02e70b84efdac9d29048169652f9e5b2a6807 100644 (file)
 \input grid.tex
 \input gridattr.tex
 \input gridedit.tex
+\input gridevt.tex
 \input gridrend.tex
 \input gridtbl.tex
 \input gridsizr.tex
index 72824ca7c176e1f15e73d801a78bdf58ab8a2ac4..f99e99099deaa01e4492c8e6aab173d1fc10c9f9 100644 (file)
@@ -36,6 +36,33 @@ There are presently no specific window styles for wxGrid.
 
 \wxheading{Event handling}
 
+\input gridevt.inc
+
+The event handler for the following functions takes a 
+ \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_COL\_SIZE(func)}}{The user resized a column by dragging it. Processes a wxEVT\_GRID\_COL\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.}
+\end{twocollist}%
+
+The event handler for the following functions takes a 
+ \helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
+\end{twocollist}%
+
+The event handler for the following functions takes a 
+ \helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_EDITOR\_CREATED(func)}}{The editor for a cell was created. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
+\end{twocollist}%
+
 \wxheading{See also}
 
 \helpref{wxGrid overview}{gridoverview}
index 639a300d6e736f19f900bf613393fb7ed4cb7daf..0474225ea6300b5786392dfeb8b652c9f240c33b 100644 (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]]"
+
diff --git a/docs/latex/wx/gridevt.inc b/docs/latex/wx/gridevt.inc
new file mode 100644 (file)
index 0000000..5db0245
--- /dev/null
@@ -0,0 +1,18 @@
+The event handler for the following functions takes a \helpref{wxGridEvent}{wxgridevent} parameter.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_CELL\_LEFT\_CLICK(func)}}{The user clicked a cell with the left mouse button. Processes a wxEVT\_GRID\_CELL\_LEFT\_CLICK.}
+\twocolitem{{\bf EVT\_GRID\_CELL\_RIGHT\_CLICK(func)}}{The user clicked a cell with the right mouse button. Processes a wxEVT\_GRID\_CELL\_RIGHT\_CLICK.}
+\twocolitem{{\bf EVT\_GRID\_CELL\_LEFT\_DCLICK(func)}}{The user double-clicked a cell with the left mouse button. Processes a wxEVT\_GRID\_CELL\_LEFT\_DCLICK.}
+\twocolitem{{\bf EVT\_GRID\_CELL\_RIGHT\_DCLICK(func)}}{The user double-clicked a cell with the right mouse button. Processes a wxEVT\_GRID\_CELL\_RIGHT\_DCLICK.}
+\twocolitem{{\bf EVT\_GRID\_LABEL\_LEFT\_CLICK(func)}}{The user clicked a label with the left mouse button. Processes a wxEVT\_GRID\_LABEL\_LEFT\_CLICK.}
+\twocolitem{{\bf EVT\_GRID\_LABEL\_RIGHT\_CLICK(func)}}{The user clicked a label with the right mouse button. Processes a wxEVT\_GRID\_LABEL\_RIGHT\_CLICK.}
+\twocolitem{{\bf EVT\_GRID\_LABEL\_LEFT\_DCLICK(func)}}{The user double-clicked a label with the left mouse button. Processes a wxEVT\_GRID\_LABEL\_LEFT\_DCLICK.}
+\twocolitem{{\bf EVT\_GRID\_LABEL\_RIGHT\_DCLICK(func)}}{The user double-clicked a label with the right mouse button. Processes a wxEVT\_GRID\_LABEL\_RIGHT\_DCLICK.}
+\twocolitem{{\bf EVT\_GRID\_CELL\_CHANGE(func)}}{The user moved the cursor to another cell. Processes a wxEVT\_GRID\_CELL\_CHANGE.}
+\twocolitem{{\bf EVT\_GRID\_SELECT\_CELL(func)}}{The user selected a cell. Processes a wxEVT\_GRID\_SELECT\_CELL.}
+\twocolitem{{\bf EVT\_GRID\_EDITOR\_HIDDEN(func)}}{The editor for a cell was hidden. Processes a wxEVT\_GRID\_EDITOR\_HIDDEN.}
+\twocolitem{{\bf EVT\_GRID\_EDITOR\_SHOWN(func)}}{The editor for a cell was shown. Processes a wxEVT\_GRID\_EDITOR\_SHOWN.}
+\end{twocollist}%
+
diff --git a/docs/latex/wx/gridevt.tex b/docs/latex/wx/gridevt.tex
new file mode 100644 (file)
index 0000000..f1f4b57
--- /dev/null
@@ -0,0 +1,322 @@
+\section{\class{wxGridEvent}}\label{wxgridevent}
+
+This event class contains information about various grid events.
+
+\wxheading{Derived from}
+
+\helpref{wxNotifyEvent}{wxnotifyevent}\\
+\helpref{wxCommandEvent}{wxcommandevent}\\
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\wxheading{Event handling}
+
+\input gridevt.inc
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridEvent::wxGridEvent}\label{wxgrideventconstr}
+
+\func{}{wxGridEvent}{\void}
+
+Default constructor.
+
+\func{}{wxGridEvent}{\param{int }{id}, \param{wxEventType }{type}, \param{wxObject* }{obj},
+ \param{int }{row = -1}, \param{int }{col = -1}, \param{int }{x = -1}, \param{int }{y = -1},
+ \param{bool }{sel = TRUE}, \param{bool }{control = FALSE}, \param{bool }{shift = FALSE},
+ \param{bool }{alt = FALSE}, \param{bool }{meta = FALSE}}
+
+\wxheading{Parameters}
+
+\membersection{wxGridEvent::AltDown}\label{wxgrideventaltdown}
+
+\func{bool}{AltDown}{\void}
+
+Returns TRUE if the Alt key was down at the time of the event.
+
+\membersection{wxGridEvent::ControlDown}\label{wxgrideventcontroldown}
+
+\func{bool}{ControlDown}{\void}
+
+Returns TRUE if the Control key was down at the time of the event.
+
+\membersection{wxGridEvent::GetCol}\label{wxgrideventgetcol}
+
+\func{int}{GetCol}{\void}
+
+Column at which the event occurred.
+
+\membersection{wxGridEvent::GetPosition}\label{wxgrideventgetposition}
+
+\func{wxPoint}{GetPosition}{\void}
+
+Position in pixels at which the event occurred.
+
+\membersection{wxGridEvent::GetRow}\label{wxgrideventgetrow}
+
+\func{int}{GetRow}{\void}
+
+Row at which the evnet occurred.
+
+\membersection{wxGridEvent::MetaDown}\label{wxgrideventmetadown}
+
+\func{bool}{MetaDown}{\void}
+
+Returns TRUE if the Meta key was down at the time of the event.
+
+\membersection{wxGridEvent::Selecting}\label{wxgrideventselecting}
+
+\func{bool}{Selecting}{\void}
+
+Returns TRUE if the user deselected a cell, FALSE if the user
+deselected a cell.
+
+\membersection{wxGridEvent::ShiftDown}\label{wxgrideventshiftdown}
+
+\func{bool}{ShiftDown}{\void}
+
+Returns TRUE if the Shift key was down at the time of the event.
+
+\section{\class{wxGridSizeEvent}}\label{wxgridsizeevent}
+
+This event class contains information about a row/column resize event.
+
+\wxheading{Derived from}
+
+\helpref{wxNotifyEvent}{wxnotifyevent}\\
+\helpref{wxCommandEvent}{wxcommandevent}\\
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\wxheading{Event handling}
+
+The event handler for the following functions takes a 
+ \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_COL\_SIZE(func)}}{The user resized a column by dragging it. Processes a wxEVT\_GRID\_COL\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.}
+\end{twocollist}%
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridSizeEvent::wxGridSizeEvent}\label{wxgridsizeeventconstr}
+
+\func{}{wxGridSizeEvent}{\void}
+
+Default constructor.
+
+\func{}{wxGridSizeEvent}{\param{int }{id}, \param{wxEventType }{type},
+ \param{wxObject* }{obj}, \param{int }{rowOrCol = -1}, \param{int }{x = -1},
+ \param{int }{y = -1}, \param{bool }{control = FALSE}, \param{bool }{shift = FALSE},
+ \param{bool }{alt = FALSE}, \param{bool }{meta = FALSE}}
+
+\membersection{wxGridSizeEvent::AltDown}\label{wxgridsizeeventaltdown}
+
+\func{bool}{AltDown}{\void}
+
+Returns TRUE if the Alt key was down at the time of the event.
+
+\membersection{wxGridSizeEvent::ControlDown}\label{wxgridsizeeventcontroldown}
+
+\func{bool}{ControlDown}{\void}
+
+Returns TRUE if the Control key was down at the time of the event.
+
+\membersection{wxGridSizeEvent::GetPosition}\label{wxgridsizeeventgetposition}
+
+\func{wxPoint}{GetPosition}{\void}
+
+Position in pixels at which the event occurred.
+
+\membersection{wxGridSizeEvent::GetRowOrCol}\label{wxgridsizeeventgetroworcol}
+
+\func{int}{GetRowOrCol}{\void}
+
+Row or column at that was resized.
+
+\membersection{wxGridSizeEvent::MetaDown}\label{wxgridsizeeventmetadown}
+
+\func{bool}{MetaDown}{\void}
+
+Returns TRUE if the Meta key was down at the time of the event.
+
+\membersection{wxGridSizeEvent::ShiftDown}\label{wxgridsizeeventshiftdown}
+
+\func{bool}{ShiftDown}{\void}
+
+Returns TRUE if the Shift key was down at the time of the event.
+
+\section{\class{wxGridRangeSelectEvent}}\label{wxgridrangeselectevent}
+
+\wxheading{Derived from}
+
+\helpref{wxNotifyEvent}{wxnotifyevent}\\
+\helpref{wxCommandEvent}{wxcommandevent}\\
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Event handling}
+
+The event handler for the following functions takes a 
+ \helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
+\end{twocollist}%
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridRangeSelectEvent::wxGridRangeSelectEvent}\label{wxgridrangeselecteventconstr}
+
+\func{}{wxGridRangeSelectEvent}{\void}
+
+Default constructor.
+
+\func{}{wxGridRangeSelectEvent}{\param{int }{id}, \param{wxEventType }{type},
+ \param{wxObject* }{obj}, \param{const wxGridCellCoords\& }{topLeft},
+ \param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{sel = TRUE},
+ \param{bool }{control = FALSE}, \param{bool }{shift = FALSE}, \param{bool }{alt = FALSE},
+ \param{bool }{meta = FALSE}}
+
+\membersection{wxGridRangeSelectEvent::AltDown}\label{wxgridrangeselecteventaltdown}
+
+\func{bool}{AltDown}{\void}
+
+Returns TRUE if the Alt key was down at the time of the event.
+
+\membersection{wxGridRangeSelectEvent::ControlDown}\label{wxgridrangeselecteventcontroldown}
+
+\func{bool}{ControlDown}{\void}
+
+Returns TRUE if the Control key was down at the time of the event.
+
+\membersection{wxGridRangeSelectEvent::GetBottomRightCoords}\label{wxgridrangeselecteventgetbottomrightcoords}
+
+\func{wxGridCellCoords}{GetBottomRightCoords}{\void}
+
+Top left corner of the rectangular area that was (de)selected.
+
+\membersection{wxGridRangeSelectEvent::GetBottomRow}\label{wxgridrangeselecteventgetbottomrow}
+
+\func{int}{GetBottomRow}{\void}
+
+Bottom row of the rectangular area that was (de)selected.
+
+\membersection{wxGridRangeSelectEvent::GetLeftCol}\label{wxgridrangeselecteventgetleftcol}
+
+\func{int}{GetLeftCol}{\void}
+
+Left column of the rectangualr area that was (de)selected.
+
+\membersection{wxGridRangeSelectEvent::GetRightCol}\label{wxgridrangeselecteventgetrightcol}
+
+\func{int}{GetRightCol}{\void}
+
+Right column of the rectangular area that was (de)selected.
+
+\membersection{wxGridRangeSelectEvent::GetTopLeftCoords}\label{wxgridrangeselecteventgettopleftcoords}
+
+\func{wxGridCellCoords}{GetTopLeftCoords}{\void}
+
+Top left corner of the rectangular area that was (de)delected.
+
+\membersection{wxGridRangeSelectEvent::GetTopRow}\label{wxgridrangeselecteventgettoprow}
+
+\func{int}{GetTopRow}{\void}
+
+Top row of the rectangular area that was (de)selected.
+
+\membersection{wxGridRangeSelectEvent::MetaDown}\label{wxgridrangeselecteventmetadown}
+
+\func{bool}{MetaDown}{\void}
+
+Returns TRUE if the Meta key was down at the time of the event.
+
+\membersection{wxGridRangeSelectEvent::Selecting}\label{wxgridrangeselecteventselecting}
+
+\func{bool}{Selecting}{\void}
+
+Returns TRUE if the area was selected, FALSE otherwise.
+
+\membersection{wxGridRangeSelectEvent::ShiftDown}\label{wxgridrangeselecteventshiftdown}
+
+\func{bool}{ShiftDown}{\void}
+
+Returns TRUE if the Shift key was down at the time of the event.
+
+\section{\class{wxGridEditorCreatedEvent}}\label{wxgrideditorcreatedevent}
+
+\wxheading{Derived from}
+
+\helpref{wxCommandEvent}{wxcommandevent}\\
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Event handling}
+
+The event handler for the following functions takes a 
+ \helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_GRID\_EDITOR\_CREATED(func)}}{The editor for a cell was created. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
+\end{twocollist}%
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridEditorCreatedEvent::wxGridEditorCreatedEvent}\label{wxgrideditorcreatedeventconstr}
+
+\func{}{wxGridEditorCreatedEvent}{\void}
+
+Default constructor.
+
+\func{}{wxGridEditorCreatedEvent}{\param{int }{id}, \param{wxEventType }{type},
+ \param{wxObject* }{obj}, \param{int }{row}, \param{int }{col}, \param{wxControl* }{ctrl}}
+
+\membersection{wxGridEditorCreatedEvent::GetCol}\label{wxgrideditorcreatedeventgetcol}
+
+\func{int}{GetCol}{\void}
+
+Returns the column at which the event occurred.
+
+\membersection{wxGridEditorCreatedEvent::GetControl}\label{wxgrideditorcreatedeventgetcontrol}
+
+\func{wxControl*}{GetControl}{\void}
+
+Returns the edit control.
+
+\membersection{wxGridEditorCreatedEvent::GetRow}\label{wxgrideditorcreatedeventgetrow}
+
+\func{int}{GetRow}{\void}
+
+Returns the row at which the event occurred.
+
+\membersection{wxGridEditorCreatedEvent::SetCol}\label{wxgrideditorcreatedeventsetcol}
+
+\func{void}{SetCol}{\param{int }{col}}
+
+Sets the column at which the event occurred.
+
+\membersection{wxGridEditorCreatedEvent::SetControl}\label{wxgrideditorcreatedeventsetcontrol}
+
+\func{void}{SetControl}{\param{wxControl* }{ctrl}}
+
+Sets the edit control.
+
+\membersection{wxGridEditorCreatedEvent::SetRow}\label{wxgrideditorcreatedeventsetrow}
+
+\func{void}{SetRow}{\param{int }{row}}
+
+Sets the row at which the event occurred.
+
index 11a86f6535cae0bc27531dbd99102139467eda71..b66267086941d03ed2bc1563e4371763190d98fe 100644 (file)
@@ -12,7 +12,12 @@ predefined derived classes or derive your own class from it.
 
 wxGridCellWorker
 
-\wxheading{Data structures}
+\wxheading{See also}
+
+\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
+\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
+\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
+\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -38,3 +43,137 @@ Get the preferred size of the cell for its contents.
 
 \constfunc{wxGridCellRenderer*}{Clone}{\void}
 
+
+\section{\class{wxGridCellBoolRenderer}}\label{wxgridcellboolrenderer}
+
+This class may be used to format boolean data in a cell.
+for string cells.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellRenderer}{wxgridcellrenderer}
+
+\wxheading{See also}
+
+\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
+\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
+\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
+\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridCellBoolRenderer::wxGridCellBoolRenderer}\label{wxgridcellboolrendererconstr}
+
+\func{}{wxGridCellBoolRenderer}{}
+
+Default constructor
+
+
+
+\section{\class{wxGridCellFloatRenderer}}\label{wxgridcellfloatrenderer}
+
+This class may be used to format floating point data in a cell.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer}\\
+\helpref{wxGridCellRenderer}{wxgridcellrenderer}
+
+\wxheading{See also}
+
+\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
+\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
+\helpref{wxGridCellTextRenderer}{wxgridcelltextrenderer},\rtfsp
+\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridCellFloatRenderer::wxGridCellFloatRenderer}\label{wxgridcellfloatrendererconstr}
+
+\func{}{wxGridCellFloatRenderer}{\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{wxGridCellFloatRenderer::GetPrecision}\label{wxgridcellfloatrenderergetprecision}
+
+\constfunc{int}{GetPrecision}{\void}
+
+Returns the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
+
+\membersection{wxGridCellFloatRenderer::GetWidth}\label{wxgridcellfloatrenderergetwidth}
+
+\constfunc{int}{GetWidth}{\void}
+
+Returns the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
+
+\membersection{wxGridCellFloatRenderer::SetParameters}\label{wxgridcellfloatrenderersetparameters}
+
+\func{void}{SetParameters}{\param{const wxString\& }{params}}
+
+Parameters string format is "width[,precision]".
+
+\membersection{wxGridCellFloatRenderer::SetPrecision}\label{wxgridcellfloatrenderersetprecision}
+
+\func{void}{SetPrecision}{\param{int }{precision}}
+
+Sets the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
+
+\membersection{wxGridCellFloatRenderer::SetWidth}\label{wxgridcellfloatrenderersetwidth}
+
+\func{void}{SetWidth}{\param{int }{width}}
+
+Sets the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} )
+
+
+
+\section{\class{wxGridCellNumberRenderer}}\label{wxgridcellnumberrenderer}
+
+This class may be used to format integer data in a cell.
+
+\wxheading{Derived from}
+
+\helpref{wxGridellStringRenderer}{wxgridcellstringrenderer}\\
+\helpref{wxGridCellRenderer}{wxgridcellrenderer}
+
+\wxheading{See also}
+
+\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
+\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
+\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
+\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridCellNumberRenderer::wxGridCellNumberRenderer}\label{wxgridcellnumberrendererconstr}
+
+\func{}{wxGridCellNumberRenderer}{}
+
+Default constructor
+
+
+\section{\class{wxGridCellStringRenderer}}\label{wxgridcellstringrenderer}
+
+This class may be used to format string data in a cell; it is the default
+for string cells.
+
+\wxheading{Derived from}
+
+\helpref{wxGridCellRenderer}{wxgridcellrenderer}
+
+\wxheading{See also}
+
+\helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
+\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
+\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
+\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxGridCellStringRenderer::wxGridCellStringRenderer}\label{wxgridcellstringrendererconstr}
+
+\func{}{wxGridCellStringRenderer}{}
+
+Default constructor
+
+
index 705a3676dcc9886ef79f242f386f954fff98163c..51bc22e9feb0a2707b1b24aaee88e52775a7f92a 100644 (file)
@@ -21,7 +21,6 @@ unnecessary to process both events at once.
 \helpref{wxNotifyEvent}{wxnotifyevent}\\
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
-\helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}