X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..6aaee6afdcde7c9e677f642303d4988a66cb9dc9:/docs/latex/wx/grid.tex diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex index db3368f9b7..59ffc0df30 100644 --- a/docs/latex/wx/grid.tex +++ b/docs/latex/wx/grid.tex @@ -1,9 +1,38 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: grid.tex +%% Purpose: wxGrid +%% Author: +%% Modified by: Santiago Palacios +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxGrid}}\label{wxgrid} -wxGrid 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} +\helpref{wxScrolledWindow}{wxscrolledwindow}\\ \helpref{wxPanel}{wxpanel}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -13,509 +42,2009 @@ wxGrid is a class for displaying and editing tabular information. +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{Window styles} -There are no specific window styles for this class. +There are presently no specific window styles for wxGrid. + +\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\_COL\_MOVE(func)}}{The user moved a column by dragging it. Processes a wxEVT\_GRID\_COL\_MOVE.} +\twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.} +\twocolitem{{\bf EVT\_GRID\_CMD\_COL\_SIZE(func)}}{The user resized a column by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_COL\_SIZE.} +\twocolitem{{\bf EVT\_GRID\_CMD\_COL\_MOVE(func)}}{The user moved a column by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_COL\_MOVE.} +\twocolitem{{\bf EVT\_GRID\_CMD\_ROW\_SIZE(func)}}{The user resized a row by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_ROW\_SIZE.} +\end{twocollist}% + +The event handler for the following functions takes a + \helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter. +The ...\_CMD\_... variant also takes a window identifier. -See also \helpref{window styles overview}{windowstyles}. +\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} -\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} + +%%%%%%%%% MEMBER FUNCTIONS %%%%%%%%%% +\helponly{\insertatlevel{2}{ + +\wxheading{Members} + +}} + + + +\membersection{wxGrid::wxGrid}\label{wxgridctor} + +\func{}{wxGrid}{\void} + +Default constructor + +\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. -\latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxGrid::wxGrid}\label{wxgridconstr} -\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"}} +\membersection{wxGrid::\destruct{wxGrid}}\label{wxgriddtor} -Constructor. Before using a wxGrid object, you must call CreateGrid to set up the required rows and columns. +\func{}{\destruct{wxGrid}}{\void} -\membersection{wxGrid::AdjustScrollbars}\label{wxgridadjustscrollbars} +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}). -\func{void}{AdjustScrollbars}{\void} -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. \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. + +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. + -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. \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::AutoSizeColLabelSize}\label{wxgridautosizecollabelsize} + +\func{void}{AutoSizeColLabelSize}{\param{int }{col}} + +Automatically adjusts width of the column to fit its label. + + + +\membersection{wxGrid::AutoSizeColumn}\label{wxgridautosizecolumn} + +\func{void}{AutoSizeColumn}{\param{int }{col}, \param{bool }{setAsMin = true}} + +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::AutoSizeRowLabelSize}\label{wxgridautosizerowlabelsize} + +\func{void}{AutoSizeRowLabelSize}{\param{int }{col}} + +Automatically adjusts height of the row to fit its label. + + + +\membersection{wxGrid::AutoSizeRows}\label{wxgridautosizerows} + +\func{void}{AutoSizeRows}{\param{bool }{setAsMin = true}} + +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. + -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. \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}. +\wxheading{See also} -\membersection{wxGrid::CellHitTest}\label{wxgridcellhittest} +\helpref{wxGridUpdateLocker}{wxgridupdatelocker} -\func{bool}{CellHitTest}{\param{int}{ x}, \param{int}{ y}, \param{int *}{row}, \param{int *}{col}} -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::BlockToDeviceRect}\label{wxgridblocktodevicerect} + +\constfunc{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}} + +This function returns the rectangle that encloses the block of cells +limited by TopLeft and BottomRight cell in device coords and clipped +to the client size of the grid window. + + + +\membersection{wxGrid::CanDragColMove}\label{wxgridcandragcolmove} + +\constfunc{bool}{CanDragColMove}{\void} + +Returns true if columns can be moved by dragging with the mouse. Columns can be moved +by dragging on their labels. + + + +\membersection{wxGrid::CanDragColSize}\label{wxgridcandragcolsize} + +\constfunc{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} + +\constfunc{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} + +\constfunc{bool}{CanDragGridSize}{\void} + +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). + + + +\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes} + +\constfunc{bool}{CanHaveAttributes}{\void} + +Do we have some place to store attributes in? + + + +\membersection{wxGrid::CellToRect}\label{wxgridcelltorect} + +\constfunc{wxRect}{CellToRect}{\param{int }{row}, \param{int }{col}} + +\constfunc{wxRect}{CellToRect}{\param{const wxGridCellCoords\& }{coords}} + +Return the rectangle corresponding to the grid cell's size and position in logical +coordinates. + + + +\membersection{wxGrid::ClearGrid}\label{wxgridcleargrid} + +\func{void}{ClearGrid}{\void} + +Clears all data in the underlying grid table and repaints the grid. The table is not deleted by +this function. If you are using a derived table class then you need to override +\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. -\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}} -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. -Call this function after creating the wxGrid object. +\membersection{wxGrid::CreateGrid}\label{wxgridcreategrid} + +\func{bool}{CreateGrid}{\param{int }{numRows}, \param{int }{numCols}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}} -\membersection{wxGrid::CurrentCellVisible}\label{wxgridcurrentcellvisible} +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}. -\func{bool}{CurrentCellVisible}{\void} -Returns TRUE if the currently selected cell is visible, FALSE otherwise. \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. + +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. + -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. \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::DisableDragColMove}\label{wxgriddisabledragcolmove} + +\func{void}{DisableDragColMove}{\void} + +Disables column moving by dragging with the mouse. Equivalent to passing false to +\helpref{wxGrid::EnableDragColMove}{wxgridenabledragcolmove}. + + + +\membersection{wxGrid::DisableDragColSize}\label{wxgriddisabledragcolsize} + +\func{void}{DisableDragColSize}{\void} + +Disables column sizing by dragging with the mouse. Equivalent to passing false to +\helpref{wxGrid::EnableDragColSize}{wxgridenabledragcolsize}. + + + +\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} + + + +\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::EnableDragColMove}\label{wxgridenabledragcolmove} + +\func{void}{EnableDragColMove}{\param{bool }{enable = true}} + +Enables or disables column moving by dragging with the mouse. + + + +\membersection{wxGrid::EnableDragGridSize}\label{wxgridenabledraggridsize} + +\func{void}{EnableDragGridSize}{\param{bool }{enable = true}} + +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. + -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. \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. + +\wxheading{See also} + +\helpref{wxGridUpdateLocker}{wxgridupdatelocker} + + + +\membersection{wxGrid::Fit}\label{wxgridfit} + +\func{void}{Fit}{\void} + +Overridden wxWindow method. + + + +\membersection{wxGrid::ForceRefresh}\label{wxgridforcerefresh} + +\func{void}{ForceRefresh}{\void} + +Causes immediate repainting of the grid. Use this instead of the usual wxWindow::Refresh. + -See also \helpref{wxGrid::BeginBatch}{wxgridbeginbatch}, \helpref{wxGrid::GetBatchCount}{wxgridgetbatchcount}. \membersection{wxGrid::GetBatchCount}\label{wxgridgetbatchcount} \constfunc{int}{GetBatchCount}{\void} -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. +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. -See also \helpref{wxGrid::BeginBatch}{wxgridbeginbatch}, \helpref{wxGrid::EndBatch}{wxgridendbatch}. -\membersection{wxGrid::GetCell}\label{wxgridgetcell} -\constfunc{wxGridCell *}{GetCell}{\param{int}{ row}, \param{int}{ col}} +\membersection{wxGrid::GetCellAlignment}\label{wxgridgetcellalignment} -Returns the grid cell object associated with this position. +\constfunc{void}{GetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int* }{horiz}, \param{int* }{vert}} -wxGenericGrid implementation only. +Sets the arguments to the horizontal and vertical text alignment values for the +grid cell at the specified location. -\membersection{wxGrid::GetCellAlignment}\label{wxgridgetcellalignment} +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. -\constfunc{int}{GetCellAlignment}{\param{int}{ row}, \param{int}{ col}} +\perlnote{This method only takes the parameters {\tt row} and {\tt col} and +returns a 2-element list {\tt ( horiz, vert )}.} -\constfunc{int}{GetCellAlignment}{\void} -Sets the text alignment for the cell at the given position, or the global alignment value. -The return value is wxLEFT, wxRIGHT or wxCENTRE. \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour} -\constfunc{wxColour\&}{GetCellBackgroundColour}{\param{int}{ row}, \param{int}{ col}} +\constfunc{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::GetCells}\label{wxgridgetcells} -\constfunc{wxGridCell ***}{GetCells}{\void} +\membersection{wxGrid::GetCellEditor}\label{wxgridgetcelleditor} -Returns the array of grid cell object associated with this wxGrid. +\constfunc{wxGridCellEditor*}{GetCellEditor}{\param{int }{row}, \param{int }{col}} -\membersection{wxGrid::GetCellTextColour}\label{wxgridgetcelltextcolour} +Returns a pointer to the editor for the cell at the specified location. + +See \helpref{wxGridCellEditor}{wxgridcelleditor} and +the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + + +\membersection{wxGrid::GetCellFont}\label{wxgridgetcellfont} + +\constfunc{wxFont}{GetCellFont}{\param{int }{row}, \param{int }{col}} + +Returns the font for text in the grid cell at the specified location. + + + +\membersection{wxGrid::GetCellRenderer}\label{wxgridgetcellrenderer} -\constfunc{wxColour\&}{GetCellTextColour}{\param{int}{ row}, \param{int}{ col}} +\constfunc{wxGridCellRenderer*}{GetCellRenderer}{\param{int }{row}, \param{int }{col}} -\constfunc{wxColour\&}{GetCellTextColour}{\void} +Returns a pointer to the renderer for the grid cell at the specified location. -Gets the text colour for the cell at the given position, or the global text colour. +See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and +the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. -\membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont} -\constfunc{const wxFont\&}{GetCellTextFont}{\param{int}{ row}, \param{int}{ col}} -\constfunc{wxFont\&}{GetCellTextFont}{\void} +\membersection{wxGrid::GetCellTextColour}\label{wxgridgetcelltextcolour} + +\constfunc{wxColour}{GetCellTextColour}{\param{int }{row}, \param{int }{col}} + +Returns the text colour for the grid cell at the specified location. + -Gets the text font for the cell at the given position, or the global text font. \membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue} -\constfunc{wxString\&}{GetCellValue}{\param{int}{ row}, \param{int}{ col}} +\constfunc{wxString}{GetCellValue}{\param{int }{row}, \param{int }{col}} -Returns the cell value at the given position. +\constfunc{wxString}{GetCellValue}{\param{const wxGridCellCoords\&}{coords}} -\membersection{wxGrid::GetCols}\label{wxgridgetcols} +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{int}{GetCols}{\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. -Returns the number of columns in the grid. +See \helpref{wxGridTableBase::CanGetValueAs}{wxgridtablebasecangetvalueas} +and the \helpref{wxGrid overview}{gridoverview} for more information. -\membersection{wxGrid::GetColumnWidth}\label{wxgridcolumnwidth} -\constfunc{int}{GetColumnWidth}{\param{int}{ col}} -Gets the width in pixels for column {\it col}. +\membersection{wxGrid::GetColAt}\label{wxgridgetcolat} -\membersection{wxGrid::GetCurrentRect}\label{wxgridgetcurrentrect} +\constfunc{int}{GetColAt}{\param{int }{colPos}} -\constfunc{wxRectangle *}{GetCurrentRect}{\void} +Returns the column ID of the specified column position. -Returns a pointer to the rectangle enclosing the currently selected cell. -Do not delete this pointer. -\membersection{wxGrid::GetCursorColumn}\label{wxgridgetcursorcolumn} +\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft} -\constfunc{int}{GetCursorColumn}{\void} +\constfunc{int}{GetColLeft}{\param{int }{col}} -Returns the column position of the currently selected cell. -\membersection{wxGrid::GetCursorRow}\label{wxgridgetcursorrow} -\constfunc{int}{GetCursorRow}{\void} +\membersection{wxGrid::GetColLabelAlignment}\label{wxgridgetcollabelalignment} -Returns the row position of the currently selected cell. +\constfunc{void}{GetColLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}} -\membersection{wxGrid::GetEditable}\label{wxgridgeteditable} +Sets the arguments to the current column label alignment values. -\constfunc{bool}{GetEditable}{\void} +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. -Returns TRUE if the grid cells can be edited. +\perlnote{This method takes no parameters and +returns a 2-element list {\tt ( horiz, vert )}.} -\membersection{wxGrid::GetHorizScrollBar}\label{wxgridgethorizscrollbar} -\constfunc{wxScrollBar *}{GetHorizScrollBar}{\void} -Returns a pointer to the horizontal scrollbar. +\membersection{wxGrid::GetColLabelSize}\label{wxgridgetcollabelsize} -\membersection{wxGrid::GetLabelAlignment}\label{wxgridgetlabelalignment} +\constfunc{int}{GetColLabelSize}{\void} -\constfunc{int}{GetLabelAlignment}{\param{int}{ orientation}} +Returns the current height of the column labels. -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::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour} -\constfunc{wxColour\&}{GetLabelBackgroundColour}{\void} +\membersection{wxGrid::GetColLabelValue}\label{wxgridgetcollabelvalue} -Gets a row and column label text colour. +\constfunc{wxString}{GetColLabelValue}{\param{int }{col}} -\membersection{wxGrid::GetLabelSize}\label{wxgridgetlabelsize} +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. -\constfunc{int}{GetLabelSize}{\param{int}{ orientation}} -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. -\membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour} +\membersection{wxGrid::GetColMinimalAcceptableWidth}\label{wxgridgetcolminimalacceptablewidth} -\constfunc{wxColour\&}{GetLabelTextColour}{\void} +\constfunc{int}{GetColMinimalAcceptableWidth}{} -Gets a row and column label text colour. +This returns the value of the lowest column width that can be handled correctly. See +member \helpref{SetColMinimalAcceptableWidth}{wxgridsetcolminimalacceptablewidth} for details. -\membersection{wxGrid::GetLabelTextFont}\label{wxgridgetlabeltextfont} -\constfunc{wxFont\&}{GetLabelTextFont}{\void} -Gets the font to be used for the row and column labels. +\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth} -\membersection{wxGrid::GetLabelValue}\label{wxgridgetlabelvalue} +\constfunc{int}{GetColMinimalWidth}{\param{int }{col}} -\constfunc{wxString\&}{GetLabelValue}{\param{int}{ orientation}, \param{int}{ pos}} +Get the minimal width of the given column/row. -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::GetRowHeight}\label{wxgridgetrowheight} -\constfunc{int}{GetRowHeight}{\param{int}{ row}} +\membersection{wxGrid::GetColPos}\label{wxgridgetcolpos} -Gets the height in pixels for row {\it row}. +\constfunc{int}{GetColPos}{\param{int }{colID}} -\membersection{wxGrid::GetRows}\label{wxgridgetrows} +Returns the position of the specified column. -\constfunc{int}{GetRows}{\void} -Returns the number of rows in the grid. -\membersection{wxGrid::GetScrollPosX}\label{wxgridgetscrollposx} +\membersection{wxGrid::GetColRight}\label{wxgridgetcolright} -\constfunc{int}{GetScrollPosX}{\void} +\constfunc{int}{GetColRight}{\param{int }{col}} -Returns the column scroll position. -\membersection{wxGrid::GetScrollPosY}\label{wxgridgetscrollposy} -\constfunc{int}{GetScrollPosY}{\void} +\membersection{wxGrid::GetColSize}\label{wxgridgetcolsize} -Returns the row scroll position. +\constfunc{int}{GetColSize}{\param{int }{col}} -\membersection{wxGrid::GetTextItem}\label{wxgridgettextitem} +Returns the width of the specified column. -\constfunc{wxText *}{GetTextItem}{\void} -Returns a pointer to the text item used for entering text into a cell. -\membersection{wxGrid::GetVertScrollBar}\label{wxgridgetvertscrollbar} +\membersection{wxGrid::GetDefaultCellAlignment}\label{wxgridgetdefaultcellalignment} -\constfunc{wxScrollBar *}{GetVertScrollBar}{\void} +\constfunc{void}{GetDefaultCellAlignment}{\param{int* }{horiz}, \param{int* }{vert}} -Returns a pointer to the vertical scrollbar. +Sets the arguments to the current default horizontal and vertical text alignment +values. -\membersection{wxGrid::InsertCols}\label{wxgridinsertcols} +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. -\func{bool}{InsertCols}{\param{int}{ pos=0}, \param{int}{ n=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. -\membersection{wxGrid::InsertRows}\label{wxgridinsertrows} +\membersection{wxGrid::GetDefaultCellBackgroundColour}\label{wxgridgetdefaultcellbackgroundcolour} -\func{bool}{InsertRows}{\param{int}{ pos=0}, \param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}} +\constfunc{wxColour}{GetDefaultCellBackgroundColour}{\void} -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. +Returns the current default background colour for grid cells. -\membersection{wxGrid::OnActivate}\label{wxgridonactivate} -\func{void}{OnActivate}{\param{bool}{ active}} -Sets the text item to have the focus. Call this function when the wxGrid window should have the -focus, for example from wxFrame::OnActivate. +\membersection{wxGrid::GetDefaultCellFont}\label{wxgridgetdefaultcellfont} -\membersection{wxGrid::OnChangeLabels}\label{wxgridonchangelabels} +\constfunc{wxFont}{GetDefaultCellFont}{\void} -\func{void}{OnChangeLabels}{\void} +Returns the current default font for grid cell text. -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. -\membersection{wxGrid::OnChangeSelectionLabel}\label{wxgridonchangeselectionlabel} -\func{void}{OnChangeSelectionLabel}{\void} +\membersection{wxGrid::GetDefaultCellTextColour}\label{wxgridgetdefaultcelltextcolour} -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. +\constfunc{wxColour}{GetDefaultCellTextColour}{\void} -\membersection{wxGrid::OnCreateCell}\label{wxgridoncreatecell} +Returns the current default colour for grid cell text. -\func{wxGridCell *}{OnCreateCell}{\void} -Override this virtual function if you want to replace the normal wxGridCell with a derived -class. -\membersection{wxGrid::OnCellLeftClick}\label{wxgridoncellleftclick} +\membersection{wxGrid::GetDefaultColLabelSize}\label{wxgridgetdefaultcollabelsize} -\func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}} +\constfunc{int}{GetDefaultColLabelSize}{\void} -Virtual function called when the left button is depressed within a cell, just after OnSelectCell is called. +Returns the default height for column labels. -\membersection{wxGrid::OnCellRightClick}\label{wxgridoncellrightclick} -\func{void}{OnRightClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}} -Virtual function called when the right button is depressed within a cell, just after OnSelectCell is called. +\membersection{wxGrid::GetDefaultColSize}\label{wxgridgetdefaultcolsize} -\membersection{wxGrid::OnLabelLeftClick}\label{wxgridonlabelleftclick} +\constfunc{int}{GetDefaultColSize}{\void} -\func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}} +Returns the current default width for grid columns. -Virtual function called when the left button is depressed within a -label. -{\it row} will be {\it -1} if the click is in the top labels. -{\it col} will be {\it -1} if the click is in the left labels. +\membersection{wxGrid::GetDefaultEditor}\label{wxgridgetdefaulteditor} -{\it row} and {\it col} will be {\it -1} if the click is in the upper -left corner. +\constfunc{wxGridCellEditor*}{GetDefaultEditor}{\void} -\membersection{wxGrid::OnLabelRightClick}\label{wxgridonlabelrightclick} +Returns a pointer to the current default grid cell editor. -\func{void}{OnRightClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}} +See \helpref{wxGridCellEditor}{wxgridcelleditor} and +the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. -Virtual function called when the right button is depressed within a label. -{\it row} will be {\it -1} if the click is in the top labels. -{\it col} will be {\it -1} if the click is in the left labels. +\membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell} -{\it row} and {\it col} will be {\it -1} if the click is in the upper -left corner. +\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}} -\membersection{wxGrid::OnSelectCell}\label{wxgridonselectcell} +\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{const wxGridCellCoords\& }{c}} -\func{void}{OnSelectCell}{\param{int}{ row}, \param{int}{ col}} -Virtual function called when the user left-clicks on a cell. -\membersection{wxGrid::OnSelectCellImplementation}\label{wxgridonselectcellimplementation} +\membersection{wxGrid::GetDefaultEditorForType}\label{wxgridgetdefaulteditorfortype} -\func{void}{OnSelectCellImplementation}{\param{wxDC *}{dc}, \param{int}{ row}, \param{int}{ col}} +\constfunc{wxGridCellEditor*}{GetDefaultEditorForType}{\param{const wxString\& }{typeName}} -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::SetCellAlignment}\label{wxgridsetcellalignment} -\func{void}{SetCellAlignment}{\param{int}{ alignment}, \param{int}{ row}, \param{int}{ col}} +\membersection{wxGrid::GetDefaultRenderer}\label{wxgridgetdefaultrenderer} -\func{void}{SetCellAlignment}{\param{int}{ alignment}} +\constfunc{wxGridCellRenderer*}{GetDefaultRenderer}{\void} -Sets the text alignment for the cell at the given position, or for the whole grid. {\it alignment} may be wxLEFT, wxRIGHT or wxCENTRE. +Returns a pointer to the current default grid cell renderer. -\membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour} +See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and +the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. -\func{void}{SetCellBackgroundColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}} -\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::GetDefaultRendererForCell}\label{wxgridgetdefaultrendererforcell} -\membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour} +\constfunc{wxGridCellRenderer*}{GetDefaultRendererForCell}{\param{int }{row}, \param{int }{col}} -\func{void}{SetCellTextColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}} -\func{void}{SetCellTextColour}{\param{const wxColour\&}{ colour}} -Sets the text colour for the cell at the given position, or for the whole grid. +\membersection{wxGrid::GetDefaultRendererForType}\label{wxgridgetdefaultrendererfortype} -\membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont} +\constfunc{wxGridCellRenderer*}{GetDefaultRendererForType}{\param{const wxString\& }{typeName}} -\func{void}{SetCellTextFont}{\param{const wxFont\&}{ font}, \param{int}{ row}, \param{int}{ col}} -\func{void}{SetCellTextFont}{\param{const wxFont\&}{ font}} -Sets the text font for the cell at the given position, or for the whole grid. +\membersection{wxGrid::GetDefaultRowLabelSize}\label{wxgridgetdefaultrowlabelsize} -\membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue} +\constfunc{int}{GetDefaultRowLabelSize}{\void} -\func{void}{SetCellValue}{\param{const wxString\&}{ val}, \param{int}{ row}, \param{int}{ col}} +Returns the default width for the row labels. -Sets the cell value at the given position. -\membersection{wxGrid::SetColumnWidth}\label{wxgridsetcolumnwidth} -\func{void}{SetColumnWidth}{\param{int}{ col}, \param{int}{ width}} +\membersection{wxGrid::GetDefaultRowSize}\label{wxgridgetdefaultrowsize} -Sets the width in pixels for column {\it col}. +\constfunc{int}{GetDefaultRowSize}{\void} -\membersection{wxGrid::SetDividerPen}\label{wxgridsetdividerpen} +Returns the current default height for grid rows. -\func{void}{SetDividerPen}{\param{const wxPen\&}{ pen}} -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. -\membersection{wxGrid::SetEditable}\label{wxgridseteditable} +\membersection{wxGrid::GetGridCursorCol}\label{wxgridgetgridcursorcol} -\func{void}{SetEditable}{\param{bool}{ editable}} +\constfunc{int}{GetGridCursorCol}{\void} -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. +Returns the current grid cell column position. -\membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor} -\func{void}{SetGridCursor}{\param{int }{row}, \param{int}{ col}} -Sets the position of the selected cell. +\membersection{wxGrid::GetGridCursorRow}\label{wxgridgetgridcursorrow} -\membersection{wxGrid::SetLabelAlignment}\label{wxgridsetlabelalignment} +\constfunc{int}{GetGridCursorRow}{\void} -\func{void}{SetLabelAlignment}{\param{int}{ orientation}, \param{int}{ alignment}} +Returns the current grid cell row position. -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. -\membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour} -\func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ value}} +\membersection{wxGrid::GetGridLineColour}\label{wxgridgetgridlinecolour} -Sets a row or column label background colour. +\constfunc{wxColour}{GetGridLineColour}{\void} -\membersection{wxGrid::SetLabelSize}\label{wxgridsetlabelsize} +Returns the colour used for grid lines. -\func{void}{SetLabelSize}{\param{int}{ orientation}, \param{int}{ size}} +\wxheading{See also} -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. +\helpref{GetDefaultGridLinePen()}{wxgridgetdefaultgridlinepen} -If a dimension of zero is specified, the row or column labels will not be -shown. -\membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour} +\membersection{wxGrid::GetDefaultGridLinePen}\label{wxgridgetdefaultgridlinepen} + +\func{wxPen}{GetDefaultGridLinePen}{\void} + +Returns the pen used for grid lines. This virtual function may be overridden in +derived classes in order to change the appearance of grid lines. Note that +currently the pen width must be $1$. + +\wxheading{See also} + +\helpref{GetColGridLinePen()}{wxgridgetcolgridlinepen},\\ +\helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen} + + + + +\membersection{wxGrid::GetRowGridLinePen}\label{wxgridgetrowgridlinepen} + +\func{wxPen}{GetRowGridLinePen}{\param{int }{row}} + +Returns the pen used for horizontal grid lines. This virtual function may be +overridden in derived classes in order to change the appearance of individual +grid line for the given row \arg{row}. + +Example: \\ +\\ +\begin{verbatim} + // in a grid displaying music notation, use a solid black pen between + // octaves (C0=row 127, C1=row 115 etc.) + wxPen MidiGrid::GetRowGridLinePen(int row) + { + if ( row%12 == 7 ) + return wxPen(*wxBLACK, 1, wxSOLID); + else + return GetDefaultGridLinePen(); + } +\end{verbatim} + + + +\membersection{wxGrid::GetColGridLinePen}\label{wxgridgetcolgridlinepen} + +\func{wxPen}{GetColGridLinePen}{\param{int }{col}} + +Returns the pen used for vertical grid lines. This virtual function may be +overridden in derived classes in order to change the appearance of individual +grid lines for the given column \arg{col}. + +See \helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen} for an example. + + + + +\membersection{wxGrid::GridLinesEnabled}\label{wxgridgridlinesenabled} + +\constfunc{bool}{GridLinesEnabled}{\void} + +Returns true if drawing of grid lines is turned on, false otherwise. + + + +\membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour} + +\constfunc{wxColour}{GetLabelBackgroundColour}{\void} + +Returns the colour used for the background of row and column labels. + + + +\membersection{wxGrid::GetLabelFont}\label{wxgridgetlabelfont} + +\constfunc{wxFont}{GetLabelFont}{\void} + +Returns the font used for row and column labels. + + + +\membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour} + +\constfunc{wxColour}{GetLabelTextColour}{\void} + +Returns the colour used for row and column label text. + + + +\membersection{wxGrid::GetNumberCols}\label{wxgridgetnumbercols} + +\constfunc{int}{GetNumberCols}{\void} + +Returns the total number of grid columns (actually the number of columns in the underlying grid +table). + + + +\membersection{wxGrid::GetNumberRows}\label{wxgridgetnumberrows} + +\constfunc{int}{GetNumberRows}{\void} + +Returns the total number of grid rows (actually the number of rows in the underlying grid table). + + + +\membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr} + +\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}} + + + +\membersection{wxGrid::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight} + +\constfunc{int}{GetRowMinimalAcceptableHeight}{} + +This returns the value of the lowest row width that can be handled correctly. See +member \helpref{SetRowMinimalAcceptableHeight}{wxgridsetrowminimalacceptableheight} for details. + + + +\membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight} + +\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}} + + + +\membersection{wxGrid::GetRowLabelAlignment}\label{wxgridgetrowlabelalignment} + +\constfunc{void}{GetRowLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}} + +Sets the arguments to the current row label alignment values. + +Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\ +Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM. + +\perlnote{This method takes no parameters and +returns a 2-element list {\tt ( horiz, vert )}.} + + + +\membersection{wxGrid::GetRowLabelSize}\label{wxgridgetrowlabelsize} + +\constfunc{int}{GetRowLabelSize}{\void} + +Returns the current width of the row labels. + + + +\membersection{wxGrid::GetRowLabelValue}\label{wxgridgetrowlabelvalue} + +\constfunc{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} + +\constfunc{int}{GetRowSize}{\param{int }{row}} + +Returns the height of the specified row. + + + +\membersection{wxGrid::GetScrollLineX}\label{wxgridgetscrolllinex} + +\constfunc{int}{GetScrollLineX}{\void} + +Returns the number of pixels per horizontal scroll increment. The default is 15. + +\wxheading{See also} + +\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp +\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp +\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney} + + + +\membersection{wxGrid::GetScrollLineY}\label{wxgridgetscrollliney} + +\constfunc{int}{GetScrollLineY}{\void} + +Returns the number of pixels per vertical scroll increment. The default is 15. + +\wxheading{See also} + +\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp +\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp +\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney} + + + +\membersection{wxGrid::GetSelectionMode}\label{wxgridgetselectionmode} + +\constfunc{wxGrid::wxGridSelectionModes}{GetSelectionMode}{\void} + +Returns the current selection mode, see \helpref{wxGrid::SetSelectionMode}{wxgridsetselectionmode}. + + + +\membersection{wxGrid::GetSelectedCells}\label{wxgridgetselectedcells} + +\constfunc{wxGridCellCoordsArray}{GetSelectedCells}{\void} + +Returns an array of singly selected cells. + + + +\membersection{wxGrid::GetSelectedCols}\label{wxgridgetselectedcols} + +\constfunc{wxArrayInt}{GetSelectedCols}{\void} + +Returns an array of selected cols. + + + +\membersection{wxGrid::GetSelectedRows}\label{wxgridgetselectedrows} + +\constfunc{wxArrayInt}{GetSelectedRows}{\void} + +Returns an array of selected rows. + + + +\membersection{wxGrid::GetSelectionBackground}\label{wxgridgetselectionbackground} + +\constfunc{wxColour}{GetSelectionBackground}{\void} + +Access or update the selection fore/back colours + + + +\membersection{wxGrid::GetSelectionBlockTopLeft}\label{wxgridgetselectionblocktopleft} + +\constfunc{wxGridCellCoordsArray}{GetSelectionBlockTopLeft}{\void} + +Returns an array of the top left corners of blocks of selected cells, +see \helpref{wxGrid::GetSelectionBlockBottomRight}{wxgridgetselectionblockbottomright}. + + + +\membersection{wxGrid::GetSelectionBlockBottomRight}\label{wxgridgetselectionblockbottomright} + +\constfunc{wxGridCellCoordsArray}{GetSelectionBlockBottomRight}{\void} + +Returns an array of the bottom right corners of blocks of selected cells, +see \helpref{wxGrid::GetSelectionBlockTopLeft}{wxgridgetselectionblocktopleft}. + + + +\membersection{wxGrid::GetSelectionForeground}\label{wxgridgetselectionforeground} + +\constfunc{wxColour}{GetSelectionForeground}{\void} + + + +\membersection{wxGrid::GetTable}\label{wxgridgettable} + +\constfunc{wxGridTableBase *}{GetTable}{\void} + +Returns a base pointer to the current table object. + + + +\membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth} + +\constfunc{int}{GetViewWidth}{\void} + +Returned number of whole cols visible. + + + +\membersection{wxGrid::HideCellEditControl}\label{wxgridhidecelleditcontrol} + +\func{void}{HideCellEditControl}{\void} + +Hides the in-place cell edit control. + + + +\membersection{wxGrid::InitColWidths}\label{wxgridinitcolwidths} + +\func{void}{InitColWidths}{\void} + +Init the m\_colWidths/Rights arrays + + + +\membersection{wxGrid::InitRowHeights}\label{wxgridinitrowheights} + +\func{void}{InitRowHeights}{\void} + +NB: {\it never} access m\_row/col arrays directly because they are created +on demand, {\it always} use accessor functions instead! + +Init the m\_rowHeights/Bottoms arrays with default values. + + + +\membersection{wxGrid::InsertCols}\label{wxgridinsertcols} + +\func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}} + +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} + +\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} + +\constfunc{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} + +\constfunc{bool}{IsSelection}{\void} + +Returns true if there are currently rows, columns or blocks of cells selected. + + + +\membersection{wxGrid::IsVisible}\label{wxgridisvisible} + +\constfunc{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}} + +\constfunc{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = true}} + +Returns true if a cell is either wholly visible (the default) or at least partially +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. + +\wxheading{Keyboard}\\ +This function is called for Left cursor key presses or Shift+Left to expand a selection. + + + +\membersection{wxGrid::MoveCursorRight}\label{wxgridmovecursorright} + +\func{bool}{MoveCursorRight}{\param{bool }{expandSelection}} + +Moves the grid cursor right by one column. If a block of cells was previously selected it +will expand if the argument is true or be cleared if the argument is false. + +\wxheading{Keyboard}\\ +This function is called for Right cursor key presses or Shift+Right to expand a selection. + + + +\membersection{wxGrid::MoveCursorUp}\label{wxgridmovecursorup} + +\func{bool}{MoveCursorUp}{\param{bool }{expandSelection}} + +Moves the grid cursor up by one row. If a block of cells was previously selected it +will expand if the argument is true or be cleared if the argument is false. + +\wxheading{Keyboard}\\ +This function is called for Up cursor key presses or Shift+Up to expand a selection. + + + +\membersection{wxGrid::MoveCursorDownBlock}\label{wxgridmovecursordownblock} + +\func{bool}{MoveCursorDownBlock}{\param{bool }{expandSelection}} + +Moves the grid cursor down in the current column such that it skips to the beginning or +end of a block of non-empty cells. If a block of cells was previously selected it +will expand if the argument is true or be cleared if the argument is false. + +\wxheading{Keyboard}\\ +This function is called for the Ctrl+Down key combination. Shift+Ctrl+Down expands a selection. + + + +\membersection{wxGrid::MoveCursorLeftBlock}\label{wxgridmovecursorleftblock} + +\func{bool}{MoveCursorLeftBlock}{\param{bool }{expandSelection}} + +Moves the grid cursor left in the current row such that it skips to the beginning or +end of a block of non-empty cells. If a block of cells was previously selected it +will expand if the argument is true or be cleared if the argument is false. + +\wxheading{Keyboard}\\ +This function is called for the Ctrl+Left key combination. Shift+Ctrl+left expands a selection. + + + +\membersection{wxGrid::MoveCursorRightBlock}\label{wxgridmovecursorrightblock} + +\func{bool}{MoveCursorRightBlock}{\param{bool }{expandSelection}} + +Moves the grid cursor right in the current row such that it skips to the beginning or +end of a block of non-empty cells. If a block of cells was previously selected it +will expand if the argument is true or be cleared if the argument is false. + +\wxheading{Keyboard}\\ +This function is called for the Ctrl+Right key combination. Shift+Ctrl+Right expands a selection. + + + +\membersection{wxGrid::MoveCursorUpBlock}\label{wxgridmovecursorupblock} + +\func{bool}{MoveCursorUpBlock}{\param{bool }{expandSelection}} + +Moves the grid cursor up in the current column such that it skips to the beginning or +end of a block of non-empty cells. If a block of cells was previously selected it +will expand if the argument is true or be cleared if the argument is false. + +\wxheading{Keyboard}\\ +This function is called for the Ctrl+Up key combination. Shift+Ctrl+Up expands a selection. + + + +\membersection{wxGrid::MovePageDown}\label{wxgridmovepagedown} + +\func{bool}{MovePageDown}{\void} + +Moves the grid cursor down by some number of rows so that the previous bottom visible row +becomes the top visible row. + +\wxheading{Keyboard}\\ +This function is called for PgDn keypresses. + + + +\membersection{wxGrid::MovePageUp}\label{wxgridmovepageup} + +\func{bool}{MovePageUp}{\void} + +Moves the grid cursor up by some number of rows so that the previous top visible row +becomes the bottom visible row. + +\wxheading{Keyboard}\\ +This function is called for PgUp keypresses. + + + +\membersection{wxGrid::RegisterDataType}\label{wxgridregisterdatatype} + +\func{void}{RegisterDataType}{\param{const wxString\& }{typeName}, \param{wxGridCellRenderer* }{renderer}, \param{wxGridCellEditor* }{editor}} + +Methods for a registry for mapping data types to Renderers/Editors + + + +\membersection{wxGrid::SaveEditControlValue}\label{wxgridsaveeditcontrolvalue} + +\func{void}{SaveEditControlValue}{\void} + +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} + +\constfunc{wxRect}{SelectionToDeviceRect}{\void} + +This function returns the rectangle that encloses the selected cells +in device coords and clipped to the client size of the grid window. + + + +\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} + +\func{void}{SetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int }{horiz}, \param{int }{vert}} + +\func{void}{SetCellAlignment}{\param{int }{align}, \param{int }{row}, \param{int }{col}} + +Sets the horizontal and vertical alignment for grid cell text at the specified location. + +Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. \\ +Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM. + + + +\membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour} + +\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}} + + + +\membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor} + +\func{void}{SetCellEditor}{\param{int }{row}, \param{int }{col}, \param{wxGridCellEditor* }{editor}} + +Sets the editor for the grid cell at the specified location. +The grid will take ownership of the pointer. + +See \helpref{wxGridCellEditor}{wxgridcelleditor} and +the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + + +\membersection{wxGrid::SetCellFont}\label{wxgridsetcellfont} + +\func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const wxFont\&}{ font}} + +Sets the font for text in the grid cell at the specified location. + + + +\membersection{wxGrid::SetCellRenderer}\label{wxgridsetcellrenderer} + +\func{void}{SetCellRenderer}{\param{int }{row}, \param{int }{col}, \param{wxGridCellRenderer* }{renderer}} + +Sets the renderer for the grid cell at the specified location. +The grid will take ownership of the pointer. + +See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and +the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + + +\membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour} + +\func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}} + +\func{void}{SetCellTextColour}{\param{const wxColour\& }{val}, \param{int }{row}, \param{int }{col}} + +\func{void}{SetCellTextColour}{\param{const wxColour\& }{colour}} + +Sets the text colour for the grid cell at the specified location. + + + +\membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue} + +\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. + +Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. + +Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM. + + + +\membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize} + +\func{void}{SetColLabelSize}{\param{int }{height}} + +Sets the height of the column labels. + +If \arg{height} equals to \texttt{wxGRID\_AUTOSIZE} then height is calculated automatically +so that no label is truncated. Note that this could be slow for a large table. + + + +\membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue} + +\func{void}{SetColLabelValue}{\param{int }{col}, \param{const wxString\&}{ value}} + +Set the value for the given column label. If you are using a derived grid table you must +override \helpref{wxGridTableBase::SetColLabelValue}{wxgridtablebasesetcollabelvalue} +for this to have any effect. + + + +\membersection{wxGrid::SetColMinimalWidth}\label{wxgridsetcolminimalwidth} + +\func{void}{SetColMinimalWidth}{\param{int }{col}, \param{int }{width}} + +Sets the minimal width for the specified column. This should normally be called when creating the grid +because it will not resize a column that is already narrower than the minimal width. +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::SetColPos}\label{wxgridsetcolpos} + +\func{void}{SetColPos}{\param{int }{colID}, \param{int }{newPos}} + +Sets the position of the specified column. + + + +\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} + +\func{void}{SetGridCursor}{\param{int }{row}, \param{int }{col}} + +Set the grid cursor to the specified cell. +This function calls \helpref{wxGrid::MakeCellVisible}{wxgridmakecellvisible}. + + + +\membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour} + +\func{void}{SetGridLineColour}{\param{const wxColour\&}{colour}} + +Sets the colour used to draw grid lines. + + + +\membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour} + +\func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ colour}} + +Sets the background colour for row and column labels. + + + +\membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont} + +\func{void}{SetLabelFont}{\param{const wxFont\&}{ font}} + +Sets the font for row and column labels. + + + +\membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour} + +\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ 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. + +If \arg{width} equals \texttt{wxGRID\_AUTOSIZE} then width is calculated automatically +so that no label is truncated. Note that this could be slow for a large table. + + + +\membersection{wxGrid::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::SetScrollLineX}\label{wxgridsetscrolllinex} + +\func{void}{SetScrollLineX}{\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. + +\wxheading{See also} + +\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp +\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp +\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney} + + + +\membersection{wxGrid::SetScrollLineY}\label{wxgridsetscrollliney} + +\func{void}{SetScrollLineY}{\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. + +\wxheading{See also} + +\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp +\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp +\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex} + + + +\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} + +\func{void}{ShowCellEditControl}{\void} + +Displays the in-place cell edit control for the current cell. + + + +\membersection{wxGrid::XToCol}\label{wxgridxtocol} + +\constfunc{int}{XToCol}{\param{int }{x}, \param{bool }{clipToMinMax = false}} + +\wxheading{Parameters} +\docparam{x}{The x position to evaluate.} +\docparam{clipToMinMax}{If true, rather than returning wxNOT\_FOUND, it returns either the first or last column depending on whether x is too far to the left or right respectively.} + +\wxheading{Return value} +The grid column that corresponds to the logical x coordinate. Returns +{\tt wxNOT\_FOUND} if there is no column at the x position. -\func{void}{SetLabelTextColour}{\param{const wxColour\&}{ value}} -Sets a row and column label text colour. -\membersection{wxGrid::SetLabelTextFont}\label{wxgridsetlabeltextfont} +\membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol} -\func{void}{SetLabelTextFont}{\param{const wxFont\&}{ font}} +\constfunc{int}{XToEdgeOfCol}{\param{int }{x}} -Sets the font to be used for the row and column labels. +Returns the column whose right hand edge is close to the given logical x position. +If no column edge is near to this position {\tt wxNOT\_FOUND} is returned. -\membersection{wxGrid::SetLabelValue}\label{wxgridsetlabelvalue} -\func{void}{SetLabelValue}{\param{int}{ orientation}, \param{const wxString\&}{ value}, \param{int}{ pos}} -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. +\membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow} -\membersection{wxGrid::SetRowHeight}\label{wxgridsetrowheight} +\constfunc{int}{YToEdgeOfRow}{\param{int }{y}} -\func{void}{SetRowHeight}{\param{int}{ row}, \param{int}{ height}} +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. -Sets the height in pixels for row {\it row}. -\membersection{wxGrid::UpdateDimensions}\label{wxgridupdatedimensions} -\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. +\constfunc{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.