fixed typo in GetNextItem example (bug 1333797)

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

diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex
index 384d32438c9a27045ede6dc5de5b465296f1cd0f..465a1dcec37edf8f69339af8e373b765e265ce03 100644 (file)
--- a/docs/latex/wx/grid.tex
+++ b/docs/latex/wx/grid.tex
@@ -1,10 +1,27 @@
 \section{\class{wxGrid}}\label{wxgrid}
 
 \section{\class{wxGrid}}\label{wxgrid}
 

-wxGrid is a class for displaying and editing tabular information.
+wxGrid and its related classes are used for displaying and editing tabular
+data. They provide a rich set of features for display, editing, and
+interacting with a variety of data sources. For simple applications, and to
+help you get started, wxGrid is the only class you need to refer to
+directly. It will set up default instances of the other classes and manage
+them for you. For more complex applications you can derive your own
+classes for custom grid views, grid data tables, cell editors and
+renderers. The \helpref{wxGrid classes overview}{gridoverview} has
+examples of simple and more complex applications, explains the
+relationship between the various grid classes and has a summary of the
+keyboard shortcuts and mouse functions provided by wxGrid.
+
+wxGrid has been greatly expanded and redesigned for 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
+but there are some exceptions. There are also easier ways of doing many things compared to
+the previous implementation. 

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxPanel}{wxpanel}\\
+\helpref{wxScrolledWindow}{wxscrolledwindow}\\

 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}


@@ -15,597 +32,1499 @@ wxGrid is a class for displaying and editing tabular information.
 
 \wxheading{Window styles}
 
 
 \wxheading{Window styles}
 

-There are no specific window styles for this class, but you may use different
-SetXXX() functions to change the controls behaviour (for example, to enable
-in-place editing).
+There are presently no specific window styles for wxGrid.

 
 

-See also \helpref{window styles overview}{windowstyles}.
+\wxheading{Event handling}
+
+\input gridevt.inc
+
+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\_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\_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 
+ \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 
+ \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}
 
 
 \wxheading{See also}
 

-\helpref{wxGrid classes overview}{gridoverview}
+\helpref{wxGrid overview}{gridoverview}
+
+%%%%%%%%%%% FUNCTION GROUPS %%%%%%%%%%%%%
+\latexignore{\rtfignore{\wxheading{Function groups}}}
+
+\membersection{Constructors and initialization}\label{wxgridconstructors}
+
+\helpref{wxGrid}{wxgridctor}\\
+\helpref{\destruct{wxGrid}}{wxgriddtor}\\
+\helpref{CreateGrid}{wxgridcreategrid}\\
+\helpref{SetTable}{wxgridsettable}
+
+\membersection{Display format}\label{wxgriddisplayformat}
+
+\membersection{Selection functions}\label{wxgridselectionfunctions}
+
+\helpref{wxGrid::ClearSelection}{wxgridclearselection}\\
+\helpref{wxGrid::IsSelection}{wxgridisselection}\\
+\helpref{wxGrid::SelectAll}{wxgridselectall}\\
+\helpref{wxGrid::SelectBlock}{wxgridselectblock}\\
+\helpref{wxGrid::SelectCol}{wxgridselectcol}\\
+\helpref{wxGrid::SelectRow}{wxgridselectrow}

 
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+%%%%%%%%% MEMBER FUNCTIONS %%%%%%%%%%
+\helponly{\insertatlevel{2}{

 
 

-\membersection{wxGrid::wxGrid}\label{wxgridconstr}
+\wxheading{Members}

 
 

-\func{void}{wxGrid}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxPoint\&}{ pos},
-\rtfsp\param{const wxSize\&}{ size}, \param{long}{ style=0}, \param{const wxString\& }{name="grid"}}
+}}

 
 

-Constructor. Before using a wxGrid object, you must call CreateGrid to set up the required rows and columns.
+\membersection{wxGrid::wxGrid}\label{wxgridctor}

 
 

-\membersection{wxGrid::AdjustScrollbars}\label{wxgridadjustscrollbars}
+\func{}{wxGrid}{\void}

 
 

-\func{void}{AdjustScrollbars}{\void}
+Default constructor

 
 

-Call this function whenever a change has been made via the API that might alter the scrollbar characteristics:
-particularly when adding or deleting rows, or changing row or column dimensions. For example,
-removing rows might make it unnecessary to show the vertical scrollbar.
+\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 
+\helpref{wxGrid::SetTable}{wxgridsettable} directly after this to initialize the grid before using
+it. 
+
+\membersection{wxGrid::\destruct{wxGrid}}\label{wxgriddtor}
+
+\func{}{\destruct{wxGrid}}{\void}
+
+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}). 

 
 \membersection{wxGrid::AppendCols}\label{wxgridappendcols}
 
 
 \membersection{wxGrid::AppendCols}\label{wxgridappendcols}
 

-\func{bool}{AppendCols}{\param{int}{ n=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
+successful. The updateLabels argument is not used at present.

 
 

-Appends {\it n} columns to the grid. If {\it updateLabels} is TRUE,
-the function OnChangeLabels is called to give the application the opportunity to relabel.
+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}
 
 
 \membersection{wxGrid::AppendRows}\label{wxgridappendrows}
 

-\func{bool}{AppendRows}{\param{int}{ n=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
+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. 
+
+\membersection{wxGrid::AutoSize}\label{wxgridautosize}
+
+\func{void}{AutoSize}{\void}
+
+Automatically sets the height and width of all rows and columns to fit their contents.
+
+\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::AutoSizeColOrRow}\label{wxgridautosizecolorrow}

 
 

-Appends {\it n} rows to the grid. If {\it updateLabels} is TRUE,
-the function OnChangeLabels is called to give the application the opportunity to relabel.
+\func{void}{AutoSizeColOrRow}{\param{int }{n}, \param{bool }{setAsMin}, \param{bool }{column}}
+
+Common part of AutoSizeColumn/Row() or row? 
+
+\membersection{wxGrid::AutoSizeColumn}\label{wxgridautosizecolumn}
+
+\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
+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::AutoSizeColumns}\label{wxgridautosizecolumns}
+
+\func{void}{AutoSizeColumns}{\param{bool }{setAsMin = true}}
+
+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. 
+
+\membersection{wxGrid::AutoSizeRow}\label{wxgridautosizerow}
+
+\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
+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. 
+
+\membersection{wxGrid::AutoSizeRows}\label{wxgridautosizerows}
+
+\func{void}{AutoSizeRows}{\param{bool }{setAsMin = true}}
+
+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. 

 
 \membersection{wxGrid::BeginBatch}\label{wxgridbeginbatch}
 
 \func{void}{BeginBatch}{\void}
 
 
 \membersection{wxGrid::BeginBatch}\label{wxgridbeginbatch}
 
 \func{void}{BeginBatch}{\void}
 

-Start a BeginBatch/EndBatch pair between which, calls to SetCellValue or
-SetCellBitmap will not cause a refresh. This allows you to speed up some operations
-(for example, setting several hundred cell values). You can nest, but not overlap,
-these two functions.
+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 
+\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.

 
 

-See also \helpref{wxGrid::EndBatch}{wxgridendbatch}, \helpref{wxGrid::GetBatchCount}{wxgridgetbatchcount}.
+\membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect}

 
 

