*** empty log message ***

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

diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index fb5d809879bb67fcc3d3b9754499f32fc9c5cbaf..384d32438c9a27045ede6dc5de5b465296f1cd0f 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}
 
 
 \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}.
 
 
 See also \helpref{window styles overview}{windowstyles}.
 


@@ -83,7 +85,7 @@ and widths, and/or default cell width and height.
 
 Call this function after creating the wxGrid object.
 
 
 Call this function after creating the wxGrid object.
 

-\pythonnote{Currently the \tt{cellValues} and \tt{widths} parameters
+\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}
 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}


@@ -155,8 +157,8 @@ 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}
 \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()}}{}
+\twocolitem{{\bf GetCellAlignment(row, col)}}{}
+\twocolitem{{\bf GetDefCellAlignment()}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -171,8 +173,8 @@ Gets the background colour for the cell at the given position, or the global bac
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \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()}}{}
+\twocolitem{{\bf GetCellBackgroundColour(row, col)}}{}
+\twocolitem{{\bf GetDefCellBackgroundColourt()}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -193,8 +195,8 @@ Gets the text colour for the cell at the given position, or the global text colo
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \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()}}{}
+\twocolitem{{\bf GetCellTextColour(row, col)}}{}
+\twocolitem{{\bf GetDefCellTextColour()}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -209,8 +211,8 @@ 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}
 \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()}}{}
+\twocolitem{{\bf GetCellTextFont(row, col)}}{}
+\twocolitem{{\bf GetDefCellTextFont()}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -257,6 +259,12 @@ Returns the row position of the currently selected cell.
 
 Returns TRUE if the grid cells can be edited.
 
 
 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}
 \membersection{wxGrid::GetHorizScrollBar}\label{wxgridgethorizscrollbar}
 
 \constfunc{wxScrollBar *}{GetHorizScrollBar}{\void}


@@ -448,8 +456,8 @@ Sets the text alignment for the cell at the given position, or for the whole gri
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \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)}}{}
+\twocolitem{{\bf SetCellAlignment(alignment, row, col)}}{}
+\twocolitem{{\bf SetDefCellAlignment(alignment)}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -464,8 +472,8 @@ Sets the background colour for the cell at the given position, or for the whole
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \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)}}{}
+\twocolitem{{\bf SetCellBackgroundColour(colour, row, col)}}{}
+\twocolitem{{\bf SetDefCellBackgroundColour(colour)}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -480,8 +488,8 @@ 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}
 \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)}}{}
+\twocolitem{{\bf SetCellTextColour(colour, row, col)}}{}
+\twocolitem{{\bf SetDefCellTextColour(colour)}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -496,8 +504,8 @@ 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}
 \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)}}{}
+\twocolitem{{\bf SetCellTextFont(font, row, col)}}{}
+\twocolitem{{\bf SetDefCellTextFont(font)}}{}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 


@@ -528,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.
 
 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}}
 \membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
 
 \func{void}{SetGridCursor}{\param{int }{row}, \param{int}{ col}}