Some doc updates,

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

diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index db3368f9b702032581c6fd60e8c76423f88d0b27..540ed2fed189a80c06b9660815abf78ed8949a9a 100644 (file)
--- a/docs/latex/wx/grid.tex
+++ b/docs/latex/wx/grid.tex
@@ -15,7 +15,9 @@ wxGrid is a class for displaying and editing tabular information.
 
 \wxheading{Window styles}
 
-There are no specific window styles for this class.
+There are no specific window styles for this class, but you may use different
+SetXXX() functions to change the controls behaviour (for example, to enable
+in-place editing).
 
 See also \helpref{window styles overview}{windowstyles}.
 
@@ -83,6 +85,16 @@ and widths, and/or default cell width and height.
 
 Call this function after creating the wxGrid object.
 
+\pythonnote{Currently the {\tt cellValues} and {\tt widths} parameters
+don't exisit in the wxPython version of this method.  So in other
+words, the definition of the  wxPython version of this method looks like this:
+\begin{verbatim}
+    CreateGrid(rows, cols,
+               defaultWidth = wxGRID_DEFAULT_CELL_WIDTH,
+               defaultHeight = wxGRID_DEFAULT_CELL_HEIGHT)
+\end{verbatim}
+}
+
 \membersection{wxGrid::CurrentCellVisible}\label{wxgridcurrentcellvisible}
 
 \func{bool}{CurrentCellVisible}{\void}
@@ -142,6 +154,14 @@ wxGenericGrid implementation only.
 Sets the text alignment for the cell at the given position, or the global alignment value.
 The return value is wxLEFT, wxRIGHT or wxCENTRE.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetCellAlignment(row, col)}}{}
+\twocolitem{{\bf GetDefCellAlignment()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
 
 \constfunc{wxColour\&}{GetCellBackgroundColour}{\param{int}{ row}, \param{int}{ col}}
@@ -150,6 +170,14 @@ The return value is wxLEFT, wxRIGHT or wxCENTRE.
 
 Gets the background colour for the cell at the given position, or the global background colour.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetCellBackgroundColour(row, col)}}{}
+\twocolitem{{\bf GetDefCellBackgroundColourt()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCells}\label{wxgridgetcells}
 
 \constfunc{wxGridCell ***}{GetCells}{\void}
@@ -164,6 +192,14 @@ Returns the array of grid cell object associated with this wxGrid.
 
 Gets the text colour for the cell at the given position, or the global text colour.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetCellTextColour(row, col)}}{}
+\twocolitem{{\bf GetDefCellTextColour()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont}
 
 \constfunc{const wxFont\&}{GetCellTextFont}{\param{int}{ row}, \param{int}{ col}}
@@ -172,6 +208,14 @@ Gets the text colour for the cell at the given position, or the global text colo
 
 Gets the text font for the cell at the given position, or the global text font.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetCellTextFont(row, col)}}{}
+\twocolitem{{\bf GetDefCellTextFont()}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue}
 
 \constfunc{wxString\&}{GetCellValue}{\param{int}{ row}, \param{int}{ col}}
@@ -215,6 +259,12 @@ Returns the row position of the currently selected cell.
 
 Returns TRUE if the grid cells can be edited.
 
+\membersection{wxGrid::GetEditInPlace}\label{wxgridgeteditinplace}
+
+\constfunc{bool}{GetEditInPlace}{\void}
+
+Returns TRUE if editing in-place is enabled.
+
 \membersection{wxGrid::GetHorizScrollBar}\label{wxgridgethorizscrollbar}
 
 \constfunc{wxScrollBar *}{GetHorizScrollBar}{\void}
@@ -360,7 +410,7 @@ Virtual function called when the right button is depressed within a cell, just a
 \func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
 
 Virtual function called when the left button is depressed within a
-label.  
+label.
 
 {\it row} will be {\it -1} if the click is in the top labels.
 
@@ -403,6 +453,14 @@ call wxGrid::OnSelectCell to apply the default behaviour.
 
 Sets the text alignment for the cell at the given position, or for the whole grid. {\it alignment} may be wxLEFT, wxRIGHT or wxCENTRE.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf SetCellAlignment(alignment, row, col)}}{}
+\twocolitem{{\bf SetDefCellAlignment(alignment)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
 
 \func{void}{SetCellBackgroundColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
@@ -411,6 +469,14 @@ Sets the text alignment for the cell at the given position, or for the whole gri
 
 Sets the background colour for the cell at the given position, or for the whole grid.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf SetCellBackgroundColour(colour, row, col)}}{}
+\twocolitem{{\bf SetDefCellBackgroundColour(colour)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
 
 \func{void}{SetCellTextColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
@@ -419,6 +485,14 @@ Sets the background colour for the cell at the given position, or for the whole
 
 Sets the text colour for the cell at the given position, or for the whole grid.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf SetCellTextColour(colour, row, col)}}{}
+\twocolitem{{\bf SetDefCellTextColour(colour)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont}
 
 \func{void}{SetCellTextFont}{\param{const wxFont\&}{ font}, \param{int}{ row}, \param{int}{ col}}
@@ -427,6 +501,14 @@ Sets the text colour for the cell at the given position, or for the whole grid.
 
 Sets the text font for the cell at the given position, or for the whole grid.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf SetCellTextFont(font, row, col)}}{}
+\twocolitem{{\bf SetDefCellTextFont(font)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
 
 \func{void}{SetCellValue}{\param{const wxString\&}{ val}, \param{int}{ row}, \param{int}{ col}}
@@ -454,6 +536,14 @@ If {\it editable} is TRUE (the default), the grid cells will be editable by mean
 text edit control. If FALSE, the text edit control will be hidden and the user will not
 be able to edit the cell contents.
 
+\membersection{wxGrid::SetEditInPlace}\label{wxgridseteditinplace}
+
+\func{void}{SetEditInPlace}{\param{bool}{ edit = TRUE}}
+
+Enables (if {\it edit} is TRUE, default value) or disables in-place editing.
+When it is enabled, the cells contents can be changed by typing text directly
+in the cell.
+
 \membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
 
 \func{void}{SetGridCursor}{\param{int }{row}, \param{int}{ col}}
@@ -518,4 +608,3 @@ Call this function whenever a change has been made via the API that
 might alter size characteristics. You may also need to follow it with
 a call to AdjustScrollbars.
 
-