-\membersection{wxGrid::CellHitTest}\label{wxgridcellhittest}
+\func{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}}

 
 

-\func{bool}{CellHitTest}{\param{int}{ x}, \param{int}{ y}, \param{int *}{row}, \param{int *}{col}}
+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.

 
 

-Returns TRUE if the x, y panel position coincides with a cell. If so, {\it row} and {\it col} are
-returned.

 
 

-\membersection{wxGrid::CreateGrid}\label{wxgridcreategrid}
+\membersection{wxGrid::CanDragColSize}\label{wxgridcandragcolsize}
+
+\func{bool}{CanDragColSize}{\void}
+
+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}).
+
+\membersection{wxGrid::CanDragRowSize}\label{wxgridcandragrowsize}
+
+\func{bool}{CanDragRowSize}{\void}
+
+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}).
+
+\membersection{wxGrid::CanDragGridSize}\label{wxgridcandraggridsize}
+
+\func{bool}{CanDragGridSize}{\void}

 
 

-\func{bool}{CreateGrid}{\param{int}{ rows}, \param{int}{ cols}, \param{wxString **}{cellValues=NULL},
- \param{short *}{widths=NULL}, \param{short}{ defaultWidth=wxGRID\_DEFAULT\_CELL\_WIDTH},
- \param{short}{ defaultHeight=wxGRID\_DEFAULT\_CELL\_HEIGHT}}
+Return true if the dragging of grid lines to resize rows and columns is enabled or false otherwise.

 
 

-Creates a grid {\it rows} high and {\it cols} wide. You can optionally specify an array of initial values
-and widths, and/or default cell width and height.
+\membersection{wxGrid::CanEnableCellControl}\label{wxgridcanenablecellcontrol}

 
 

-Call this function after creating the wxGrid object.
+\constfunc{bool}{CanEnableCellControl}{\void}

 
 

-\pythonnote{Currently the {\tt cellValues} and {\tt widths} parameters
-don't exisit in the wxPython version of this method.  So in other
-words, the definition of the  wxPython version of this method looks like this:
-\begin{verbatim}
-    CreateGrid(rows, cols,
-               defaultWidth = wxGRID_DEFAULT_CELL_WIDTH,
-               defaultHeight = wxGRID_DEFAULT_CELL_HEIGHT)
-\end{verbatim}
-}
+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::CurrentCellVisible}\label{wxgridcurrentcellvisible}
+\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes}

 
 

-\func{bool}{CurrentCellVisible}{\void}
+\func{bool}{CanHaveAttributes}{\void}

 
 

-Returns TRUE if the currently selected cell is visible, FALSE otherwise.
+Do we have some place to store attributes in?
+
+\membersection{wxGrid::CellToRect}\label{wxgridcelltorect}
+
+\func{wxRect}{CellToRect}{\param{int }{row}, \param{int }{col}}
+
+\func{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 
+\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}}
+
+Creates a grid with the specified initial number of rows and columns.
+Call this directly after the grid constructor. When you use this
+function wxGrid will create and manage a simple table of string values
+for you. All of the grid data will be stored in memory.
+
+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}. 

 
 \membersection{wxGrid::DeleteCols}\label{wxgriddeletecols}
 
 
 \membersection{wxGrid::DeleteCols}\label{wxgriddeletecols}
 

-\func{bool}{DeleteCols}{\param{int}{ pos=0}, \param{int}{ n=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.

 
 

-Deletes {\it n} columns from the grid at position {\it pos}. If {\it updateLabels} is TRUE,
-the function OnChangeLabels is called to give the application the opportunity to relabel.
+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}
 
 
 \membersection{wxGrid::DeleteRows}\label{wxgriddeleterows}
 

-\func{bool}{DeleteRows}{\param{int}{ pos=0}, \param{int}{ n=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.
+
+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).
+
+\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}. 
+
+\membersection{wxGrid::DisableDragGridSize}\label{wxgriddisabledraggridsize}

 
 

-Deletes {\it n} rows from the grid at position {\it pos}. If {\it updateLabels} is TRUE,
-the function OnChangeLabels is called to give the application the opportunity to relabel.
+\func{void}{DisableDragGridSize}{\void}
+
+Disable mouse dragging of grid lines to resize rows and columns. Equivalent to passing
+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}. 
+
+\membersection{wxGrid::EnableCellEditControl}\label{wxgridenablecelleditcontrol}
+
+\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}}
+
+Enables or disables column sizing by dragging with the mouse.
+
+\membersection{wxGrid::EnableDragGridSize}\label{wxgridenabledraggridsize}
+
+\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}}
+
+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
+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
+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 
+\helpref{wxGrid classes overview}{gridoverview}.
+
+\membersection{wxGrid::EnableGridLines}\label{wxgridenablegridlines}
+
+\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}
 
 
 \membersection{wxGrid::EndBatch}\label{wxgridendbatch}
 
 \func{void}{EndBatch}{\void}
 

-End a BeginBatch/EndBatch pair between which, calls to SetCellValue or
-SetCellBitmap will not cause a refresh. This allows you to speed up some operations
-(for example, setting several hundred cell values). You can nest, but not overlap,
-these two functions.
+Decrements the grid's batch count. When the count is greater than zero repainting of
+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.

 
 

-See also \helpref{wxGrid::BeginBatch}{wxgridbeginbatch}, \helpref{wxGrid::GetBatchCount}{wxgridgetbatchcount}.
+\membersection{wxGrid::Fit}\label{wxgridfit}

 
 

-\membersection{wxGrid::GetBatchCount}\label{wxgridgetbatchcount}
+\func{void}{Fit}{\void}

 
 

-\constfunc{int}{GetBatchCount}{\void}
+Overridden wxWindow method.

 
 

