\section{\class{wxGrid}}\label{wxgrid}
wxGrid and its related classes are used for displaying and editing tabular
-data. They provide a rich set of features for display, editing, and
+data. They provide a rich set of features for display, editing, and
interacting with a variety of data sources. For simple applications, and to
help you get started, wxGrid is the only class you need to refer to
-directly. It will set up default instances of the other classes and manage
-them for you. For more complex applications you can derive your own
+directly. It will set up default instances of the other classes and manage
+them for you. For more complex applications you can derive your own
classes for custom grid views, grid data tables, cell editors and
-renderers. The \helpref{wxGrid classes overview}{gridoverview} has
+renderers. The \helpref{wxGrid classes overview}{gridoverview} has
examples of simple and more complex applications, explains the
relationship between the various grid classes and has a summary of the
keyboard shortcuts and mouse functions provided by wxGrid.
wxGrid has been greatly expanded and redesigned for wxWindows 2.2
onwards. If you have been using the old wxGrid class you will probably
-want to have a look at the \helpref{wxGrid classes
-overview}{gridoverview} to see how things have changed. The new grid
-classes are reasonably backward-compatible but there are some
-exceptions. There are also easier ways of doing many things compared to
+want to have a look at the \helpref{wxGrid classes overview}{gridoverview} to see
+how things have changed. The new grid classes are reasonably backward-compatible
+but there are some exceptions. There are also easier ways of doing many things compared to
the previous implementation.
-
\wxheading{Derived from}
-% UNCOMMENT THIS BEFORE COMMITTING TO CVS
-\begin{comment}
\helpref{wxScrolledWindow}{wxscrolledwindow}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
-\end{comment}
\wxheading{Include files}
\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}
\membersection{Constructors and initialization}
-\helpref{wxGrid}{wxgridctor} \\
-\helpref{\destruct{wxGrid}}{wxgriddtor} \\
-\helpref{CreateGrid}{wxgridcreategrid} \\
+\helpref{wxGrid}{wxgridctor}\\
+\helpref{\destruct{wxGrid}}{wxgriddtor}\\
+\helpref{CreateGrid}{wxgridcreategrid}\\
\helpref{SetTable}{wxgridsettable}
\membersection{Display format}
\membersection{Selection functions}
-\helpref{wxGrid::ClearSelection}{wxgridclearselection} \\
-\helpref{wxGrid::IsSelection}{wxgridisselection} \\
-\helpref{wxGrid::SelectAll}{wxgridselectall} \\
-\helpref{wxGrid::SelectBlock}{wxgridselectblock} \\
-\helpref{wxGrid::SelectCol}{wxgridselectcol} \\
+\helpref{wxGrid::ClearSelection}{wxgridclearselection}\\
+\helpref{wxGrid::IsSelection}{wxgridisselection}\\
+\helpref{wxGrid::SelectAll}{wxgridselectall}\\
+\helpref{wxGrid::SelectBlock}{wxgridselectblock}\\
+\helpref{wxGrid::SelectCol}{wxgridselectcol}\\
\helpref{wxGrid::SelectRow}{wxgridselectrow}
%%%%%%%%% MEMBER FUNCTIONS %%%%%%%%%%
Automatically sets the height and width of all rows and columns to fit their contents.
-\wxheading{Note} \\
+\wxheading{Note}\\
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
\func{void}{AutoSizeColumn}{\param{int }{col}, \param{bool }{setAsMin = TRUE}}
-Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
+Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
also be set as the minimal width for the column.
-\wxheading{Note} \\
+\wxheading{Note}\\
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
\func{void}{AutoSizeColumns}{\param{bool }{setAsMin = TRUE}}
-Automatically sizes all columns to fit their contents. If setAsMin is TRUE the calculated widths will
+Automatically sizes all columns to fit their contents. If setAsMin is TRUE the calculated widths will
also be set as the minimal widths for the columns.
-\wxheading{Note} \\
+\wxheading{Note}\\
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
\func{void}{AutoSizeRow}{\param{int }{row}, \param{bool }{setAsMin = TRUE}}
-Automatically sizes the row to fit its contents. If setAsMin is TRUE the calculated height will
+Automatically sizes the row to fit its contents. If setAsMin is TRUE the calculated height will
also be set as the minimal height for the row.
-\wxheading{Note} \\
+\wxheading{Note}\\
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
\func{void}{AutoSizeRows}{\param{bool }{setAsMin = TRUE}}
-Automatically sizes all rows to fit their contents. If setAsMin is TRUE the calculated heights will
+Automatically sizes all rows to fit their contents. If setAsMin is TRUE the calculated heights will
also be set as the minimal heights for the rows.
-\wxheading{Note} \\
+\wxheading{Note}\\
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
\func{bool}{CanDragColSize}{\void}
-Returns TRUE if columns can be resized by dragging with the mouse. Columns can be resized
+Returns TRUE if columns can be resized by dragging with the mouse. Columns can be resized
by dragging the edges of their labels. If grid line dragging is enabled they can also be
resized by dragging the right edge of the column in the grid cell area
(see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}).
\func{bool}{CanDragRowSize}{\void}
-Returns TRUE if rows can be resized by dragging with the mouse. Rows can be resized
+Returns TRUE if rows can be resized by dragging with the mouse. Rows can be resized
by dragging the edges of their labels. If grid line dragging is enabled they can also be
resized by dragging the lower edge of the row in the grid cell area
(see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}).
\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}
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}
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}
\func{wxString}{GetColLabelValue}{\param{int }{col}}
-Returns the specifed 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
+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.
Sets the arguments to the current default horizontal and vertical text alignment
values.
-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.
\membersection{wxGrid::GetDefaultCellBackgroundColour}\label{wxgridgetdefaultcellbackgroundcolour}
\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}
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}
\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.
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}
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}}
\membersection{wxGrid::IsVisible}\label{wxgridisvisible}
-\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col},
-\param{bool }{wholeCellVisible = TRUE}
+\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = TRUE}}
-\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords},
-\param{bool }{wholeCellVisible = TRUE}}
+\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = TRUE}}
Returns TRUE if a cell is either wholly visible (the default) or at least partially
visible in the grid window.
\func{bool}{MoveCursorDown}{\param{bool }{expandSelection}}
-Moves the grid cursor down by one row. If a block of cells was previously selected it
+Moves the grid cursor down by one row. If a block of cells was previously selected it
will expand if the argument is TRUE or be cleared if the argument is FALSE.
\wxheading{Keyboard}\\
\func{void}{SetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int }{horiz}, \param{int }{vert}}
-Sets the horizontal and vertial alignment for grid cell text at the specified location.
+\func{void}{SetCellAlignment}{\param{int }{align}, \param{int }{row}, \param{int }{col}}
+
+\func{void}{SetCellAlignment}{\param{int }{align}}
+
+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.
+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}
\membersection{wxGrid::SetCellFont}\label{wxgridsetcellfont}
-\func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const }{wxFont\&}}
+\func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const wxFont\&}{ font}}
Sets the font for text in the grid cell at the specified location.
\membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
-\func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const }{wxColour\&}}
+\func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}
+
+\func{void}{SetCellTextColour}{\param{const wxColour\& }{val}, \param{int }{row}, \param{int }{col}}
+
+\func{void}{SetCellTextColour}{\param{const wxColour\& }{colour}}
Sets the text colour for the grid cell at the specified location.
\func{void}{SetCellValue}{\param{const wxGridCellCoords\& }{coords}, \param{const wxString\& }{s}}
+\func{void}{SetCellValue}{\param{const wxString\& }{val}, \param{int }{row}, \param{int }{col}}
+
Sets the string value for the cell at the specified location. For simple applications where a
grid object automatically uses a default grid table of string values you use this function together
with \helpref{wxGrid::GetCellValue}{wxgridgetcellvalue} to access cell values.
For more complex applications where you have derived your own grid table class that contains
various data types (e.g. numeric, boolean or user-defined custom types) then you only use this
-function for those cells that contain string values.
+function for those cells that contain string values.
+
+The last form is for backward compatibility only.
See \helpref{wxGridTableBase::CanSetValueAs}{wxgridtablebasecangetvalueas}
and the \helpref{wxGrid overview}{gridoverview} for more information.
Sets the horizontal and vertical alignment of column label text.
-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::SetColLabelSize}\label{wxgridsetcollabelsize}
\membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue}
-\func{void}{SetColLabelValue}{\param{int }{col}, \param{const }{wxString\&}}
+\func{void}{SetColLabelValue}{\param{int }{col}, \param{const wxString\&}{ value}}
Set the value for the given column label. If you are using a derived grid table you must
override \helpref{wxGridTableBase::SetColLabelValue}{wxgridtablebasesetcollabelvalue}
This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch
block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes.
-Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
+Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
also be set as the minimal width for the column.
-\wxheading{Note} \\
+\wxheading{Note}\\
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
\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.
-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}
-\func{void}{SetDefaultCellBackgroundColour}{\param{const }{wxColour\&}}
+\func{void}{SetDefaultCellBackgroundColour}{\param{const wxColour\&}{ colour}}
Sets the default background colour for grid cells.
\membersection{wxGrid::SetDefaultCellFont}\label{wxgridsetdefaultcellfont}
-\func{void}{SetDefaultCellFont}{\param{const }{wxFont\&}}
+\func{void}{SetDefaultCellFont}{\param{const wxFont\&}{ font}}
Sets the default font to be used for grid cell text.
\membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour}
-\func{void}{SetGridLineColour}{\param{const }{wxColour\&}}
+\func{void}{SetGridLineColour}{\param{const wxColour\&}{colour}}
Sets the colour used to draw grid lines.
\membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
-\func{void}{SetLabelBackgroundColour}{\param{const }{wxColour\&}}
+\func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ colour}}
Sets the background colour for row and column labels.
\membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont}
-\func{void}{SetLabelFont}{\param{const }{wxFont\&}}
+\func{void}{SetLabelFont}{\param{const wxFont\&}{ font}}
Sets the font for row and column labels.
\membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
-\func{void}{SetLabelTextColour}{\param{const }{wxColour\&}}
+\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ colour}}
Sets the colour for row and column label text.
Sets the horizontal and vertical alignment of row label text.
-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::SetRowLabelSize}\label{wxgridsetrowlabelsize}
\membersection{wxGrid::SetRowLabelValue}\label{wxgridsetrowlabelvalue}
-\func{void}{SetRowLabelValue}{\param{int }{row}, \param{const }{wxString\&}}
+\func{void}{SetRowLabelValue}{\param{int }{row}, \param{const wxString\&}{ value}}
Set the value for the given row label. If you are using a derived grid table you must
-override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue}
+override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue}
for this to have any effect.
\membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}
This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch
block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes.
-Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
+Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
also be set as the minimal width for the column.
-\wxheading{Note} \\
+\wxheading{Note}
+
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
\membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode}
-\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{selmode}}
+\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}}
Set the selection behaviour of the grid.
\docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.}
-\docparam(wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
+\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
\docparam{wxGrid::wxGridSelectionColumns}{Selections will consist of whole columns.}
\func{bool}{SetTable}{\param{wxGridTableBase* }{table}, \param{bool }{takeOwnership = FALSE}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}}
-Passes a pointer to a custom grid table to be used by the grid. This should be called
+Passes a pointer to a custom grid table to be used by the grid. This should be called
after the grid constructor and before using the grid object. If takeOwnership is set to
TRUE then the table will be deleted by the wxGrid destructor.
\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.
-
-
-
-\membersection{wxGrid::IsInSelection}\label{wxgridisinselection}
-
-\func{bool}{IsInSelection}{\param{int }{row}, \param{int }{col}}
-
-\func{bool}{IsInSelection}{\param{const wxGridCellCoords\& }{coords}}
+wxNOT\_FOUND if there is no row at the y position.
\membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect}
Methods for a registry for mapping data types to Renderers/Editors
-
\membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell}
\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}}
\func{void}{SetMargins}{\param{int }{extraWidth}, \param{int }{extraHeight}}
-grid may occupy more space than needed for its rows/columns, this
+A grid may occupy more space than needed for its rows/columns. This
function allows to set how big this extra space is
-
\membersection{wxGrid::wxGrid}\label{wxgridwxgrid}
\func{}{wxGrid}{\param{wxWindow* }{parent}, \param{int }{x}, \param{int }{y}, \param{int }{w = -1}, \param{int }{h = -1}, \param{long }{style = wxWANTS\_CHARS}, \param{const wxString\& }{name = wxPanelNameStr}}
------- For compatibility with previous wxGrid only...
-
-** Don't use these in new code because they **
-** are liable to disappear in a future **
-** revision **
-
-
-
-\membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
-
-\func{void}{SetCellValue}{\param{const wxString\& }{val}, \param{int }{row}, \param{int }{col}}
-
+Backward compatibility.
\membersection{wxGrid::UpdateDimensions}\label{wxgridupdatedimensions}
\func{void}{UpdateDimensions}{\void}
+Backward compatibility.
\membersection{wxGrid::GetRows}\label{wxgridgetrows}
\func{int}{GetRows}{\void}
+Backward compatibility.
\membersection{wxGrid::GetCols}\label{wxgridgetcols}
\func{int}{GetCols}{\void}
+Backward compatibility.
\membersection{wxGrid::GetCursorRow}\label{wxgridgetcursorrow}
\func{int}{GetCursorRow}{\void}
+Backward compatibility.
\membersection{wxGrid::GetCursorColumn}\label{wxgridgetcursorcolumn}
\func{int}{GetCursorColumn}{\void}
+Backward compatibility.
\membersection{wxGrid::GetScrollPosX}\label{wxgridgetscrollposx}
\func{int}{GetScrollPosX}{\void}
+Backward compatibility.
\membersection{wxGrid::GetScrollPosY}\label{wxgridgetscrollposy}
\func{int}{GetScrollPosY}{\void}
+Backward compatibility.
\membersection{wxGrid::SetScrollX}\label{wxgridsetscrollx}
-\func{void}{SetScrollX}{\param{int }{WXUNUSED(x)}}
+\func{void}{SetScrollX}{\param{int }{x}}
+Backward compatibility.
\membersection{wxGrid::SetScrollY}\label{wxgridsetscrolly}
-\func{void}{SetScrollY}{\param{int }{WXUNUSED(y)}}
+\func{void}{SetScrollY}{\param{int }{y}}
+Backward compatibility.
\membersection{wxGrid::SetColumnWidth}\label{wxgridsetcolumnwidth}
\func{void}{SetColumnWidth}{\param{int }{col}, \param{int }{width}}
+Backward compatibility.
\membersection{wxGrid::GetColumnWidth}\label{wxgridgetcolumnwidth}
\func{int}{GetColumnWidth}{\param{int }{col}}
+Backward compatibility.
\membersection{wxGrid::SetRowHeight}\label{wxgridsetrowheight}
\func{void}{SetRowHeight}{\param{int }{row}, \param{int }{height}}
+Backward compatibility.
\membersection{wxGrid::GetViewHeight}\label{wxgridgetviewheight}
\func{int}{GetViewHeight}{\void}
-GetRowHeight() is below
-returned num whole rows visible
-
+Backward compatibility.
\membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth}
\func{int}{GetViewWidth}{\void}
-returned num whole cols visible
-
+Returned number of whole cols visible.
\membersection{wxGrid::SetLabelSize}\label{wxgridsetlabelsize}
\membersection{wxGrid::GetLabelAlignment}\label{wxgridgetlabelalignment}
-\func{int}{GetLabelAlignment}{\param{int }{orientation}, \param{int }{WXUNUSED(align)}}
+\func{int}{GetLabelAlignment}{\param{int }{orientation}, \param{int }{align}}
\membersection{wxGrid::SetLabelValue}\label{wxgridsetlabelvalue}
\constfunc{wxFont}{GetCellTextFont}{\void}
-
-\membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont}
-
-\constfunc{wxFont}{GetCellTextFont}{\param{int }{WXUNUSED(row)}, \param{int }{WXUNUSED(col)}}
+\constfunc{wxFont}{GetCellTextFont}{\param{int }{row}, \param{int }{col}}
\membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont}
\func{void}{SetCellTextFont}{\param{const wxFont\& }{fnt}}
-
-\membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont}
-
\func{void}{SetCellTextFont}{\param{const wxFont\& }{fnt}, \param{int }{row}, \param{int }{col}}
-\membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
-
-\func{void}{SetCellTextColour}{\param{const wxColour\& }{val}, \param{int }{row}, \param{int }{col}}
-
-
-\membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
-
-\func{void}{SetCellTextColour}{\param{const wxColour\& }{col}}
-
-
\membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
\func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{col}}
-\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const }{wxColour\&}}
+\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}
\func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{colour}, \param{int }{row}, \param{int }{col}}
\membersection{wxGrid::SetEditInPlace}\label{wxgridseteditinplace}
-\func{void}{SetEditInPlace}{\param{bool }{WXUNUSED(edit) = TRUE}}
-
-
-\membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment}
-
-\func{void}{SetCellAlignment}{\param{int }{align}, \param{int }{row}, \param{int }{col}}
-
-
-\membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment}
-
-\func{void}{SetCellAlignment}{\param{int }{WXUNUSED(align)}}
+\func{void}{SetEditInPlace}{\param{bool }{edit = TRUE}}
\membersection{wxGrid::SetCellBitmap}\label{wxgridsetcellbitmap}
-\func{void}{SetCellBitmap}{\param{wxBitmap* }{WXUNUSED(bitmap)}, \param{int }{WXUNUSED(row)}, \param{int }{WXUNUSED(col)}}
+\func{void}{SetCellBitmap}{\param{wxBitmap* }{bitmap}, \param{int }{row}, \param{int }{col}}
\membersection{wxGrid::SetDividerPen}\label{wxgridsetdividerpen}
-\func{void}{SetDividerPen}{\param{const wxPen\& }{WXUNUSED(pen)}}
+\func{void}{SetDividerPen}{\param{const wxPen\& }{pen}}
\membersection{wxGrid::GetDividerPen}\label{wxgridgetdividerpen}
\membersection{wxGrid::OnActivate}\label{wxgridonactivate}
-\func{void}{OnActivate}{\param{bool }{WXUNUSED(active)}}
-
+\func{void}{OnActivate}{\param{bool }{active}}
\membersection{wxGrid::Fit}\label{wxgridfit}
\func{void}{Fit}{\void}
-overridden wxWindow methods
-
+Overridden wxWindow methods
\membersection{wxGrid::DoGetBestSize}\label{wxgriddogetbestsize}
\constfunc{wxSize}{DoGetBestSize}{\void}
-
\membersection{wxGrid::InitRowHeights}\label{wxgridinitrowheights}
\func{void}{InitRowHeights}{\void}
-NB: *never* access m\_row/col arrays directly because they are created
-on demand, *always* use accessor functions instead!
-init the m\_rowHeights/Bottoms arrays with default values
+NB: {\it never} access m\_row/col arrays directly because they are created
+on demand, {\it always} use accessor functions instead!
+Init the m\_rowHeights/Bottoms arrays with default values.
\membersection{wxGrid::InitColWidths}\label{wxgridinitcolwidths}
\func{void}{InitColWidths}{\void}
-init the m\_colWidths/Rights arrays
+Init the m\_colWidths/Rights arrays
\membersection{wxGrid::GetColWidth}\label{wxgridgetcolwidth}
\constfunc{int}{GetColWidth}{\param{int }{col}}
-get the col/row coords
+Get the col/row coords
\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft}
\constfunc{int}{GetRowHeight}{\param{int }{row}}
-this function must be public for compatibility...
-
+This function must be public for compatibility.
\membersection{wxGrid::GetRowTop}\label{wxgridgetrowtop}
\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}}
-common part of AutoSizeColumn/Row() and GetBestSize()
-
+Common part of AutoSizeColumn/Row() and GetBestSize()
\membersection{wxGrid::SetOrCalcRowSizes}\label{wxgridsetorcalcrowsizes}
\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}}
-
\membersection{wxGrid::AutoSizeColOrRow}\label{wxgridautosizecolorrow}
\func{void}{AutoSizeColOrRow}{\param{int }{n}, \param{bool }{setAsMin}, \param{bool }{column}}
-common part of AutoSizeColumn/Row()
-or row?
+Common part of AutoSizeColumn/Row() or row?
\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth}
get the minimal width of the given column/row
-
\membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight}
\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}}
-
\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes}
\func{bool}{CanHaveAttributes}{\void}
-do we have some place to store attributes in?
-
+Do we have some place to store attributes in?
\membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
-\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}
\ No newline at end of file
+\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
+
projects / wxWidgets.git / blobdiff