added wxHtmlHelpController::AddBook(wxFileName)

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

diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index 72824ca7c176e1f15e73d801a78bdf58ab8a2ac4..99971585be354c6856d692e4867a2f0f84f886de 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}
@@ -373,6 +400,9 @@ 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.
 
+\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}
 
 \func{wxColour}{GetCellBackgroundColour}{\param{int }{row}, \param{int }{col}}
@@ -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}
@@ -445,7 +478,7 @@ Returns the current height of the column labels.
 
 \func{wxString}{GetColLabelValue}{\param{int }{col}}
 
-Returns the specifed column label. The default grid table class provides column labels of
+Returns the specified column label. The default grid table class provides column labels of
 the form A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can override 
 \helpref{wxGridTableBase::GetColLabelValue}{wxgridtablebasegetcollabelvalue} to provide
 your own labels. 
@@ -548,7 +581,7 @@ Returns the colour used for grid lines.
 
 \func{bool}{GridLinesEnabled}{\void}
 
-Returnes TRUE if drawing of grid lines is turned on, FALSE otherwise.
+Returns TRUE if drawing of grid lines is turned on, FALSE otherwise.
 
 \membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
 
@@ -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}
@@ -600,7 +636,7 @@ Returns the current width of the row labels.
 
 \func{wxString}{GetRowLabelValue}{\param{int }{row}}
 
-Returns the specifed row label. The default grid table class provides numeric row labels.
+Returns the specified row label. The default grid table class provides numeric row labels.
 If you are using a custom grid table you can override 
 \helpref{wxGridTableBase::GetRowLabelValue}{wxgridtablebasegetcollabelvalue} to provide
 your own labels. 
@@ -611,6 +647,44 @@ your own labels.
 
 Returns the height of the specified row.
 
+\membersection{wxGrid::GetSelectionMode}\label{wxgridgetselectionmode}
+
+\constfunc{wxGrid::wxGridSelectionModes}{GetSelectionMode}{\void}
+
+Returns the current selection mode, see \helpref{wxGrid::SetSelectionMode}{wxgridsetselectionmode}.
+
+\membersection{wxGrid::GetSelectedCells}\label{wxgridgetselectedcells}
+
+\constfunc{wxGridCellCoordsArray}{GetSelectedCells}{\void}
+
+Returns an array of singly selected cells.
+
+\membersection{wxGrid::GetSelectedCols}\label{wxgridgetselectedcols}
+
+\constfunc{wxArrayInt}{GetSelectedCols}{\void}
+
+Returns an array of selected cols.
+
+\membersection{wxGrid::GetSelectedRows}\label{wxgridgetselectedrows}
+
+\constfunc{wxArrayInt}{GetSelectedRows}{\void}
+
+Returns an array of selected rows.
+
+\membersection{wxGrid::GetSelectionBlockTopLeft}\label{wxgridgetselectionblocktopleft}
+
+\constfunc{wxGridCellCoordsArray}{GetSelectionBlockTopLeft}{\void}
+
+Returns an array of the top left corners of blocks of selected cells, 
+see \helpref{wxGrid::GetSelectionBlockBottomRight}{wxgridgetselectionblockbottomright}.
+
+\membersection{wxGrid::GetSelectionBlockBottomRight}\label{wxgridgetselectionblockbottomright}
+
+\constfunc{wxGridCellCoordsArray}{GetSelectionBlockBottomRight}{\void}
+
+Returns an array of the bottom right corners of blocks of selected cells,
+see \helpref{wxGrid::GetSelectionBlockTopLeft}{wxgridgetselectionblocktopleft}.
+
 \membersection{wxGrid::GetTable}\label{wxgridgettable}
 
 \constfunc{wxGridTableBase *}{GetTable}{\void}
@@ -678,6 +752,14 @@ Returns FALSE if the whole grid has been set as read-only or TRUE otherwise.
 See \helpref{wxGrid::EnableEditing}{wxgridenableediting} for more information about
 controlling the editing status of grid cells.
 
+\membersection{wxGrid::IsInSelection}\label{wxgridisinselection}
+
+\constfunc{bool}{IsInSelection}{\param{int }{row}, \param{int }{col}}
+
+\constfunc{bool}{IsInSelection}{\param{const wxGridCellCoords\& }{coords}}
+
+Is this cell currently selected.
+
 \membersection{wxGrid::IsReadOnly}\label{wxgridisreadonly}
 
 \constfunc{bool}{IsReadOnly}{\param{int }{row}, \param{int }{col}}
@@ -861,7 +943,7 @@ deselected; if TRUE the row will be added to the existing selection.
 
 \func{void}{SetCellAlignment}{\param{int }{align}}
 
-Sets the horizontal and vertial alignment for grid cell text at the specified location.
+Sets the horizontal and vertical 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.
@@ -1010,7 +1092,7 @@ The memory requirements for this could become prohibitive if your grid is very l
 
 \func{void}{SetDefaultCellAlignment}{\param{int }{horiz}, \param{int }{vert}}
 
-Sets the default horizontal and vertial alignment for grid cell text.
+Sets the default horizontal and vertical alignment for grid cell text.
 
 Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
 
@@ -1215,14 +1297,6 @@ Returns the grid row that corresponds to the logical y coordinate. Returns
 wxNOT\_FOUND if there is no row at the y position.
 
 
-
-\membersection{wxGrid::IsInSelection}\label{wxgridisinselection}
-
-\func{bool}{IsInSelection}{\param{int }{row}, \param{int }{col}}
-
-\func{bool}{IsInSelection}{\param{const wxGridCellCoords\& }{coords}}
-
-
 \membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect}
 
 \func{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}}