-Return the level of batch nesting. This is initially zero, and will be incremented
-every time BeginBatch is called, and decremented when EndBatch is called. When the
-batch count is more zero, some functions (such as SetCellValue and SetCellBitmap) will
-not refresh the cell.
+\membersection{wxGrid::ForceRefresh}\label{wxgridforcerefresh}

 
 

-See also \helpref{wxGrid::BeginBatch}{wxgridbeginbatch}, \helpref{wxGrid::EndBatch}{wxgridendbatch}.
+\func{void}{ForceRefresh}{\void}

 
 

-\membersection{wxGrid::GetCell}\label{wxgridgetcell}
+Causes immediate repainting of the grid. Use this instead of the usual wxWindow::Refresh.

 
 

-\constfunc{wxGridCell *}{GetCell}{\param{int}{ row}, \param{int}{ col}}
+\membersection{wxGrid::GetBatchCount}\label{wxgridgetbatchcount}

 
 

-Returns the grid cell object associated with this position.
+\func{int}{GetBatchCount}{\void}

 
 

-wxGenericGrid implementation only.
+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}
 
 
 \membersection{wxGrid::GetCellAlignment}\label{wxgridgetcellalignment}
 

-\constfunc{int}{GetCellAlignment}{\param{int}{ row}, \param{int}{ col}}
+\func{void}{GetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int* }{horiz}, \param{int* }{vert}}

 
 

-\constfunc{int}{GetCellAlignment}{\void}
+Sets the arguments to the horizontal and vertical text alignment values for the
+grid cell at the specified location.

 
 

-Sets the text alignment for the cell at the given position, or the global alignment value.
-The return value is wxLEFT, wxRIGHT or wxCENTRE.
+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.

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf GetCellAlignment(row, col)}}{}
-\twocolitem{{\bf GetDefCellAlignment()}}{}
-\end{twocollist}}
-}
+\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}
 
 
 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
 

-\constfunc{wxColour\&}{GetCellBackgroundColour}{\param{int}{ row}, \param{int}{ col}}
+\func{wxColour}{GetCellBackgroundColour}{\param{int }{row}, \param{int }{col}}

 
 

-\constfunc{wxColour\&}{GetCellBackgroundColour}{\void}
+Returns the background colour of the cell at the specified location.

 
 

-Gets the background colour for the cell at the given position, or the global background colour.
+\membersection{wxGrid::GetCellEditor}\label{wxgridgetcelleditor}

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf GetCellBackgroundColour(row, col)}}{}
-\twocolitem{{\bf GetDefCellBackgroundColourt()}}{}
-\end{twocollist}}
-}
+\func{wxGridCellEditor*}{GetCellEditor}{\param{int }{row}, \param{int }{col}}

 
 

-\membersection{wxGrid::GetCells}\label{wxgridgetcells}
+Returns a pointer to the editor for the cell at the specified location.

 
 

-\constfunc{wxGridCell ***}{GetCells}{\void}
+See \helpref{wxGridCellEditor}{wxgridcelleditor} and
+the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.

 
 

-Returns the array of grid cell object associated with this wxGrid.
+\membersection{wxGrid::GetCellFont}\label{wxgridgetcellfont}
+
+\func{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}}
+
+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}
 
 
 \membersection{wxGrid::GetCellTextColour}\label{wxgridgetcelltextcolour}
 

-\constfunc{wxColour\&}{GetCellTextColour}{\param{int}{ row}, \param{int}{ col}}
+\func{wxColour}{GetCellTextColour}{\param{int }{row}, \param{int }{col}}

 
 

-\constfunc{wxColour\&}{GetCellTextColour}{\void}
+Returns the text colour for the grid cell at the specified location.

 
 

-Gets the text colour for the cell at the given position, or the global text colour.
+\membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue}

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf GetCellTextColour(row, col)}}{}
-\twocolitem{{\bf GetDefCellTextColour()}}{}
-\end{twocollist}}
-}
+\func{wxString}{GetCellValue}{\param{int }{row}, \param{int }{col}}

 
 

-\membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont}
+\func{wxString}{GetCellValue}{\param{const wxGridCellCoords\&}{coords}}

 
 

-\constfunc{const wxFont\&}{GetCellTextFont}{\param{int}{ row}, \param{int}{ col}}
+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. 

 
 

-\constfunc{wxFont\&}{GetCellTextFont}{\void}
+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. 

 
 

-Gets the text font for the cell at the given position, or the global text font.
+See \helpref{wxGridTableBase::CanGetValueAs}{wxgridtablebasecangetvalueas}
+and the \helpref{wxGrid overview}{gridoverview} for more information.

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf GetCellTextFont(row, col)}}{}
-\twocolitem{{\bf GetDefCellTextFont()}}{}
-\end{twocollist}}
-}

 
 

-\membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue}
+\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}}
+
+Sets the arguments to the current column label 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.
+
+\perlnote{This method takes no parameters and
+returns a 2-element list {\tt ( horiz, vert )}.}
+
+\membersection{wxGrid::GetColLabelSize}\label{wxgridgetcollabelsize}
+
+\func{int}{GetColLabelSize}{\void}
+
+Returns the current height of the column labels.
+
+\membersection{wxGrid::GetColLabelValue}\label{wxgridgetcollabelvalue}
+
+\func{wxString}{GetColLabelValue}{\param{int }{col}}
+
+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. 
+
+\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::GetColMinimalWidth}\label{wxgridgetcolminimalwidth}
+
+\constfunc{int}{GetColMinimalWidth}{\param{int }{col}}
+
+Get the minimal width of the given column/row.
+
+
+\membersection{wxGrid::GetColRight}\label{wxgridgetcolright}
+
+\constfunc{int}{GetColRight}{\param{int }{col}}
+
+\membersection{wxGrid::GetColSize}\label{wxgridgetcolsize}
+
+\func{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}}
+
+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}
+
+Returns the current default background colour for grid cells.
+
+\membersection{wxGrid::GetDefaultCellFont}\label{wxgridgetdefaultcellfont}
+
+\func{wxFont}{GetDefaultCellFont}{\void}
+
+Returns the current default font for grid cell text.
+
+\membersection{wxGrid::GetDefaultCellTextColour}\label{wxgridgetdefaultcelltextcolour}
+
+\func{wxColour}{GetDefaultCellTextColour}{\void}
+
+Returns the current default colour for grid cell text.
+
+\membersection{wxGrid::GetDefaultColLabelSize}\label{wxgridgetdefaultcollabelsize}
+
+\func{int}{GetDefaultColLabelSize}{\void}
+
+Returns the default height for column labels.
+
+\membersection{wxGrid::GetDefaultColSize}\label{wxgridgetdefaultcolsize}
+
+\func{int}{GetDefaultColSize}{\void}

 
 

