]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/gridedit.tex
Fixed compile errors, warnings and other DSMs, and improved comments.
[wxWidgets.git] / docs / latex / wx / gridedit.tex
index 67a8e7080b3a82c95dc619be10d4254395ceb9dc..639a300d6e736f19f900bf613393fb7ed4cb7daf 100644 (file)
@@ -3,89 +3,75 @@
 % grid.h at 11/May/00 18:30:18
 %
 
-
 \section{\class{wxGridCellEditor}}\label{wxgridcelleditor}
 
-
-
-wxGridCellEditor:  This class is responsible for providing and manipulating
+This class is responsible for providing and manipulating
 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.
 
-
 \wxheading{Derived from}
 
-\helpref{wxGridCellWorker}{wxgridcellworker}
+wxGridCellWorker
 
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-
 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
 
 \func{}{wxGridCellEditor}{\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}}
 
-Creates the actual edit control
-
+Creates the actual edit control.
 
 \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
-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
-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
-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
-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}
 
-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}
 
@@ -95,14 +81,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.
 
-
 \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}
 
@@ -111,24 +95,21 @@ called
 Some types of controls on some platforms may need some help
 with the Return key.
 
-
 \membersection{wxGridCellEditor::Destroy}\label{wxgridcelleditordestroy}
 
 \func{void}{Destroy}{\void}
 
-Final cleanup
-
+Final cleanup.
 
 \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}
 
-the dtor is private because only DecRef() can delete us
+The dtor is private because only DecRef() can delete us.