X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b8d24d4edd1f91339918134d2420af39c324aa1f..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/grid.tex?ds=sidebyside diff --git a/docs/latex/wx/grid.tex b/docs/latex/wx/grid.tex index 4dcd0089f5..0960fe50ac 100644 --- a/docs/latex/wx/grid.tex +++ b/docs/latex/wx/grid.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: grid.tex +%% Purpose: wxGrid +%% Author: +%% Modified by: Santiago Palacios +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxGrid}}\label{wxgrid} wxGrid and its related classes are used for displaying and editing tabular @@ -12,12 +23,12 @@ examples of simple and more complex applications, explains the relationship between the various grid classes and has a summary of the keyboard shortcuts and mouse functions provided by wxGrid. -wxGrid has been greatly expanded and redesigned for wxWindows 2.2 +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. +the previous implementation. \wxheading{Derived from} @@ -30,6 +41,10 @@ the previous implementation. +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{Window styles} There are presently no specific window styles for wxGrid. @@ -38,29 +53,36 @@ There are presently no specific window styles for wxGrid. \input gridevt.inc -The event handler for the following functions takes a +The event handler for the following functions takes a \helpref{wxGridSizeEvent}{wxgridsizeevent} parameter. +The ...\_CMD\_... variants also take a window identifier. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt \twocolitem{{\bf EVT\_GRID\_COL\_SIZE(func)}}{The user resized a column by dragging it. Processes a wxEVT\_GRID\_COL\_SIZE.} \twocolitem{{\bf EVT\_GRID\_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 +The event handler for the following functions takes a \helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter. +The ...\_CMD\_... variant also takes a window identifier. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt \twocolitem{{\bf EVT\_GRID\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells. Processes a wxEVT\_GRID\_RANGE\_SELECT.} +\twocolitem{{\bf EVT\_GRID\_CMD\_RANGE\_SELECT(id, func)}}{The user selected a group of contiguous cells; variant taking a window identifier. Processes a wxEVT\_GRID\_RANGE\_SELECT.} \end{twocollist}% -The event handler for the following functions takes a +The event handler for the following functions takes a \helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter. +The ...\_CMD\_... variant also takes a window identifier. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt \twocolitem{{\bf EVT\_GRID\_EDITOR\_CREATED(func)}}{The editor for a cell was created. Processes a wxEVT\_GRID\_EDITOR\_CREATED.} +\twocolitem{{\bf EVT\_GRID\_CMD\_EDITOR\_CREATED(id, func)}}{The editor for a cell was created; variant taking a window identifier. Processes a wxEVT\_GRID\_EDITOR\_CREATED.} \end{twocollist}% \wxheading{See also} @@ -70,16 +92,22 @@ The event handler for the following functions takes a %%%%%%%%%%% FUNCTION GROUPS %%%%%%%%%%%%% \latexignore{\rtfignore{\wxheading{Function groups}}} -\membersection{Constructors and initialization} + + +\membersection{Constructors and initialization}\label{wxgridconstructors} \helpref{wxGrid}{wxgridctor}\\ \helpref{\destruct{wxGrid}}{wxgriddtor}\\ \helpref{CreateGrid}{wxgridcreategrid}\\ \helpref{SetTable}{wxgridsettable} -\membersection{Display format} -\membersection{Selection functions} + +\membersection{Display format}\label{wxgriddisplayformat} + + + +\membersection{Selection functions}\label{wxgridselectionfunctions} \helpref{wxGrid::ClearSelection}{wxgridclearselection}\\ \helpref{wxGrid::IsSelection}{wxgridisselection}\\ @@ -95,6 +123,8 @@ The event handler for the following functions takes a }} + + \membersection{wxGrid::wxGrid}\label{wxgridctor} \func{}{wxGrid}{\void} @@ -103,9 +133,11 @@ 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 +Constructor to create a grid object. Call either \helpref{wxGrid::CreateGrid}{wxgridcreategrid} or \helpref{wxGrid::SetTable}{wxgridsettable} directly after this to initialize the grid before using -it. +it. + + \membersection{wxGrid::\destruct{wxGrid}}\label{wxgriddtor} @@ -113,7 +145,9 @@ it. Destructor. This will also destroy the associated grid table unless you passed a table object to the grid and specified that the grid should not take ownership of the -table (see \helpref{wxGrid::SetTable}{wxgridsettable}). +table (see \helpref{wxGrid::SetTable}{wxgridsettable}). + + \membersection{wxGrid::AppendCols}\label{wxgridappendcols} @@ -122,9 +156,11 @@ table (see \helpref{wxGrid::SetTable}{wxgridsettable}). Appends one or more new columns to the right of the grid and returns true if successful. The updateLabels argument is not used at present. -If you are using a derived grid table class you will need to override -\helpref{wxGridTableBase::AppendCols}{wxgridtablebaseappendcols}. See -\helpref{wxGrid::InsertCols}{wxgridinsertcols} for further information. +If you are using a derived grid table class you will need to override +\helpref{wxGridTableBase::AppendCols}{wxgridtablebaseappendcols}. See +\helpref{wxGrid::InsertCols}{wxgridinsertcols} for further information. + + \membersection{wxGrid::AppendRows}\label{wxgridappendrows} @@ -133,9 +169,11 @@ If you are using a derived grid table class you will need to override Appends one or more new rows to the bottom of the grid and returns true if successful. The updateLabels argument is not used at present. -If you are using a derived grid table class you will need to override -\helpref{wxGridTableBase::AppendRows}{wxgridtablebaseappendrows}. See -\helpref{wxGrid::InsertRows}{wxgridinsertrows} for further information. +If you are using a derived grid table class you will need to override +\helpref{wxGridTableBase::AppendRows}{wxgridtablebaseappendrows}. See +\helpref{wxGrid::InsertRows}{wxgridinsertrows} for further information. + + \membersection{wxGrid::AutoSize}\label{wxgridautosize} @@ -145,7 +183,17 @@ Automatically sets the height and width of all rows and columns to fit their con \wxheading{Note}\\ wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used. -The memory requirements for this could become prohibitive if your grid is very large. +The memory requirements for this could become prohibitive if your grid is very large. + + + +\membersection{wxGrid::AutoSizeColLabelSize}\label{wxgridautosizecollabelsize} + +\func{void}{AutoSizeColLabelSize}{\param{int }{col}} + +Automatically adjusts width of the column to fit its label. + + \membersection{wxGrid::AutoSizeColumn}\label{wxgridautosizecolumn} @@ -156,7 +204,9 @@ also be set as the minimal width for the column. \wxheading{Note}\\ wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used. -The memory requirements for this could become prohibitive if your grid is very large. +The memory requirements for this could become prohibitive if your grid is very large. + + \membersection{wxGrid::AutoSizeColumns}\label{wxgridautosizecolumns} @@ -167,7 +217,9 @@ also be set as the minimal widths for the columns. \wxheading{Note}\\ wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used. -The memory requirements for this could become prohibitive if your grid is very large. +The memory requirements for this could become prohibitive if your grid is very large. + + \membersection{wxGrid::AutoSizeRow}\label{wxgridautosizerow} @@ -178,7 +230,17 @@ also be set as the minimal height for the row. \wxheading{Note}\\ wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used. -The memory requirements for this could become prohibitive if your grid is very large. +The memory requirements for this could become prohibitive if your grid is very large. + + + +\membersection{wxGrid::AutoSizeRowLabelSize}\label{wxgridautosizerowlabelsize} + +\func{void}{AutoSizeRowLabelSize}{\param{int }{col}} + +Automatically adjusts height of the row to fit its label. + + \membersection{wxGrid::AutoSizeRows}\label{wxgridautosizerows} @@ -189,42 +251,75 @@ also be set as the minimal heights for the rows. \wxheading{Note}\\ wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used. -The memory requirements for this could become prohibitive if your grid is very large. +The memory requirements for this could become prohibitive if your grid is very large. + + \membersection{wxGrid::BeginBatch}\label{wxgridbeginbatch} \func{void}{BeginBatch}{\void} Increments the grid's batch count. When the count is greater than zero repainting of -the grid is suppressed. Each call to BeginBatch must be matched by a later call to +the grid is suppressed. Each call to BeginBatch must be matched by a later call to \helpref{wxGrid::EndBatch}{wxgridendbatch}. Code that does a lot of grid modification can be enclosed between BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will cause the grid to be repainted. +\wxheading{See also} + +\helpref{wxGridUpdateLocker}{wxgridupdatelocker} + + + +\membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect} + +\constfunc{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}} + +This function returns the rectangle that encloses the block of cells +limited by TopLeft and BottomRight cell in device coords and clipped +to the client size of the grid window. + + + +\membersection{wxGrid::CanDragColMove}\label{wxgridcandragcolmove} + +\constfunc{bool}{CanDragColMove}{\void} + +Returns true if columns can be moved by dragging with the mouse. Columns can be moved +by dragging on their labels. + + + \membersection{wxGrid::CanDragColSize}\label{wxgridcandragcolsize} -\func{bool}{CanDragColSize}{\void} +\constfunc{bool}{CanDragColSize}{\void} Returns true if columns can be resized by dragging with the mouse. Columns can be resized by dragging the edges of their labels. If grid line dragging is enabled they can also be -resized by dragging the right edge of the column in the grid cell area +resized by dragging the right edge of the column in the grid cell area (see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}). + + \membersection{wxGrid::CanDragRowSize}\label{wxgridcandragrowsize} -\func{bool}{CanDragRowSize}{\void} +\constfunc{bool}{CanDragRowSize}{\void} Returns true if rows can be resized by dragging with the mouse. Rows can be resized by dragging the edges of their labels. If grid line dragging is enabled they can also be -resized by dragging the lower edge of the row in the grid cell area +resized by dragging the lower edge of the row in the grid cell area (see \helpref{wxGrid::EnableDragGridSize}{wxgridenabledraggridsize}). + + \membersection{wxGrid::CanDragGridSize}\label{wxgridcandraggridsize} -\func{bool}{CanDragGridSize}{\void} +\constfunc{bool}{CanDragGridSize}{\void} Return true if the dragging of grid lines to resize rows and columns is enabled or false otherwise. + + \membersection{wxGrid::CanEnableCellControl}\label{wxgridcanenablecellcontrol} \constfunc{bool}{CanEnableCellControl}{\void} @@ -232,29 +327,45 @@ Return true if the dragging of grid lines to resize rows and columns is enabled Returns true if the in-place edit control for the current grid cell can be used and false otherwise (e.g. if the current cell is read-only). + + +\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes} + +\constfunc{bool}{CanHaveAttributes}{\void} + +Do we have some place to store attributes in? + + + \membersection{wxGrid::CellToRect}\label{wxgridcelltorect} -\func{wxRect}{CellToRect}{\param{int }{row}, \param{int }{col}} +\constfunc{wxRect}{CellToRect}{\param{int }{row}, \param{int }{col}} -\func{wxRect}{CellToRect}{\param{const wxGridCellCoords\& }{coords}} +\constfunc{wxRect}{CellToRect}{\param{const wxGridCellCoords\& }{coords}} Return the rectangle corresponding to the grid cell's size and position in logical coordinates. + + \membersection{wxGrid::ClearGrid}\label{wxgridcleargrid} \func{void}{ClearGrid}{\void} Clears all data in the underlying grid table and repaints the grid. The table is not deleted by -this function. If you are using a derived table class then you need to override +this function. If you are using a derived table class then you need to override \helpref{wxGridTableBase::Clear}{wxgridtablebaseclear} for this function to have any effect. + + \membersection{wxGrid::ClearSelection}\label{wxgridclearselection} \func{void}{ClearSelection}{\void} Deselects all cells that are currently selected. + + \membersection{wxGrid::CreateGrid}\label{wxgridcreategrid} \func{bool}{CreateGrid}{\param{int }{numRows}, \param{int }{numCols}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}} @@ -266,7 +377,9 @@ 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}. +class and pass a table object to the grid with \helpref{wxGrid::SetTable}{wxgridsettable}. + + \membersection{wxGrid::DeleteCols}\label{wxgriddeletecols} @@ -275,10 +388,12 @@ class and pass a table object to the grid with \helpref{wxGrid::SetTable}{wxgrid 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 +If you are using a derived grid table class you will need to override +\helpref{wxGridTableBase::DeleteCols}{wxgridtablebasedeletecols}. See \helpref{wxGrid::InsertCols}{wxgridinsertcols} for further information. + + \membersection{wxGrid::DeleteRows}\label{wxgriddeleterows} \func{bool}{DeleteRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = true}} @@ -286,23 +401,38 @@ If you are using a derived grid table class you will need to override 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 +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. +Disables in-place editing of grid cells. Equivalent to calling EnableCellEditControl(false). + + +\membersection{wxGrid::DisableDragColMove}\label{wxgriddisabledragcolmove} + +\func{void}{DisableDragColMove}{\void} + +Disables column moving by dragging with the mouse. Equivalent to passing false to +\helpref{wxGrid::EnableDragColMove}{wxgridenabledragcolmove}. + + + \membersection{wxGrid::DisableDragColSize}\label{wxgriddisabledragcolsize} \func{void}{DisableDragColSize}{\void} -Disables column sizing by dragging with the mouse. Equivalent to passing false to -\helpref{wxGrid::EnableDragColSize}{wxgridenabledragcolsize}. +Disables column sizing by dragging with the mouse. Equivalent to passing false to +\helpref{wxGrid::EnableDragColSize}{wxgridenabledragcolsize}. + + \membersection{wxGrid::DisableDragGridSize}\label{wxgriddisabledraggridsize} @@ -311,12 +441,16 @@ Disables column sizing by dragging with the mouse. Equivalent to passing false t 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}. +Disables row sizing by dragging with the mouse. Equivalent to passing false to +\helpref{wxGrid::EnableDragRowSize}{wxgridenabledragrowsize}. + + \membersection{wxGrid::EnableCellEditControl}\label{wxgridenablecelleditcontrol} @@ -325,24 +459,40 @@ Disables row sizing by dragging with the mouse. Equivalent to passing false to 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}} @@ -350,49 +500,71 @@ Enables or disables row sizing by dragging with the mouse. If the edit argument is false this function sets the whole grid as read-only. If the argument is true the grid is set to the default state where cells may be editable. In the default state you can set single grid cells and whole rows and columns to be editable or -read-only via +read-only via \helpref{wxGridCellAttribute::SetReadOnly}{wxgridcellattrsetreadonly}. For single -cells you can also use the shortcut function -\helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}. +cells you can also use the shortcut function +\helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}. -For more information about controlling grid cell attributes see the -\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the +For more information about controlling grid cell attributes see the +\helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the \helpref{wxGrid classes overview}{gridoverview}. + + \membersection{wxGrid::EnableGridLines}\label{wxgridenablegridlines} \func{void}{EnableGridLines}{\param{bool }{enable = true}} Turns the drawing of grid lines on or off. + + \membersection{wxGrid::EndBatch}\label{wxgridendbatch} \func{void}{EndBatch}{\void} Decrements the grid's batch count. When the count is greater than zero repainting of -the grid is suppressed. Each previous call to +the grid is suppressed. Each previous call to \helpref{wxGrid::BeginBatch}{wxgridbeginbatch} must be matched by a later call to EndBatch. Code that does a lot of grid modification can be enclosed between BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will cause the grid to be repainted. +\wxheading{See also} + +\helpref{wxGridUpdateLocker}{wxgridupdatelocker} + + + +\membersection{wxGrid::Fit}\label{wxgridfit} + +\func{void}{Fit}{\void} + +Overridden wxWindow method. + + + \membersection{wxGrid::ForceRefresh}\label{wxgridforcerefresh} \func{void}{ForceRefresh}{\void} Causes immediate repainting of the grid. Use this instead of the usual wxWindow::Refresh. + + \membersection{wxGrid::GetBatchCount}\label{wxgridgetbatchcount} -\func{int}{GetBatchCount}{\void} +\constfunc{int}{GetBatchCount}{\void} Returns the number of times that \helpref{wxGrid::BeginBatch}{wxgridbeginbatch} has been called without (yet) matching calls to \helpref{wxGrid::EndBatch}{wxgridendbatch}. While the grid's batch count is greater than zero the display will not be updated. + + \membersection{wxGrid::GetCellAlignment}\label{wxgridgetcellalignment} -\func{void}{GetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int* }{horiz}, \param{int* }{vert}} +\constfunc{void}{GetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int* }{horiz}, \param{int* }{vert}} Sets the arguments to the horizontal and vertical text alignment values for the grid cell at the specified location. @@ -403,95 +575,161 @@ Vertical alignment will be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTT \perlnote{This method only takes the parameters {\tt row} and {\tt col} and returns a 2-element list {\tt ( horiz, vert )}.} + + \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour} -\func{wxColour}{GetCellBackgroundColour}{\param{int }{row}, \param{int }{col}} +\constfunc{wxColour}{GetCellBackgroundColour}{\param{int }{row}, \param{int }{col}} Returns the background colour of the cell at the specified location. + + \membersection{wxGrid::GetCellEditor}\label{wxgridgetcelleditor} -\func{wxGridCellEditor*}{GetCellEditor}{\param{int }{row}, \param{int }{col}} +\constfunc{wxGridCellEditor*}{GetCellEditor}{\param{int }{row}, \param{int }{col}} Returns a pointer to the editor for the cell at the specified location. See \helpref{wxGridCellEditor}{wxgridcelleditor} and the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + \membersection{wxGrid::GetCellFont}\label{wxgridgetcellfont} -\func{wxFont}{GetCellFont}{\param{int }{row}, \param{int }{col}} +\constfunc{wxFont}{GetCellFont}{\param{int }{row}, \param{int }{col}} Returns the font for text in the grid cell at the specified location. + + \membersection{wxGrid::GetCellRenderer}\label{wxgridgetcellrenderer} -\func{wxGridCellRenderer*}{GetCellRenderer}{\param{int }{row}, \param{int }{col}} +\constfunc{wxGridCellRenderer*}{GetCellRenderer}{\param{int }{row}, \param{int }{col}} Returns a pointer to the renderer for the grid cell at the specified location. See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + \membersection{wxGrid::GetCellTextColour}\label{wxgridgetcelltextcolour} -\func{wxColour}{GetCellTextColour}{\param{int }{row}, \param{int }{col}} +\constfunc{wxColour}{GetCellTextColour}{\param{int }{row}, \param{int }{col}} Returns the text colour for the grid cell at the specified location. + + \membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue} -\func{wxString}{GetCellValue}{\param{int }{row}, \param{int }{col}} +\constfunc{wxString}{GetCellValue}{\param{int }{row}, \param{int }{col}} -\func{wxString}{GetCellValue}{\param{const wxGridCellCoords\&}{coords}} +\constfunc{wxString}{GetCellValue}{\param{const wxGridCellCoords\&}{coords}} Returns the string contained in the cell at the specified location. For simple applications where a grid object automatically uses a default grid table of string values you use this function together -with \helpref{wxGrid::SetCellValue}{wxgridsetcellvalue} to access cell values. +with \helpref{wxGrid::SetCellValue}{wxgridsetcellvalue} to access cell values. For more complex applications where you have derived your own grid table class that contains various data types (e.g. numeric, boolean or user-defined custom types) then you only use this -function for those cells that contain string values. +function for those cells that contain string values. See \helpref{wxGridTableBase::CanGetValueAs}{wxgridtablebasecangetvalueas} and the \helpref{wxGrid overview}{gridoverview} for more information. + + +\membersection{wxGrid::GetColAt}\label{wxgridgetcolat} + +\constfunc{int}{GetColAt}{\param{int }{colPos}} + +Returns the column ID of the specified column position. + + +\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft} + +\constfunc{int}{GetColLeft}{\param{int }{col}} + + + \membersection{wxGrid::GetColLabelAlignment}\label{wxgridgetcollabelalignment} -\func{void}{GetColLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}} +\constfunc{void}{GetColLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}} Sets the arguments to the current column label alignment values. -Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\ -Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM. +Horizontal alignment will be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.\\ +Vertical alignment will be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM. \perlnote{This method takes no parameters and returns a 2-element list {\tt ( horiz, vert )}.} + + \membersection{wxGrid::GetColLabelSize}\label{wxgridgetcollabelsize} -\func{int}{GetColLabelSize}{\void} +\constfunc{int}{GetColLabelSize}{\void} Returns the current height of the column labels. + + \membersection{wxGrid::GetColLabelValue}\label{wxgridgetcollabelvalue} -\func{wxString}{GetColLabelValue}{\param{int }{col}} +\constfunc{wxString}{GetColLabelValue}{\param{int }{col}} Returns the 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 +the form A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can override \helpref{wxGridTableBase::GetColLabelValue}{wxgridtablebasegetcollabelvalue} to provide -your own labels. +your own labels. + + + +\membersection{wxGrid::GetColMinimalAcceptableWidth}\label{wxgridgetcolminimalacceptablewidth} + +\constfunc{int}{GetColMinimalAcceptableWidth}{} + +This returns the value of the lowest column width that can be handled correctly. See +member \helpref{SetColMinimalAcceptableWidth}{wxgridsetcolminimalacceptablewidth} for details. + + + +\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth} + +\constfunc{int}{GetColMinimalWidth}{\param{int }{col}} + +Get the minimal width of the given column/row. + + + +\membersection{wxGrid::GetColPos}\label{wxgridgetcolpos} + +\constfunc{int}{GetColPos}{\param{int }{colID}} + +Returns the position of the specified column. + + + +\membersection{wxGrid::GetColRight}\label{wxgridgetcolright} + +\constfunc{int}{GetColRight}{\param{int }{col}} + + \membersection{wxGrid::GetColSize}\label{wxgridgetcolsize} -\func{int}{GetColSize}{\param{int }{col}} +\constfunc{int}{GetColSize}{\param{int }{col}} Returns the width of the specified column. + + \membersection{wxGrid::GetDefaultCellAlignment}\label{wxgridgetdefaultcellalignment} -\func{void}{GetDefaultCellAlignment}{\param{int* }{horiz}, \param{int* }{vert}} +\constfunc{void}{GetDefaultCellAlignment}{\param{int* }{horiz}, \param{int* }{vert}} Sets the arguments to the current default horizontal and vertical text alignment values. @@ -499,36 +737,48 @@ values. Horizontal alignment will be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. \\ Vertical alignment will be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM. + + \membersection{wxGrid::GetDefaultCellBackgroundColour}\label{wxgridgetdefaultcellbackgroundcolour} -\func{wxColour}{GetDefaultCellBackgroundColour}{\void} +\constfunc{wxColour}{GetDefaultCellBackgroundColour}{\void} Returns the current default background colour for grid cells. + + \membersection{wxGrid::GetDefaultCellFont}\label{wxgridgetdefaultcellfont} -\func{wxFont}{GetDefaultCellFont}{\void} +\constfunc{wxFont}{GetDefaultCellFont}{\void} Returns the current default font for grid cell text. + + \membersection{wxGrid::GetDefaultCellTextColour}\label{wxgridgetdefaultcelltextcolour} -\func{wxColour}{GetDefaultCellTextColour}{\void} +\constfunc{wxColour}{GetDefaultCellTextColour}{\void} Returns the current default colour for grid cell text. + + \membersection{wxGrid::GetDefaultColLabelSize}\label{wxgridgetdefaultcollabelsize} -\func{int}{GetDefaultColLabelSize}{\void} +\constfunc{int}{GetDefaultColLabelSize}{\void} Returns the default height for column labels. + + \membersection{wxGrid::GetDefaultColSize}\label{wxgridgetdefaultcolsize} -\func{int}{GetDefaultColSize}{\void} +\constfunc{int}{GetDefaultColSize}{\void} Returns the current default width for grid columns. + + \membersection{wxGrid::GetDefaultEditor}\label{wxgridgetdefaulteditor} \constfunc{wxGridCellEditor*}{GetDefaultEditor}{\void} @@ -538,6 +788,22 @@ Returns a pointer to the current default grid cell editor. See \helpref{wxGridCellEditor}{wxgridcelleditor} and the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + +\membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell} + +\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}} + +\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{const wxGridCellCoords\& }{c}} + + + +\membersection{wxGrid::GetDefaultEditorForType}\label{wxgridgetdefaulteditorfortype} + +\constfunc{wxGridCellEditor*}{GetDefaultEditorForType}{\param{const wxString\& }{typeName}} + + + \membersection{wxGrid::GetDefaultRenderer}\label{wxgridgetdefaultrenderer} \constfunc{wxGridCellRenderer*}{GetDefaultRenderer}{\void} @@ -547,76 +813,189 @@ Returns a pointer to the current default grid cell renderer. See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + +\membersection{wxGrid::GetDefaultRendererForCell}\label{wxgridgetdefaultrendererforcell} + +\constfunc{wxGridCellRenderer*}{GetDefaultRendererForCell}{\param{int }{row}, \param{int }{col}} + + + +\membersection{wxGrid::GetDefaultRendererForType}\label{wxgridgetdefaultrendererfortype} + +\constfunc{wxGridCellRenderer*}{GetDefaultRendererForType}{\param{const wxString\& }{typeName}} + + + \membersection{wxGrid::GetDefaultRowLabelSize}\label{wxgridgetdefaultrowlabelsize} -\func{int}{GetDefaultRowLabelSize}{\void} +\constfunc{int}{GetDefaultRowLabelSize}{\void} Returns the default width for the row labels. + + \membersection{wxGrid::GetDefaultRowSize}\label{wxgridgetdefaultrowsize} -\func{int}{GetDefaultRowSize}{\void} +\constfunc{int}{GetDefaultRowSize}{\void} Returns the current default height for grid rows. + + \membersection{wxGrid::GetGridCursorCol}\label{wxgridgetgridcursorcol} -\func{int}{GetGridCursorCol}{\void} +\constfunc{int}{GetGridCursorCol}{\void} Returns the current grid cell column position. + + \membersection{wxGrid::GetGridCursorRow}\label{wxgridgetgridcursorrow} -\func{int}{GetGridCursorRow}{\void} +\constfunc{int}{GetGridCursorRow}{\void} Returns the current grid cell row position. + + \membersection{wxGrid::GetGridLineColour}\label{wxgridgetgridlinecolour} -\func{wxColour}{GetGridLineColour}{\void} +\constfunc{wxColour}{GetGridLineColour}{\void} Returns the colour used for grid lines. -\membersection{wxGrid::GridLinesEnabled}\label{wxgridgridlinesenabled} +\wxheading{See also} -\func{bool}{GridLinesEnabled}{\void} +\helpref{GetDefaultGridLinePen()}{wxgridgetdefaultgridlinepen} -Returns true if drawing of grid lines is turned on, false otherwise. -\membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour} +\membersection{wxGrid::GetDefaultGridLinePen}\label{wxgridgetdefaultgridlinepen} -\func{wxColour}{GetLabelBackgroundColour}{\void} +\func{wxPen}{GetDefaultGridLinePen}{\void} -Returns the colour used for the background of row and column labels. +Returns the pen used for grid lines. This virtual function may be overridden in +derived classes in order to change the appearance of grid lines. Note that +currently the pen width must be $1$. -\membersection{wxGrid::GetLabelFont}\label{wxgridgetlabelfont} +\wxheading{See also} -\func{wxFont}{GetLabelFont}{\void} +\helpref{GetColGridLinePen()}{wxgridgetcolgridlinepen},\\ +\helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen} -Returns the font used for row and column labels. -\membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour} -\func{wxColour}{GetLabelTextColour}{\void} -Returns the colour used for row and column label text. +\membersection{wxGrid::GetRowGridLinePen}\label{wxgridgetrowgridlinepen} -\membersection{wxGrid::GetNumberCols}\label{wxgridgetnumbercols} +\func{wxPen}{GetRowGridLinePen}{\param{int }{row}} -\func{int}{GetNumberCols}{\void} +Returns the pen used for horizontal grid lines. This virtual function may be +overridden in derived classes in order to change the appearance of individual +grid line for the given row \arg{row}. + +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} -\func{int}{GetNumberRows}{\void} +\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} -\func{void}{GetRowLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}} +\constfunc{void}{GetRowLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}} Sets the arguments to the current row label alignment values. @@ -626,58 +1005,112 @@ Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM. \perlnote{This method takes no parameters and returns a 2-element list {\tt ( horiz, vert )}.} + + \membersection{wxGrid::GetRowLabelSize}\label{wxgridgetrowlabelsize} -\func{int}{GetRowLabelSize}{\void} +\constfunc{int}{GetRowLabelSize}{\void} Returns the current width of the row labels. + + \membersection{wxGrid::GetRowLabelValue}\label{wxgridgetrowlabelvalue} -\func{wxString}{GetRowLabelValue}{\param{int }{row}} +\constfunc{wxString}{GetRowLabelValue}{\param{int }{row}} Returns the specified row label. The default grid table class provides numeric row labels. -If you are using a custom grid table you can override +If you are using a custom grid table you can override \helpref{wxGridTableBase::GetRowLabelValue}{wxgridtablebasegetcollabelvalue} to provide -your own labels. +your own labels. + + \membersection{wxGrid::GetRowSize}\label{wxgridgetrowsize} -\func{int}{GetRowSize}{\param{int }{row}} +\constfunc{int}{GetRowSize}{\param{int }{row}} Returns the height of the specified row. + + +\membersection{wxGrid::GetScrollLineX}\label{wxgridgetscrolllinex} + +\constfunc{int}{GetScrollLineX}{\void} + +Returns the number of pixels per horizontal scroll increment. The default is 15. + +\wxheading{See also} + +\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp +\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp +\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney} + + + +\membersection{wxGrid::GetScrollLineY}\label{wxgridgetscrollliney} + +\constfunc{int}{GetScrollLineY}{\void} + +Returns the number of pixels per vertical scroll increment. The default is 15. + +\wxheading{See also} + +\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp +\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp +\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney} + + + \membersection{wxGrid::GetSelectionMode}\label{wxgridgetselectionmode} \constfunc{wxGrid::wxGridSelectionModes}{GetSelectionMode}{\void} Returns the current selection mode, see \helpref{wxGrid::SetSelectionMode}{wxgridsetselectionmode}. + + \membersection{wxGrid::GetSelectedCells}\label{wxgridgetselectedcells} \constfunc{wxGridCellCoordsArray}{GetSelectedCells}{\void} Returns an array of singly selected cells. + + \membersection{wxGrid::GetSelectedCols}\label{wxgridgetselectedcols} \constfunc{wxArrayInt}{GetSelectedCols}{\void} Returns an array of selected cols. + + \membersection{wxGrid::GetSelectedRows}\label{wxgridgetselectedrows} \constfunc{wxArrayInt}{GetSelectedRows}{\void} Returns an array of selected rows. + + +\membersection{wxGrid::GetSelectionBackground}\label{wxgridgetselectionbackground} + +\constfunc{wxColour}{GetSelectionBackground}{\void} + +Access or update the selection fore/back colours + + + \membersection{wxGrid::GetSelectionBlockTopLeft}\label{wxgridgetselectionblocktopleft} \constfunc{wxGridCellCoordsArray}{GetSelectionBlockTopLeft}{\void} -Returns an array of the top left corners of blocks of selected cells, +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} @@ -685,58 +1118,103 @@ see \helpref{wxGrid::GetSelectionBlockBottomRight}{wxgridgetselectionblockbottom 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. +used at present. The sequence of actions begins with the grid object requesting the underlying grid table to insert new columns. If this is successful the table notifies the grid and the -grid updates the display. For a default grid (one where you have called +grid updates the display. For a default grid (one where you have called \helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are -using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable}) -then you must override +using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable}) +then you must override \helpref{wxGridTableBase::InsertCols}{wxgridtablebaseinsertcols} in your derived table class. + + \membersection{wxGrid::InsertRows}\label{wxgridinsertrows} \func{bool}{InsertRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = true}} 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. +present. The sequence of actions begins with the grid object requesting the underlying grid table to insert new rows. If this is successful the table notifies the grid and the -grid updates the display. For a default grid (one where you have called +grid updates the display. For a default grid (one where you have called \helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are -using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable}) -then you must override +using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable}) +then you must override \helpref{wxGridTableBase::InsertRows}{wxgridtablebaseinsertrows} in your derived table class. + + \membersection{wxGrid::IsCellEditControlEnabled}\label{wxgridiscelleditcontrolenabled} \constfunc{bool}{IsCellEditControlEnabled}{\void} Returns true if the in-place edit control is currently enabled. + + \membersection{wxGrid::IsCurrentCellReadOnly}\label{wxgridiscurrentcellreadonly} \constfunc{bool}{IsCurrentCellReadOnly}{\void} @@ -744,14 +1222,18 @@ Returns true if the in-place edit control is currently enabled. Returns true if the current cell has been set to read-only (see \helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}). + + \membersection{wxGrid::IsEditable}\label{wxgridiseditable} -\func{bool}{IsEditable}{\void} +\constfunc{bool}{IsEditable}{\void} Returns false if the whole grid has been set as read-only or true otherwise. 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}} @@ -760,6 +1242,8 @@ controlling the editing status of grid cells. Is this cell currently selected. + + \membersection{wxGrid::IsReadOnly}\label{wxgridisreadonly} \constfunc{bool}{IsReadOnly}{\param{int }{row}, \param{int }{col}} @@ -767,21 +1251,27 @@ Is this cell currently selected. Returns true if the cell at the specified location can't be edited. See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}. + + \membersection{wxGrid::IsSelection}\label{wxgridisselection} -\func{bool}{IsSelection}{\void} +\constfunc{bool}{IsSelection}{\void} Returns true if there are currently rows, columns or blocks of cells selected. + + \membersection{wxGrid::IsVisible}\label{wxgridisvisible} -\func{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}} +\constfunc{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}} -\func{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = true}} +\constfunc{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = true}} Returns true if a cell is either wholly visible (the default) or at least partially visible in the grid window. + + \membersection{wxGrid::MakeCellVisible}\label{wxgridmakecellvisible} \func{void}{MakeCellVisible}{\param{int }{row}, \param{int }{col}} @@ -789,7 +1279,9 @@ visible in the grid window. \func{void}{MakeCellVisible}{\param{const wxGridCellCoords\& }{coords}} Brings the specified cell into the visible grid cell area with minimal scrolling. Does -nothing if the cell is already visible. +nothing if the cell is already visible. + + \membersection{wxGrid::MoveCursorDown}\label{wxgridmovecursordown} @@ -801,6 +1293,8 @@ 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}} @@ -811,6 +1305,8 @@ 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}} @@ -821,6 +1317,8 @@ 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}} @@ -831,6 +1329,8 @@ 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}} @@ -842,6 +1342,8 @@ 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}} @@ -853,6 +1355,8 @@ 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}} @@ -864,6 +1368,8 @@ 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}} @@ -875,6 +1381,8 @@ 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} @@ -885,6 +1393,8 @@ becomes the top visible row. \wxheading{Keyboard}\\ This function is called for PgDn keypresses. + + \membersection{wxGrid::MovePageUp}\label{wxgridmovepageup} \func{bool}{MovePageUp}{\void} @@ -895,6 +1405,16 @@ 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} @@ -904,22 +1424,28 @@ This is called automatically when the grid cursor moves from the current cell to 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}, +\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}, +\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. +deselected; if true the column will be added to the existing selection. + + \membersection{wxGrid::SelectCol}\label{wxgridselectcol} @@ -928,6 +1454,17 @@ deselected; if true the column will be added to the existing selection. Selects the specified column. If addToSelected is false then any existing selection will be deselected; if true the column will be added to the existing selection. + + +\membersection{wxGrid::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}} @@ -935,45 +1472,59 @@ deselected; if true the column will be added to the existing selection. Selects the specified row. If addToSelected is false then any existing selection will be deselected; if true the row will be added to the existing selection. + + \membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment} \func{void}{SetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int }{horiz}, \param{int }{vert}} \func{void}{SetCellAlignment}{\param{int }{align}, \param{int }{row}, \param{int }{col}} -\func{void}{SetCellAlignment}{\param{int }{align}} - Sets the horizontal and vertical alignment for grid cell text at the specified location. Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. \\ Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM. + + +\membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour} + +\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}} + + + \membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor} \func{void}{SetCellEditor}{\param{int }{row}, \param{int }{col}, \param{wxGridCellEditor* }{editor}} -Sets the editor for the grid cell at the specified location. +Sets the editor for the grid cell at the specified location. The grid will take ownership of the pointer. See \helpref{wxGridCellEditor}{wxgridcelleditor} and the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + \membersection{wxGrid::SetCellFont}\label{wxgridsetcellfont} \func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const wxFont\&}{ font}} Sets the font for text in the grid cell at the specified location. + + \membersection{wxGrid::SetCellRenderer}\label{wxgridsetcellrenderer} \func{void}{SetCellRenderer}{\param{int }{row}, \param{int }{col}, \param{wxGridCellRenderer* }{renderer}} -Sets the renderer for the grid cell at the specified location. +Sets the renderer for the grid cell at the specified location. The grid will take ownership of the pointer. See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers. + + \membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour} \func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}} @@ -984,6 +1535,8 @@ the \helpref{wxGrid overview}{gridoverview} for more information about cell edit 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}} @@ -994,7 +1547,7 @@ Sets the text colour for the grid cell at the specified location. Sets the string value for the cell at the specified location. For simple applications where a grid object automatically uses a default grid table of string values you use this function together -with \helpref{wxGrid::GetCellValue}{wxgridgetcellvalue} to access cell values. +with \helpref{wxGrid::GetCellValue}{wxgridgetcellvalue} to access cell values. For more complex applications where you have derived your own grid table class that contains various data types (e.g. numeric, boolean or user-defined custom types) then you only use this @@ -1005,34 +1558,44 @@ 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 +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}} @@ -1041,6 +1604,8 @@ 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}} @@ -1051,20 +1616,29 @@ Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\ 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 +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}} @@ -1074,6 +1648,8 @@ because it will not resize a column that is already narrower than the minimal wi 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}} @@ -1083,30 +1659,35 @@ allows smaller grid cells to be dealt with correctly. Specifying a value here wh 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. +with sizes smaller than the value specified here. -\membersection{wxGrid::GetColMinimalAcceptableWidth}\label{wxgridgetcolminimalacceptablewidth} -\func{int}{GetColMinimalAcceptableWidth}{} -This returns the value of the lowest column width that can be handled correctly. See -member \helpref{SetColMinimalAcceptableWidth}{wxgridsetcolminimalacceptablewidth} for details. +\membersection{wxGrid::SetColPos}\label{wxgridsetcolpos} -\membersection{wxGrid::SetColSize}\label{wxgridsetcolsize} +\func{void}{SetColPos}{\param{int }{colID}, \param{int }{newPos}} -\func{void}{SetColSize}{\param{int }{col}, \param{int }{width}} +Sets the position of the specified column. -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. + +\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. +The memory requirements for this could become prohibitive if your grid is very large. + + \membersection{wxGrid::SetDefaultCellAlignment}\label{wxgridsetdefaultcellalignment} @@ -1118,18 +1699,32 @@ Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\ 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}} @@ -1139,6 +1734,8 @@ Sets the default editor for grid cells. The grid will take ownership of the poin 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}} @@ -1148,12 +1745,16 @@ Sets the default renderer for grid cells. The grid will take ownership of the po 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. +the grid unless resizeExistingCols is true. + + \membersection{wxGrid::SetDefaultRowSize}\label{wxgridsetdefaultrowsize} @@ -1162,37 +1763,72 @@ the grid unless resizeExistingCols is true. 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. +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}} @@ -1200,6 +1836,8 @@ Sets the colour for row and column label text. 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}} @@ -1208,6 +1846,8 @@ 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}} @@ -1218,20 +1858,29 @@ Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\ 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} +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}} @@ -1241,6 +1890,8 @@ 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}} @@ -1250,23 +1901,18 @@ allows smaller grid cells to be dealt with correctly. Specifying a value here wh 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. +with sizes smaller than the value specified here. -\membersection{wxGrid::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight} -\func{int}{GetRowMinimalAcceptableHeight}{} - -This returns the value of the lowest row width that can be handled correctly. See -member \helpref{SetRowMinimalAcceptableHeight}{wxgridsetrowminimalacceptableheight} for details. \membersection{wxGrid::SetRowSize}\label{wxgridsetrowsize} \func{void}{SetRowSize}{\param{int }{row}, \param{int }{height}} -Sets the height of the specified row. +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. +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. @@ -1274,417 +1920,128 @@ 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::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::wxGridSelectionColumns}{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. +The memory requirements for this could become prohibitive if your grid is very large. -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} +\membersection{wxGrid::SetScrollLineX}\label{wxgridsetscrolllinex} -Displays the in-place cell edit control for the current cell. - -\membersection{wxGrid::XToCol}\label{wxgridxtocol} +\func{void}{SetScrollLineX}{\param{int }{x}} -\func{int}{XToCol}{\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. -Returns the grid column that corresponds to the logical x coordinate. Returns -wxNOT\_FOUND if there is no column at the x position. - -\membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol} - -\func{int}{XToEdgeOfCol}{\param{int }{x}} - -Returns the column whose right hand edge is close to the given logical x position. -If no column edge is near to this position wxNOT\_FOUND is returned. - -\membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow} - -\func{int}{YToEdgeOfRow}{\param{int }{y}} - -Returns the row whose bottom edge is close to the given logical y position. -If no row edge is near to this position wxNOT\_FOUND is returned. - -\membersection{wxGrid::YToRow}\label{wxgridytorow} - -\func{int}{YToRow}{\param{int }{y}} - -Returns the grid row that corresponds to the logical y coordinate. Returns -wxNOT\_FOUND if there is no row at the y position. - - -\membersection{wxGrid::BlockToDeviceRect}\label{wxgridblocktodevicerect} - -\func{wxRect}{BlockToDeviceRect}{\param{const wxGridCellCoords \& }{topLeft}, \param{const wxGridCellCoords \& }{bottomRight}} - -This function returns the rectangle that encloses the block of cells -limited by TopLeft and BottomRight cell in device coords and clipped -to the client size of the grid window. +\wxheading{See also} +\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp +\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp +\helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney} -\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::SetScrollLineY}\label{wxgridsetscrollliney} +\func{void}{SetScrollLineY}{\param{int }{y}} -\membersection{wxGrid::GetSelectionBackground}\label{wxgridgetselectionbackground} +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. -\constfunc{wxColour}{GetSelectionBackground}{\void} +\wxheading{See also} -Access or update the selection fore/back colours +\helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp +\helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp +\helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex} -\membersection{wxGrid::GetSelectionForeground}\label{wxgridgetselectionforeground} - -\constfunc{wxColour}{GetSelectionForeground}{\void} - \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::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::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell} - -\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}} - -\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{const wxGridCellCoords\& }{c}} - - -\membersection{wxGrid::GetDefaultRendererForCell}\label{wxgridgetdefaultrendererforcell} - -\constfunc{wxGridCellRenderer*}{GetDefaultRendererForCell}{\param{int }{row}, \param{int }{col}} - - -\membersection{wxGrid::GetDefaultEditorForType}\label{wxgridgetdefaulteditorfortype} - -\constfunc{wxGridCellEditor*}{GetDefaultEditorForType}{\param{const wxString\& }{typeName}} - - -\membersection{wxGrid::GetDefaultRendererForType}\label{wxgridgetdefaultrendererfortype} - -\constfunc{wxGridCellRenderer*}{GetDefaultRendererForType}{\param{const wxString\& }{typeName}} - - -\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::wxGrid}\label{wxgridwxgrid} - -\func{}{wxGrid}{\param{wxWindow* }{parent}, \param{int }{x}, \param{int }{y}, \param{int }{w = -1}, \param{int }{h = -1}, \param{long }{style = wxWANTS\_CHARS}, \param{const wxString\& }{name = wxPanelNameStr}} - -Backward compatibility. - -\membersection{wxGrid::UpdateDimensions}\label{wxgridupdatedimensions} - -\func{void}{UpdateDimensions}{\void} - -Backward compatibility. - -\membersection{wxGrid::GetRows}\label{wxgridgetrows} - -\func{int}{GetRows}{\void} - -Backward compatibility. - -\membersection{wxGrid::GetCols}\label{wxgridgetcols} - -\func{int}{GetCols}{\void} - -Backward compatibility. - -\membersection{wxGrid::GetCursorRow}\label{wxgridgetcursorrow} - -\func{int}{GetCursorRow}{\void} - -Backward compatibility. - -\membersection{wxGrid::GetCursorColumn}\label{wxgridgetcursorcolumn} - -\func{int}{GetCursorColumn}{\void} - -Backward compatibility. - -\membersection{wxGrid::GetScrollPosX}\label{wxgridgetscrollposx} - -\func{int}{GetScrollPosX}{\void} - -Backward compatibility. - -\membersection{wxGrid::GetScrollPosY}\label{wxgridgetscrollposy} - -\func{int}{GetScrollPosY}{\void} - -Backward compatibility. - -\membersection{wxGrid::SetScrollX}\label{wxgridsetscrollx} - -\func{void}{SetScrollX}{\param{int }{x}} - -Backward compatibility. - -\membersection{wxGrid::SetScrollY}\label{wxgridsetscrolly} - -\func{void}{SetScrollY}{\param{int }{y}} - -Backward compatibility. - -\membersection{wxGrid::SetColumnWidth}\label{wxgridsetcolumnwidth} - -\func{void}{SetColumnWidth}{\param{int }{col}, \param{int }{width}} - -Backward compatibility. - -\membersection{wxGrid::GetColumnWidth}\label{wxgridgetcolumnwidth} - -\func{int}{GetColumnWidth}{\param{int }{col}} - -Backward compatibility. - -\membersection{wxGrid::SetRowHeight}\label{wxgridsetrowheight} - -\func{void}{SetRowHeight}{\param{int }{row}, \param{int }{height}} - -Backward compatibility. - -\membersection{wxGrid::GetViewHeight}\label{wxgridgetviewheight} - -\func{int}{GetViewHeight}{\void} - -Backward compatibility. - -\membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth} - -\func{int}{GetViewWidth}{\void} - -Returned number of whole cols visible. - -\membersection{wxGrid::SetLabelSize}\label{wxgridsetlabelsize} - -\func{void}{SetLabelSize}{\param{int }{orientation}, \param{int }{sz}} - - -\membersection{wxGrid::GetLabelSize}\label{wxgridgetlabelsize} - -\func{int}{GetLabelSize}{\param{int }{orientation}} - - -\membersection{wxGrid::SetLabelAlignment}\label{wxgridsetlabelalignment} - -\func{void}{SetLabelAlignment}{\param{int }{orientation}, \param{int }{align}} - - -\membersection{wxGrid::GetLabelAlignment}\label{wxgridgetlabelalignment} - -\func{int}{GetLabelAlignment}{\param{int }{orientation}, \param{int }{align}} - - -\membersection{wxGrid::SetLabelValue}\label{wxgridsetlabelvalue} - -\func{void}{SetLabelValue}{\param{int }{orientation}, \param{const wxString\& }{val}, \param{int }{pos}} - - -\membersection{wxGrid::GetLabelValue}\label{wxgridgetlabelvalue} - -\func{wxString}{GetLabelValue}{\param{int }{orientation}, \param{int }{pos}} - - -\membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont} - -\constfunc{wxFont}{GetCellTextFont}{\void} - -\constfunc{wxFont}{GetCellTextFont}{\param{int }{row}, \param{int }{col}} - - -\membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont} - -\func{void}{SetCellTextFont}{\param{const wxFont\& }{fnt}} - -\func{void}{SetCellTextFont}{\param{const wxFont\& }{fnt}, \param{int }{row}, \param{int }{col}} - - -\membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour} - -\func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{col}} - -\func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}} - -\func{void}{SetCellBackgroundColour}{\param{const wxColour\& }{colour}, \param{int }{row}, \param{int }{col}} - - -\membersection{wxGrid::GetEditable}\label{wxgridgeteditable} - -\func{bool}{GetEditable}{\void} - - -\membersection{wxGrid::SetEditable}\label{wxgridseteditable} - -\func{void}{SetEditable}{\param{bool }{edit = true}} - - -\membersection{wxGrid::GetEditInPlace}\label{wxgridgeteditinplace} - -\func{bool}{GetEditInPlace}{\void} - - -\membersection{wxGrid::SetEditInPlace}\label{wxgridseteditinplace} - -\func{void}{SetEditInPlace}{\param{bool }{edit = true}} - - -\membersection{wxGrid::SetCellBitmap}\label{wxgridsetcellbitmap} - -\func{void}{SetCellBitmap}{\param{wxBitmap* }{bitmap}, \param{int }{row}, \param{int }{col}} - - -\membersection{wxGrid::SetDividerPen}\label{wxgridsetdividerpen} - -\func{void}{SetDividerPen}{\param{const wxPen\& }{pen}} - - -\membersection{wxGrid::GetDividerPen}\label{wxgridgetdividerpen} - -\constfunc{wxPen\&}{GetDividerPen}{\void} - - -\membersection{wxGrid::OnActivate}\label{wxgridonactivate} - -\func{void}{OnActivate}{\param{bool }{active}} - -\membersection{wxGrid::Fit}\label{wxgridfit} - -\func{void}{Fit}{\void} - -Overridden wxWindow methods - -\membersection{wxGrid::DoGetBestSize}\label{wxgriddogetbestsize} - -\constfunc{wxSize}{DoGetBestSize}{\void} - -\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::InitColWidths}\label{wxgridinitcolwidths} - -\func{void}{InitColWidths}{\void} - -Init the m\_colWidths/Rights arrays +\membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode} +\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}} -\membersection{wxGrid::GetColWidth}\label{wxgridgetcolwidth} +Set the selection behaviour of the grid. -\constfunc{int}{GetColWidth}{\param{int }{col}} +\wxheading{Parameters} -Get the col/row coords +\docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.} +\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.} -\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft} +\docparam{wxGrid::wxGridSelectColumns}{Selections will consist of whole columns.} -\constfunc{int}{GetColLeft}{\param{int }{col}} -\membersection{wxGrid::GetColRight}\label{wxgridgetcolright} +\membersection{wxGrid::SetTable}\label{wxgridsettable} -\constfunc{int}{GetColRight}{\param{int }{col}} +\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. -\membersection{wxGrid::GetRowHeight}\label{wxgridgetrowheight} +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. -\constfunc{int}{GetRowHeight}{\param{int }{row}} -This function must be public for compatibility. -\membersection{wxGrid::GetRowTop}\label{wxgridgetrowtop} +\membersection{wxGrid::ShowCellEditControl}\label{wxgridshowcelleditcontrol} -\constfunc{int}{GetRowTop}{\param{int }{row}} +\func{void}{ShowCellEditControl}{\void} +Displays the in-place cell edit control for the current cell. -\membersection{wxGrid::GetRowBottom}\label{wxgridgetrowbottom} -\constfunc{int}{GetRowBottom}{\param{int }{row}} +\membersection{wxGrid::XToCol}\label{wxgridxtocol} -\membersection{wxGrid::SetOrCalcColumnSizes}\label{wxgridsetorcalccolumnsizes} +\constfunc{int}{XToCol}{\param{int }{x}, \param{bool }{clipToMinMax = false}} -\func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}} +\wxheading{Parameters} +\docparam{x}{The x position to evaluate.} +\docparam{clipToMinMax}{If true, rather than returning wxNOT\_FOUND, it returns either the first or last column depending on whether x is too far to the left or right respectively.} -Common part of AutoSizeColumn/Row() and GetBestSize() +\wxheading{Return value} +The grid column that corresponds to the logical x coordinate. Returns +{\tt wxNOT\_FOUND} if there is no column at the x position. -\membersection{wxGrid::SetOrCalcRowSizes}\label{wxgridsetorcalcrowsizes} -\func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}} -\membersection{wxGrid::AutoSizeColOrRow}\label{wxgridautosizecolorrow} +\membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol} -\func{void}{AutoSizeColOrRow}{\param{int }{n}, \param{bool }{setAsMin}, \param{bool }{column}} +\constfunc{int}{XToEdgeOfCol}{\param{int }{x}} -Common part of AutoSizeColumn/Row() or row? +Returns the column whose right hand edge is close to the given logical x position. +If no column edge is near to this position {\tt wxNOT\_FOUND} is returned. -\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth} -\constfunc{int}{GetColMinimalWidth}{\param{int }{col}} -get the minimal width of the given column/row +\membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow} -\membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight} +\constfunc{int}{YToEdgeOfRow}{\param{int }{y}} -\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}} +Returns the row whose bottom edge is close to the given logical y position. +If no row edge is near to this position {\tt wxNOT\_FOUND} is returned. -\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes} -\func{bool}{CanHaveAttributes}{\void} -Do we have some place to store attributes in? +\membersection{wxGrid::YToRow}\label{wxgridytorow} -\membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr} +\constfunc{int}{YToRow}{\param{int }{y}} -\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}} +Returns the grid row that corresponds to the logical y coordinate. Returns +{\tt wxNOT\_FOUND} if there is no row at the y position.