-\constfunc{wxString\&}{GetCellValue}{\param{int}{ row}, \param{int}{ col}}
+Returns the current default width for grid columns.

 
 

-Returns the cell value at the given position.
+\membersection{wxGrid::GetDefaultEditor}\label{wxgridgetdefaulteditor}

 
 

-\membersection{wxGrid::GetCols}\label{wxgridgetcols}
+\constfunc{wxGridCellEditor*}{GetDefaultEditor}{\void}

 
 

-\constfunc{int}{GetCols}{\void}
+Returns a pointer to the current default grid cell editor.

 
 

-Returns the number of columns in the grid.
+See \helpref{wxGridCellEditor}{wxgridcelleditor} and
+the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.

 
 

-\membersection{wxGrid::GetColumnWidth}\label{wxgridcolumnwidth}
+\membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell}

 
 

-\constfunc{int}{GetColumnWidth}{\param{int}{ col}}
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}}

 
 

-Gets the width in pixels for column {\it col}.
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{const wxGridCellCoords\& }{c}}

 
 

-\membersection{wxGrid::GetCurrentRect}\label{wxgridgetcurrentrect}

 
 

-\constfunc{wxRectangle *}{GetCurrentRect}{\void}
+\membersection{wxGrid::GetDefaultEditorForType}\label{wxgridgetdefaulteditorfortype}

 
 

-Returns a pointer to the rectangle enclosing the currently selected cell.
-Do not delete this pointer.
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForType}{\param{const wxString\& }{typeName}}

 
 

-\membersection{wxGrid::GetCursorColumn}\label{wxgridgetcursorcolumn}

 
 

-\constfunc{int}{GetCursorColumn}{\void}
+\membersection{wxGrid::GetDefaultRenderer}\label{wxgridgetdefaultrenderer}

 
 

-Returns the column position of the currently selected cell.
+\constfunc{wxGridCellRenderer*}{GetDefaultRenderer}{\void}

 
 

-\membersection{wxGrid::GetCursorRow}\label{wxgridgetcursorrow}
+Returns a pointer to the current default grid cell renderer.

 
 

-\constfunc{int}{GetCursorRow}{\void}
+See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
+the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.

 
 

-Returns the row position of the currently selected cell.
+\membersection{wxGrid::GetDefaultRendererForCell}\label{wxgridgetdefaultrendererforcell}

 
 

-\membersection{wxGrid::GetEditable}\label{wxgridgeteditable}
+\constfunc{wxGridCellRenderer*}{GetDefaultRendererForCell}{\param{int }{row}, \param{int }{col}}

 
 

-\constfunc{bool}{GetEditable}{\void}
+\membersection{wxGrid::GetDefaultRendererForType}\label{wxgridgetdefaultrendererfortype}

 
 

-Returns TRUE if the grid cells can be edited.
+\constfunc{wxGridCellRenderer*}{GetDefaultRendererForType}{\param{const wxString\& }{typeName}}

 
 

-\membersection{wxGrid::GetEditInPlace}\label{wxgridgeteditinplace}

 
 

-\constfunc{bool}{GetEditInPlace}{\void}

 
 

-Returns TRUE if editing in-place is enabled.
+\membersection{wxGrid::GetDefaultRowLabelSize}\label{wxgridgetdefaultrowlabelsize}

 
 

-\membersection{wxGrid::GetHorizScrollBar}\label{wxgridgethorizscrollbar}
+\func{int}{GetDefaultRowLabelSize}{\void}

 
 

-\constfunc{wxScrollBar *}{GetHorizScrollBar}{\void}
+Returns the default width for the row labels.

 
 

-Returns a pointer to the horizontal scrollbar.
+\membersection{wxGrid::GetDefaultRowSize}\label{wxgridgetdefaultrowsize}

 
 

-\membersection{wxGrid::GetLabelAlignment}\label{wxgridgetlabelalignment}
+\func{int}{GetDefaultRowSize}{\void}

 
 

-\constfunc{int}{GetLabelAlignment}{\param{int}{ orientation}}
+Returns the current default height for grid rows.

 
 

-Gets the row or column label alignment. {\it orientation} should
-be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
-{\it alignment} should be wxCENTRE, wxLEFT or wxRIGHT.
+\membersection{wxGrid::GetGridCursorCol}\label{wxgridgetgridcursorcol}
+
+\func{int}{GetGridCursorCol}{\void}
+
+Returns the current grid cell column position.
+
+\membersection{wxGrid::GetGridCursorRow}\label{wxgridgetgridcursorrow}
+
+\func{int}{GetGridCursorRow}{\void}
+
+Returns the current grid cell row position.
+
+\membersection{wxGrid::GetGridLineColour}\label{wxgridgetgridlinecolour}
+
+\func{wxColour}{GetGridLineColour}{\void}
+
+Returns the colour used for grid lines.
+
+\membersection{wxGrid::GridLinesEnabled}\label{wxgridgridlinesenabled}
+
+\func{bool}{GridLinesEnabled}{\void}
+
+Returns true if drawing of grid lines is turned on, false otherwise.

 
 \membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
 
 
 \membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
 

-\constfunc{wxColour\&}{GetLabelBackgroundColour}{\void}
+\func{wxColour}{GetLabelBackgroundColour}{\void}

 
 

-Gets a row and column label text colour.
+Returns the colour used for the background of row and column labels.

 
 

-\membersection{wxGrid::GetLabelSize}\label{wxgridgetlabelsize}
+\membersection{wxGrid::GetLabelFont}\label{wxgridgetlabelfont}

 
 

-\constfunc{int}{GetLabelSize}{\param{int}{ orientation}}
+\func{wxFont}{GetLabelFont}{\void}

 
 

-Gets the row label height, or column label width, in pixels. {\it orientation} should
-be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.
+Returns the font used for row and column labels.

 
 \membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour}
 
 
 \membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour}
 

