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
The event handler for the following functions takes a
\helpref{wxGridSizeEvent}{wxgridsizeevent} parameter.
+The ...\_CMD\_... variants also take a window identifier.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_GRID\_COL\_SIZE(func)}}{The user resized a column by dragging it. Processes a wxEVT\_GRID\_COL\_SIZE.}
\twocolitem{{\bf EVT\_GRID\_ROW\_SIZE(func)}}{The user resized a row by dragging it. Processes a wxEVT\_GRID\_ROW\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_COL\_SIZE(func)}}{The user resized a column by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_COL\_SIZE.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_ROW\_SIZE(func)}}{The user resized a row by dragging it; variant taking a window identifier. Processes a wxEVT\_GRID\_ROW\_SIZE.}
\end{twocollist}%
The event handler for the following functions takes a
\helpref{wxGridRangeSelectEvent}{wxgridrangeselectevent} parameter.
+The ...\_CMD\_... variant also takes a window identifier.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_GRID\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_RANGE\_SELECT(id, func)}}{The user selected a group of contiguous cells; variant taking a window identifier. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
\end{twocollist}%
The event handler for the following functions takes a
\helpref{wxGridEditorCreatedEvent}{wxgrideditorcreatedevent} parameter.
+The ...\_CMD\_... variant also takes a window identifier.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_GRID\_EDITOR\_CREATED(func)}}{The editor for a cell was created. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
+\twocolitem{{\bf EVT\_GRID\_CMD\_EDITOR\_CREATED(id, func)}}{The editor for a cell was created; variant taking a window identifier. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
\end{twocollist}%
\wxheading{See also}
%%%%%%%%%%% 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{Display format}\label{wxgriddisplayformat}
-\membersection{Selection functions}
+\membersection{Selection functions}\label{wxgridselectionfunctions}
\helpref{wxGrid::ClearSelection}{wxgridclearselection}\\
\helpref{wxGrid::IsSelection}{wxgridisselection}\\
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
+\membersection{wxGrid::AutoSizeColOrRow}\label{wxgridautosizecolorrow}
+
+\func{void}{AutoSizeColOrRow}{\param{int }{n}, \param{bool }{setAsMin}, \param{bool }{column}}
+
+Common part of AutoSizeColumn/Row() or row?
+
\membersection{wxGrid::AutoSizeColumn}\label{wxgridautosizecolumn}
\func{void}{AutoSizeColumn}{\param{int }{col}, \param{bool }{setAsMin = true}}
modification can be enclosed between BeginBatch and EndBatch calls to avoid
screen flicker. The final EndBatch will cause the grid to be repainted.
+\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.
+
+
\membersection{wxGrid::CanDragColSize}\label{wxgridcandragcolsize}
\func{bool}{CanDragColSize}{\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}
+
+\func{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}}
Disables row sizing by dragging with the mouse. Equivalent to passing false to
\helpref{wxGrid::EnableDragRowSize}{wxgridenabledragrowsize}.
+\membersection{wxGrid::DoGetBestSize}\label{wxgriddogetbestsize}
+
+\constfunc{wxSize}{DoGetBestSize}{\void}
+
\membersection{wxGrid::EnableCellEditControl}\label{wxgridenablecelleditcontrol}
\func{void}{EnableCellEditControl}{\param{bool }{enable = true}}
BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will
cause the grid to be repainted.
+\membersection{wxGrid::Fit}\label{wxgridfit}
+
+\func{void}{Fit}{\void}
+
+Overridden wxWindow method.
+
\membersection{wxGrid::ForceRefresh}\label{wxgridforcerefresh}
\func{void}{ForceRefresh}{\void}
See \helpref{wxGridTableBase::CanGetValueAs}{wxgridtablebasecangetvalueas}
and the \helpref{wxGrid overview}{gridoverview} for more information.
+
+\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft}
+
+\constfunc{int}{GetColLeft}{\param{int }{col}}
+
\membersection{wxGrid::GetColLabelAlignment}\label{wxgridgetcollabelalignment}
\func{void}{GetColLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
Sets the arguments to the current column label alignment values.
-Horizontal alignment will be one of 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 )}.}
\helpref{wxGridTableBase::GetColLabelValue}{wxgridtablebasegetcollabelvalue} to provide
your own labels.
+\membersection{wxGrid::GetColMinimalAcceptableWidth}\label{wxgridgetcolminimalacceptablewidth}
+
+\func{int}{GetColMinimalAcceptableWidth}{}
+
+This returns the value of the lowest column width that can be handled correctly. See
+member \helpref{SetColMinimalAcceptableWidth}{wxgridsetcolminimalacceptablewidth} for details.
+
+\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth}
+
+\constfunc{int}{GetColMinimalWidth}{\param{int }{col}}
+
+Get the minimal width of the given column/row.
+
+
+\membersection{wxGrid::GetColRight}\label{wxgridgetcolright}
+
+\constfunc{int}{GetColRight}{\param{int }{col}}
+
\membersection{wxGrid::GetColSize}\label{wxgridgetcolsize}
\func{int}{GetColSize}{\param{int }{col}}
See \helpref{wxGridCellEditor}{wxgridcelleditor} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+\membersection{wxGrid::GetDefaultEditorForCell}\label{wxgridgetdefaulteditorforcell}
+
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{int }{row}, \param{int }{col}}
+
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForCell}{\param{const wxGridCellCoords\& }{c}}
+
+
+\membersection{wxGrid::GetDefaultEditorForType}\label{wxgridgetdefaulteditorfortype}
+
+\constfunc{wxGridCellEditor*}{GetDefaultEditorForType}{\param{const wxString\& }{typeName}}
+
+
\membersection{wxGrid::GetDefaultRenderer}\label{wxgridgetdefaultrenderer}
\constfunc{wxGridCellRenderer*}{GetDefaultRenderer}{\void}
See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
+\membersection{wxGrid::GetDefaultRendererForCell}\label{wxgridgetdefaultrendererforcell}
+
+\constfunc{wxGridCellRenderer*}{GetDefaultRendererForCell}{\param{int }{row}, \param{int }{col}}
+
+\membersection{wxGrid::GetDefaultRendererForType}\label{wxgridgetdefaultrendererfortype}
+
+\constfunc{wxGridCellRenderer*}{GetDefaultRendererForType}{\param{const wxString\& }{typeName}}
+
+
+
\membersection{wxGrid::GetDefaultRowLabelSize}\label{wxgridgetdefaultrowlabelsize}
\func{int}{GetDefaultRowLabelSize}{\void}
Returns the total number of grid rows (actually the number of rows in the underlying grid table).
+\membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
+
+\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
+
+\membersection{wxGrid::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight}
+
+\func{int}{GetRowMinimalAcceptableHeight}{}
+
+This returns the value of the lowest row width that can be handled correctly. See
+member \helpref{SetRowMinimalAcceptableHeight}{wxgridsetrowminimalacceptableheight} for details.
+
+
+\membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight}
+
+\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}}
+
\membersection{wxGrid::GetRowLabelAlignment}\label{wxgridgetrowlabelalignment}
\func{void}{GetRowLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
Returns the height of the specified row.
+\membersection{wxGrid::GetScrollLinesX}\label{wxgridgetscrolllinesx}
+
+\constfunc{int}{GetScrollLinesX}{\void}
+
+Returns the number of pixels per horizontal scroll increment. The default is 15.
+
+\membersection{wxGrid::GetScrollLinesY}\label{wxgridgetscrolllinesy}
+
+\constfunc{int}{GetScrollLinesY}{\void}
+
+Returns the number of pixels per vertical scroll increment. The default is 15.
+
\membersection{wxGrid::GetSelectionMode}\label{wxgridgetselectionmode}
\constfunc{wxGrid::wxGridSelectionModes}{GetSelectionMode}{\void}
Returns 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 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}
+
+\func{int}{GetViewWidth}{\void}
+
+Returned number of whole cols visible.
+
\membersection{wxGrid::HideCellEditControl}\label{wxgridhidecelleditcontrol}
\func{void}{HideCellEditControl}{\void}
Hides the in-place cell edit control.
+\membersection{wxGrid::InitColWidths}\label{wxgridinitcolwidths}
+
+\func{void}{InitColWidths}{\void}
+
+Init the m\_colWidths/Rights arrays
+
+\membersection{wxGrid::InitRowHeights}\label{wxgridinitrowheights}
+
+\func{void}{InitRowHeights}{\void}
+
+NB: {\it never} access m\_row/col arrays directly because they are created
+on demand, {\it always} use accessor functions instead!
+
+Init the m\_rowHeights/Bottoms arrays with default values.
+
\membersection{wxGrid::InsertCols}\label{wxgridinsertcols}
\func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}}
\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}
Selects the specified column. If addToSelected is false then any existing selection will be
deselected; if true the column will be added to the existing selection.
+\membersection{wxGrid::SelectionToDeviceRect}\label{wxgridselectiontodevicerect}
+
+\func{wxRect}{SelectionToDeviceRect}{\void}
+
+This function returns the rectangle that encloses the selected cells
+in device coords and clipped to the client size of the grid window.
+
+
\membersection{wxGrid::SelectRow}\label{wxgridselectrow}
\func{void}{SelectRow}{\param{int }{row}, \param{bool }{addToSelected = false}}
\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}}
This should normally be called when creating the grid because it will not resize existing columns
with sizes smaller than the value specified here.
-\membersection{wxGrid::GetColMinimalAcceptableWidth}\label{wxgridgetcolminimalacceptablewidth}
-
-\func{int}{GetColMinimalAcceptableWidth}{}
-
-This returns the value of the lowest column width that can be handled correctly. See
-member \helpref{SetColMinimalAcceptableWidth}{wxgridsetcolminimalacceptablewidth} for details.
-
\membersection{wxGrid::SetColSize}\label{wxgridsetcolsize}
\func{void}{SetColSize}{\param{int }{col}, \param{int }{width}}
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 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}}
This should normally be called when creating the grid because it will not resize existing rows
with sizes smaller than the value specified here.
-\membersection{wxGrid::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight}
-
-\func{int}{GetRowMinimalAcceptableHeight}{}
-
-This returns the value of the lowest row width that can be handled correctly. See
-member \helpref{SetRowMinimalAcceptableHeight}{wxgridsetrowminimalacceptableheight} for details.
-
\membersection{wxGrid::SetRowSize}\label{wxgridsetrowsize}
\func{void}{SetRowSize}{\param{int }{row}, \param{int }{height}}
wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
The memory requirements for this could become prohibitive if your grid is very large.
+\membersection{wxGrid::SetScrollLinesX}\label{wxgridsetscrolllinesx}
+
+\func{void}{SetScrollLinesX}{\param{int }{x}}
+
+Sets the number of pixels per horizontal scroll increment. The default is 15.
+Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
+errors: setting this to 1 can help.
+
+\membersection{wxGrid::SetScrollLinesY}\label{wxgridsetscrolllinesy}
+
+\func{void}{SetScrollLinesY}{\param{int }{y}}
+
+Sets the number of pixels per vertical scroll increment. The default is 15.
+Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
+errors: setting this to 1 can help.
+
+\membersection{wxGrid::SetSelectionBackground}\label{wxgridsetselectionbackground}
+
+\func{void}{SetSelectionBackground}{\param{const wxColour\& }{c}}
+
+
+\membersection{wxGrid::SetSelectionForeground}\label{wxgridsetselectionforeground}
+
+\func{void}{SetSelectionForeground}{\param{const wxColour\& }{c}}
+
+
\membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode}
\func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}}
\docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
-\docparam{wxGrid::wxGridSelectionColumns}{Selections will consist of whole columns.}
+\docparam{wxGrid::wxGridSelectColumns}{Selections will consist of whole columns.}
\membersection{wxGrid::SetTable}\label{wxgridsettable}
\func{int}{XToCol}{\param{int }{x}}
Returns the grid column that corresponds to the logical x coordinate. Returns
-wxNOT\_FOUND if there is no column at the x position.
+{\tt 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.
+If no column edge is near to this position {\tt 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.
+If no row edge is near to this position {\tt 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.
-
-
-\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::GetSelectionBackground}\label{wxgridgetselectionbackground}
-
-\constfunc{wxColour}{GetSelectionBackground}{\void}
-
-Access or update the selection fore/back colours
-
-
-\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::GetColWidth}\label{wxgridgetcolwidth}
-
-\constfunc{int}{GetColWidth}{\param{int }{col}}
-
-Get the col/row coords
-
-
-\membersection{wxGrid::GetColLeft}\label{wxgridgetcolleft}
-
-\constfunc{int}{GetColLeft}{\param{int }{col}}
-
-
-\membersection{wxGrid::GetColRight}\label{wxgridgetcolright}
-
-\constfunc{int}{GetColRight}{\param{int }{col}}
-
-
-\membersection{wxGrid::GetRowHeight}\label{wxgridgetrowheight}
-
-\constfunc{int}{GetRowHeight}{\param{int }{row}}
-
-This function must be public for compatibility.
-
-\membersection{wxGrid::GetRowTop}\label{wxgridgetrowtop}
-
-\constfunc{int}{GetRowTop}{\param{int }{row}}
-
-
-\membersection{wxGrid::GetRowBottom}\label{wxgridgetrowbottom}
-
-\constfunc{int}{GetRowBottom}{\param{int }{row}}
-
-
-\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::AutoSizeColOrRow}\label{wxgridautosizecolorrow}
-
-\func{void}{AutoSizeColOrRow}{\param{int }{n}, \param{bool }{setAsMin}, \param{bool }{column}}
-
-Common part of AutoSizeColumn/Row() or row?
-
-\membersection{wxGrid::GetColMinimalWidth}\label{wxgridgetcolminimalwidth}
-
-\constfunc{int}{GetColMinimalWidth}{\param{int }{col}}
-
-get the minimal width of the given column/row
-
-\membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight}
-
-\constfunc{int}{GetRowMinimalHeight}{\param{int }{col}}
-
-\membersection{wxGrid::CanHaveAttributes}\label{wxgridcanhaveattributes}
-
-\func{bool}{CanHaveAttributes}{\void}
-
-Do we have some place to store attributes in?
-
-\membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
-
-\constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
+{\tt wxNOT\_FOUND} if there is no row at the y position.
projects / wxWidgets.git / blobdiff