X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9722642d5d29a39c9b7ab3d0a07e773ea0c8829a..fcf77487edae715c75f0f802a96e203d88dd56c6:/docs/latex/wx/grid.tex diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex index 1ffe177d10..99971585be 100644 --- a/docs/latex/wx/grid.tex +++ b/docs/latex/wx/grid.tex @@ -478,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. @@ -581,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} @@ -636,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. @@ -647,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} @@ -714,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}} @@ -897,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. @@ -1046,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. @@ -1251,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}}