-\constfunc{wxColour\&}{GetLabelTextColour}{\void}
+\func{wxColour}{GetLabelTextColour}{\void}
+
+Returns the colour used for row and column label text.
+
+\membersection{wxGrid::GetNumberCols}\label{wxgridgetnumbercols}
+
+\func{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}
+
+\func{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}
+
+\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::GetRowMinimalHeight}\label{wxgridgetrowminimalheight}
+
+\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}}
+
+\membersection{wxGrid::GetRowLabelAlignment}\label{wxgridgetrowlabelalignment}
+
+\func{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}
+
+Returns the current width of the row labels.
+
+\membersection{wxGrid::GetRowLabelValue}\label{wxgridgetrowlabelvalue}
+
+\func{wxString}{GetRowLabelValue}{\param{int }{row}}
+
+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. 
+
+\membersection{wxGrid::GetRowSize}\label{wxgridgetrowsize}
+
+\func{int}{GetRowSize}{\param{int }{row}}
+
+Returns the height of the specified row.
+
+\membersection{wxGrid::GetScrollLinesX}\label{wxgridgetscrolllinesx}
+
+\constfunc{int}{GetScrollLinesX}{\void}
+
+Returns the number of pixels per horizontal scroll increment. The default is 15.
+
+\membersection{wxGrid::GetScrollLinesY}\label{wxgridgetscrolllinesy}
+
+\constfunc{int}{GetScrollLinesY}{\void}
+
+Returns the number of pixels per vertical scroll increment. The default is 15.
+
+\membersection{wxGrid::GetSelectionMode}\label{wxgridgetselectionmode}
+
+\constfunc{wxGrid::wxGridSelectionModes}{GetSelectionMode}{\void}
+
+Returns the current selection mode, see \helpref{wxGrid::SetSelectionMode}{wxgridsetselectionmode}.

 
 

-Gets a row and column label text colour.
+\membersection{wxGrid::GetSelectedCells}\label{wxgridgetselectedcells}

 
 

-\membersection{wxGrid::GetLabelTextFont}\label{wxgridgetlabeltextfont}
+\constfunc{wxGridCellCoordsArray}{GetSelectedCells}{\void}

 
 

-\constfunc{wxFont\&}{GetLabelTextFont}{\void}
+Returns an array of singly selected cells.

 
 

-Gets the font to be used for the row and column labels.
+\membersection{wxGrid::GetSelectedCols}\label{wxgridgetselectedcols}

 
 

-\membersection{wxGrid::GetLabelValue}\label{wxgridgetlabelvalue}
+\constfunc{wxArrayInt}{GetSelectedCols}{\void}

 
 

-\constfunc{wxString\&}{GetLabelValue}{\param{int}{ orientation}, \param{int}{ pos}}
+Returns an array of selected cols.

 
 

-Gets a row or column label value. {\it orientation} should
-be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
-{\it pos} is the label position.
+\membersection{wxGrid::GetSelectedRows}\label{wxgridgetselectedrows}

 
 

-\membersection{wxGrid::GetRowHeight}\label{wxgridgetrowheight}
+\constfunc{wxArrayInt}{GetSelectedRows}{\void}

 
 

-\constfunc{int}{GetRowHeight}{\param{int}{ row}}
+Returns an array of selected rows.

 
 

-Gets the height in pixels for row {\it row}.
+\membersection{wxGrid::GetSelectionBackground}\label{wxgridgetselectionbackground}

 
 

-\membersection{wxGrid::GetRows}\label{wxgridgetrows}
+\constfunc{wxColour}{GetSelectionBackground}{\void}

 
 

-\constfunc{int}{GetRows}{\void}
+Access or update the selection fore/back colours

 
 

-Returns the number of rows in the grid.

 
 

-\membersection{wxGrid::GetScrollPosX}\label{wxgridgetscrollposx}
+\membersection{wxGrid::GetSelectionBlockTopLeft}\label{wxgridgetselectionblocktopleft}

 
 

-\constfunc{int}{GetScrollPosX}{\void}
+\constfunc{wxGridCellCoordsArray}{GetSelectionBlockTopLeft}{\void}

 
 

-Returns the column scroll position.
+Returns an array of the top left corners of blocks of selected cells, 
+see \helpref{wxGrid::GetSelectionBlockBottomRight}{wxgridgetselectionblockbottomright}.

 
 

-\membersection{wxGrid::GetScrollPosY}\label{wxgridgetscrollposy}
+\membersection{wxGrid::GetSelectionBlockBottomRight}\label{wxgridgetselectionblockbottomright}

 
 

-\constfunc{int}{GetScrollPosY}{\void}
+\constfunc{wxGridCellCoordsArray}{GetSelectionBlockBottomRight}{\void}

 
 

-Returns the row scroll position.
+Returns an array of the bottom right corners of blocks of selected cells,
+see \helpref{wxGrid::GetSelectionBlockTopLeft}{wxgridgetselectionblocktopleft}.

 
 

-\membersection{wxGrid::GetTextItem}\label{wxgridgettextitem}
+\membersection{wxGrid::GetSelectionForeground}\label{wxgridgetselectionforeground}

 
 

-\constfunc{wxText *}{GetTextItem}{\void}
+\constfunc{wxColour}{GetSelectionForeground}{\void}

 
 

-Returns a pointer to the text item used for entering text into a cell.

 
 

-\membersection{wxGrid::GetVertScrollBar}\label{wxgridgetvertscrollbar}
+\membersection{wxGrid::GetTable}\label{wxgridgettable}

 
 

-\constfunc{wxScrollBar *}{GetVertScrollBar}{\void}
+\constfunc{wxGridTableBase *}{GetTable}{\void}

 
 

-Returns a pointer to the vertical scrollbar.
+Returns a base pointer to the current table object.
+
+\membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth}
+
+\func{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::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}
 
 
 \membersection{wxGrid::InsertCols}\label{wxgridinsertcols}
 

-\func{bool}{InsertCols}{\param{int}{ pos=0}, \param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}}
+\func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}}

 
 

-Inserts {\it n} number of columns before position {\it pos}. If {\it updateLabels} is TRUE,
-the function OnChangeLabels is called to give the application the opportunity to relabel.
+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. 
+
+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 
+\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 
+\helpref{wxGridTableBase::InsertCols}{wxgridtablebaseinsertcols} in your derived
+table class.

 
 \membersection{wxGrid::InsertRows}\label{wxgridinsertrows}
 
 
 \membersection{wxGrid::InsertRows}\label{wxgridinsertrows}
 

-\func{bool}{InsertRows}{\param{int}{ pos=0}, \param{int}{ n=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. 
+
+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 
+\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 
+\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.
+
+\membersection{wxGrid::IsCurrentCellReadOnly}\label{wxgridiscurrentcellreadonly}
+
+\constfunc{bool}{IsCurrentCellReadOnly}{\void}
+
+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.
+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.
+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.
+
+\membersection{wxGrid::IsVisible}\label{wxgridisvisible}
+
+\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}}
+
+\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = true}}
+
+Returns true if a cell is either wholly visible (the default) or at least partially
+visible in the grid window.
+
+\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. 
+
+\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.
+
+\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.

 
 

