+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name: grid.tex
+%% Purpose: wxGrid
+%% Author:
+%% Modified by: Santiago Palacios
+%% Created:
+%% RCS-ID: $Id$
+%% Copyright: (c) wxWidgets
+%% License: wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\section{\class{wxGrid}}\label{wxgrid}
wxGrid and its related classes are used for displaying and editing tabular
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
+wxGrid has been greatly expanded and redesigned for wxWidgets 2.2
+onwards. 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.
+the previous implementation.
+
+A \helpref{wxGridTableBase}{wxgridtablebase} class holds the actual
+data to be displayed by a wxGrid class. One or more wxGrid classes
+may act as a view for one table class.
+The default table class is called wxGridStringTable and
+holds an array of strings. An instance of such a class is created
+by \helpref{wxGrid::CreateGrid}{wxgridcreategrid}.
+
+\helpref{wxGridCellRenderer}{wxgridcellrenderer} is the abstract base
+class for rendereing contents in a cell. The following renderers are
+predefined:
+\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},
+\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer},
+\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},
+\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer}. The
+look of a cell can be further defined using \helpref{wxGridCellAttr}{wxgridcellattr}.
+An object of this type may be returned by \helpref{wxGridTableBase::GetAttr}{wxgridtablebasegetattr}.
+
+\helpref{wxGridCellEditor}{wxgridcelleditor} is the abstract base
+class for editing the value of a cell. The following editors are
+predefined:
+\helpref{wxGridCellTextEditor}{wxgridcelltexteditor}
+\helpref{wxGridCellBoolEditor}{wxgridcellbooleditor}
+\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
+\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor}.
+
\wxheading{Derived from}
\helpref{wxScrolledWindow}{wxscrolledwindow}\\
+\helpref{wxPanel}{wxpanel}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
<wx/grid.h>
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
\wxheading{Window styles}
There are presently no specific window styles for wxGrid.
\input gridevt.inc
-The event handler for the following functions takes a
+The event handler for the following functions takes a
\helpref{wxGridSizeEvent}{wxgridsizeevent} parameter.
+The ...\_CMD\_... variants also take a window identifier.
\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\_COL\_MOVE(func)}}{The user moved a column by dragging it. Processes a wxEVT\_GRID\_COL\_MOVE.}
\twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_COL\_SIZE(func)}}{The user resized a column by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_COL\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_COL\_MOVE(func)}}{The user moved a column by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_COL\_MOVE.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_ROW\_SIZE(func)}}{The user resized a row by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_ROW\_SIZE.}
\end{twocollist}%
-The event handler for the following functions takes a
+The event handler for the following functions takes a
\helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter.
+The ...\_CMD\_... variant also takes a window identifier.
\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.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_RANGE\_SELECT(id, func)}}{The user selected a group of contiguous cells; variant taking a window identifier. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
\end{twocollist}%
-The event handler for the following functions takes a
+The event handler for the following functions takes a
\helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter.
+The ...\_CMD\_... variant also takes a window identifier.
\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.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_EDITOR\_CREATED(id, func)}}{The editor for a cell was created; variant taking a window identifier. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
\end{twocollist}%
\wxheading{See also}
%%%%%%%%%%% FUNCTION GROUPS %%%%%%%%%%%%%
\latexignore{\rtfignore{\wxheading{Function groups}}}
-\membersection{Constructors and initialization}
+
+
+\membersection{Constructors and initialization}\label{wxgridconstructors}
\helpref{wxGrid}{wxgridctor}\\
\helpref{\destruct{wxGrid}}{wxgriddtor}\\
\helpref{CreateGrid}{wxgridcreategrid}\\
\helpref{SetTable}{wxgridsettable}
-\membersection{Display format}
-\membersection{Selection functions}
+\membersection{Cursor movement}\label{wxgridcursormovement}
+
+\helpref{wxGrid::MoveCursorUp}{wxgridmovecursorup}\\
+\helpref{wxGrid::MoveCursorDown}{wxgridmovecursordown}\\
+\helpref{wxGrid::MoveCursorLeft}{wxgridmovecursorleft}\\
+\helpref{wxGrid::MoveCursorRight}{wxgridmovecursorright}\\
+\helpref{wxGrid::MoveCursorPageUp}{wxgridmovecursorup}\\
+\helpref{wxGrid::MoveCursorPageDown}{wxgridmovecursordown}\\
+\helpref{wxGrid::MoveCursorUpBlock}{wxgridmovecursorupblock}\\
+\helpref{wxGrid::MoveCursorDownBlock}{wxgridmovecursordownblock}\\
+\helpref{wxGrid::MoveCursorLeftBlock}{wxgridmovecursorleftblock}\\
+\helpref{wxGrid::MoveCursorRightBlock}{wxgridmovecursorrightblock}
+
+
+\membersection{Grid line formatting}\label{wxgridlineformatting}
+
+\helpref{wxGrid::EnableGridLines}{wxgridenablegridlines}\\
+\helpref{wxGrid::GridLinesEnabled}{wxgridgridlinesenabled}\\
+\helpref{wxGrid::SetGridLineColour}{wxgridsetgridlinecolour}\\
+\helpref{wxGrid::GetGridLineColour}{wxgridgetgridlinecolour}\\
+\helpref{wxGrid::GetDefaultGridLinePen}{wxgridgetdefaultgridlinepen}\\
+\helpref{wxGrid::GetRowGridLinePen}{wxgridgetrowgridlinepen}\\
+\helpref{wxGrid::GetColGridLinePen}{wxgridgetcolgridlinepen}
+
+\membersection{Row and column label value and format}\label{wxgridrowcoulmlabelformat}
+
+\helpref{wxGrid::SetRowLabelValue}{wxgridsetrowlabelvalue}\\
+\helpref{wxGrid::SetColLabelValue}{wxgridsetcollabelvalue}\\
+\helpref{wxGrid::GetRowLabelValue}{wxgridgetrowlabelvalue}\\
+\helpref{wxGrid::GetColLabelValue}{wxgridgetcollabelvalue}\\
+\helpref{wxGrid::SetUseNativeColLabels}{wxgridsetsenativecollabels}\\
+\helpref{wxGrid::HideColLabels}{wxgridhidecollabels}\\
+\helpref{wxGrid::HideRowLabels}{wxgridhiderowlabels}\\
+\helpref{wxGrid::SetRowLabelSize}{wxgridsetrowlabelsize}\\
+\helpref{wxGrid::SetColLabelSize}{wxgridsetcollabelsize}\\
+\helpref{wxGrid::GetRowLabelSize}{wxgridgetrowlabelsize}\\
+\helpref{wxGrid::GetColLabelSize}{wxgridgetcollabelsize}\\
+\helpref{wxGrid::AutoSizeRowLabelSize}{wxgridautosizerowlabelsize}\\
+\helpref{wxGrid::AutoSizeColLabelSize}{wxgridautosizecollabelsize}\\
+\helpref{wxGrid::GetDefaultRowLabelSize}{wxgridgetdefaultrowlabelsize}\\
+\helpref{wxGrid::GetDefaultColLabelSize}{wxgridgetdefaultcollabelsize}\\
+\helpref{wxGrid::SetRowLabelAlignment}{wxgridsetrowlabelalignment}\\
+\helpref{wxGrid::SetColLabelAlignment}{wxgridsetcollabelalignment}\\
+\helpref{wxGrid::GetRowLabelAlignment}{wxgridgetrowlabelalignment}\\
+\helpref{wxGrid::GetColLabelAlignment}{wxgridgetcollabelalignment}\\
+\helpref{wxGrid::SetLabelFont}{wxgridsetlabelfont}\\
+\helpref{wxGrid::SetLabelTextColour}{wxgridsetlabeltextcolour}\\
+\helpref{wxGrid::SetLabelBackgroundColour}{wxgridsetlabelbackgroundcolour}\\
+\helpref{wxGrid::GetLabelFont}{wxgridgetlabelfont}\\
+\helpref{wxGrid::GetLabelBackgroundColour}{wxgridgetlabelbackgroundcolour}\\
+\helpref{wxGrid::GetLabelTextColour}{wxgridgetlabeltextcolour}\\
+%\helpref{wxGrid::SetColLabelTextOrientation}{wxgridsetcollabeltextorientation}\\
+%\helpref{wxGrid::GetColLabelTextOrientation}{wxgridgetcollabeltextorientation}
+wxGrid::SetColLabelTextOrientation\\
+wxGrid::GetColLabelTextOrientation
+
+\membersection{Cell, row and column user-resizing and dragging}\label{wxgridcellrowcolresizing}
+
+\helpref{wxGrid::EnableDragRowSize}{wxgridenabledragrowsize}\\
+\helpref{wxGrid::EnableDragColSize}{wxgridenabledragcolsize}\\
+\helpref{wxGrid::CanDragRowSize}{wxgridcandragrowsize}\\
+\helpref{wxGrid::CanDragColSize}{wxgridcandragcolsize}\\
+\helpref{wxGrid::EnableDragColMove}{wxgridenabledragcolmove}\\
+\helpref{wxGrid::CanDragColMove}{wxgridcandragcolmove}\\
+\helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}\\
+\helpref{wxGrid::CanDragGridSize}{wxgridcandraggridsize}\\
+\helpref{wxGrid::GetColAt}{wxgridgetcolat}\\
+\helpref{wxGrid::SetColPos}{wxgridsetcolpos}\\
+\helpref{wxGrid::GetColPos}{wxgridgetcolpos}\\
+%\helpref{wxGrid::EnableDragCell}{wxgridenabledragcell}\\
+%\helpref{wxGrid::CanDragCell}{wxgridcandragcell}
+wxGrid::EnableDragCell\\
+wxGrid::CanDragCell
+
+\membersection{Autoresizing and cell size constraints}\label{wxgridautoresizingandcellconstriants}
+
+\helpref{wxGrid::AutoSizeColumn}{wxgridautosizecolumn}\\
+\helpref{wxGrid::AutoSizeRow}{wxgridautosizerow}\\
+\helpref{wxGrid::AutoSizeColumns}{wxgridautosizecolumns}\\
+\helpref{wxGrid::AutoSizeRows}{wxgridautosizerows}\\
+\helpref{wxGrid::AutoSize}{wxgridautosize}\\
+\helpref{wxGrid::SetColMinimalWidth}{wxgridsetcolminimalwidth}\\
+\helpref{wxGrid::SetRowMinimalHeight}{wxgridsetrowminimalheight}\\
+\helpref{wxGrid::SetColMinimalAcceptableWidth}{wxgridsetcolminimalacceptablewidth}\\
+\helpref{wxGrid::SetRowMinimalAcceptableHeight}{wxgridsetrowminimalacceptableheight}\\
+\helpref{wxGrid::GetColMinimalAcceptableWidth}{wxgridgetcolminimalacceptablewidth}\\
+\helpref{wxGrid::GetRowMinimalAcceptableHeight}{wxgridgetrowminimalacceptableheight}
+
+\membersection{Selection functions}\label{wxgridselectionfunctions}
\helpref{wxGrid::ClearSelection}{wxgridclearselection}\\
\helpref{wxGrid::IsSelection}{wxgridisselection}\\
}}
+
+
\membersection{wxGrid::wxGrid}\label{wxgridctor}
\func{}{wxGrid}{\void}
\func{}{wxGrid}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxWANTS\_CHARS}, \param{const wxString\& }{name = wxPanelNameStr}}
-Constructor to create a grid object. Call either \helpref{wxGrid::CreateGrid}{wxgridcreategrid} or
+Constructor to create a grid object. Call either \helpref{wxGrid::CreateGrid}{wxgridcreategrid} or
\helpref{wxGrid::SetTable}{wxgridsettable} directly after this to initialize the grid before using
-it.
+it.
+
+
\membersection{wxGrid::\destruct{wxGrid}}\label{wxgriddtor}
Destructor. This will also destroy the associated grid table unless you passed a table
object to the grid and specified that the grid should not take ownership of the
-table (see \helpref{wxGrid::SetTable}{wxgridsettable}).
+table (see \helpref{wxGrid::SetTable}{wxgridsettable}).
+
+
\membersection{wxGrid::AppendCols}\label{wxgridappendcols}
-\func{bool}{AppendCols}{\param{int }{numCols = 1}, \param{bool }{updateLabels = TRUE}}
+\func{bool}{AppendCols}{\param{int }{numCols = 1}, \param{bool }{updateLabels = true}}
-Appends one or more new columns to the right of the grid and returns TRUE if
+Appends one or more new columns to the right of the grid and returns true if
successful. The updateLabels argument is not used at present.
-If you are using a derived grid table class you will need to override
-\helpref{wxGridTableBase::AppendCols}{wxgridtablebaseappendcols}. See
-\helpref{wxGrid::InsertCols}{wxgridinsertcols} for further information.
+If you are using a derived grid table class you will need to override
+\helpref{wxGridTableBase::AppendCols}{wxgridtablebaseappendcols}. See
+\helpref{wxGrid::InsertCols}{wxgridinsertcols} for further information.
+
+
\membersection{wxGrid::AppendRows}\label{wxgridappendrows}
-\func{bool}{AppendRows}{\param{int }{numRows = 1}, \param{bool }{updateLabels = TRUE}}
+\func{bool}{AppendRows}{\param{int }{numRows = 1}, \param{bool }{updateLabels = true}}
-Appends one or more new rows to the bottom of the grid and returns TRUE if
+Appends one or more new rows to the bottom of the grid and returns true if
successful. The updateLabels argument is not used at present.
-If you are using a derived grid table class you will need to override
-\helpref{wxGridTableBase::AppendRows}{wxgridtablebaseappendrows}. See
-\helpref{wxGrid::InsertRows}{wxgridinsertrows} for further information.
+If you are using a derived grid table class you will need to override
+\helpref{wxGridTableBase::AppendRows}{wxgridtablebaseappendrows}. See
+\helpref{wxGrid::InsertRows}{wxgridinsertrows} for further information.
+
+
\membersection{wxGrid::AutoSize}\label{wxgridautosize}
\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.
+The memory requirements for this could become prohibitive if your grid is very large.
+
+
+
+\membersection{wxGrid::AutoSizeColLabelSize}\label{wxgridautosizecollabelsize}
+
+\func{void}{AutoSizeColLabelSize}{\param{int }{col}}
+
+Automatically adjusts width of the column to fit its label.
+
+
\membersection{wxGrid::AutoSizeColumn}\label{wxgridautosizecolumn}
-\func{void}{AutoSizeColumn}{\param{int }{col}, \param{bool }{setAsMin = TRUE}}
+\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}\\
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.
+The memory requirements for this could become prohibitive if your grid is very large.
+
+
\membersection{wxGrid::AutoSizeColumns}\label{wxgridautosizecolumns}
-\func{void}{AutoSizeColumns}{\param{bool }{setAsMin = TRUE}}
+\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}\\
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.
+The memory requirements for this could become prohibitive if your grid is very large.
+
+
\membersection{wxGrid::AutoSizeRow}\label{wxgridautosizerow}
-\func{void}{AutoSizeRow}{\param{int }{row}, \param{bool }{setAsMin = TRUE}}
+\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}\\
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.
+The memory requirements for this could become prohibitive if your grid is very large.
+
+
+
+\membersection{wxGrid::AutoSizeRowLabelSize}\label{wxgridautosizerowlabelsize}
+
+\func{void}{AutoSizeRowLabelSize}{\param{int }{col}}
+
+Automatically adjusts height of the row to fit its label.
+
+
\membersection{wxGrid::AutoSizeRows}\label{wxgridautosizerows}
-\func{void}{AutoSizeRows}{\param{bool }{setAsMin = TRUE}}
+\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}\\
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.
+The memory requirements for this could become prohibitive if your grid is very large.
+
+
\membersection{wxGrid::BeginBatch}\label{wxgridbeginbatch}
\func{void}{BeginBatch}{\void}
Increments the grid's batch count. When the count is greater than zero repainting of
-the grid is suppressed. Each call to BeginBatch must be matched by a later call to
+the grid is suppressed. Each call to BeginBatch must be matched by a later call to
\helpref{wxGrid::EndBatch}{wxgridendbatch}. Code that does a lot of grid
modification can be enclosed between BeginBatch and EndBatch calls to avoid
screen flicker. The final EndBatch will cause the grid to be repainted.
+\wxheading{See also}
+
+\helpref{wxGridUpdateLocker}{wxgridupdatelocker}
+
+
+
+\membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect}
+
+\constfunc{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}}
+
+This function returns the rectangle that encloses the block of cells
+limited by TopLeft and BottomRight cell in device coords and clipped
+to the client size of the grid window.
+
+
+
+\membersection{wxGrid::CanDragColMove}\label{wxgridcandragcolmove}
+
+\constfunc{bool}{CanDragColMove}{\void}
+
+Returns true if columns can be moved by dragging with the mouse. Columns can be moved
+by dragging on their labels.
+
+
+
\membersection{wxGrid::CanDragColSize}\label{wxgridcandragcolsize}
-\func{bool}{CanDragColSize}{\void}
+\constfunc{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
+resized by dragging the right edge of the column in the grid cell area
(see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}).
+
+
\membersection{wxGrid::CanDragRowSize}\label{wxgridcandragrowsize}
-\func{bool}{CanDragRowSize}{\void}
+\constfunc{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
+resized by dragging the lower edge of the row in the grid cell area
(see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}).
+
+
\membersection{wxGrid::CanDragGridSize}\label{wxgridcandraggridsize}
-\func{bool}{CanDragGridSize}{\void}
+\constfunc{bool}{CanDragGridSize}{\void}
+
+Return true if the dragging of grid lines to resize rows and columns is enabled or false otherwise.
+
-Return TRUE if the dragging of grid lines to resize rows and columns is enabled or FALSE otherwise.
\membersection{wxGrid::CanEnableCellControl}\label{wxgridcanenablecellcontrol}
\constfunc{bool}{CanEnableCellControl}{\void}
-Returns TRUE if the in-place edit control for the current grid cell can be used and
-FALSE otherwise (e.g. if the current cell is read-only).
+Returns true if the in-place edit control for the current grid cell can be used and
+false otherwise (e.g. if the current cell is read-only).
+
+
+
+\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes}
+
+\constfunc{bool}{CanHaveAttributes}{\void}
+
+Do we have some place to store attributes in?
+
+
\membersection{wxGrid::CellToRect}\label{wxgridcelltorect}
-\func{wxRect}{CellToRect}{\param{int }{row}, \param{int }{col}}
+\constfunc{wxRect}{CellToRect}{\param{int }{row}, \param{int }{col}}
-\func{wxRect}{CellToRect}{\param{const wxGridCellCoords\& }{coords}}
+\constfunc{wxRect}{CellToRect}{\param{const wxGridCellCoords\& }{coords}}
Return the rectangle corresponding to the grid cell's size and position in logical
coordinates.
+
+
\membersection{wxGrid::ClearGrid}\label{wxgridcleargrid}
\func{void}{ClearGrid}{\void}
Clears all data in the underlying grid table and repaints the grid. The table is not deleted by
-this function. If you are using a derived table class then you need to override
+this function. If you are using a derived table class then you need to override
\helpref{wxGridTableBase::Clear}{wxgridtablebaseclear} for this function to have any effect.
+
+
\membersection{wxGrid::ClearSelection}\label{wxgridclearselection}
\func{void}{ClearSelection}{\void}
Deselects all cells that are currently selected.
+
+
\membersection{wxGrid::CreateGrid}\label{wxgridcreategrid}
\func{bool}{CreateGrid}{\param{int }{numRows}, \param{int }{numCols}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}}
For applications with more complex data types or relationships, or for
dealing with very large datasets, you should derive your own grid table
-class and pass a table object to the grid with \helpref{wxGrid::SetTable}{wxgridsettable}.
+class and pass a table object to the grid with \helpref{wxGrid::SetTable}{wxgridsettable}.
+
+
\membersection{wxGrid::DeleteCols}\label{wxgriddeletecols}
-\func{bool}{DeleteCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = TRUE}}
+\func{bool}{DeleteCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}}
Deletes one or more columns from a grid starting at the specified position and returns
-TRUE if successful. The updateLabels argument is not used at present.
+true if successful. The updateLabels argument is not used at present.
-If you are using a derived grid table class you will need to override
-\helpref{wxGridTableBase::DeleteCols}{wxgridtablebasedeletecols}. See
+If you are using a derived grid table class you will need to override
+\helpref{wxGridTableBase::DeleteCols}{wxgridtablebasedeletecols}. See
\helpref{wxGrid::InsertCols}{wxgridinsertcols} for further information.
+
+
\membersection{wxGrid::DeleteRows}\label{wxgriddeleterows}
-\func{bool}{DeleteRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = TRUE}}
+\func{bool}{DeleteRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = true}}
Deletes one or more rows from a grid starting at the specified position and returns
-TRUE if successful. The updateLabels argument is not used at present.
+true if successful. The updateLabels argument is not used at present.
-If you are using a derived grid table class you will need to override
-\helpref{wxGridTableBase::DeleteRows}{wxgridtablebasedeleterows}. See
+If you are using a derived grid table class you will need to override
+\helpref{wxGridTableBase::DeleteRows}{wxgridtablebasedeleterows}. See
\helpref{wxGrid::InsertRows}{wxgridinsertrows} for further information.
+
+
\membersection{wxGrid::DisableCellEditControl}\label{wxgriddisablecelleditcontrol}
\func{void}{DisableCellEditControl}{\void}
-Disables in-place editing of grid cells.
-Equivalent to calling EnableCellEditControl(FALSE).
+Disables in-place editing of grid cells.
+Equivalent to calling EnableCellEditControl(false).
+
+
+
+\membersection{wxGrid::DisableDragColMove}\label{wxgriddisabledragcolmove}
+
+\func{void}{DisableDragColMove}{\void}
+
+Disables column moving by dragging with the mouse. Equivalent to passing false to
+\helpref{wxGrid::EnableDragColMove}{wxgridenabledragcolmove}.
+
+
\membersection{wxGrid::DisableDragColSize}\label{wxgriddisabledragcolsize}
\func{void}{DisableDragColSize}{\void}
-Disables column sizing by dragging with the mouse. Equivalent to passing FALSE to
-\helpref{wxGrid::EnableDragColSize}{wxgridenabledragcolsize}.
+Disables column sizing by dragging with the mouse. Equivalent to passing false to
+\helpref{wxGrid::EnableDragColSize}{wxgridenabledragcolsize}.
+
+
\membersection{wxGrid::DisableDragGridSize}\label{wxgriddisabledraggridsize}
\func{void}{DisableDragGridSize}{\void}
Disable mouse dragging of grid lines to resize rows and columns. Equivalent to passing
-FALSE to \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}
+false to \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}
+
+
\membersection{wxGrid::DisableDragRowSize}\label{wxgriddisabledragrowsize}
\func{void}{DisableDragRowSize}{\void}
-Disables row sizing by dragging with the mouse. Equivalent to passing FALSE to
-\helpref{wxGrid::EnableDragRowSize}{wxgridenabledragrowsize}.
+Disables row sizing by dragging with the mouse. Equivalent to passing false to
+\helpref{wxGrid::EnableDragRowSize}{wxgridenabledragrowsize}.
+
+
\membersection{wxGrid::EnableCellEditControl}\label{wxgridenablecelleditcontrol}
-\func{void}{EnableCellEditControl}{\param{bool }{enable = TRUE}}
+\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.
+
+
\membersection{wxGrid::EnableDragColSize}\label{wxgridenabledragcolsize}
-\func{void}{EnableDragColSize}{\param{bool }{enable = TRUE}}
+\func{void}{EnableDragColSize}{\param{bool }{enable = true}}
Enables or disables column sizing by dragging with the mouse.
+
+
+\membersection{wxGrid::EnableDragColMove}\label{wxgridenabledragcolmove}
+
+\func{void}{EnableDragColMove}{\param{bool }{enable = true}}
+
+Enables or disables column moving by dragging with the mouse.
+
+
+
\membersection{wxGrid::EnableDragGridSize}\label{wxgridenabledraggridsize}
-\func{void}{EnableDragGridSize}{\param{bool }{enable = TRUE}}
+\func{void}{EnableDragGridSize}{\param{bool }{enable = true}}
Enables or disables row and column resizing by dragging gridlines with the mouse.
+
+
\membersection{wxGrid::EnableDragRowSize}\label{wxgridenabledragrowsize}
-\func{void}{EnableDragRowSize}{\param{bool }{enable = TRUE}}
+\func{void}{EnableDragRowSize}{\param{bool }{enable = true}}
Enables or disables row sizing by dragging with the mouse.
+
+
\membersection{wxGrid::EnableEditing}\label{wxgridenableediting}
\func{void}{EnableEditing}{\param{bool }{edit}}
-If the edit argument is FALSE this function sets the whole grid as read-only. If the
-argument is TRUE the grid is set to the default state where cells may be editable. In the
+If the edit argument is false this function sets the whole grid as read-only. If the
+argument is true the grid is set to the default state where cells may be editable. In the
default state you can set single grid cells and whole rows and columns to be editable or
-read-only via
+read-only via
\helpref{wxGridCellAttribute::SetReadOnly}{wxgridcellattrsetreadonly}. For single
-cells you can also use the shortcut function
-\helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}.
+cells you can also use the shortcut function
+\helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}.
-For more information about controlling grid cell attributes see the
-\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the
+For more information about controlling grid cell attributes see the
+\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the
\helpref{wxGrid classes overview}{gridoverview}.
+
+
\membersection{wxGrid::EnableGridLines}\label{wxgridenablegridlines}
-\func{void}{EnableGridLines}{\param{bool }{enable = TRUE}}
+\func{void}{EnableGridLines}{\param{bool }{enable = true}}
Turns the drawing of grid lines on or off.
+
+
\membersection{wxGrid::EndBatch}\label{wxgridendbatch}
\func{void}{EndBatch}{\void}
Decrements the grid's batch count. When the count is greater than zero repainting of
-the grid is suppressed. Each previous call to
+the grid is suppressed. Each previous call to
\helpref{wxGrid::BeginBatch}{wxgridbeginbatch} must be matched by a later call to
EndBatch. Code that does a lot of grid modification can be enclosed between
BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will
cause the grid to be repainted.
+\wxheading{See also}
+
+\helpref{wxGridUpdateLocker}{wxgridupdatelocker}
+
+
+
+\membersection{wxGrid::Fit}\label{wxgridfit}
+
+\func{void}{Fit}{\void}
+
+Overridden wxWindow method.
+
+
+
\membersection{wxGrid::ForceRefresh}\label{wxgridforcerefresh}
\func{void}{ForceRefresh}{\void}
Causes immediate repainting of the grid. Use this instead of the usual wxWindow::Refresh.
+
+
\membersection{wxGrid::GetBatchCount}\label{wxgridgetbatchcount}
-\func{int}{GetBatchCount}{\void}
+\constfunc{int}{GetBatchCount}{\void}
Returns the number of times that \helpref{wxGrid::BeginBatch}{wxgridbeginbatch} has been called
without (yet) matching calls to \helpref{wxGrid::EndBatch}{wxgridendbatch}. While
the grid's batch count is greater than zero the display will not be updated.
+
+
\membersection{wxGrid::GetCellAlignment}\label{wxgridgetcellalignment}
-\func{void}{GetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int* }{horiz}, \param{int* }{vert}}
+\constfunc{void}{GetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int* }{horiz}, \param{int* }{vert}}
Sets the arguments to the horizontal and vertical text alignment values for the
grid cell at the specified location.
\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}}
+\constfunc{wxColour}{GetCellBackgroundColour}{\param{int }{row}, \param{int }{col}}
Returns the background colour of the cell at the specified location.
+
+
\membersection{wxGrid::GetCellEditor}\label{wxgridgetcelleditor}
-\func{wxGridCellEditor*}{GetCellEditor}{\param{int }{row}, \param{int }{col}}
+\constfunc{wxGridCellEditor*}{GetCellEditor}{\param{int }{row}, \param{int }{col}}
Returns a pointer to the editor for the cell at the specified location.
See \helpref{wxGridCellEditor}{wxgridcelleditor} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+
+
\membersection{wxGrid::GetCellFont}\label{wxgridgetcellfont}
-\func{wxFont}{GetCellFont}{\param{int }{row}, \param{int }{col}}
+\constfunc{wxFont}{GetCellFont}{\param{int }{row}, \param{int }{col}}
Returns the font for text in the grid cell at the specified location.
+
+
\membersection{wxGrid::GetCellRenderer}\label{wxgridgetcellrenderer}
-\func{wxGridCellRenderer*}{GetCellRenderer}{\param{int }{row}, \param{int }{col}}
+\constfunc{wxGridCellRenderer*}{GetCellRenderer}{\param{int }{row}, \param{int }{col}}
Returns a pointer to the renderer for the grid cell at the specified location.
See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+
+
\membersection{wxGrid::GetCellTextColour}\label{wxgridgetcelltextcolour}
-\func{wxColour}{GetCellTextColour}{\param{int }{row}, \param{int }{col}}
+\constfunc{wxColour}{GetCellTextColour}{\param{int }{row}, \param{int }{col}}
Returns the text colour for the grid cell at the specified location.
+
+
\membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue}
-\func{wxString}{GetCellValue}{\param{int }{row}, \param{int }{col}}
+\constfunc{wxString}{GetCellValue}{\param{int }{row}, \param{int }{col}}
-\func{wxString}{GetCellValue}{\param{const wxGridCellCoords\&}{coords}}
+\constfunc{wxString}{GetCellValue}{\param{const wxGridCellCoords\&}{coords}}
Returns the string contained in 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::SetCellValue}{wxgridsetcellvalue} to access cell values.
+with \helpref{wxGrid::SetCellValue}{wxgridsetcellvalue} 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.
See \helpref{wxGridTableBase::CanGetValueAs}{wxgridtablebasecangetvalueas}
and the \helpref{wxGrid overview}{gridoverview} for more information.
+
+
+\membersection{wxGrid::GetColAt}\label{wxgridgetcolat}
+
+\constfunc{int}{GetColAt}{\param{int }{colPos}}
+
+Returns the column ID of the specified column position.
+
+
+\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft}
+
+\constfunc{int}{GetColLeft}{\param{int }{col}}
+
+
+
\membersection{wxGrid::GetColLabelAlignment}\label{wxgridgetcollabelalignment}
-\func{void}{GetColLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
+\constfunc{void}{GetColLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
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.
+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 takes no parameters and
returns a 2-element list {\tt ( horiz, vert )}.}
+
+
\membersection{wxGrid::GetColLabelSize}\label{wxgridgetcollabelsize}
-\func{int}{GetColLabelSize}{\void}
+\constfunc{int}{GetColLabelSize}{\void}
Returns the current height of the column labels.
+
+
\membersection{wxGrid::GetColLabelValue}\label{wxgridgetcollabelvalue}
-\func{wxString}{GetColLabelValue}{\param{int }{col}}
+\constfunc{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.
+your own labels.
+
+
+
+\membersection{wxGrid::GetColMinimalAcceptableWidth}\label{wxgridgetcolminimalacceptablewidth}
+
+\constfunc{int}{GetColMinimalAcceptableWidth}{}
+
+This returns the value of the lowest column width that can be handled correctly. See
+member \helpref{SetColMinimalAcceptableWidth}{wxgridsetcolminimalacceptablewidth} for details.
+
+
+
+\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth}
+
+\constfunc{int}{GetColMinimalWidth}{\param{int }{col}}
+
+Get the minimal width of the given column/row.
+
+
+
+\membersection{wxGrid::GetColPos}\label{wxgridgetcolpos}
+
+\constfunc{int}{GetColPos}{\param{int }{colID}}
+
+Returns the position of the specified column.
+
+
+
+\membersection{wxGrid::GetColRight}\label{wxgridgetcolright}
+
+\constfunc{int}{GetColRight}{\param{int }{col}}
+
+
\membersection{wxGrid::GetColSize}\label{wxgridgetcolsize}
-\func{int}{GetColSize}{\param{int }{col}}
+\constfunc{int}{GetColSize}{\param{int }{col}}
Returns the width of the specified column.
+
+
\membersection{wxGrid::GetDefaultCellAlignment}\label{wxgridgetdefaultcellalignment}
-\func{void}{GetDefaultCellAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
+\constfunc{void}{GetDefaultCellAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
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.
+
+
\membersection{wxGrid::GetDefaultCellBackgroundColour}\label{wxgridgetdefaultcellbackgroundcolour}
-\func{wxColour}{GetDefaultCellBackgroundColour}{\void}
+\constfunc{wxColour}{GetDefaultCellBackgroundColour}{\void}
Returns the current default background colour for grid cells.
+
+
\membersection{wxGrid::GetDefaultCellFont}\label{wxgridgetdefaultcellfont}
-\func{wxFont}{GetDefaultCellFont}{\void}
+\constfunc{wxFont}{GetDefaultCellFont}{\void}
Returns the current default font for grid cell text.
+
+
\membersection{wxGrid::GetDefaultCellTextColour}\label{wxgridgetdefaultcelltextcolour}
-\func{wxColour}{GetDefaultCellTextColour}{\void}
+\constfunc{wxColour}{GetDefaultCellTextColour}{\void}
Returns the current default colour for grid cell text.
+
+
\membersection{wxGrid::GetDefaultColLabelSize}\label{wxgridgetdefaultcollabelsize}
-\func{int}{GetDefaultColLabelSize}{\void}
+\constfunc{int}{GetDefaultColLabelSize}{\void}
Returns the default height for column labels.
+
+
\membersection{wxGrid::GetDefaultColSize}\label{wxgridgetdefaultcolsize}
-\func{int}{GetDefaultColSize}{\void}
+\constfunc{int}{GetDefaultColSize}{\void}
Returns the current default width for grid columns.
+
+
\membersection{wxGrid::GetDefaultEditor}\label{wxgridgetdefaulteditor}
\constfunc{wxGridCellEditor*}{GetDefaultEditor}{\void}
See \helpref{wxGridCellEditor}{wxgridcelleditor} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+
+
+\membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell}
+
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}}
+
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{const wxGridCellCoords\& }{c}}
+
+
+
+\membersection{wxGrid::GetDefaultEditorForType}\label{wxgridgetdefaulteditorfortype}
+
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForType}{\param{const wxString\& }{typeName}}
+
+
+
\membersection{wxGrid::GetDefaultRenderer}\label{wxgridgetdefaultrenderer}
\constfunc{wxGridCellRenderer*}{GetDefaultRenderer}{\void}
See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+
+
+\membersection{wxGrid::GetDefaultRendererForCell}\label{wxgridgetdefaultrendererforcell}
+
+\constfunc{wxGridCellRenderer*}{GetDefaultRendererForCell}{\param{int }{row}, \param{int }{col}}
+
+
+
+\membersection{wxGrid::GetDefaultRendererForType}\label{wxgridgetdefaultrendererfortype}
+
+\constfunc{wxGridCellRenderer*}{GetDefaultRendererForType}{\param{const wxString\& }{typeName}}
+
+
+
\membersection{wxGrid::GetDefaultRowLabelSize}\label{wxgridgetdefaultrowlabelsize}
-\func{int}{GetDefaultRowLabelSize}{\void}
+\constfunc{int}{GetDefaultRowLabelSize}{\void}
Returns the default width for the row labels.
+
+
\membersection{wxGrid::GetDefaultRowSize}\label{wxgridgetdefaultrowsize}
-\func{int}{GetDefaultRowSize}{\void}
+\constfunc{int}{GetDefaultRowSize}{\void}
Returns the current default height for grid rows.
+
+
\membersection{wxGrid::GetGridCursorCol}\label{wxgridgetgridcursorcol}
-\func{int}{GetGridCursorCol}{\void}
+\constfunc{int}{GetGridCursorCol}{\void}
Returns the current grid cell column position.
+
+
\membersection{wxGrid::GetGridCursorRow}\label{wxgridgetgridcursorrow}
-\func{int}{GetGridCursorRow}{\void}
+\constfunc{int}{GetGridCursorRow}{\void}
Returns the current grid cell row position.
+
+
\membersection{wxGrid::GetGridLineColour}\label{wxgridgetgridlinecolour}
-\func{wxColour}{GetGridLineColour}{\void}
+\constfunc{wxColour}{GetGridLineColour}{\void}
Returns the colour used for grid lines.
-\membersection{wxGrid::GridLinesEnabled}\label{wxgridgridlinesenabled}
+\wxheading{See also}
-\func{bool}{GridLinesEnabled}{\void}
+\helpref{GetDefaultGridLinePen()}{wxgridgetdefaultgridlinepen}
-Returnes TRUE if drawing of grid lines is turned on, FALSE otherwise.
-\membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
+\membersection{wxGrid::GetDefaultGridLinePen}\label{wxgridgetdefaultgridlinepen}
-\func{wxColour}{GetLabelBackgroundColour}{\void}
+\func{wxPen}{GetDefaultGridLinePen}{\void}
-Returns the colour used for the background of row and column labels.
+Returns the pen used for grid lines. This virtual function may be overridden in
+derived classes in order to change the appearance of grid lines. Note that
+currently the pen width must be $1$.
-\membersection{wxGrid::GetLabelFont}\label{wxgridgetlabelfont}
+\wxheading{See also}
-\func{wxFont}{GetLabelFont}{\void}
+\helpref{GetColGridLinePen()}{wxgridgetcolgridlinepen},\\
+\helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen}
-Returns the font used for row and column labels.
-\membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour}
-\func{wxColour}{GetLabelTextColour}{\void}
-Returns the colour used for row and column label text.
+\membersection{wxGrid::GetRowGridLinePen}\label{wxgridgetrowgridlinepen}
-\membersection{wxGrid::GetNumberCols}\label{wxgridgetnumbercols}
+\func{wxPen}{GetRowGridLinePen}{\param{int }{row}}
-\func{int}{GetNumberCols}{\void}
+Returns the pen used for horizontal grid lines. This virtual function may be
+overridden in derived classes in order to change the appearance of individual
+grid line for the given row \arg{row}.
-Returns the total number of grid columns (actually the number of columns in the underlying grid
-table).
+Example: \\
+\\
+\begin{verbatim}
+ // in a grid displaying music notation, use a solid black pen between
+ // octaves (C0=row 127, C1=row 115 etc.)
+ wxPen MidiGrid::GetRowGridLinePen(int row)
+ {
+ if ( row%12 == 7 )
+ return wxPen(*wxBLACK, 1, wxSOLID);
+ else
+ return GetDefaultGridLinePen();
+ }
+\end{verbatim}
-\membersection{wxGrid::GetNumberRows}\label{wxgridgetnumberrows}
-\func{int}{GetNumberRows}{\void}
-Returns the total number of grid rows (actually the number of rows in the underlying grid table).
+\membersection{wxGrid::GetColGridLinePen}\label{wxgridgetcolgridlinepen}
-\membersection{wxGrid::GetRowLabelAlignment}\label{wxgridgetrowlabelalignment}
+\func{wxPen}{GetColGridLinePen}{\param{int }{col}}
-\func{void}{GetRowLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
+Returns the pen used for vertical grid lines. This virtual function may be
+overridden in derived classes in order to change the appearance of individual
+grid lines for the given column \arg{col}.
-Sets the arguments to the current row label alignment values.
+See \helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen} for an example.
-Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\
+
+
+
+\membersection{wxGrid::GridLinesEnabled}\label{wxgridgridlinesenabled}
+
+\constfunc{bool}{GridLinesEnabled}{\void}
+
+Returns true if drawing of grid lines is turned on, false otherwise.
+
+
+
+\membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
+
+\constfunc{wxColour}{GetLabelBackgroundColour}{\void}
+
+Returns the colour used for the background of row and column labels.
+
+
+
+\membersection{wxGrid::GetLabelFont}\label{wxgridgetlabelfont}
+
+\constfunc{wxFont}{GetLabelFont}{\void}
+
+Returns the font used for row and column labels.
+
+
+
+\membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour}
+
+\constfunc{wxColour}{GetLabelTextColour}{\void}
+
+Returns the colour used for row and column label text.
+
+
+
+\membersection{wxGrid::GetNumberCols}\label{wxgridgetnumbercols}
+
+\constfunc{int}{GetNumberCols}{\void}
+
+Returns the total number of grid columns (actually the number of columns in the underlying grid
+table).
+
+
+
+\membersection{wxGrid::GetNumberRows}\label{wxgridgetnumberrows}
+
+\constfunc{int}{GetNumberRows}{\void}
+
+Returns the total number of grid rows (actually the number of rows in the underlying grid table).
+
+
+
+\membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
+
+\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
+
+
+
+\membersection{wxGrid::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight}
+
+\constfunc{int}{GetRowMinimalAcceptableHeight}{}
+
+This returns the value of the lowest row width that can be handled correctly. See
+member \helpref{SetRowMinimalAcceptableHeight}{wxgridsetrowminimalacceptableheight} for details.
+
+
+
+\membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight}
+
+\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}}
+
+
+
+\membersection{wxGrid::GetRowLabelAlignment}\label{wxgridgetrowlabelalignment}
+
+\constfunc{void}{GetRowLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
+
+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}
+\constfunc{int}{GetRowLabelSize}{\void}
Returns the current width of the row labels.
+
+
\membersection{wxGrid::GetRowLabelValue}\label{wxgridgetrowlabelvalue}
-\func{wxString}{GetRowLabelValue}{\param{int }{row}}
+\constfunc{wxString}{GetRowLabelValue}{\param{int }{row}}
-Returns the specifed row label. The default grid table class provides numeric row labels.
-If you are using a custom grid table you can override
+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.
+your own labels.
+
+
\membersection{wxGrid::GetRowSize}\label{wxgridgetrowsize}
-\func{int}{GetRowSize}{\param{int }{row}}
+\constfunc{int}{GetRowSize}{\param{int }{row}}
Returns the height of the specified row.
+
+
+\membersection{wxGrid::GetScrollLineX}\label{wxgridgetscrolllinex}
+
+\constfunc{int}{GetScrollLineX}{\void}
+
+Returns the number of pixels per horizontal scroll increment. The default is 15.
+
+\wxheading{See also}
+
+\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp
+\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp
+\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney}
+
+
+
+\membersection{wxGrid::GetScrollLineY}\label{wxgridgetscrollliney}
+
+\constfunc{int}{GetScrollLineY}{\void}
+
+Returns the number of pixels per vertical scroll increment. The default is 15.
+
+\wxheading{See also}
+
+\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp
+\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp
+\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney}
+
+
+
+\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::GetSelectionBackground}\label{wxgridgetselectionbackground}
+
+\constfunc{wxColour}{GetSelectionBackground}{\void}
+
+Access or update the selection fore/back colours
+
+
+
+\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::GetSelectionForeground}\label{wxgridgetselectionforeground}
+
+\constfunc{wxColour}{GetSelectionForeground}{\void}
+
+
+
\membersection{wxGrid::GetTable}\label{wxgridgettable}
\constfunc{wxGridTableBase *}{GetTable}{\void}
Returns a base pointer to the current table object.
+
+
+\membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth}
+
+\constfunc{int}{GetViewWidth}{\void}
+
+Returned number of whole cols visible.
+
+
+
\membersection{wxGrid::HideCellEditControl}\label{wxgridhidecelleditcontrol}
\func{void}{HideCellEditControl}{\void}
Hides the in-place cell edit control.
+
+\membersection{wxGrid::HideColLabels}\label{wxgridhidecollabels}
+
+\func{void}{HideColLabels}{\void}
+
+Hides the column labels by calling \helpref{SetColLabelSize}{wxgridsetcollabelsize}
+with a size of 0. Show labels again by calling that method with
+a width greater than 0.
+
+
+\membersection{wxGrid::HideRowLabels}\label{wxgridhiderowlabels}
+
+\func{void}{HideRowLabels}{\void}
+
+Hides the row labels by calling \helpref{SetRowLabelSize}{wxgridsetrowlabelsize}
+with a size of 0. Show labels again by calling that method with
+a width greater than 0.
+
+
+\membersection{wxGrid::InitColWidths}\label{wxgridinitcolwidths}
+
+\func{void}{InitColWidths}{\void}
+
+Init the m\_colWidths/Rights arrays
+
+
+
+\membersection{wxGrid::InitRowHeights}\label{wxgridinitrowheights}
+
+\func{void}{InitRowHeights}{\void}
+
+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::InsertCols}\label{wxgridinsertcols}
-\func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = TRUE}}
+\func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}}
Inserts one or more new columns into a grid with the first new column at the
-specified position and returns TRUE if successful. The updateLabels argument is not
-used at present.
+specified position and returns true if successful. The updateLabels argument is not
+used at present.
The sequence of actions begins with the grid object requesting the underlying grid
table to insert new columns. If this is successful the table notifies the grid and the
-grid updates the display. For a default grid (one where you have called
+grid updates the display. For a default grid (one where you have called
\helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are
-using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
-then you must override
+using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
+then you must override
\helpref{wxGridTableBase::InsertCols}{wxgridtablebaseinsertcols} in your derived
table class.
+
+
\membersection{wxGrid::InsertRows}\label{wxgridinsertrows}
-\func{bool}{InsertRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = TRUE}}
+\func{bool}{InsertRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = true}}
Inserts one or more new rows into a grid with the first new row at the specified
-position and returns TRUE if successful. The updateLabels argument is not used at
-present.
+position and returns true if successful. The updateLabels argument is not used at
+present.
The sequence of actions begins with the grid object requesting the underlying grid
table to insert new rows. If this is successful the table notifies the grid and the
-grid updates the display. For a default grid (one where you have called
+grid updates the display. For a default grid (one where you have called
\helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are
-using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
-then you must override
+using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
+then you must override
\helpref{wxGridTableBase::InsertRows}{wxgridtablebaseinsertrows} in your derived
table class.
+
+
\membersection{wxGrid::IsCellEditControlEnabled}\label{wxgridiscelleditcontrolenabled}
\constfunc{bool}{IsCellEditControlEnabled}{\void}
-Returns TRUE if the in-place edit control is currently enabled.
+Returns true if the in-place edit control is currently enabled.
+
+
\membersection{wxGrid::IsCurrentCellReadOnly}\label{wxgridiscurrentcellreadonly}
\constfunc{bool}{IsCurrentCellReadOnly}{\void}
-Returns TRUE if the current cell has been set to read-only
+Returns true if the current cell has been set to read-only
(see \helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}).
+
+
\membersection{wxGrid::IsEditable}\label{wxgridiseditable}
-\func{bool}{IsEditable}{\void}
+\constfunc{bool}{IsEditable}{\void}
-Returns FALSE if the whole grid has been set as read-only or TRUE otherwise.
+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}}
-Returns TRUE if the cell at the specified location can't be edited.
+Returns true if the cell at the specified location can't be edited.
See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}.
+
+
\membersection{wxGrid::IsSelection}\label{wxgridisselection}
-\func{bool}{IsSelection}{\void}
+\constfunc{bool}{IsSelection}{\void}
+
+Returns true if there are currently rows, columns or blocks of cells selected.
+
-Returns TRUE if there are currently rows, columns or blocks of cells selected.
\membersection{wxGrid::IsVisible}\label{wxgridisvisible}
-\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = TRUE}}
+\constfunc{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}}
-\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = TRUE}}
+\constfunc{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
+Returns true if a cell is either wholly visible (the default) or at least partially
visible in the grid window.
+
+
\membersection{wxGrid::MakeCellVisible}\label{wxgridmakecellvisible}
\func{void}{MakeCellVisible}{\param{int }{row}, \param{int }{col}}
\func{void}{MakeCellVisible}{\param{const wxGridCellCoords\& }{coords}}
Brings the specified cell into the visible grid cell area with minimal scrolling. Does
-nothing if the cell is already visible.
+nothing if the cell is already visible.
+
+
\membersection{wxGrid::MoveCursorDown}\label{wxgridmovecursordown}
\func{bool}{MoveCursorDown}{\param{bool }{expandSelection}}
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.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for Down cursor key presses or Shift+Down to expand a selection.
+
+
\membersection{wxGrid::MoveCursorLeft}\label{wxgridmovecursorleft}
\func{bool}{MoveCursorLeft}{\param{bool }{expandSelection}}
Moves the grid cursor left by one column. If a block of cells was previously selected it
-will expand if the argument is TRUE or be cleared if the argument is FALSE.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for Left cursor key presses or Shift+Left to expand a selection.
+
+
\membersection{wxGrid::MoveCursorRight}\label{wxgridmovecursorright}
\func{bool}{MoveCursorRight}{\param{bool }{expandSelection}}
Moves the grid cursor right by one column. If a block of cells was previously selected it
-will expand if the argument is TRUE or be cleared if the argument is FALSE.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for Right cursor key presses or Shift+Right to expand a selection.
+
+
\membersection{wxGrid::MoveCursorUp}\label{wxgridmovecursorup}
\func{bool}{MoveCursorUp}{\param{bool }{expandSelection}}
Moves the grid cursor up 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.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for Up cursor key presses or Shift+Up to expand a selection.
+
+
\membersection{wxGrid::MoveCursorDownBlock}\label{wxgridmovecursordownblock}
\func{bool}{MoveCursorDownBlock}{\param{bool }{expandSelection}}
Moves the grid cursor down in the current column such that it skips to the beginning or
end of a block of non-empty cells. If a block of cells was previously selected it
-will expand if the argument is TRUE or be cleared if the argument is FALSE.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for the Ctrl+Down key combination. Shift+Ctrl+Down expands a selection.
+
+
\membersection{wxGrid::MoveCursorLeftBlock}\label{wxgridmovecursorleftblock}
\func{bool}{MoveCursorLeftBlock}{\param{bool }{expandSelection}}
Moves the grid cursor left in the current row such that it skips to the beginning or
end of a block of non-empty cells. If a block of cells was previously selected it
-will expand if the argument is TRUE or be cleared if the argument is FALSE.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for the Ctrl+Left key combination. Shift+Ctrl+left expands a selection.
+
+
\membersection{wxGrid::MoveCursorRightBlock}\label{wxgridmovecursorrightblock}
\func{bool}{MoveCursorRightBlock}{\param{bool }{expandSelection}}
Moves the grid cursor right in the current row such that it skips to the beginning or
end of a block of non-empty cells. If a block of cells was previously selected it
-will expand if the argument is TRUE or be cleared if the argument is FALSE.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for the Ctrl+Right key combination. Shift+Ctrl+Right expands a selection.
+
+
\membersection{wxGrid::MoveCursorUpBlock}\label{wxgridmovecursorupblock}
\func{bool}{MoveCursorUpBlock}{\param{bool }{expandSelection}}
Moves the grid cursor up in the current column such that it skips to the beginning or
end of a block of non-empty cells. If a block of cells was previously selected it
-will expand if the argument is TRUE or be cleared if the argument is FALSE.
+will expand if the argument is true or be cleared if the argument is false.
\wxheading{Keyboard}\\
This function is called for the Ctrl+Up key combination. Shift+Ctrl+Up expands a selection.
+
+
\membersection{wxGrid::MovePageDown}\label{wxgridmovepagedown}
\func{bool}{MovePageDown}{\void}
\wxheading{Keyboard}\\
This function is called for PgDn keypresses.
+
+
\membersection{wxGrid::MovePageUp}\label{wxgridmovepageup}
\func{bool}{MovePageUp}{\void}
\wxheading{Keyboard}\\
This function is called for PgUp keypresses.
+
+
+\membersection{wxGrid::RegisterDataType}\label{wxgridregisterdatatype}
+
+\func{void}{RegisterDataType}{\param{const wxString\& }{typeName}, \param{wxGridCellRenderer* }{renderer}, \param{wxGridCellEditor* }{editor}}
+
+Methods for a registry for mapping data types to Renderers/Editors
+
+
+
\membersection{wxGrid::SaveEditControlValue}\label{wxgridsaveeditcontrolvalue}
\func{void}{SaveEditControlValue}{\void}
new cell. It is also a good idea to call this function when closing a grid since
any edits to the final cell location will not be saved otherwise.
+
+
\membersection{wxGrid::SelectAll}\label{wxgridselectall}
\func{void}{SelectAll}{\void}
Selects all cells in the grid.
+
+
\membersection{wxGrid::SelectBlock}\label{wxgridselectblock}
-\func{void}{SelectBlock}{\param{int }{topRow}, \param{int }{leftCol},
-\param{int }{bottomRow}, \param{int }{rightCol}, \param{bool }{addToSelected = FALSE}}
+\func{void}{SelectBlock}{\param{int }{topRow}, \param{int }{leftCol},
+\param{int }{bottomRow}, \param{int }{rightCol}, \param{bool }{addToSelected = false}}
+
+\func{void}{SelectBlock}{\param{const wxGridCellCoords\& }{topLeft},
+\param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{addToSelected = false}}
+
+Selects a rectangular block of cells. If addToSelected is false then any existing selection will be
+deselected; if true the column will be added to the existing selection.
-\func{void}{SelectBlock}{\param{const wxGridCellCoords\& }{topLeft},
-\param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{addToSelected = FALSE}}
-Selects a rectangular block of cells. If addToSelected is FALSE then any existing selection will be
-deselected; if TRUE the column will be added to the existing selection.
\membersection{wxGrid::SelectCol}\label{wxgridselectcol}
-\func{void}{SelectCol}{\param{int }{col}, \param{bool }{addToSelected = FALSE}}
+\func{void}{SelectCol}{\param{int }{col}, \param{bool }{addToSelected = false}}
+
+Selects the specified column. If addToSelected is false then any existing selection will be
+deselected; if true the column will be added to the existing selection.
+
+
+
+\membersection{wxGrid::SelectionToDeviceRect}\label{wxgridselectiontodevicerect}
+
+\constfunc{wxRect}{SelectionToDeviceRect}{\void}
+
+This function returns the rectangle that encloses the selected cells
+in device coords and clipped to the client size of the grid window.
+
-Selects the specified column. If addToSelected is FALSE then any existing selection will be
-deselected; if TRUE the column will be added to the existing selection.
\membersection{wxGrid::SelectRow}\label{wxgridselectrow}
-\func{void}{SelectRow}{\param{int }{row}, \param{bool }{addToSelected = FALSE}}
+\func{void}{SelectRow}{\param{int }{row}, \param{bool }{addToSelected = false}}
+
+Selects the specified row. If addToSelected is false then any existing selection will be
+deselected; if true the row will be added to the existing selection.
+
-Selects the specified row. If addToSelected is FALSE then any existing selection will be
-deselected; if TRUE the row will be added to the existing selection.
\membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment}
\func{void}{SetCellAlignment}{\param{int }{align}, \param{int }{row}, \param{int }{col}}
-\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.
+
+
+\membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
+
+\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}
+
+
+
\membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor}
\func{void}{SetCellEditor}{\param{int }{row}, \param{int }{col}, \param{wxGridCellEditor* }{editor}}
-Sets the editor for the grid cell at the specified location.
+Sets the editor for the grid cell at the specified location.
The grid will take ownership of the pointer.
See \helpref{wxGridCellEditor}{wxgridcelleditor} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+
+
\membersection{wxGrid::SetCellFont}\label{wxgridsetcellfont}
\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::SetCellRenderer}\label{wxgridsetcellrenderer}
\func{void}{SetCellRenderer}{\param{int }{row}, \param{int }{col}, \param{wxGridCellRenderer* }{renderer}}
-Sets the renderer for the grid cell at the specified location.
+Sets the renderer for the grid cell at the specified location.
The grid will take ownership of the pointer.
See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+
+
\membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
\func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}
Sets the text colour for the grid cell at the specified location.
+
+
\membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
\func{void}{SetCellValue}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{s}}
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.
+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
See \helpref{wxGridTableBase::CanSetValueAs}{wxgridtablebasecangetvalueas}
and the \helpref{wxGrid overview}{gridoverview} for more information.
+
+
\membersection{wxGrid::SetColAttr}\label{wxgridsetcolattr}
\func{void}{SetColAttr}{\param{int }{col}, \param{wxGridCellAttr* }{attr}}
Sets the cell attributes for all cells in the specified column.
-For more information about controlling grid cell attributes see the
-\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the
+For more information about controlling grid cell attributes see the
+\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the
\helpref{wxGrid classes overview}{gridoverview}.
-\membersection{wxGrid::SetColFormatBool}\label{wxgridsetcolformatbool}
-
-\func{void}{SetColFormatBool}{\param{int }{col}}
-
-Sets the specified column to display boolean values. wxGrid displays boolean values with a checkbox.
-
-\membersection{wxGrid::SetColFormatNumber}\label{wxgridsetcolformatnumber}
-
-\func{void}{SetColFormatNumber}{\param{int }{col}}
-
-Sets the specified column to display integer values.
-
-\membersection{wxGrid::SetColFormatFloat}\label{wxgridsetcolformatfloat}
-
-\func{void}{SetColFormatFloat}{\param{int }{col}, \param{int }{width = -1}, \param{int }{precision = -1}}
-
-Sets the specified column to display floating point values with the given width and precision.
-
-\membersection{wxGrid::SetColFormatCustom}\label{wxgridsetcolformatcustom}
-
-\func{void}{SetColFormatCustom}{\param{int }{col}, \param{const wxString\& }{typeName}}
-
-Sets the specified column to display data in a custom format.
-See the \helpref{wxGrid overview}{gridoverview} for more information on working
-with custom data types.
-
-\membersection{wxGrid::SetColLabelAlignment}\label{wxgridsetcollabelalignment}
-
-\func{void}{SetColLabelAlignment}{\param{int }{horiz}, \param{int }{vert}}
-
-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.
-
-\membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize}
-
-\func{void}{SetColLabelSize}{\param{int }{height}}
-
-Sets the height of the column labels.
-
-\membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue}
-
-\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}
-for this to have any effect.
-
-\membersection{wxGrid::SetColMinimalWidth}\label{wxgridsetcolminimalwidth}
-
-\func{void}{SetColMinimalWidth}{\param{int }{col}, \param{int }{width}}
-
-Sets the minimal width for the specified column. This should normally be called when creating the grid
-because it will not resize a column that is already narrower than the minimal width.
-
-\membersection{wxGrid::SetColSize}\label{wxgridsetcolsize}
-
-\func{void}{SetColSize}{\param{int }{col}, \param{int }{width}}
-
-Sets the width of the specified column.
-
-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
-also be set as the minimal width for the column.
-
-\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::SetDefaultCellAlignment}\label{wxgridsetdefaultcellalignment}
-
-\func{void}{SetDefaultCellAlignment}{\param{int }{horiz}, \param{int }{vert}}
-
-Sets the default horizontal and vertial alignment for grid cell 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.
-
-\membersection{wxGrid::SetDefaultCellBackgroundColour}\label{wxgridsetdefaultcellbackgroundcolour}
-
-\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\&}{ font}}
-
-Sets the default font to be used for grid cell text.
-
-\membersection{wxGrid::SetDefaultEditor}\label{wxgridsetdefaulteditor}
-
-\func{void}{SetDefaultEditor}{\param{wxGridCellEditor* }{editor}}
-
-Sets the default editor for grid cells. The grid will take ownership of the pointer.
-
-See \helpref{wxGridCellEditor}{wxgridcelleditor} and
-the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
-
-\membersection{wxGrid::SetDefaultRenderer}\label{wxgridsetdefaultrenderer}
-
-\func{void}{SetDefaultRenderer}{\param{wxGridCellRenderer* }{renderer}}
-
-Sets the default renderer for grid cells. The grid will take ownership of the pointer.
-
-See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
-the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
-
-\membersection{wxGrid::SetDefaultColSize}\label{wxgridsetdefaultcolsize}
-
-\func{void}{SetDefaultColSize}{\param{int }{width}, \param{bool }{resizeExistingCols = FALSE}}
-
-Sets the default width for columns in the grid. This will only affect columns subsequently added to
-the grid unless resizeExistingCols is TRUE.
-
-\membersection{wxGrid::SetDefaultRowSize}\label{wxgridsetdefaultrowsize}
-
-\func{void}{SetDefaultRowSize}{\param{int }{height}, \param{bool }{resizeExistingRows = FALSE}}
-
-Sets the default height for rows in the grid. This will only affect rows subsequently added
-to the grid unless resizeExistingRows is TRUE.
-
-\membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
-
-\func{void}{SetGridCursor}{\param{int }{row}, \param{int }{col}}
-
-Set the grid cursor to the specified cell.
-This function calls \helpref{wxGrid::MakeCellVisible}{wxgridmakecellvisible}.
-
-\membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour}
-
-\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\&}{ colour}}
-Sets the background colour for row and column labels.
-\membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont}
+\membersection{wxGrid::SetColFormatBool}\label{wxgridsetcolformatbool}
-\func{void}{SetLabelFont}{\param{const wxFont\&}{ font}}
+\func{void}{SetColFormatBool}{\param{int }{col}}
-Sets the font for row and column labels.
+Sets the specified column to display boolean values. wxGrid displays boolean values with a checkbox.
-\membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
-\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ colour}}
-Sets the colour for row and column label text.
+\membersection{wxGrid::SetColFormatNumber}\label{wxgridsetcolformatnumber}
-\membersection{wxGrid::SetReadOnly}\label{wxgridsetreadonly}
+\func{void}{SetColFormatNumber}{\param{int }{col}}
-\func{void}{SetReadOnly}{\param{int }{row}, \param{int }{col}, \param{bool }{isReadOnly = TRUE}}
+Sets the specified column to display integer values.
-Makes the cell at the specified location read-only or editable.
-See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}.
-\membersection{wxGrid::SetRowAttr}\label{wxgridsetrowattr}
-\func{void}{SetRowAttr}{\param{int }{row}, \param{wxGridCellAttr* }{attr}}
+\membersection{wxGrid::SetColFormatFloat}\label{wxgridsetcolformatfloat}
-Sets the cell attributes for all cells in the specified row.
-See the \helpref{wxGridCellAttr}{wxgridcellattr} class for more information
-about controlling cell attributes.
+\func{void}{SetColFormatFloat}{\param{int }{col}, \param{int }{width = -1}, \param{int }{precision = -1}}
-\membersection{wxGrid::SetRowLabelAlignment}\label{wxgridsetrowlabelalignment}
+Sets the specified column to display floating point values with the given width and precision.
-\func{void}{SetRowLabelAlignment}{\param{int }{horiz}, \param{int }{vert}}
-Sets the horizontal and vertical alignment of row label text.
-Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
+\membersection{wxGrid::SetColFormatCustom}\label{wxgridsetcolformatcustom}
-Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
+\func{void}{SetColFormatCustom}{\param{int }{col}, \param{const wxString\& }{typeName}}
-\membersection{wxGrid::SetRowLabelSize}\label{wxgridsetrowlabelsize}
+Sets the specified column to display data in a custom format.
+See the \helpref{wxGrid overview}{gridoverview} for more information on working
+with custom data types.
-\func{void}{SetRowLabelSize}{\param{int }{width}}
-Sets the width of the row labels.
-\membersection{wxGrid::SetRowLabelValue}\label{wxgridsetrowlabelvalue}
+\membersection{wxGrid::SetColLabelAlignment}\label{wxgridsetcollabelalignment}
-\func{void}{SetRowLabelValue}{\param{int }{row}, \param{const wxString\&}{ value}}
+\func{void}{SetColLabelAlignment}{\param{int }{horiz}, \param{int }{vert}}
-Set the value for the given row label. If you are using a derived grid table you must
-override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue}
-for this to have any effect.
+Sets the horizontal and vertical alignment of column label text.
-\membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}
+Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
-\func{void}{SetRowMinimalHeight}{\param{int }{row}, \param{int }{width}}
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
-Sets the minimal height for the specified row. This should normally be called when creating the grid
-because it will not resize a row that is already shorter than the minimal height.
-\membersection{wxGrid::SetRowSize}\label{wxgridsetrowsize}
-\func{void}{SetRowSize}{\param{int }{row}, \param{int }{height}}
+\membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize}
-Sets the height of the specified row.
+\func{void}{SetColLabelSize}{\param{int }{height}}
-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.
+Sets the height of the column labels.
-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.
+If \arg{height} equals to \texttt{wxGRID\_AUTOSIZE} then height is calculated automatically
+so that no label is truncated. Note that this could be slow for a large table.
-\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}
+\membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue}
-\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}}
+\func{void}{SetColLabelValue}{\param{int }{col}, \param{const wxString\&}{ value}}
-Set the selection behaviour of the grid.
+Set the value for the given column label. If you are using a derived grid table you must
+override \helpref{wxGridTableBase::SetColLabelValue}{wxgridtablebasesetcollabelvalue}
+for this to have any effect.
-\wxheading{Parameters}
-\docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.}
-\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
+\membersection{wxGrid::SetColMinimalWidth}\label{wxgridsetcolminimalwidth}
-\docparam{wxGrid::wxGridSelectionColumns}{Selections will consist of whole columns.}
+\func{void}{SetColMinimalWidth}{\param{int }{col}, \param{int }{width}}
-\membersection{wxGrid::SetTable}\label{wxgridsettable}
+Sets the minimal width for the specified column. This should normally be called when creating the grid
+because it will not resize a column that is already narrower than the minimal width.
+The width argument must be higher than the minimimal acceptable column width, see
+\helpref{wxGrid::GetColMinimalAcceptableWidth}{wxgridgetcolminimalacceptablewidth}.
-\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
-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.
-Use this function instead of \helpref{wxGrid::CreateGrid}{wxgridcreategrid} when your
-application involves complex or non-string data or data sets that are too large to fit
-wholly in memory.
+\membersection{wxGrid::SetColMinimalAcceptableWidth}\label{wxgridsetcolminimalacceptablewidth}
-\membersection{wxGrid::ShowCellEditControl}\label{wxgridshowcelleditcontrol}
+\func{void}{SetColMinimalAcceptableWidth}{\param{int }{width}}
-\func{void}{ShowCellEditControl}{\void}
+This modifies the minimum column width that can be handled correctly. Specifying a low value here
+allows smaller grid cells to be dealt with correctly. Specifying a value here which is much smaller
+than the actual minimum size will incur a performance penalty in the functions which perform
+grid cell index lookup on the basis of screen coordinates.
+This should normally be called when creating the grid because it will not resize existing columns
+with sizes smaller than the value specified here.
-Displays the in-place cell edit control for the current cell.
-\membersection{wxGrid::XToCol}\label{wxgridxtocol}
-\func{int}{XToCol}{\param{int }{x}}
+\membersection{wxGrid::SetColPos}\label{wxgridsetcolpos}
-Returns the grid column that corresponds to the logical x coordinate. Returns
-wxNOT\_FOUND if there is no column at the x position.
+\func{void}{SetColPos}{\param{int }{colID}, \param{int }{newPos}}
-\membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol}
+Sets the position of the specified column.
-\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.
-\membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow}
+\membersection{wxGrid::SetColSize}\label{wxgridsetcolsize}
-\func{int}{YToEdgeOfRow}{\param{int }{y}}
+\func{void}{SetColSize}{\param{int }{col}, \param{int }{width}}
-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.
+Sets the width of the specified column.
-\membersection{wxGrid::YToRow}\label{wxgridytorow}
+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.
-\func{int}{YToRow}{\param{int }{y}}
+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.
-Returns the grid row that corresponds to the logical y coordinate. Returns
-wxNOT\_FOUND if there is no row at the y position.
+\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::IsInSelection}\label{wxgridisinselection}
+\membersection{wxGrid::SetDefaultCellAlignment}\label{wxgridsetdefaultcellalignment}
-\func{bool}{IsInSelection}{\param{int }{row}, \param{int }{col}}
+\func{void}{SetDefaultCellAlignment}{\param{int }{horiz}, \param{int }{vert}}
-\func{bool}{IsInSelection}{\param{const wxGridCellCoords\& }{coords}}
+Sets the default horizontal and vertical alignment for grid cell text.
+Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
-\membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect}
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
-\func{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}}
-This function returns the rectangle that encloses the block of cells
-limited by TopLeft and BottomRight cell in device coords and clipped
-to the client size of the grid window.
+\membersection{wxGrid::SetDefaultCellBackgroundColour}\label{wxgridsetdefaultcellbackgroundcolour}
-\membersection{wxGrid::SelectionToDeviceRect}\label{wxgridselectiontodevicerect}
+\func{void}{SetDefaultCellBackgroundColour}{\param{const wxColour\&}{ colour}}
-\func{wxRect}{SelectionToDeviceRect}{\void}
+Sets the default background colour for grid cells.
-This function returns the rectangle that encloses the selected cells
-in device coords and clipped to the client size of the grid window.
-\membersection{wxGrid::GetSelectionBackground}\label{wxgridgetselectionbackground}
+\membersection{wxGrid::SetDefaultCellFont}\label{wxgridsetdefaultcellfont}
-\constfunc{wxColour}{GetSelectionBackground}{\void}
+\func{void}{SetDefaultCellFont}{\param{const wxFont\&}{ font}}
-Access or update the selection fore/back colours
+Sets the default font to be used for grid cell text.
-\membersection{wxGrid::GetSelectionForeground}\label{wxgridgetselectionforeground}
-\constfunc{wxColour}{GetSelectionForeground}{\void}
+\membersection{wxGrid::SetDefaultCellTextColour}\label{wxgridsetdefaultcelltextcolour}
+\func{void}{SetDefaultCellTextColour}{\param{const wxColour\&}{ colour}}
-\membersection{wxGrid::SetSelectionBackground}\label{wxgridsetselectionbackground}
+Sets the current default colour for grid cell text.
-\func{void}{SetSelectionBackground}{\param{const wxColour\& }{c}}
-\membersection{wxGrid::SetSelectionForeground}\label{wxgridsetselectionforeground}
+\membersection{wxGrid::SetDefaultEditor}\label{wxgridsetdefaulteditor}
-\func{void}{SetSelectionForeground}{\param{const wxColour\& }{c}}
+\func{void}{SetDefaultEditor}{\param{wxGridCellEditor* }{editor}}
+Sets the default editor for grid cells. The grid will take ownership of the pointer.
-\membersection{wxGrid::RegisterDataType}\label{wxgridregisterdatatype}
+See \helpref{wxGridCellEditor}{wxgridcelleditor} and
+the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
-\func{void}{RegisterDataType}{\param{const wxString\& }{typeName}, \param{wxGridCellRenderer* }{renderer}, \param{wxGridCellEditor* }{editor}}
-Methods for a registry for mapping data types to Renderers/Editors
-\membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell}
+\membersection{wxGrid::SetDefaultRenderer}\label{wxgridsetdefaultrenderer}
-\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}}
+\func{void}{SetDefaultRenderer}{\param{wxGridCellRenderer* }{renderer}}
-\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{const wxGridCellCoords\& }{c}}
+Sets the default renderer for grid cells. The grid will take ownership of the pointer.
+See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
+the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
-\membersection{wxGrid::GetDefaultRendererForCell}\label{wxgridgetdefaultrendererforcell}
-\constfunc{wxGridCellRenderer*}{GetDefaultRendererForCell}{\param{int }{row}, \param{int }{col}}
+\membersection{wxGrid::SetDefaultColSize}\label{wxgridsetdefaultcolsize}
-\membersection{wxGrid::GetDefaultEditorForType}\label{wxgridgetdefaulteditorfortype}
+\func{void}{SetDefaultColSize}{\param{int }{width}, \param{bool }{resizeExistingCols = false}}
-\constfunc{wxGridCellEditor*}{GetDefaultEditorForType}{\param{const wxString\& }{typeName}}
+Sets the default width for columns in the grid. This will only affect columns subsequently added to
+the grid unless resizeExistingCols is true.
-\membersection{wxGrid::GetDefaultRendererForType}\label{wxgridgetdefaultrendererfortype}
-\constfunc{wxGridCellRenderer*}{GetDefaultRendererForType}{\param{const wxString\& }{typeName}}
+\membersection{wxGrid::SetDefaultRowSize}\label{wxgridsetdefaultrowsize}
+\func{void}{SetDefaultRowSize}{\param{int }{height}, \param{bool }{resizeExistingRows = false}}
-\membersection{wxGrid::SetMargins}\label{wxgridsetmargins}
+Sets the default height for rows in the grid. This will only affect rows subsequently added
+to the grid unless resizeExistingRows is true.
-\func{void}{SetMargins}{\param{int }{extraWidth}, \param{int }{extraHeight}}
-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}
+\membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
-\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}}
+\func{void}{SetGridCursor}{\param{int }{row}, \param{int }{col}}
-Backward compatibility.
+Set the grid cursor to the specified cell.
+This function calls \helpref{wxGrid::MakeCellVisible}{wxgridmakecellvisible}.
-\membersection{wxGrid::UpdateDimensions}\label{wxgridupdatedimensions}
-\func{void}{UpdateDimensions}{\void}
-Backward compatibility.
+\membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour}
-\membersection{wxGrid::GetRows}\label{wxgridgetrows}
+\func{void}{SetGridLineColour}{\param{const wxColour\&}{colour}}
-\func{int}{GetRows}{\void}
+Sets the colour used to draw grid lines.
-Backward compatibility.
-\membersection{wxGrid::GetCols}\label{wxgridgetcols}
-\func{int}{GetCols}{\void}
+\membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
-Backward compatibility.
+\func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ colour}}
-\membersection{wxGrid::GetCursorRow}\label{wxgridgetcursorrow}
+Sets the background colour for row and column labels.
-\func{int}{GetCursorRow}{\void}
-Backward compatibility.
-\membersection{wxGrid::GetCursorColumn}\label{wxgridgetcursorcolumn}
+\membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont}
-\func{int}{GetCursorColumn}{\void}
+\func{void}{SetLabelFont}{\param{const wxFont\&}{ font}}
-Backward compatibility.
+Sets the font for row and column labels.
-\membersection{wxGrid::GetScrollPosX}\label{wxgridgetscrollposx}
-\func{int}{GetScrollPosX}{\void}
-Backward compatibility.
+\membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
-\membersection{wxGrid::GetScrollPosY}\label{wxgridgetscrollposy}
+\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ colour}}
-\func{int}{GetScrollPosY}{\void}
+Sets the colour for row and column label text.
-Backward compatibility.
-\membersection{wxGrid::SetScrollX}\label{wxgridsetscrollx}
-\func{void}{SetScrollX}{\param{int }{x}}
+\membersection{wxGrid::SetMargins}\label{wxgridsetmargins}
-Backward compatibility.
+\func{void}{SetMargins}{\param{int }{extraWidth}, \param{int }{extraHeight}}
-\membersection{wxGrid::SetScrollY}\label{wxgridsetscrolly}
+A grid may occupy more space than needed for its rows/columns. This
+function allows to set how big this extra space is
-\func{void}{SetScrollY}{\param{int }{y}}
-Backward compatibility.
-\membersection{wxGrid::SetColumnWidth}\label{wxgridsetcolumnwidth}
+\membersection{wxGrid::SetOrCalcColumnSizes}\label{wxgridsetorcalccolumnsizes}
-\func{void}{SetColumnWidth}{\param{int }{col}, \param{int }{width}}
+\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}}
-Backward compatibility.
+Common part of AutoSizeColumn/Row() and GetBestSize()
-\membersection{wxGrid::GetColumnWidth}\label{wxgridgetcolumnwidth}
-\func{int}{GetColumnWidth}{\param{int }{col}}
-Backward compatibility.
+\membersection{wxGrid::SetOrCalcRowSizes}\label{wxgridsetorcalcrowsizes}
-\membersection{wxGrid::SetRowHeight}\label{wxgridsetrowheight}
+\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}}
-\func{void}{SetRowHeight}{\param{int }{row}, \param{int }{height}}
-Backward compatibility.
-\membersection{wxGrid::GetViewHeight}\label{wxgridgetviewheight}
+\membersection{wxGrid::SetReadOnly}\label{wxgridsetreadonly}
-\func{int}{GetViewHeight}{\void}
+\func{void}{SetReadOnly}{\param{int }{row}, \param{int }{col}, \param{bool }{isReadOnly = true}}
-Backward compatibility.
+Makes the cell at the specified location read-only or editable.
+See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}.
-\membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth}
-\func{int}{GetViewWidth}{\void}
-Returned number of whole cols visible.
+\membersection{wxGrid::SetRowAttr}\label{wxgridsetrowattr}
-\membersection{wxGrid::SetLabelSize}\label{wxgridsetlabelsize}
+\func{void}{SetRowAttr}{\param{int }{row}, \param{wxGridCellAttr* }{attr}}
-\func{void}{SetLabelSize}{\param{int }{orientation}, \param{int }{sz}}
+Sets the cell attributes for all cells in the specified row.
+See the \helpref{wxGridCellAttr}{wxgridcellattr} class for more information
+about controlling cell attributes.
-\membersection{wxGrid::GetLabelSize}\label{wxgridgetlabelsize}
-\func{int}{GetLabelSize}{\param{int }{orientation}}
+\membersection{wxGrid::SetRowLabelAlignment}\label{wxgridsetrowlabelalignment}
+\func{void}{SetRowLabelAlignment}{\param{int }{horiz}, \param{int }{vert}}
-\membersection{wxGrid::SetLabelAlignment}\label{wxgridsetlabelalignment}
+Sets the horizontal and vertical alignment of row label text.
-\func{void}{SetLabelAlignment}{\param{int }{orientation}, \param{int }{align}}
+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::GetLabelAlignment}\label{wxgridgetlabelalignment}
-\func{int}{GetLabelAlignment}{\param{int }{orientation}, \param{int }{align}}
+\membersection{wxGrid::SetRowLabelSize}\label{wxgridsetrowlabelsize}
-\membersection{wxGrid::SetLabelValue}\label{wxgridsetlabelvalue}
+\func{void}{SetRowLabelSize}{\param{int }{width}}
-\func{void}{SetLabelValue}{\param{int }{orientation}, \param{const wxString\& }{val}, \param{int }{pos}}
+Sets the width of the row labels.
+If \arg{width} equals \texttt{wxGRID\_AUTOSIZE} then width is calculated automatically
+so that no label is truncated. Note that this could be slow for a large table.
-\membersection{wxGrid::GetLabelValue}\label{wxgridgetlabelvalue}
-\func{wxString}{GetLabelValue}{\param{int }{orientation}, \param{int }{pos}}
+\membersection{wxGrid::SetRowLabelValue}\label{wxgridsetrowlabelvalue}
-\membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont}
+\func{void}{SetRowLabelValue}{\param{int }{row}, \param{const wxString\&}{ value}}
-\constfunc{wxFont}{GetCellTextFont}{\void}
+Set the value for the given row label. If you are using a derived grid table you must
+override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue}
+for this to have any effect.
-\constfunc{wxFont}{GetCellTextFont}{\param{int }{row}, \param{int }{col}}
-\membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont}
+\membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}
-\func{void}{SetCellTextFont}{\param{const wxFont\& }{fnt}}
+\func{void}{SetRowMinimalHeight}{\param{int }{row}, \param{int }{height}}
-\func{void}{SetCellTextFont}{\param{const wxFont\& }{fnt}, \param{int }{row}, \param{int }{col}}
+Sets the minimal height for the specified row. This should normally be called when creating the grid
+because it will not resize a row that is already shorter than the minimal height.
+The height argument must be higher than the minimimal acceptable row height, see
+\helpref{wxGrid::GetRowMinimalAcceptableHeight}{wxgridgetrowminimalacceptableheight}.
-\membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
-\func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{col}}
+\membersection{wxGrid::SetRowMinimalAcceptableHeight}\label{wxgridsetrowminimalacceptableheight}
-\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}
+\func{void}{SetRowMinimalAcceptableHeight}{\param{int }{height}}
-\func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{colour}, \param{int }{row}, \param{int }{col}}
+This modifies the minimum row width that can be handled correctly. Specifying a low value here
+allows smaller grid cells to be dealt with correctly. Specifying a value here which is much smaller
+than the actual minimum size will incur a performance penalty in the functions which perform
+grid cell index lookup on the basis of screen coordinates.
+This should normally be called when creating the grid because it will not resize existing rows
+with sizes smaller than the value specified here.
-\membersection{wxGrid::GetEditable}\label{wxgridgeteditable}
-\func{bool}{GetEditable}{\void}
+\membersection{wxGrid::SetRowSize}\label{wxgridsetrowsize}
+\func{void}{SetRowSize}{\param{int }{row}, \param{int }{height}}
-\membersection{wxGrid::SetEditable}\label{wxgridseteditable}
+Sets the height of the specified row.
-\func{void}{SetEditable}{\param{bool }{edit = TRUE}}
+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
+also be set as the minimal width for the column.
-\membersection{wxGrid::GetEditInPlace}\label{wxgridgeteditinplace}
+\wxheading{Note}
-\func{bool}{GetEditInPlace}{\void}
+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::SetEditInPlace}\label{wxgridseteditinplace}
-\func{void}{SetEditInPlace}{\param{bool }{edit = TRUE}}
+\membersection{wxGrid::SetScrollLineX}\label{wxgridsetscrolllinex}
+\func{void}{SetScrollLineX}{\param{int }{x}}
-\membersection{wxGrid::SetCellBitmap}\label{wxgridsetcellbitmap}
+Sets the number of pixels per horizontal scroll increment. The default is 15.
+Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
+errors: setting this to 1 can help.
-\func{void}{SetCellBitmap}{\param{wxBitmap* }{bitmap}, \param{int }{row}, \param{int }{col}}
+\wxheading{See also}
+\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp
+\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp
+\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney}
-\membersection{wxGrid::SetDividerPen}\label{wxgridsetdividerpen}
-\func{void}{SetDividerPen}{\param{const wxPen\& }{pen}}
+\membersection{wxGrid::SetScrollLineY}\label{wxgridsetscrollliney}
-\membersection{wxGrid::GetDividerPen}\label{wxgridgetdividerpen}
+\func{void}{SetScrollLineY}{\param{int }{y}}
-\constfunc{wxPen\&}{GetDividerPen}{\void}
+Sets the number of pixels per vertical scroll increment. The default is 15.
+Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
+errors: setting this to 1 can help.
+\wxheading{See also}
-\membersection{wxGrid::OnActivate}\label{wxgridonactivate}
+\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp
+\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp
+\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex}
-\func{void}{OnActivate}{\param{bool }{active}}
-\membersection{wxGrid::Fit}\label{wxgridfit}
-\func{void}{Fit}{\void}
+\membersection{wxGrid::SetSelectionBackground}\label{wxgridsetselectionbackground}
-Overridden wxWindow methods
+\func{void}{SetSelectionBackground}{\param{const wxColour\& }{c}}
-\membersection{wxGrid::DoGetBestSize}\label{wxgriddogetbestsize}
-\constfunc{wxSize}{DoGetBestSize}{\void}
-\membersection{wxGrid::InitRowHeights}\label{wxgridinitrowheights}
+\membersection{wxGrid::SetSelectionForeground}\label{wxgridsetselectionforeground}
-\func{void}{InitRowHeights}{\void}
+\func{void}{SetSelectionForeground}{\param{const wxColour\& }{c}}
-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}
+\membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode}
-\func{void}{InitColWidths}{\void}
+\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}}
-Init the m\_colWidths/Rights arrays
+Set the selection behaviour of the grid.
+\wxheading{Parameters}
-\membersection{wxGrid::GetColWidth}\label{wxgridgetcolwidth}
+\docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.}
-\constfunc{int}{GetColWidth}{\param{int }{col}}
+\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
-Get the col/row coords
+\docparam{wxGrid::wxGridSelectColumns}{Selections will consist of whole columns.}
-\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft}
-\constfunc{int}{GetColLeft}{\param{int }{col}}
+\membersection{wxGrid::SetTable}\label{wxgridsettable}
+\func{bool}{SetTable}{\param{wxGridTableBase* }{table}, \param{bool }{takeOwnership = false}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}}
-\membersection{wxGrid::GetColRight}\label{wxgridgetcolright}
+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.
-\constfunc{int}{GetColRight}{\param{int }{col}}
+Use this function instead of \helpref{wxGrid::CreateGrid}{wxgridcreategrid} when your
+application involves complex or non-string data or data sets that are too large to fit
+wholly in memory.
-\membersection{wxGrid::GetRowHeight}\label{wxgridgetrowheight}
+\membersection{wxGrid::SetUseNativeColLabels}\label{wxgridsetsenativecollabels}
-\constfunc{int}{GetRowHeight}{\param{int }{row}}
+\func{void}{SetUseNativeColLabels}{\param{bool }{native= true}}
-This function must be public for compatibility.
+Call this in order to make the column labels use a native look by using
+\helpref{wxRenderer::DrawHeaderButton}{wxrenderernativedrawheaderbutton}
+internally. There is no equivalent method for drawing row columns as
+there is not native look for that. This option is useful when using
+wxGrid for displaying tables and not as a spread-sheet.
-\membersection{wxGrid::GetRowTop}\label{wxgridgetrowtop}
+\membersection{wxGrid::ShowCellEditControl}\label{wxgridshowcelleditcontrol}
-\constfunc{int}{GetRowTop}{\param{int }{row}}
+\func{void}{ShowCellEditControl}{\void}
+Displays the in-place cell edit control for the current cell.
-\membersection{wxGrid::GetRowBottom}\label{wxgridgetrowbottom}
-\constfunc{int}{GetRowBottom}{\param{int }{row}}
+\membersection{wxGrid::XToCol}\label{wxgridxtocol}
-\membersection{wxGrid::SetOrCalcColumnSizes}\label{wxgridsetorcalccolumnsizes}
+\constfunc{int}{XToCol}{\param{int }{x}, \param{bool }{clipToMinMax = false}}
-\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}}
+\wxheading{Parameters}
+\docparam{x}{The x position to evaluate.}
+\docparam{clipToMinMax}{If true, rather than returning wxNOT\_FOUND, it returns either the first or last column depending on whether x is too far to the left or right respectively.}
-Common part of AutoSizeColumn/Row() and GetBestSize()
+\wxheading{Return value}
+The grid column that corresponds to the logical x coordinate. Returns
+{\tt wxNOT\_FOUND} if there is no column at the x position.
-\membersection{wxGrid::SetOrCalcRowSizes}\label{wxgridsetorcalcrowsizes}
-\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}}
-\membersection{wxGrid::AutoSizeColOrRow}\label{wxgridautosizecolorrow}
+\membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol}
-\func{void}{AutoSizeColOrRow}{\param{int }{n}, \param{bool }{setAsMin}, \param{bool }{column}}
+\constfunc{int}{XToEdgeOfCol}{\param{int }{x}}
-Common part of AutoSizeColumn/Row() or row?
+Returns the column whose right hand edge is close to the given logical x position.
+If no column edge is near to this position {\tt wxNOT\_FOUND} is returned.
-\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth}
-\constfunc{int}{GetColMinimalWidth}{\param{int }{col}}
-get the minimal width of the given column/row
+\membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow}
-\membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight}
+\constfunc{int}{YToEdgeOfRow}{\param{int }{y}}
-\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}}
+Returns the row whose bottom edge is close to the given logical y position.
+If no row edge is near to this position {\tt wxNOT\_FOUND} is returned.
-\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes}
-\func{bool}{CanHaveAttributes}{\void}
-Do we have some place to store attributes in?
+\membersection{wxGrid::YToRow}\label{wxgridytorow}
-\membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
+\constfunc{int}{YToRow}{\param{int }{y}}
-\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
+Returns the grid row that corresponds to the logical y coordinate. Returns
+{\tt wxNOT\_FOUND} if there is no row at the y position.
projects / wxWidgets.git / blobdiff