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
+wxGrid has been greatly expanded and redesigned for wxWidgets 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
\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
\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
\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}\\
\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}\\
\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}\\
\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}\\
\func{bool}{CanDragColSize}{\void}
-Returns TRUE if columns can be resized by dragging with the mouse. Columns can be resized
+Returns true if columns can be resized by dragging with the mouse. Columns can be resized
by dragging the edges of their labels. If grid line dragging is enabled they can also be
resized by dragging the right edge of the column in the grid cell area
(see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}).
\func{bool}{CanDragRowSize}{\void}
-Returns TRUE if rows can be resized by dragging with the mouse. Rows can be resized
+Returns true if rows can be resized by dragging with the mouse. Rows can be resized
by dragging the edges of their labels. If grid line dragging is enabled they can also be
resized by dragging the lower edge of the row in the grid cell area
(see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}).
\func{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::CellToRect}\label{wxgridcelltorect}
\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
\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
\func{void}{DisableCellEditControl}{\void}
Disables in-place editing of grid cells.
-Equivalent to calling EnableCellEditControl(FALSE).
+Equivalent to calling EnableCellEditControl(false).
\membersection{wxGrid::DisableDragColSize}\label{wxgriddisabledragcolsize}
\func{void}{DisableDragColSize}{\void}
-Disables column sizing by dragging with the mouse. Equivalent to passing FALSE to
+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
+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::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.
\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
\helpref{wxGridCellAttribute::SetReadOnly}{wxgridcellattrsetreadonly}. For single
\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.
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 )}.}
\func{wxString}{GetColLabelValue}{\param{int }{col}}
-Returns the specifed column label. The default grid table class provides column labels of
+Returns the specified column label. The default grid table class provides column labels of
the form A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can override
\helpref{wxGridTableBase::GetColLabelValue}{wxgridtablebasegetcollabelvalue} to provide
your own labels.
\func{bool}{GridLinesEnabled}{\void}
-Returnes TRUE if drawing of grid lines is turned on, FALSE otherwise.
+Returns true if drawing of grid lines is turned on, false otherwise.
\membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
\func{wxString}{GetRowLabelValue}{\param{int }{row}}
-Returns the specifed row label. The default grid table class provides numeric row labels.
+Returns the specified row label. The default grid table class provides numeric row labels.
If you are using a custom grid table you can override
\helpref{wxGridTableBase::GetRowLabelValue}{wxgridtablebasegetcollabelvalue} to provide
your own labels.
Returns the height of the specified row.
+\membersection{wxGrid::GetSelectionMode}\label{wxgridgetselectionmode}
+
+\constfunc{wxGrid::wxGridSelectionModes}{GetSelectionMode}{\void}
+
+Returns the current selection mode, see \helpref{wxGrid::SetSelectionMode}{wxgridsetselectionmode}.
+
+\membersection{wxGrid::GetSelectedCells}\label{wxgridgetselectedcells}
+
+\constfunc{wxGridCellCoordsArray}{GetSelectedCells}{\void}
+
+Returns an array of singly selected cells.
+
+\membersection{wxGrid::GetSelectedCols}\label{wxgridgetselectedcols}
+
+\constfunc{wxArrayInt}{GetSelectedCols}{\void}
+
+Returns an array of selected cols.
+
+\membersection{wxGrid::GetSelectedRows}\label{wxgridgetselectedrows}
+
+\constfunc{wxArrayInt}{GetSelectedRows}{\void}
+
+Returns an array of selected rows.
+
+\membersection{wxGrid::GetSelectionBlockTopLeft}\label{wxgridgetselectionblocktopleft}
+
+\constfunc{wxGridCellCoordsArray}{GetSelectionBlockTopLeft}{\void}
+
+Returns an array of the top left corners of blocks of selected cells,
+see \helpref{wxGrid::GetSelectionBlockBottomRight}{wxgridgetselectionblockbottomright}.
+
+\membersection{wxGrid::GetSelectionBlockBottomRight}\label{wxgridgetselectionblockbottomright}
+
+\constfunc{wxGridCellCoordsArray}{GetSelectionBlockBottomRight}{\void}
+
+Returns an array of the bottom right corners of blocks of selected cells,
+see \helpref{wxGrid::GetSelectionBlockTopLeft}{wxgridgetselectionblocktopleft}.
+
\membersection{wxGrid::GetTable}\label{wxgridgettable}
\constfunc{wxGridTableBase *}{GetTable}{\void}
\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
+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
\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
+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
\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}
-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}
-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}}
+\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}}
-\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = TRUE}}
+\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = true}}
-Returns TRUE if a cell is either wholly visible (the default) or at least partially
+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{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.
\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.
\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.
\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.
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.
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.
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.
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::SelectBlock}\label{wxgridselectblock}
\func{void}{SelectBlock}{\param{int }{topRow}, \param{int }{leftCol},
-\param{int }{bottomRow}, \param{int }{rightCol}, \param{bool }{addToSelected = FALSE}}
+\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}}
+\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.
+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.
+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}}
-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.
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}.
+
+\membersection{wxGrid::SetColMinimalAcceptableWidth}\label{wxgridsetcolminimalacceptablewidth}
+
+\func{void}{SetColMinimalAcceptableWidth}{\param{int }{width}}
+
+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.
+
+\membersection{wxGrid::GetColMinimalAcceptableWidth}\label{wxgridgetcolminimalacceptablewidth}
+
+\func{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::SetColSize}\label{wxgridsetcolsize}
This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch
block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes.
-Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
+Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will
also be set as the minimal width for the column.
\wxheading{Note}\\
\func{void}{SetDefaultCellAlignment}{\param{int }{horiz}, \param{int }{vert}}
-Sets the default horizontal and vertial alignment for grid cell text.
+Sets the default horizontal and vertical alignment for grid cell text.
Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
\membersection{wxGrid::SetDefaultColSize}\label{wxgridsetdefaultcolsize}
-\func{void}{SetDefaultColSize}{\param{int }{width}, \param{bool }{resizeExistingCols = FALSE}}
+\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.
+the grid unless resizeExistingCols is true.
\membersection{wxGrid::SetDefaultRowSize}\label{wxgridsetdefaultrowsize}
-\func{void}{SetDefaultRowSize}{\param{int }{height}, \param{bool }{resizeExistingRows = FALSE}}
+\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.
+to the grid unless resizeExistingRows is true.
\membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
\membersection{wxGrid::SetReadOnly}\label{wxgridsetreadonly}
-\func{void}{SetReadOnly}{\param{int }{row}, \param{int }{col}, \param{bool }{isReadOnly = TRUE}}
+\func{void}{SetReadOnly}{\param{int }{row}, \param{int }{col}, \param{bool }{isReadOnly = true}}
Makes the cell at the specified location read-only or editable.
See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}.
\membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}
-\func{void}{SetRowMinimalHeight}{\param{int }{row}, \param{int }{width}}
+\func{void}{SetRowMinimalHeight}{\param{int }{row}, \param{int }{height}}
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::SetRowMinimalAcceptableHeight}\label{wxgridsetrowminimalacceptableheight}
+
+\func{void}{SetRowMinimalAcceptableHeight}{\param{int }{height}}
+
+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::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight}
+
+\func{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::SetRowSize}\label{wxgridsetrowsize}
This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch
block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes.
-Automatically sizes the column to fit its contents. If setAsMin is TRUE the calculated width will
+Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will
also be set as the minimal width for the column.
\wxheading{Note}
\membersection{wxGrid::SetTable}\label{wxgridsettable}
-\func{bool}{SetTable}{\param{wxGridTableBase* }{table}, \param{bool }{takeOwnership = FALSE}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}}
+\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.
+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
wxNOT\_FOUND if there is no row at the y position.
-
-\membersection{wxGrid::IsInSelection}\label{wxgridisinselection}
-
-\func{bool}{IsInSelection}{\param{int }{row}, \param{int }{col}}
-
-\func{bool}{IsInSelection}{\param{const wxGridCellCoords\& }{coords}}
-
-
\membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect}
\func{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}}
\membersection{wxGrid::SetEditable}\label{wxgridseteditable}
-\func{void}{SetEditable}{\param{bool }{edit = TRUE}}
+\func{void}{SetEditable}{\param{bool }{edit = true}}
\membersection{wxGrid::GetEditInPlace}\label{wxgridgeteditinplace}
\membersection{wxGrid::SetEditInPlace}\label{wxgridseteditinplace}
-\func{void}{SetEditInPlace}{\param{bool }{edit = TRUE}}
+\func{void}{SetEditInPlace}{\param{bool }{edit = true}}
\membersection{wxGrid::SetCellBitmap}\label{wxgridsetcellbitmap}
\membersection{wxGrid::SetOrCalcColumnSizes}\label{wxgridsetorcalccolumnsizes}
-\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}}
+\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}}
Common part of AutoSizeColumn/Row() and GetBestSize()
\membersection{wxGrid::SetOrCalcRowSizes}\label{wxgridsetorcalcrowsizes}
-\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = TRUE}}
+\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}}
\membersection{wxGrid::AutoSizeColOrRow}\label{wxgridautosizecolorrow}
projects / wxWidgets.git / blobdiff