-Inserts {\it n} number of rows before position {\it pos}. If {\it updateLabels} is TRUE,
-the function OnChangeLabels is called to give the application the opportunity to relabel.
+\wxheading{Keyboard}\\
+This function is called for Left cursor key presses or Shift+Left to expand a selection.

 
 

-\membersection{wxGrid::OnActivate}\label{wxgridonactivate}
+\membersection{wxGrid::MoveCursorRight}\label{wxgridmovecursorright}

 
 

-\func{void}{OnActivate}{\param{bool}{ active}}
+\func{bool}{MoveCursorRight}{\param{bool }{expandSelection}}

 
 

-Sets the text item to have the focus. Call this function when the wxGrid window should have the
-focus, for example from wxFrame::OnActivate.
+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.

 
 

-\membersection{wxGrid::OnChangeLabels}\label{wxgridonchangelabels}
+\wxheading{Keyboard}\\
+This function is called for Right cursor key presses or Shift+Right to expand a selection.

 
 

-\func{void}{OnChangeLabels}{\void}
+\membersection{wxGrid::MoveCursorUp}\label{wxgridmovecursorup}

 
 

-Called when rows and columns are created or deleted, to allow the application an
-opportunity to update the labels. By default, columns are labelled alphabetically,
-and rows numerically.
+\func{bool}{MoveCursorUp}{\param{bool }{expandSelection}}

 
 

-\membersection{wxGrid::OnChangeSelectionLabel}\label{wxgridonchangeselectionlabel}
+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.

 
 

-\func{void}{OnChangeSelectionLabel}{\void}
+\wxheading{Keyboard}\\
+This function is called for Up cursor key presses or Shift+Up to expand a selection.

 
 

-Called when a cell is selected, to allow the application an
-opportunity to update the selection label (the label of the wxText item
-used for entering cell text). By default, the cell column letter and row
-number are concatenated to form the selection label.
+\membersection{wxGrid::MoveCursorDownBlock}\label{wxgridmovecursordownblock}

 
 

-\membersection{wxGrid::OnCreateCell}\label{wxgridoncreatecell}
+\func{bool}{MoveCursorDownBlock}{\param{bool }{expandSelection}}

 
 

-\func{wxGridCell *}{OnCreateCell}{\void}
+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.

 
 

-Override this virtual function if you want to replace the normal wxGridCell with a derived
-class.
+\wxheading{Keyboard}\\
+This function is called for the Ctrl+Down key combination. Shift+Ctrl+Down expands a selection.

 
 

-\membersection{wxGrid::OnCellLeftClick}\label{wxgridoncellleftclick}
+\membersection{wxGrid::MoveCursorLeftBlock}\label{wxgridmovecursorleftblock}

 
 

-\func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
+\func{bool}{MoveCursorLeftBlock}{\param{bool }{expandSelection}}

 
 

-Virtual function called when the left button is depressed within a cell, just after OnSelectCell is called.
+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.

 
 

-\membersection{wxGrid::OnCellRightClick}\label{wxgridoncellrightclick}
+\wxheading{Keyboard}\\
+This function is called for the Ctrl+Left key combination. Shift+Ctrl+left expands a selection.

 
 

-\func{void}{OnRightClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
+\membersection{wxGrid::MoveCursorRightBlock}\label{wxgridmovecursorrightblock}

 
 

-Virtual function called when the right button is depressed within a cell, just after OnSelectCell is called.
+\func{bool}{MoveCursorRightBlock}{\param{bool }{expandSelection}}

 
 

-\membersection{wxGrid::OnLabelLeftClick}\label{wxgridonlabelleftclick}
+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.

 
 

-\func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
+\wxheading{Keyboard}\\
+This function is called for the Ctrl+Right key combination. Shift+Ctrl+Right expands a selection.

 
 

-Virtual function called when the left button is depressed within a
-label.
+\membersection{wxGrid::MoveCursorUpBlock}\label{wxgridmovecursorupblock}

 
 

-{\it row} will be {\it -1} if the click is in the top labels.
+\func{bool}{MoveCursorUpBlock}{\param{bool }{expandSelection}}

 
 

-{\it col} will be {\it -1} if the click is in the left labels.
+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.

 
 

-{\it row} and {\it col} will be {\it -1} if the click is in the upper
-left corner.
+\wxheading{Keyboard}\\
+This function is called for the Ctrl+Up key combination. Shift+Ctrl+Up expands a selection.

 
 

-\membersection{wxGrid::OnLabelRightClick}\label{wxgridonlabelrightclick}
+\membersection{wxGrid::MovePageDown}\label{wxgridmovepagedown}

 
 

-\func{void}{OnRightClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
+\func{bool}{MovePageDown}{\void}

 
 

-Virtual function called when the right button is depressed within a label.
+Moves the grid cursor down by some number of rows so that the previous bottom visible row
+becomes the top visible row.

 
 

-{\it row} will be {\it -1} if the click is in the top labels.
+\wxheading{Keyboard}\\
+This function is called for PgDn keypresses.

 
 

-{\it col} will be {\it -1} if the click is in the left labels.
+\membersection{wxGrid::MovePageUp}\label{wxgridmovepageup}

 
 

-{\it row} and {\it col} will be {\it -1} if the click is in the upper
-left corner.
+\func{bool}{MovePageUp}{\void}

 
 

-\membersection{wxGrid::OnSelectCell}\label{wxgridonselectcell}
+Moves the grid cursor up by some number of rows so that the previous top visible row
+becomes the bottom visible row.

 
 

-\func{void}{OnSelectCell}{\param{int}{ row}, \param{int}{ col}}
+\wxheading{Keyboard}\\
+This function is called for PgUp keypresses.

 
 

-Virtual function called when the user left-clicks on a cell.
+\membersection{wxGrid::RegisterDataType}\label{wxgridregisterdatatype}

 
 

-\membersection{wxGrid::OnSelectCellImplementation}\label{wxgridonselectcellimplementation}
+\func{void}{RegisterDataType}{\param{const wxString\& }{typeName}, \param{wxGridCellRenderer* }{renderer}, \param{wxGridCellEditor* }{editor}}

 
 

-\func{void}{OnSelectCellImplementation}{\param{wxDC *}{dc}, \param{int}{ row}, \param{int}{ col}}
+Methods for a registry for mapping data types to Renderers/Editors

 
 

-Virtual function called when the user left-clicks on a cell. If you override this function,
-call wxGrid::OnSelectCell to apply the default behaviour.
+\membersection{wxGrid::SaveEditControlValue}\label{wxgridsaveeditcontrolvalue}
+
+\func{void}{SaveEditControlValue}{\void}
+
+Sets the value of the current grid cell to the current in-place edit control value.
+This is called automatically when the grid cursor moves from the current cell to a
+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{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}}
+
+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}
+
+\func{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.
+
+
+\membersection{wxGrid::SelectRow}\label{wxgridselectrow}
+
+\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.

 
 \membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment}
 
 
 \membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment}
 

