mention that doing SetFocus() results in the focus event being sent

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

diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index 7c5160206b052c937ab3b24570cc95ea59efa73a..1ffe177d109658e69cddf108d06b6adf44abd719 100644 (file)
--- a/docs/latex/wx/grid.tex
+++ b/docs/latex/wx/grid.tex
@@ -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}
@@ -296,7 +323,7 @@ Disables row sizing by dragging with the mouse. Equivalent to passing FALSE to
 \func{void}{EnableCellEditControl}{\param{bool }{enable = TRUE}}
 
 Enables or disables in-place editing of grid cell data. The grid will issue either a
-wxEVT_GRID_EDITOR_SHOWN or wxEVT_GRID_EDITOR_HIDDEN event.
+wxEVT\_GRID\_EDITOR\_SHOWN or wxEVT\_GRID\_EDITOR\_HIDDEN event.
 
 \membersection{wxGrid::EnableDragColSize}\label{wxgridenabledragcolsize}
 
@@ -370,8 +397,11 @@ the grid's batch count is greater than zero the display will not be updated.
 Sets the arguments to the horizontal and vertical text alignment values for the
 grid cell at the specified location.
 
-Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT. \\
-Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
+Horizontal alignment will be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. \\
+Vertical alignment will be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
+
+\perlnote{This method only takes the parameters {\tt row} and {\tt col} and
+returns a 2-element list {\tt ( horiz, vert )}.}
 
 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
 
@@ -435,6 +465,9 @@ Sets the arguments to the current column label alignment values.
 Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\
 Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
 
+\perlnote{This method takes no parameters and
+returns a 2-element list {\tt ( horiz, vert )}.}
+
 \membersection{wxGrid::GetColLabelSize}\label{wxgridgetcollabelsize}
 
 \func{int}{GetColLabelSize}{\void}
@@ -590,6 +623,9 @@ Sets the arguments to the current row label alignment values.
 Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\
 Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
 
+\perlnote{This method takes no parameters and
+returns a 2-element list {\tt ( horiz, vert )}.}
+
 \membersection{wxGrid::GetRowLabelSize}\label{wxgridgetrowlabelsize}
 
 \func{int}{GetRowLabelSize}{\void}
@@ -863,8 +899,8 @@ deselected; if TRUE the row will be added to the existing selection.
 
 Sets the horizontal and vertial alignment for grid cell text at the specified location.
 
-Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT. \\
-Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
+Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. \\
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
 
 \membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor}
 
@@ -965,9 +1001,9 @@ with custom data types.
 
 Sets the horizontal and vertical alignment of column label text.
 
-Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT.
+Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
 
-Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
 
 \membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize}
 
@@ -1012,9 +1048,9 @@ The memory requirements for this could become prohibitive if your grid is very l
 
 Sets the default horizontal and vertial alignment for grid cell text.
 
-Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT.
+Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
 
-Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
 
 \membersection{wxGrid::SetDefaultCellBackgroundColour}\label{wxgridsetdefaultcellbackgroundcolour}
 
@@ -1112,9 +1148,9 @@ about controlling cell attributes.
 
 Sets the horizontal and vertical alignment of row label text.
 
-Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT.
+Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
 
-Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
 
 \membersection{wxGrid::SetRowLabelSize}\label{wxgridsetrowlabelsize}
 
@@ -1191,28 +1227,28 @@ Displays the in-place cell edit control for the current cell.
 \func{int}{XToCol}{\param{int }{x}}
 
 Returns the grid column that corresponds to the logical x coordinate. Returns
-wxNOT_FOUND if there is no column at the x position.
+wxNOT\_FOUND if there is no column at the x position.
 
 \membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol}
 
 \func{int}{XToEdgeOfCol}{\param{int }{x}}
 
 Returns the column whose right hand edge is close to the given logical x position.
-If no column edge is near to this position wxNOT_FOUND is returned.
+If no column edge is near to this position wxNOT\_FOUND is returned.
 
 \membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow}
 
 \func{int}{YToEdgeOfRow}{\param{int }{y}}
 
 Returns the row whose bottom edge is close to the given logical y position.
-If no row edge is near to this position wxNOT_FOUND is returned.
+If no row edge is near to this position wxNOT\_FOUND is returned.
 
 \membersection{wxGrid::YToRow}\label{wxgridytorow}
 
 \func{int}{YToRow}{\param{int }{y}}
 
 Returns the grid row that corresponds to the logical y coordinate. Returns
-wxNOT_FOUND if there is no row at the y position.
+wxNOT\_FOUND if there is no row at the y position.