-\func{void}{SetCellAlignment}{\param{int}{ alignment}, \param{int}{ row}, \param{int}{ col}}
+\func{void}{SetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int }{horiz}, \param{int }{vert}}

 
 

-\func{void}{SetCellAlignment}{\param{int}{ alignment}}
+\func{void}{SetCellAlignment}{\param{int }{align}, \param{int }{row}, \param{int }{col}}

 
 

-Sets the text alignment for the cell at the given position, or for the whole grid. {\it alignment} may be wxLEFT, wxRIGHT or wxCENTRE.
+Sets the horizontal and vertical alignment for grid cell text at the specified location.

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf SetCellAlignment(alignment, row, col)}}{}
-\twocolitem{{\bf SetDefCellAlignment(alignment)}}{}
-\end{twocollist}}
-}
+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}
 
 
 \membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
 

-\func{void}{SetCellBackgroundColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
+\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}

 
 

-\func{void}{SetCellBackgroundColour}{\param{const wxColour\&}{ colour}}

 
 

-Sets the background colour for the cell at the given position, or for the whole grid.
+\membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor}

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf SetCellBackgroundColour(colour, row, col)}}{}
-\twocolitem{{\bf SetDefCellBackgroundColour(colour)}}{}
-\end{twocollist}}
-}
+\func{void}{SetCellEditor}{\param{int }{row}, \param{int }{col}, \param{wxGridCellEditor* }{editor}}

 
 

-\membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
+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}{SetCellTextColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
+\func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const wxFont\&}{ font}}

 
 

-\func{void}{SetCellTextColour}{\param{const wxColour\&}{ colour}}
+Sets the font for text in the grid cell at the specified location.

 
 

-Sets the text colour for the cell at the given position, or for the whole grid.
+\membersection{wxGrid::SetCellRenderer}\label{wxgridsetcellrenderer}

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf SetCellTextColour(colour, row, col)}}{}
-\twocolitem{{\bf SetDefCellTextColour(colour)}}{}
-\end{twocollist}}
-}
+\func{void}{SetCellRenderer}{\param{int }{row}, \param{int }{col}, \param{wxGridCellRenderer* }{renderer}}

 
 

-\membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont}
+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}{SetCellTextFont}{\param{const wxFont\&}{ font}, \param{int}{ row}, \param{int}{ col}}
+\func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}

 
 

-\func{void}{SetCellTextFont}{\param{const wxFont\&}{ font}}
+\func{void}{SetCellTextColour}{\param{const wxColour\& }{val}, \param{int }{row}, \param{int }{col}}

 
 

-Sets the text font for the cell at the given position, or for the whole grid.
+\func{void}{SetCellTextColour}{\param{const wxColour\& }{colour}}

 
 

-\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
-\indented{2cm}{\begin{twocollist}
-\twocolitem{{\bf SetCellTextFont(font, row, col)}}{}
-\twocolitem{{\bf SetDefCellTextFont(font)}}{}
-\end{twocollist}}
-}
+Sets the text colour for the grid cell at the specified location.

 
 \membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
 
 
 \membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
 

-\func{void}{SetCellValue}{\param{const wxString\&}{ val}, \param{int}{ row}, \param{int}{ col}}
+\func{void}{SetCellValue}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{s}}
+
+\func{void}{SetCellValue}{\param{const wxGridCellCoords\& }{coords}, \param{const wxString\& }{s}}
+
+\func{void}{SetCellValue}{\param{const wxString\& }{val}, \param{int }{row}, \param{int }{col}}
+
+Sets the string value for the cell at the specified location. For simple applications where a
+grid object automatically uses a default grid table of string values you use this function together
+with \helpref{wxGrid::GetCellValue}{wxgridgetcellvalue} to access cell values. 
+
+For more complex applications where you have derived your own grid table class that contains
+various data types (e.g. numeric, boolean or user-defined custom types) then you only use this
+function for those cells that contain string values.
+
+The last form is for backward compatibility only.
+
+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 
+\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.

 
 

-Sets the cell value at the given position.
+Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.

 
 

-\membersection{wxGrid::SetColumnWidth}\label{wxgridsetcolumnwidth}
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.

 
 

-\func{void}{SetColumnWidth}{\param{int}{ col}, \param{int}{ width}}
+\membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize}

 
 

-Sets the width in pixels for column {\it col}.
+\func{void}{SetColLabelSize}{\param{int }{height}}

 
 

-\membersection{wxGrid::SetDividerPen}\label{wxgridsetdividerpen}
+Sets the height of the column labels.

 
 

-\func{void}{SetDividerPen}{\param{const wxPen\&}{ pen}}
+\membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue}

 
 

-Specifies the pen to be used for drawing the divisions between cells. The default
-is a light grey. If NULL is specified, the divisions will not be drawn.
+\func{void}{SetColLabelValue}{\param{int }{col}, \param{const wxString\&}{ value}}

 
 

-\membersection{wxGrid::SetEditable}\label{wxgridseteditable}
+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.

 
 

-\func{void}{SetEditable}{\param{bool}{ editable}}
+\membersection{wxGrid::SetColMinimalWidth}\label{wxgridsetcolminimalwidth}

 
 

-If {\it editable} is TRUE (the default), the grid cells will be editable by means of the
-text edit control. If FALSE, the text edit control will be hidden and the user will not
-be able to edit the cell contents.
+\func{void}{SetColMinimalWidth}{\param{int }{col}, \param{int }{width}}

 
 

-\membersection{wxGrid::SetEditInPlace}\label{wxgridseteditinplace}
+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{void}{SetEditInPlace}{\param{bool}{ edit = TRUE}}
+\membersection{wxGrid::SetColMinimalAcceptableWidth}\label{wxgridsetcolminimalacceptablewidth}

 
 

-Enables (if {\it edit} is TRUE, default value) or disables in-place editing.
-When it is enabled, the cells contents can be changed by typing text directly
-in the cell.
+\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::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 vertical 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::SetDefaultCellTextColour}\label{wxgridsetdefaultcelltextcolour}
+
+\func{void}{SetDefaultCellTextColour}{\param{const wxColour\&}{ colour}}
+
+Sets the current default colour 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}
 
 
 \membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
 

-\func{void}{SetGridCursor}{\param{int }{row}, \param{int}{ col}}
+\func{void}{SetGridCursor}{\param{int }{row}, \param{int }{col}}

 
 

-Sets the position of the selected cell.
+Set the grid cursor to the specified cell. 
+This function calls \helpref{wxGrid::MakeCellVisible}{wxgridmakecellvisible}.

 
 

-\membersection{wxGrid::SetLabelAlignment}\label{wxgridsetlabelalignment}
+\membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour}

 
 

-\func{void}{SetLabelAlignment}{\param{int}{ orientation}, \param{int}{ alignment}}
+\func{void}{SetGridLineColour}{\param{const wxColour\&}{colour}}

 
 

-Sets the row or column label alignment. {\it orientation} should
-be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
-{\it alignment} should be wxCENTRE, wxLEFT or wxRIGHT.
+Sets the colour used to draw grid lines.

 
 \membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
 
 
 \membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
 

-\func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ value}}
+\func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ colour}}

 
 

-Sets a row or column label background colour.
+Sets the background colour for row and column labels.

 
 

-\membersection{wxGrid::SetLabelSize}\label{wxgridsetlabelsize}
+\membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont}

 
 

-\func{void}{SetLabelSize}{\param{int}{ orientation}, \param{int}{ size}}
+\func{void}{SetLabelFont}{\param{const wxFont\&}{ font}}

 
 

-Sets the row label height, or column label width, in pixels. {\it orientation} should
-be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.
-
-If a dimension of zero is specified, the row or column labels will not be
-shown.
+Sets the font for row and column labels.

 
 \membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
 
 
 \membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
 

-\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ value}}
+\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ colour}}
+
+Sets the colour for row and column label text.
+
+\membersection{wxGrid::SetMargins}\label{wxgridsetmargins}
+
+\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::SetOrCalcColumnSizes}\label{wxgridsetorcalccolumnsizes}
+
+\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}}
+
+\membersection{wxGrid::SetReadOnly}\label{wxgridsetreadonly}
+
+\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::SetRowAttr}\label{wxgridsetrowattr}
+
+\func{void}{SetRowAttr}{\param{int }{row}, \param{wxGridCellAttr* }{attr}}
+
+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::SetRowLabelAlignment}\label{wxgridsetrowlabelalignment}
+
+\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.
+
+Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
+
+\membersection{wxGrid::SetRowLabelSize}\label{wxgridsetrowlabelsize}
+
+\func{void}{SetRowLabelSize}{\param{int }{width}}
+
+Sets the width of the row labels.
+
+\membersection{wxGrid::SetRowLabelValue}\label{wxgridsetrowlabelvalue}
+
+\func{void}{SetRowLabelValue}{\param{int }{row}, \param{const wxString\&}{ value}}
+
+Set the value for the given row label. If you are using a derived grid table you must 
+override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue} 
+for this to have any effect.
+
+\membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}
+
+\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::SetRowSize}\label{wxgridsetrowsize}
+
+\func{void}{SetRowSize}{\param{int }{row}, \param{int }{height}}
+
+Sets the height of the specified row. 
+
+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::SetScrollLinesX}\label{wxgridsetscrolllinesx}
+
+\func{void}{SetScrollLinesX}{\param{int }{x}}
+
+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.
+
+\membersection{wxGrid::SetScrollLinesY}\label{wxgridsetscrolllinesy}
+
+\func{void}{SetScrollLinesY}{\param{int }{y}}
+
+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.
+
+\membersection{wxGrid::SetSelectionBackground}\label{wxgridsetselectionbackground}
+
+\func{void}{SetSelectionBackground}{\param{const wxColour\& }{c}}
+
+
+\membersection{wxGrid::SetSelectionForeground}\label{wxgridsetselectionforeground}
+
+\func{void}{SetSelectionForeground}{\param{const wxColour\& }{c}}
+
+
+\membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode}
+
+\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}}
+
+Set the selection behaviour of the grid.
+
+\wxheading{Parameters}
+
+\docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.}
+
+\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
+
+\docparam{wxGrid::wxGridSelectColumns}{Selections will consist of whole columns.}
+
+\membersection{wxGrid::SetTable}\label{wxgridsettable}
+
+\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::ShowCellEditControl}\label{wxgridshowcelleditcontrol}

 
 

-Sets a row and column label text colour.
+\func{void}{ShowCellEditControl}{\void}

 
 

-\membersection{wxGrid::SetLabelTextFont}\label{wxgridsetlabeltextfont}
+Displays the in-place cell edit control for the current cell.

 
 

-\func{void}{SetLabelTextFont}{\param{const wxFont\&}{ font}}
+\membersection{wxGrid::XToCol}\label{wxgridxtocol}

 
 

-Sets the font to be used for the row and column labels.
+\func{int}{XToCol}{\param{int }{x}}

 
 

-\membersection{wxGrid::SetLabelValue}\label{wxgridsetlabelvalue}
+Returns the grid column that corresponds to the logical x coordinate. Returns
+{\tt wxNOT\_FOUND} if there is no column at the x position.

 
 

-\func{void}{SetLabelValue}{\param{int}{ orientation}, \param{const wxString\&}{ value}, \param{int}{ pos}}
+\membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol}

 
 

-Sets a row or column label value. {\it orientation} should
-be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
-{\it pos} is the label position.
+\func{int}{XToEdgeOfCol}{\param{int }{x}}

 
 

-\membersection{wxGrid::SetRowHeight}\label{wxgridsetrowheight}
+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.

 
 

-\func{void}{SetRowHeight}{\param{int}{ row}, \param{int}{ height}}
+\membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow}

 
 

-Sets the height in pixels for row {\it row}.
+\func{int}{YToEdgeOfRow}{\param{int }{y}}

 
 

-\membersection{wxGrid::UpdateDimensions}\label{wxgridupdatedimensions}
+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.

 
 

-\func{void}{UpdateDimensions}{\void}
+\membersection{wxGrid::YToRow}\label{wxgridytorow}

 
 

-Call this function whenever a change has been made via the API that
-might alter size characteristics. You may also need to follow it with
-a call to AdjustScrollbars.
+\func{int}{YToRow}{\param{int }{y}}

 
 

+Returns the grid row that corresponds to the logical y coordinate. Returns
+{\tt wxNOT\_FOUND} if there is no row at the y position.