1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5 %% Modified by: Santiago Palacios
8 %% Copyright: (c) wxWidgets
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \section{\class{wxGrid
}}\label{wxgrid
}
14 wxGrid and its related classes are used for displaying and editing tabular
15 data. They provide a rich set of features for display, editing, and
16 interacting with a variety of data sources. For simple applications, and to
17 help you get started, wxGrid is the only class you need to refer to
18 directly. It will set up default instances of the other classes and manage
19 them for you. For more complex applications you can derive your own
20 classes for custom grid views, grid data tables, cell editors and
21 renderers. The
\helpref{wxGrid classes overview
}{gridoverview
} has
22 examples of simple and more complex applications, explains the
23 relationship between the various grid classes and has a summary of the
24 keyboard shortcuts and mouse functions provided by wxGrid.
26 wxGrid has been greatly expanded and redesigned for wxWidgets
2.2
27 onwards. If you have been using the old wxGrid class you will probably
28 want to have a look at the
\helpref{wxGrid classes overview
}{gridoverview
} to see
29 how things have changed. The new grid classes are reasonably backward-compatible
30 but there are some exceptions. There are also easier ways of doing many things compared to
31 the previous implementation.
33 \wxheading{Derived from
}
35 \helpref{wxScrolledWindow
}{wxscrolledwindow
}\\
36 \helpref{wxWindow
}{wxwindow
}\\
37 \helpref{wxEvtHandler
}{wxevthandler
}\\
38 \helpref{wxObject
}{wxobject
}
40 \wxheading{Include files
}
44 \wxheading{Window styles
}
46 There are presently no specific window styles for wxGrid.
48 \wxheading{Event handling
}
52 The event handler for the following functions takes a
53 \helpref{wxGridSizeEvent
}{wxgridsizeevent
} parameter.
54 The ...
\_CMD\_... variants also take a window identifier.
57 \begin{twocollist
}\itemsep=
0pt
58 \twocolitem{{\bf EVT
\_GRID\_COL\_SIZE(func)
}}{The user resized a column by dragging it. Processes a wxEVT
\_GRID\_COL\_SIZE.
}
59 \twocolitem{{\bf EVT
\_GRID\_ROW\_SIZE(func)
}}{The user resized a row by dragging it. Processes a wxEVT
\_GRID\_ROW\_SIZE.
}
60 \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.
}
61 \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.
}
64 The event handler for the following functions takes a
65 \helpref{wxGridRangeSelectEvent
}{wxgridrangeselectevent
} parameter.
66 The ...
\_CMD\_... variant also takes a window identifier.
69 \begin{twocollist
}\itemsep=
0pt
70 \twocolitem{{\bf EVT
\_GRID\_RANGE\_SELECT(func)
}}{The user selected a group of contiguous cells. Processes a wxEVT
\_GRID\_RANGE\_SELECT.
}
71 \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.
}
74 The event handler for the following functions takes a
75 \helpref{wxGridEditorCreatedEvent
}{wxgrideditorcreatedevent
} parameter.
76 The ...
\_CMD\_... variant also takes a window identifier.
79 \begin{twocollist
}\itemsep=
0pt
80 \twocolitem{{\bf EVT
\_GRID\_EDITOR\_CREATED(func)
}}{The editor for a cell was created. Processes a wxEVT
\_GRID\_EDITOR\_CREATED.
}
81 \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.
}
86 \helpref{wxGrid overview
}{gridoverview
}
88 %%%%%%%%%%% FUNCTION GROUPS %%%%%%%%%%%%%
89 \latexignore{\rtfignore{\wxheading{Function groups
}}}
93 \membersection{Constructors and initialization
}\label{wxgridconstructors
}
95 \helpref{wxGrid
}{wxgridctor
}\\
96 \helpref{\destruct{wxGrid
}}{wxgriddtor
}\\
97 \helpref{CreateGrid
}{wxgridcreategrid
}\\
98 \helpref{SetTable
}{wxgridsettable
}
102 \membersection{Display format
}\label{wxgriddisplayformat
}
106 \membersection{Selection functions
}\label{wxgridselectionfunctions
}
108 \helpref{wxGrid::ClearSelection
}{wxgridclearselection
}\\
109 \helpref{wxGrid::IsSelection
}{wxgridisselection
}\\
110 \helpref{wxGrid::SelectAll
}{wxgridselectall
}\\
111 \helpref{wxGrid::SelectBlock
}{wxgridselectblock
}\\
112 \helpref{wxGrid::SelectCol
}{wxgridselectcol
}\\
113 \helpref{wxGrid::SelectRow
}{wxgridselectrow
}
115 %%%%%%%%% MEMBER FUNCTIONS %%%%%%%%%%
116 \helponly{\insertatlevel{2}{
124 \membersection{wxGrid::wxGrid
}\label{wxgridctor
}
126 \func{}{wxGrid
}{\void}
130 \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
}}
132 Constructor to create a grid object. Call either
\helpref{wxGrid::CreateGrid
}{wxgridcreategrid
} or
133 \helpref{wxGrid::SetTable
}{wxgridsettable
} directly after this to initialize the grid before using
138 \membersection{wxGrid::
\destruct{wxGrid
}}\label{wxgriddtor
}
140 \func{}{\destruct{wxGrid
}}{\void}
142 Destructor. This will also destroy the associated grid table unless you passed a table
143 object to the grid and specified that the grid should not take ownership of the
144 table (see
\helpref{wxGrid::SetTable
}{wxgridsettable
}).
148 \membersection{wxGrid::AppendCols
}\label{wxgridappendcols
}
150 \func{bool
}{AppendCols
}{\param{int
}{numCols =
1},
\param{bool
}{updateLabels = true
}}
152 Appends one or more new columns to the right of the grid and returns true if
153 successful. The updateLabels argument is not used at present.
155 If you are using a derived grid table class you will need to override
156 \helpref{wxGridTableBase::AppendCols
}{wxgridtablebaseappendcols
}. See
157 \helpref{wxGrid::InsertCols
}{wxgridinsertcols
} for further information.
161 \membersection{wxGrid::AppendRows
}\label{wxgridappendrows
}
163 \func{bool
}{AppendRows
}{\param{int
}{numRows =
1},
\param{bool
}{updateLabels = true
}}
165 Appends one or more new rows to the bottom of the grid and returns true if
166 successful. The updateLabels argument is not used at present.
168 If you are using a derived grid table class you will need to override
169 \helpref{wxGridTableBase::AppendRows
}{wxgridtablebaseappendrows
}. See
170 \helpref{wxGrid::InsertRows
}{wxgridinsertrows
} for further information.
174 \membersection{wxGrid::AutoSize
}\label{wxgridautosize
}
176 \func{void
}{AutoSize
}{\void}
178 Automatically sets the height and width of all rows and columns to fit their contents.
181 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
182 The memory requirements for this could become prohibitive if your grid is very large.
186 \membersection{wxGrid::AutoSizeColLabelSize
}\label{wxgridautosizecollabelsize
}
188 \func{void
}{AutoSizeColLabelSize
}{\param{int
}{col
}}
190 Automatically adjusts width of the column to fit its label.
194 \membersection{wxGrid::AutoSizeColumn
}\label{wxgridautosizecolumn
}
196 \func{void
}{AutoSizeColumn
}{\param{int
}{col
},
\param{bool
}{setAsMin = true
}}
198 Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will
199 also be set as the minimal width for the column.
202 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
203 The memory requirements for this could become prohibitive if your grid is very large.
207 \membersection{wxGrid::AutoSizeColumns
}\label{wxgridautosizecolumns
}
209 \func{void
}{AutoSizeColumns
}{\param{bool
}{setAsMin = true
}}
211 Automatically sizes all columns to fit their contents. If setAsMin is true the calculated widths will
212 also be set as the minimal widths for the columns.
215 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
216 The memory requirements for this could become prohibitive if your grid is very large.
220 \membersection{wxGrid::AutoSizeRow
}\label{wxgridautosizerow
}
222 \func{void
}{AutoSizeRow
}{\param{int
}{row
},
\param{bool
}{setAsMin = true
}}
224 Automatically sizes the row to fit its contents. If setAsMin is true the calculated height will
225 also be set as the minimal height for the row.
228 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
229 The memory requirements for this could become prohibitive if your grid is very large.
233 \membersection{wxGrid::AutoSizeRowLabelSize
}\label{wxgridautosizerowlabelsize
}
235 \func{void
}{AutoSizeRowLabelSize
}{\param{int
}{col
}}
237 Automatically adjusts height of the row to fit its label.
241 \membersection{wxGrid::AutoSizeRows
}\label{wxgridautosizerows
}
243 \func{void
}{AutoSizeRows
}{\param{bool
}{setAsMin = true
}}
245 Automatically sizes all rows to fit their contents. If setAsMin is true the calculated heights will
246 also be set as the minimal heights for the rows.
249 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
250 The memory requirements for this could become prohibitive if your grid is very large.
254 \membersection{wxGrid::BeginBatch
}\label{wxgridbeginbatch
}
256 \func{void
}{BeginBatch
}{\void}
258 Increments the grid's batch count. When the count is greater than zero repainting of
259 the grid is suppressed. Each call to BeginBatch must be matched by a later call to
260 \helpref{wxGrid::EndBatch
}{wxgridendbatch
}. Code that does a lot of grid
261 modification can be enclosed between BeginBatch and EndBatch calls to avoid
262 screen flicker. The final EndBatch will cause the grid to be repainted.
266 \helpref{wxGridUpdateLocker
}{wxgridupdatelocker
}
270 \membersection{wxGrid::BlockToDeviceRect
}\label{wxgridblocktodevicerect
}
272 \constfunc{wxRect
}{BlockToDeviceRect
}{\param{const wxGridCellCoords \&
}{topLeft
},
\param{const wxGridCellCoords \&
}{bottomRight
}}
274 This function returns the rectangle that encloses the block of cells
275 limited by TopLeft and BottomRight cell in device coords and clipped
276 to the client size of the grid window.
280 \membersection{wxGrid::CanDragColMove
}\label{wxgridcandragcolmove
}
282 \constfunc{bool
}{CanDragColMove
}{\void}
284 Returns true if columns can be moved by dragging with the mouse. Columns can be moved
285 by dragging on their labels.
289 \membersection{wxGrid::CanDragColSize
}\label{wxgridcandragcolsize
}
291 \constfunc{bool
}{CanDragColSize
}{\void}
293 Returns true if columns can be resized by dragging with the mouse. Columns can be resized
294 by dragging the edges of their labels. If grid line dragging is enabled they can also be
295 resized by dragging the right edge of the column in the grid cell area
296 (see
\helpref{wxGrid::EnableDragGridSize
}{wxgridenabledraggridsize
}).
300 \membersection{wxGrid::CanDragRowSize
}\label{wxgridcandragrowsize
}
302 \constfunc{bool
}{CanDragRowSize
}{\void}
304 Returns true if rows can be resized by dragging with the mouse. Rows can be resized
305 by dragging the edges of their labels. If grid line dragging is enabled they can also be
306 resized by dragging the lower edge of the row in the grid cell area
307 (see
\helpref{wxGrid::EnableDragGridSize
}{wxgridenabledraggridsize
}).
311 \membersection{wxGrid::CanDragGridSize
}\label{wxgridcandraggridsize
}
313 \constfunc{bool
}{CanDragGridSize
}{\void}
315 Return true if the dragging of grid lines to resize rows and columns is enabled or false otherwise.
319 \membersection{wxGrid::CanEnableCellControl
}\label{wxgridcanenablecellcontrol
}
321 \constfunc{bool
}{CanEnableCellControl
}{\void}
323 Returns true if the in-place edit control for the current grid cell can be used and
324 false otherwise (e.g. if the current cell is read-only).
328 \membersection{wxGrid::CanHaveAttributes
}\label{wxgridcanhaveattributes
}
330 \constfunc{bool
}{CanHaveAttributes
}{\void}
332 Do we have some place to store attributes in?
336 \membersection{wxGrid::CellToRect
}\label{wxgridcelltorect
}
338 \constfunc{wxRect
}{CellToRect
}{\param{int
}{row
},
\param{int
}{col
}}
340 \constfunc{wxRect
}{CellToRect
}{\param{const wxGridCellCoords\&
}{coords
}}
342 Return the rectangle corresponding to the grid cell's size and position in logical
347 \membersection{wxGrid::ClearGrid
}\label{wxgridcleargrid
}
349 \func{void
}{ClearGrid
}{\void}
351 Clears all data in the underlying grid table and repaints the grid. The table is not deleted by
352 this function. If you are using a derived table class then you need to override
353 \helpref{wxGridTableBase::Clear
}{wxgridtablebaseclear
} for this function to have any effect.
357 \membersection{wxGrid::ClearSelection
}\label{wxgridclearselection
}
359 \func{void
}{ClearSelection
}{\void}
361 Deselects all cells that are currently selected.
365 \membersection{wxGrid::CreateGrid
}\label{wxgridcreategrid
}
367 \func{bool
}{CreateGrid
}{\param{int
}{numRows
},
\param{int
}{numCols
},
\param{wxGrid::wxGridSelectionModes
}{selmode = wxGrid::wxGridSelectCells
}}
369 Creates a grid with the specified initial number of rows and columns.
370 Call this directly after the grid constructor. When you use this
371 function wxGrid will create and manage a simple table of string values
372 for you. All of the grid data will be stored in memory.
374 For applications with more complex data types or relationships, or for
375 dealing with very large datasets, you should derive your own grid table
376 class and pass a table object to the grid with
\helpref{wxGrid::SetTable
}{wxgridsettable
}.
380 \membersection{wxGrid::DeleteCols
}\label{wxgriddeletecols
}
382 \func{bool
}{DeleteCols
}{\param{int
}{pos =
0},
\param{int
}{numCols =
1},
\param{bool
}{updateLabels = true
}}
384 Deletes one or more columns from a grid starting at the specified position and returns
385 true if successful. The updateLabels argument is not used at present.
387 If you are using a derived grid table class you will need to override
388 \helpref{wxGridTableBase::DeleteCols
}{wxgridtablebasedeletecols
}. See
389 \helpref{wxGrid::InsertCols
}{wxgridinsertcols
} for further information.
393 \membersection{wxGrid::DeleteRows
}\label{wxgriddeleterows
}
395 \func{bool
}{DeleteRows
}{\param{int
}{pos =
0},
\param{int
}{numRows =
1},
\param{bool
}{updateLabels = true
}}
397 Deletes one or more rows from a grid starting at the specified position and returns
398 true if successful. The updateLabels argument is not used at present.
400 If you are using a derived grid table class you will need to override
401 \helpref{wxGridTableBase::DeleteRows
}{wxgridtablebasedeleterows
}. See
402 \helpref{wxGrid::InsertRows
}{wxgridinsertrows
} for further information.
406 \membersection{wxGrid::DisableCellEditControl
}\label{wxgriddisablecelleditcontrol
}
408 \func{void
}{DisableCellEditControl
}{\void}
410 Disables in-place editing of grid cells.
411 Equivalent to calling EnableCellEditControl(false).
415 \membersection{wxGrid::DisableDragColMove
}\label{wxgriddisabledragcolmove
}
417 \func{void
}{DisableDragColMove
}{\void}
419 Disables column moving by dragging with the mouse. Equivalent to passing false to
420 \helpref{wxGrid::EnableDragColMove
}{wxgridenabledragcolmove
}.
424 \membersection{wxGrid::DisableDragColSize
}\label{wxgriddisabledragcolsize
}
426 \func{void
}{DisableDragColSize
}{\void}
428 Disables column sizing by dragging with the mouse. Equivalent to passing false to
429 \helpref{wxGrid::EnableDragColSize
}{wxgridenabledragcolsize
}.
433 \membersection{wxGrid::DisableDragGridSize
}\label{wxgriddisabledraggridsize
}
435 \func{void
}{DisableDragGridSize
}{\void}
437 Disable mouse dragging of grid lines to resize rows and columns. Equivalent to passing
438 false to
\helpref{wxGrid::EnableDragGridSize
}{wxgridenabledraggridsize
}
442 \membersection{wxGrid::DisableDragRowSize
}\label{wxgriddisabledragrowsize
}
444 \func{void
}{DisableDragRowSize
}{\void}
446 Disables row sizing by dragging with the mouse. Equivalent to passing false to
447 \helpref{wxGrid::EnableDragRowSize
}{wxgridenabledragrowsize
}.
451 \membersection{wxGrid::EnableCellEditControl
}\label{wxgridenablecelleditcontrol
}
453 \func{void
}{EnableCellEditControl
}{\param{bool
}{enable = true
}}
455 Enables or disables in-place editing of grid cell data. The grid will issue either a
456 wxEVT
\_GRID\_EDITOR\_SHOWN or wxEVT
\_GRID\_EDITOR\_HIDDEN event.
460 \membersection{wxGrid::EnableDragColSize
}\label{wxgridenabledragcolsize
}
462 \func{void
}{EnableDragColSize
}{\param{bool
}{enable = true
}}
464 Enables or disables column sizing by dragging with the mouse.
468 \membersection{wxGrid::EnableDragColMove
}\label{wxgridenabledragcolmove
}
470 \func{void
}{EnableDragColMove
}{\param{bool
}{enable = true
}}
472 Enables or disables column moving by dragging with the mouse.
476 \membersection{wxGrid::EnableDragGridSize
}\label{wxgridenabledraggridsize
}
478 \func{void
}{EnableDragGridSize
}{\param{bool
}{enable = true
}}
480 Enables or disables row and column resizing by dragging gridlines with the mouse.
484 \membersection{wxGrid::EnableDragRowSize
}\label{wxgridenabledragrowsize
}
486 \func{void
}{EnableDragRowSize
}{\param{bool
}{enable = true
}}
488 Enables or disables row sizing by dragging with the mouse.
492 \membersection{wxGrid::EnableEditing
}\label{wxgridenableediting
}
494 \func{void
}{EnableEditing
}{\param{bool
}{edit
}}
496 If the edit argument is false this function sets the whole grid as read-only. If the
497 argument is true the grid is set to the default state where cells may be editable. In the
498 default state you can set single grid cells and whole rows and columns to be editable or
500 \helpref{wxGridCellAttribute::SetReadOnly
}{wxgridcellattrsetreadonly
}. For single
501 cells you can also use the shortcut function
502 \helpref{wxGrid::SetReadOnly
}{wxgridsetreadonly
}.
504 For more information about controlling grid cell attributes see the
505 \helpref{wxGridCellAttr
}{wxgridcellattr
} cell attribute class and the
506 \helpref{wxGrid classes overview
}{gridoverview
}.
510 \membersection{wxGrid::EnableGridLines
}\label{wxgridenablegridlines
}
512 \func{void
}{EnableGridLines
}{\param{bool
}{enable = true
}}
514 Turns the drawing of grid lines on or off.
518 \membersection{wxGrid::EndBatch
}\label{wxgridendbatch
}
520 \func{void
}{EndBatch
}{\void}
522 Decrements the grid's batch count. When the count is greater than zero repainting of
523 the grid is suppressed. Each previous call to
524 \helpref{wxGrid::BeginBatch
}{wxgridbeginbatch
} must be matched by a later call to
525 EndBatch. Code that does a lot of grid modification can be enclosed between
526 BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will
527 cause the grid to be repainted.
531 \helpref{wxGridUpdateLocker
}{wxgridupdatelocker
}
535 \membersection{wxGrid::Fit
}\label{wxgridfit
}
537 \func{void
}{Fit
}{\void}
539 Overridden wxWindow method.
543 \membersection{wxGrid::ForceRefresh
}\label{wxgridforcerefresh
}
545 \func{void
}{ForceRefresh
}{\void}
547 Causes immediate repainting of the grid. Use this instead of the usual wxWindow::Refresh.
551 \membersection{wxGrid::GetBatchCount
}\label{wxgridgetbatchcount
}
553 \constfunc{int
}{GetBatchCount
}{\void}
555 Returns the number of times that
\helpref{wxGrid::BeginBatch
}{wxgridbeginbatch
} has been called
556 without (yet) matching calls to
\helpref{wxGrid::EndBatch
}{wxgridendbatch
}. While
557 the grid's batch count is greater than zero the display will not be updated.
561 \membersection{wxGrid::GetCellAlignment
}\label{wxgridgetcellalignment
}
563 \constfunc{void
}{GetCellAlignment
}{\param{int
}{row
},
\param{int
}{col
},
\param{int*
}{horiz
},
\param{int*
}{vert
}}
565 Sets the arguments to the horizontal and vertical text alignment values for the
566 grid cell at the specified location.
568 Horizontal alignment will be one of wxALIGN
\_LEFT, wxALIGN
\_CENTRE or wxALIGN
\_RIGHT. \\
569 Vertical alignment will be one of wxALIGN
\_TOP, wxALIGN
\_CENTRE or wxALIGN
\_BOTTOM.
571 \perlnote{This method only takes the parameters
{\tt row
} and
{\tt col
} and
572 returns a
2-element list
{\tt ( horiz, vert )
}.
}
576 \membersection{wxGrid::GetCellBackgroundColour
}\label{wxgridgetcellbackgroundcolour
}
578 \constfunc{wxColour
}{GetCellBackgroundColour
}{\param{int
}{row
},
\param{int
}{col
}}
580 Returns the background colour of the cell at the specified location.
584 \membersection{wxGrid::GetCellEditor
}\label{wxgridgetcelleditor
}
586 \constfunc{wxGridCellEditor*
}{GetCellEditor
}{\param{int
}{row
},
\param{int
}{col
}}
588 Returns a pointer to the editor for the cell at the specified location.
590 See
\helpref{wxGridCellEditor
}{wxgridcelleditor
} and
591 the
\helpref{wxGrid overview
}{gridoverview
} for more information about cell editors and renderers.
595 \membersection{wxGrid::GetCellFont
}\label{wxgridgetcellfont
}
597 \constfunc{wxFont
}{GetCellFont
}{\param{int
}{row
},
\param{int
}{col
}}
599 Returns the font for text in the grid cell at the specified location.
603 \membersection{wxGrid::GetCellRenderer
}\label{wxgridgetcellrenderer
}
605 \constfunc{wxGridCellRenderer*
}{GetCellRenderer
}{\param{int
}{row
},
\param{int
}{col
}}
607 Returns a pointer to the renderer for the grid cell at the specified location.
609 See
\helpref{wxGridCellRenderer
}{wxgridcellrenderer
} and
610 the
\helpref{wxGrid overview
}{gridoverview
} for more information about cell editors and renderers.
614 \membersection{wxGrid::GetCellTextColour
}\label{wxgridgetcelltextcolour
}
616 \constfunc{wxColour
}{GetCellTextColour
}{\param{int
}{row
},
\param{int
}{col
}}
618 Returns the text colour for the grid cell at the specified location.
622 \membersection{wxGrid::GetCellValue
}\label{wxgridgetcellvalue
}
624 \constfunc{wxString
}{GetCellValue
}{\param{int
}{row
},
\param{int
}{col
}}
626 \constfunc{wxString
}{GetCellValue
}{\param{const wxGridCellCoords\&
}{coords
}}
628 Returns the string contained in the cell at the specified location. For simple applications where a
629 grid object automatically uses a default grid table of string values you use this function together
630 with
\helpref{wxGrid::SetCellValue
}{wxgridsetcellvalue
} to access cell values.
632 For more complex applications where you have derived your own grid table class that contains
633 various data types (e.g. numeric, boolean or user-defined custom types) then you only use this
634 function for those cells that contain string values.
636 See
\helpref{wxGridTableBase::CanGetValueAs
}{wxgridtablebasecangetvalueas
}
637 and the
\helpref{wxGrid overview
}{gridoverview
} for more information.
641 \membersection{wxGrid::GetColAt
}\label{wxgridgetcolat
}
643 \constfunc{int
}{GetColAt
}{\param{int
}{colPos
}}
645 Returns the column ID of the specified column position.
648 \membersection{wxGrid::GetColLeft
}\label{wxgridgetcolleft
}
650 \constfunc{int
}{GetColLeft
}{\param{int
}{col
}}
654 \membersection{wxGrid::GetColLabelAlignment
}\label{wxgridgetcollabelalignment
}
656 \constfunc{void
}{GetColLabelAlignment
}{\param{int*
}{horiz
},
\param{int*
}{vert
}}
658 Sets the arguments to the current column label alignment values.
660 Horizontal alignment will be one of wxALIGN
\_LEFT, wxALIGN
\_CENTRE or wxALIGN
\_RIGHT.\\
661 Vertical alignment will be one of wxALIGN
\_TOP, wxALIGN
\_CENTRE or wxALIGN
\_BOTTOM.
663 \perlnote{This method takes no parameters and
664 returns a
2-element list
{\tt ( horiz, vert )
}.
}
668 \membersection{wxGrid::GetColLabelSize
}\label{wxgridgetcollabelsize
}
670 \constfunc{int
}{GetColLabelSize
}{\void}
672 Returns the current height of the column labels.
676 \membersection{wxGrid::GetColLabelValue
}\label{wxgridgetcollabelvalue
}
678 \constfunc{wxString
}{GetColLabelValue
}{\param{int
}{col
}}
680 Returns the specified column label. The default grid table class provides column labels of
681 the form A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can override
682 \helpref{wxGridTableBase::GetColLabelValue
}{wxgridtablebasegetcollabelvalue
} to provide
687 \membersection{wxGrid::GetColMinimalAcceptableWidth
}\label{wxgridgetcolminimalacceptablewidth
}
689 \constfunc{int
}{GetColMinimalAcceptableWidth
}{}
691 This returns the value of the lowest column width that can be handled correctly. See
692 member
\helpref{SetColMinimalAcceptableWidth
}{wxgridsetcolminimalacceptablewidth
} for details.
696 \membersection{wxGrid::GetColMinimalWidth
}\label{wxgridgetcolminimalwidth
}
698 \constfunc{int
}{GetColMinimalWidth
}{\param{int
}{col
}}
700 Get the minimal width of the given column/row.
704 \membersection{wxGrid::GetColPos
}\label{wxgridgetcolpos
}
706 \constfunc{int
}{GetColPos
}{\param{int
}{colID
}}
708 Returns the position of the specified column.
712 \membersection{wxGrid::GetColRight
}\label{wxgridgetcolright
}
714 \constfunc{int
}{GetColRight
}{\param{int
}{col
}}
718 \membersection{wxGrid::GetColSize
}\label{wxgridgetcolsize
}
720 \constfunc{int
}{GetColSize
}{\param{int
}{col
}}
722 Returns the width of the specified column.
726 \membersection{wxGrid::GetDefaultCellAlignment
}\label{wxgridgetdefaultcellalignment
}
728 \constfunc{void
}{GetDefaultCellAlignment
}{\param{int*
}{horiz
},
\param{int*
}{vert
}}
730 Sets the arguments to the current default horizontal and vertical text alignment
733 Horizontal alignment will be one of wxALIGN
\_LEFT, wxALIGN
\_CENTRE or wxALIGN
\_RIGHT. \\
734 Vertical alignment will be one of wxALIGN
\_TOP, wxALIGN
\_CENTRE or wxALIGN
\_BOTTOM.
738 \membersection{wxGrid::GetDefaultCellBackgroundColour
}\label{wxgridgetdefaultcellbackgroundcolour
}
740 \constfunc{wxColour
}{GetDefaultCellBackgroundColour
}{\void}
742 Returns the current default background colour for grid cells.
746 \membersection{wxGrid::GetDefaultCellFont
}\label{wxgridgetdefaultcellfont
}
748 \constfunc{wxFont
}{GetDefaultCellFont
}{\void}
750 Returns the current default font for grid cell text.
754 \membersection{wxGrid::GetDefaultCellTextColour
}\label{wxgridgetdefaultcelltextcolour
}
756 \constfunc{wxColour
}{GetDefaultCellTextColour
}{\void}
758 Returns the current default colour for grid cell text.
762 \membersection{wxGrid::GetDefaultColLabelSize
}\label{wxgridgetdefaultcollabelsize
}
764 \constfunc{int
}{GetDefaultColLabelSize
}{\void}
766 Returns the default height for column labels.
770 \membersection{wxGrid::GetDefaultColSize
}\label{wxgridgetdefaultcolsize
}
772 \constfunc{int
}{GetDefaultColSize
}{\void}
774 Returns the current default width for grid columns.
778 \membersection{wxGrid::GetDefaultEditor
}\label{wxgridgetdefaulteditor
}
780 \constfunc{wxGridCellEditor*
}{GetDefaultEditor
}{\void}
782 Returns a pointer to the current default grid cell editor.
784 See
\helpref{wxGridCellEditor
}{wxgridcelleditor
} and
785 the
\helpref{wxGrid overview
}{gridoverview
} for more information about cell editors and renderers.
789 \membersection{wxGrid::GetDefaultEditorForCell
}\label{wxgridgetdefaulteditorforcell
}
791 \constfunc{wxGridCellEditor*
}{GetDefaultEditorForCell
}{\param{int
}{row
},
\param{int
}{col
}}
793 \constfunc{wxGridCellEditor*
}{GetDefaultEditorForCell
}{\param{const wxGridCellCoords\&
}{c
}}
797 \membersection{wxGrid::GetDefaultEditorForType
}\label{wxgridgetdefaulteditorfortype
}
799 \constfunc{wxGridCellEditor*
}{GetDefaultEditorForType
}{\param{const wxString\&
}{typeName
}}
803 \membersection{wxGrid::GetDefaultRenderer
}\label{wxgridgetdefaultrenderer
}
805 \constfunc{wxGridCellRenderer*
}{GetDefaultRenderer
}{\void}
807 Returns a pointer to the current default grid cell renderer.
809 See
\helpref{wxGridCellRenderer
}{wxgridcellrenderer
} and
810 the
\helpref{wxGrid overview
}{gridoverview
} for more information about cell editors and renderers.
814 \membersection{wxGrid::GetDefaultRendererForCell
}\label{wxgridgetdefaultrendererforcell
}
816 \constfunc{wxGridCellRenderer*
}{GetDefaultRendererForCell
}{\param{int
}{row
},
\param{int
}{col
}}
820 \membersection{wxGrid::GetDefaultRendererForType
}\label{wxgridgetdefaultrendererfortype
}
822 \constfunc{wxGridCellRenderer*
}{GetDefaultRendererForType
}{\param{const wxString\&
}{typeName
}}
826 \membersection{wxGrid::GetDefaultRowLabelSize
}\label{wxgridgetdefaultrowlabelsize
}
828 \constfunc{int
}{GetDefaultRowLabelSize
}{\void}
830 Returns the default width for the row labels.
834 \membersection{wxGrid::GetDefaultRowSize
}\label{wxgridgetdefaultrowsize
}
836 \constfunc{int
}{GetDefaultRowSize
}{\void}
838 Returns the current default height for grid rows.
842 \membersection{wxGrid::GetGridCursorCol
}\label{wxgridgetgridcursorcol
}
844 \constfunc{int
}{GetGridCursorCol
}{\void}
846 Returns the current grid cell column position.
850 \membersection{wxGrid::GetGridCursorRow
}\label{wxgridgetgridcursorrow
}
852 \constfunc{int
}{GetGridCursorRow
}{\void}
854 Returns the current grid cell row position.
858 \membersection{wxGrid::GetGridLineColour
}\label{wxgridgetgridlinecolour
}
860 \constfunc{wxColour
}{GetGridLineColour
}{\void}
862 Returns the colour used for grid lines.
866 \helpref{GetDefaultGridLinePen()
}{wxgridgetdefaultgridlinepen
}
869 \membersection{wxGrid::GetDefaultGridLinePen
}\label{wxgridgetdefaultgridlinepen
}
871 \func{wxPen
}{GetDefaultGridLinePen
}{\void}
873 Returns the pen used for grid lines. This virtual function may be overridden in
874 derived classes in order to change the appearance of grid lines. Note that
875 currently the pen width must be $
1$.
879 \helpref{GetColGridLinePen()
}{wxgridgetcolgridlinepen
},\\
880 \helpref{GetRowGridLinePen()
}{wxgridgetrowgridlinepen
}
885 \membersection{wxGrid::GetRowGridLinePen
}\label{wxgridgetrowgridlinepen
}
887 \func{wxPen
}{GetRowGridLinePen
}{\param{int
}{row
}}
889 Returns the pen used for horizontal grid lines. This virtual function may be
890 overridden in derived classes in order to change the appearance of individual
891 grid line for the given row
\arg{row
}.
896 // in a grid displaying music notation, use a solid black pen between
897 // octaves (C0=row
127, C1=row
115 etc.)
898 wxPen MidiGrid::GetRowGridLinePen(int row)
901 return wxPen
(*wxBLACK, 1, wxSOLID);
903 return GetDefaultGridLinePen();
909 \membersection{wxGrid::GetColGridLinePen}\label{wxgridgetcolgridlinepen}
911 \func{wxPen}{GetColGridLinePen}{\param{int }{col}}
913 Returns the pen used for vertical grid lines. This virtual function may be
914 overridden in derived classes in order to change the appearance of individual
915 grid lines for the given column \arg{col}.
917 See \helpref{GetRowGridLinePen()}{wxgridgetrowgridlinepen} for an example.
922 \membersection{wxGrid::GridLinesEnabled}\label{wxgridgridlinesenabled}
924 \constfunc{bool}{GridLinesEnabled}{\void}
926 Returns true if drawing of grid lines is turned on, false otherwise.
930 \membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
932 \constfunc{wxColour}{GetLabelBackgroundColour}{\void}
934 Returns the colour used for the background of row and column labels.
938 \membersection{wxGrid::GetLabelFont}\label{wxgridgetlabelfont}
940 \constfunc{wxFont}{GetLabelFont}{\void}
942 Returns the font used for row and column labels.
946 \membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour}
948 \constfunc{wxColour}{GetLabelTextColour}{\void}
950 Returns the colour used for row and column label text.
954 \membersection{wxGrid::GetNumberCols}\label{wxgridgetnumbercols}
956 \constfunc{int}{GetNumberCols}{\void}
958 Returns the total number of grid columns (actually the number of columns in the underlying grid
963 \membersection{wxGrid::GetNumberRows}\label{wxgridgetnumberrows}
965 \constfunc{int}{GetNumberRows}{\void}
967 Returns the total number of grid rows (actually the number of rows in the underlying grid table).
971 \membersection{wxGrid::GetOrCreateCellAttr}\label{wxgridgetorcreatecellattr}
973 \constfunc{wxGridCellAttr*}{GetOrCreateCellAttr}{\param{int }{row}, \param{int }{col}}
977 \membersection{wxGrid::GetRowMinimalAcceptableHeight}\label{wxgridgetrowminimalacceptableheight}
979 \constfunc{int}{GetRowMinimalAcceptableHeight}{}
981 This returns the value of the lowest row width that can be handled correctly. See
982 member \helpref{SetRowMinimalAcceptableHeight}{wxgridsetrowminimalacceptableheight} for details.
986 \membersection{wxGrid::GetRowMinimalHeight}\label{wxgridgetrowminimalheight}
988 \constfunc{int}{GetRowMinimalHeight}{\param{int }{col}}
992 \membersection{wxGrid::GetRowLabelAlignment}\label{wxgridgetrowlabelalignment}
994 \constfunc{void}{GetRowLabelAlignment}{\param{int* }{horiz}, \param{int* }{vert}}
996 Sets the arguments to the current row label alignment values.
998 Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT. \\
999 Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
1001 \perlnote{This method takes no parameters and
1002 returns a 2-element list {\tt ( horiz, vert )}.}
1006 \membersection{wxGrid::GetRowLabelSize}\label{wxgridgetrowlabelsize}
1008 \constfunc{int}{GetRowLabelSize}{\void}
1010 Returns the current width of the row labels.
1014 \membersection{wxGrid::GetRowLabelValue}\label{wxgridgetrowlabelvalue}
1016 \constfunc{wxString}{GetRowLabelValue}{\param{int }{row}}
1018 Returns the specified row label. The default grid table class provides numeric row labels.
1019 If you are using a custom grid table you can override
1020 \helpref{wxGridTableBase::GetRowLabelValue}{wxgridtablebasegetcollabelvalue} to provide
1025 \membersection{wxGrid::GetRowSize}\label{wxgridgetrowsize}
1027 \constfunc{int}{GetRowSize}{\param{int }{row}}
1029 Returns the height of the specified row.
1033 \membersection{wxGrid::GetScrollLineX}\label{wxgridgetscrolllinex}
1035 \constfunc{int}{GetScrollLineX}{\void}
1037 Returns the number of pixels per horizontal scroll increment. The default is 15.
1039 \wxheading{See also}
1041 \helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp
1042 \helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp
1043 \helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney}
1047 \membersection{wxGrid::GetScrollLineY}\label{wxgridgetscrollliney}
1049 \constfunc{int}{GetScrollLineY}{\void}
1051 Returns the number of pixels per vertical scroll increment. The default is 15.
1053 \wxheading{See also}
1055 \helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp
1056 \helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex},\rtfsp
1057 \helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney}
1061 \membersection{wxGrid::GetSelectionMode}\label{wxgridgetselectionmode}
1063 \constfunc{wxGrid::wxGridSelectionModes}{GetSelectionMode}{\void}
1065 Returns the current selection mode, see \helpref{wxGrid::SetSelectionMode}{wxgridsetselectionmode}.
1069 \membersection{wxGrid::GetSelectedCells}\label{wxgridgetselectedcells}
1071 \constfunc{wxGridCellCoordsArray}{GetSelectedCells}{\void}
1073 Returns an array of singly selected cells.
1077 \membersection{wxGrid::GetSelectedCols}\label{wxgridgetselectedcols}
1079 \constfunc{wxArrayInt}{GetSelectedCols}{\void}
1081 Returns an array of selected cols.
1085 \membersection{wxGrid::GetSelectedRows}\label{wxgridgetselectedrows}
1087 \constfunc{wxArrayInt}{GetSelectedRows}{\void}
1089 Returns an array of selected rows.
1093 \membersection{wxGrid::GetSelectionBackground}\label{wxgridgetselectionbackground}
1095 \constfunc{wxColour}{GetSelectionBackground}{\void}
1097 Access or update the selection fore/back colours
1101 \membersection{wxGrid::GetSelectionBlockTopLeft}\label{wxgridgetselectionblocktopleft}
1103 \constfunc{wxGridCellCoordsArray}{GetSelectionBlockTopLeft}{\void}
1105 Returns an array of the top left corners of blocks of selected cells,
1106 see \helpref{wxGrid::GetSelectionBlockBottomRight}{wxgridgetselectionblockbottomright}.
1110 \membersection{wxGrid::GetSelectionBlockBottomRight}\label{wxgridgetselectionblockbottomright}
1112 \constfunc{wxGridCellCoordsArray}{GetSelectionBlockBottomRight}{\void}
1114 Returns an array of the bottom right corners of blocks of selected cells,
1115 see \helpref{wxGrid::GetSelectionBlockTopLeft}{wxgridgetselectionblocktopleft}.
1119 \membersection{wxGrid::GetSelectionForeground}\label{wxgridgetselectionforeground}
1121 \constfunc{wxColour}{GetSelectionForeground}{\void}
1125 \membersection{wxGrid::GetTable}\label{wxgridgettable}
1127 \constfunc{wxGridTableBase *}{GetTable}{\void}
1129 Returns a base pointer to the current table object.
1133 \membersection{wxGrid::GetViewWidth}\label{wxgridgetviewwidth}
1135 \constfunc{int}{GetViewWidth}{\void}
1137 Returned number of whole cols visible.
1141 \membersection{wxGrid::HideCellEditControl}\label{wxgridhidecelleditcontrol}
1143 \func{void}{HideCellEditControl}{\void}
1145 Hides the in-place cell edit control.
1149 \membersection{wxGrid::InitColWidths}\label{wxgridinitcolwidths}
1151 \func{void}{InitColWidths}{\void}
1153 Init the m\_colWidths/Rights arrays
1157 \membersection{wxGrid::InitRowHeights}\label{wxgridinitrowheights}
1159 \func{void}{InitRowHeights}{\void}
1161 NB: {\it never} access m\_row/col arrays directly because they are created
1162 on demand, {\it always} use accessor functions instead!
1164 Init the m\_rowHeights/Bottoms arrays with default values.
1168 \membersection{wxGrid::InsertCols}\label{wxgridinsertcols}
1170 \func{bool}{InsertCols}{\param{int }{pos = 0}, \param{int }{numCols = 1}, \param{bool }{updateLabels = true}}
1172 Inserts one or more new columns into a grid with the first new column at the
1173 specified position and returns true if successful. The updateLabels argument is not
1176 The sequence of actions begins with the grid object requesting the underlying grid
1177 table to insert new columns. If this is successful the table notifies the grid and the
1178 grid updates the display. For a default grid (one where you have called
1179 \helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are
1180 using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
1181 then you must override
1182 \helpref{wxGridTableBase::InsertCols}{wxgridtablebaseinsertcols} in your derived
1187 \membersection{wxGrid::InsertRows}\label{wxgridinsertrows}
1189 \func{bool}{InsertRows}{\param{int }{pos = 0}, \param{int }{numRows = 1}, \param{bool }{updateLabels = true}}
1191 Inserts one or more new rows into a grid with the first new row at the specified
1192 position and returns true if successful. The updateLabels argument is not used at
1195 The sequence of actions begins with the grid object requesting the underlying grid
1196 table to insert new rows. If this is successful the table notifies the grid and the
1197 grid updates the display. For a default grid (one where you have called
1198 \helpref{wxGrid::CreateGrid}{wxgridcreategrid}) this process is automatic. If you are
1199 using a custom grid table (specified with \helpref{wxGrid::SetTable}{wxgridsettable})
1200 then you must override
1201 \helpref{wxGridTableBase::InsertRows}{wxgridtablebaseinsertrows} in your derived
1206 \membersection{wxGrid::IsCellEditControlEnabled}\label{wxgridiscelleditcontrolenabled}
1208 \constfunc{bool}{IsCellEditControlEnabled}{\void}
1210 Returns true if the in-place edit control is currently enabled.
1214 \membersection{wxGrid::IsCurrentCellReadOnly}\label{wxgridiscurrentcellreadonly}
1216 \constfunc{bool}{IsCurrentCellReadOnly}{\void}
1218 Returns true if the current cell has been set to read-only
1219 (see \helpref{wxGrid::SetReadOnly}{wxgridsetreadonly}).
1223 \membersection{wxGrid::IsEditable}\label{wxgridiseditable}
1225 \constfunc{bool}{IsEditable}{\void}
1227 Returns false if the whole grid has been set as read-only or true otherwise.
1228 See \helpref{wxGrid::EnableEditing}{wxgridenableediting} for more information about
1229 controlling the editing status of grid cells.
1233 \membersection{wxGrid::IsInSelection}\label{wxgridisinselection}
1235 \constfunc{bool}{IsInSelection}{\param{int }{row}, \param{int }{col}}
1237 \constfunc{bool}{IsInSelection}{\param{const wxGridCellCoords\& }{coords}}
1239 Is this cell currently selected.
1243 \membersection{wxGrid::IsReadOnly}\label{wxgridisreadonly}
1245 \constfunc{bool}{IsReadOnly}{\param{int }{row}, \param{int }{col}}
1247 Returns true if the cell at the specified location can't be edited.
1248 See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}.
1252 \membersection{wxGrid::IsSelection}\label{wxgridisselection}
1254 \constfunc{bool}{IsSelection}{\void}
1256 Returns true if there are currently rows, columns or blocks of cells selected.
1260 \membersection{wxGrid::IsVisible}\label{wxgridisvisible}
1262 \constfunc{bool}{IsVisible}{\param{int }{row}, \param{int }{col}, \param{bool }{wholeCellVisible = true}}
1264 \constfunc{bool}{IsVisible}{\param{const wxGridCellCoords\& }{coords}, \param{bool }{wholeCellVisible = true}}
1266 Returns true if a cell is either wholly visible (the default) or at least partially
1267 visible in the grid window.
1271 \membersection{wxGrid::MakeCellVisible}\label{wxgridmakecellvisible}
1273 \func{void}{MakeCellVisible}{\param{int }{row}, \param{int }{col}}
1275 \func{void}{MakeCellVisible}{\param{const wxGridCellCoords\& }{coords}}
1277 Brings the specified cell into the visible grid cell area with minimal scrolling. Does
1278 nothing if the cell is already visible.
1282 \membersection{wxGrid::MoveCursorDown}\label{wxgridmovecursordown}
1284 \func{bool}{MoveCursorDown}{\param{bool }{expandSelection}}
1286 Moves the grid cursor down by one row. If a block of cells was previously selected it
1287 will expand if the argument is true or be cleared if the argument is false.
1289 \wxheading{Keyboard}\\
1290 This function is called for Down cursor key presses or Shift+Down to expand a selection.
1294 \membersection{wxGrid::MoveCursorLeft}\label{wxgridmovecursorleft}
1296 \func{bool}{MoveCursorLeft}{\param{bool }{expandSelection}}
1298 Moves the grid cursor left by one column. If a block of cells was previously selected it
1299 will expand if the argument is true or be cleared if the argument is false.
1301 \wxheading{Keyboard}\\
1302 This function is called for Left cursor key presses or Shift+Left to expand a selection.
1306 \membersection{wxGrid::MoveCursorRight}\label{wxgridmovecursorright}
1308 \func{bool}{MoveCursorRight}{\param{bool }{expandSelection}}
1310 Moves the grid cursor right by one column. If a block of cells was previously selected it
1311 will expand if the argument is true or be cleared if the argument is false.
1313 \wxheading{Keyboard}\\
1314 This function is called for Right cursor key presses or Shift+Right to expand a selection.
1318 \membersection{wxGrid::MoveCursorUp}\label{wxgridmovecursorup}
1320 \func{bool}{MoveCursorUp}{\param{bool }{expandSelection}}
1322 Moves the grid cursor up by one row. If a block of cells was previously selected it
1323 will expand if the argument is true or be cleared if the argument is false.
1325 \wxheading{Keyboard}\\
1326 This function is called for Up cursor key presses or Shift+Up to expand a selection.
1330 \membersection{wxGrid::MoveCursorDownBlock}\label{wxgridmovecursordownblock}
1332 \func{bool}{MoveCursorDownBlock}{\param{bool }{expandSelection}}
1334 Moves the grid cursor down in the current column such that it skips to the beginning or
1335 end of a block of non-empty cells. If a block of cells was previously selected it
1336 will expand if the argument is true or be cleared if the argument is false.
1338 \wxheading{Keyboard}\\
1339 This function is called for the Ctrl+Down key combination. Shift+Ctrl+Down expands a selection.
1343 \membersection{wxGrid::MoveCursorLeftBlock}\label{wxgridmovecursorleftblock}
1345 \func{bool}{MoveCursorLeftBlock}{\param{bool }{expandSelection}}
1347 Moves the grid cursor left in the current row such that it skips to the beginning or
1348 end of a block of non-empty cells. If a block of cells was previously selected it
1349 will expand if the argument is true or be cleared if the argument is false.
1351 \wxheading{Keyboard}\\
1352 This function is called for the Ctrl+Left key combination. Shift+Ctrl+left expands a selection.
1356 \membersection{wxGrid::MoveCursorRightBlock}\label{wxgridmovecursorrightblock}
1358 \func{bool}{MoveCursorRightBlock}{\param{bool }{expandSelection}}
1360 Moves the grid cursor right in the current row such that it skips to the beginning or
1361 end of a block of non-empty cells. If a block of cells was previously selected it
1362 will expand if the argument is true or be cleared if the argument is false.
1364 \wxheading{Keyboard}\\
1365 This function is called for the Ctrl+Right key combination. Shift+Ctrl+Right expands a selection.
1369 \membersection{wxGrid::MoveCursorUpBlock}\label{wxgridmovecursorupblock}
1371 \func{bool}{MoveCursorUpBlock}{\param{bool }{expandSelection}}
1373 Moves the grid cursor up in the current column such that it skips to the beginning or
1374 end of a block of non-empty cells. If a block of cells was previously selected it
1375 will expand if the argument is true or be cleared if the argument is false.
1377 \wxheading{Keyboard}\\
1378 This function is called for the Ctrl+Up key combination. Shift+Ctrl+Up expands a selection.
1382 \membersection{wxGrid::MovePageDown}\label{wxgridmovepagedown}
1384 \func{bool}{MovePageDown}{\void}
1386 Moves the grid cursor down by some number of rows so that the previous bottom visible row
1387 becomes the top visible row.
1389 \wxheading{Keyboard}\\
1390 This function is called for PgDn keypresses.
1394 \membersection{wxGrid::MovePageUp}\label{wxgridmovepageup}
1396 \func{bool}{MovePageUp}{\void}
1398 Moves the grid cursor up by some number of rows so that the previous top visible row
1399 becomes the bottom visible row.
1401 \wxheading{Keyboard}\\
1402 This function is called for PgUp keypresses.
1406 \membersection{wxGrid::RegisterDataType}\label{wxgridregisterdatatype}
1408 \func{void}{RegisterDataType}{\param{const wxString\& }{typeName}, \param{wxGridCellRenderer* }{renderer}, \param{wxGridCellEditor* }{editor}}
1410 Methods for a registry for mapping data types to Renderers/Editors
1414 \membersection{wxGrid::SaveEditControlValue}\label{wxgridsaveeditcontrolvalue}
1416 \func{void}{SaveEditControlValue}{\void}
1418 Sets the value of the current grid cell to the current in-place edit control value.
1419 This is called automatically when the grid cursor moves from the current cell to a
1420 new cell. It is also a good idea to call this function when closing a grid since
1421 any edits to the final cell location will not be saved otherwise.
1425 \membersection{wxGrid::SelectAll}\label{wxgridselectall}
1427 \func{void}{SelectAll}{\void}
1429 Selects all cells in the grid.
1433 \membersection{wxGrid::SelectBlock}\label{wxgridselectblock}
1435 \func{void}{SelectBlock}{\param{int }{topRow}, \param{int }{leftCol},
1436 \param{int }{bottomRow}, \param{int }{rightCol}, \param{bool }{addToSelected = false}}
1438 \func{void}{SelectBlock}{\param{const wxGridCellCoords\& }{topLeft},
1439 \param{const wxGridCellCoords\& }{bottomRight}, \param{bool }{addToSelected = false}}
1441 Selects a rectangular block of cells. If addToSelected is false then any existing selection will be
1442 deselected; if true the column will be added to the existing selection.
1446 \membersection{wxGrid::SelectCol}\label{wxgridselectcol}
1448 \func{void}{SelectCol}{\param{int }{col}, \param{bool }{addToSelected = false}}
1450 Selects the specified column. If addToSelected is false then any existing selection will be
1451 deselected; if true the column will be added to the existing selection.
1455 \membersection{wxGrid::SelectionToDeviceRect}\label{wxgridselectiontodevicerect}
1457 \constfunc{wxRect}{SelectionToDeviceRect}{\void}
1459 This function returns the rectangle that encloses the selected cells
1460 in device coords and clipped to the client size of the grid window.
1464 \membersection{wxGrid::SelectRow}\label{wxgridselectrow}
1466 \func{void}{SelectRow}{\param{int }{row}, \param{bool }{addToSelected = false}}
1468 Selects the specified row. If addToSelected is false then any existing selection will be
1469 deselected; if true the row will be added to the existing selection.
1473 \membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment}
1475 \func{void}{SetCellAlignment}{\param{int }{row}, \param{int }{col}, \param{int }{horiz}, \param{int }{vert}}
1477 \func{void}{SetCellAlignment}{\param{int }{align}, \param{int }{row}, \param{int }{col}}
1479 Sets the horizontal and vertical alignment for grid cell text at the specified location.
1481 Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT. \\
1482 Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
1486 \membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
1488 \func{void}{SetCellBackgroundColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}
1492 \membersection{wxGrid::SetCellEditor}\label{wxgridsetcelleditor}
1494 \func{void}{SetCellEditor}{\param{int }{row}, \param{int }{col}, \param{wxGridCellEditor* }{editor}}
1496 Sets the editor for the grid cell at the specified location.
1497 The grid will take ownership of the pointer.
1499 See \helpref{wxGridCellEditor}{wxgridcelleditor} and
1500 the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
1504 \membersection{wxGrid::SetCellFont}\label{wxgridsetcellfont}
1506 \func{void}{SetCellFont}{\param{int }{row}, \param{int }{col}, \param{const wxFont\&}{ font}}
1508 Sets the font for text in the grid cell at the specified location.
1512 \membersection{wxGrid::SetCellRenderer}\label{wxgridsetcellrenderer}
1514 \func{void}{SetCellRenderer}{\param{int }{row}, \param{int }{col}, \param{wxGridCellRenderer* }{renderer}}
1516 Sets the renderer for the grid cell at the specified location.
1517 The grid will take ownership of the pointer.
1519 See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
1520 the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
1524 \membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
1526 \func{void}{SetCellTextColour}{\param{int }{row}, \param{int }{col}, \param{const wxColour\&}{ colour}}
1528 \func{void}{SetCellTextColour}{\param{const wxColour\& }{val}, \param{int }{row}, \param{int }{col}}
1530 \func{void}{SetCellTextColour}{\param{const wxColour\& }{colour}}
1532 Sets the text colour for the grid cell at the specified location.
1536 \membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
1538 \func{void}{SetCellValue}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{s}}
1540 \func{void}{SetCellValue}{\param{const wxGridCellCoords\& }{coords}, \param{const wxString\& }{s}}
1542 \func{void}{SetCellValue}{\param{const wxString\& }{val}, \param{int }{row}, \param{int }{col}}
1544 Sets the string value for the cell at the specified location. For simple applications where a
1545 grid object automatically uses a default grid table of string values you use this function together
1546 with \helpref{wxGrid::GetCellValue}{wxgridgetcellvalue} to access cell values.
1548 For more complex applications where you have derived your own grid table class that contains
1549 various data types (e.g. numeric, boolean or user-defined custom types) then you only use this
1550 function for those cells that contain string values.
1552 The last form is for backward compatibility only.
1554 See \helpref{wxGridTableBase::CanSetValueAs}{wxgridtablebasecangetvalueas}
1555 and the \helpref{wxGrid overview}{gridoverview} for more information.
1559 \membersection{wxGrid::SetColAttr}\label{wxgridsetcolattr}
1561 \func{void}{SetColAttr}{\param{int }{col}, \param{wxGridCellAttr* }{attr}}
1563 Sets the cell attributes for all cells in the specified column.
1565 For more information about controlling grid cell attributes see the
1566 \helpref{wxGridCellAttr}{wxgridcellattr} cell attribute class and the
1567 \helpref{wxGrid classes overview}{gridoverview}.
1571 \membersection{wxGrid::SetColFormatBool}\label{wxgridsetcolformatbool}
1573 \func{void}{SetColFormatBool}{\param{int }{col}}
1575 Sets the specified column to display boolean values. wxGrid displays boolean values with a checkbox.
1579 \membersection{wxGrid::SetColFormatNumber}\label{wxgridsetcolformatnumber}
1581 \func{void}{SetColFormatNumber}{\param{int }{col}}
1583 Sets the specified column to display integer values.
1587 \membersection{wxGrid::SetColFormatFloat}\label{wxgridsetcolformatfloat}
1589 \func{void}{SetColFormatFloat}{\param{int }{col}, \param{int }{width = -1}, \param{int }{precision = -1}}
1591 Sets the specified column to display floating point values with the given width and precision.
1595 \membersection{wxGrid::SetColFormatCustom}\label{wxgridsetcolformatcustom}
1597 \func{void}{SetColFormatCustom}{\param{int }{col}, \param{const wxString\& }{typeName}}
1599 Sets the specified column to display data in a custom format.
1600 See the \helpref{wxGrid overview}{gridoverview} for more information on working
1601 with custom data types.
1605 \membersection{wxGrid::SetColLabelAlignment}\label{wxgridsetcollabelalignment}
1607 \func{void}{SetColLabelAlignment}{\param{int }{horiz}, \param{int }{vert}}
1609 Sets the horizontal and vertical alignment of column label text.
1611 Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
1613 Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
1617 \membersection{wxGrid::SetColLabelSize}\label{wxgridsetcollabelsize}
1619 \func{void}{SetColLabelSize}{\param{int }{height}}
1621 Sets the height of the column labels.
1623 If \arg{height} equals to \texttt{wxGRID\_AUTOSIZE} then height is calculated automatically
1624 so that no label is truncated. Note that this could be slow for a large table.
1628 \membersection{wxGrid::SetColLabelValue}\label{wxgridsetcollabelvalue}
1630 \func{void}{SetColLabelValue}{\param{int }{col}, \param{const wxString\&}{ value}}
1632 Set the value for the given column label. If you are using a derived grid table you must
1633 override \helpref{wxGridTableBase::SetColLabelValue}{wxgridtablebasesetcollabelvalue}
1634 for this to have any effect.
1638 \membersection{wxGrid::SetColMinimalWidth}\label{wxgridsetcolminimalwidth}
1640 \func{void}{SetColMinimalWidth}{\param{int }{col}, \param{int }{width}}
1642 Sets the minimal width for the specified column. This should normally be called when creating the grid
1643 because it will not resize a column that is already narrower than the minimal width.
1644 The width argument must be higher than the minimimal acceptable column width, see
1645 \helpref{wxGrid::GetColMinimalAcceptableWidth}{wxgridgetcolminimalacceptablewidth}.
1649 \membersection{wxGrid::SetColMinimalAcceptableWidth}\label{wxgridsetcolminimalacceptablewidth}
1651 \func{void}{SetColMinimalAcceptableWidth}{\param{int }{width}}
1653 This modifies the minimum column width that can be handled correctly. Specifying a low value here
1654 allows smaller grid cells to be dealt with correctly. Specifying a value here which is much smaller
1655 than the actual minimum size will incur a performance penalty in the functions which perform
1656 grid cell index lookup on the basis of screen coordinates.
1657 This should normally be called when creating the grid because it will not resize existing columns
1658 with sizes smaller than the value specified here.
1662 \membersection{wxGrid::SetColPos}\label{wxgridsetcolpos}
1664 \func{void}{SetColPos}{\param{int }{colID}, \param{int }{newPos}}
1666 Sets the position of the specified column.
1670 \membersection{wxGrid::SetColSize}\label{wxgridsetcolsize}
1672 \func{void}{SetColSize}{\param{int }{col}, \param{int }{width}}
1674 Sets the width of the specified column.
1676 This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch
1677 block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes.
1679 Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will
1680 also be set as the minimal width for the column.
1683 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
1684 The memory requirements for this could become prohibitive if your grid is very large.
1688 \membersection{wxGrid::SetDefaultCellAlignment}\label{wxgridsetdefaultcellalignment}
1690 \func{void}{SetDefaultCellAlignment}{\param{int }{horiz}, \param{int }{vert}}
1692 Sets the default horizontal and vertical alignment for grid cell text.
1694 Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
1696 Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
1700 \membersection{wxGrid::SetDefaultCellBackgroundColour}\label{wxgridsetdefaultcellbackgroundcolour}
1702 \func{void}{SetDefaultCellBackgroundColour}{\param{const wxColour\&}{ colour}}
1704 Sets the default background colour for grid cells.
1708 \membersection{wxGrid::SetDefaultCellFont}\label{wxgridsetdefaultcellfont}
1710 \func{void}{SetDefaultCellFont}{\param{const wxFont\&}{ font}}
1712 Sets the default font to be used for grid cell text.
1716 \membersection{wxGrid::SetDefaultCellTextColour}\label{wxgridsetdefaultcelltextcolour}
1718 \func{void}{SetDefaultCellTextColour}{\param{const wxColour\&}{ colour}}
1720 Sets the current default colour for grid cell text.
1724 \membersection{wxGrid::SetDefaultEditor}\label{wxgridsetdefaulteditor}
1726 \func{void}{SetDefaultEditor}{\param{wxGridCellEditor* }{editor}}
1728 Sets the default editor for grid cells. The grid will take ownership of the pointer.
1730 See \helpref{wxGridCellEditor}{wxgridcelleditor} and
1731 the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
1735 \membersection{wxGrid::SetDefaultRenderer}\label{wxgridsetdefaultrenderer}
1737 \func{void}{SetDefaultRenderer}{\param{wxGridCellRenderer* }{renderer}}
1739 Sets the default renderer for grid cells. The grid will take ownership of the pointer.
1741 See \helpref{wxGridCellRenderer}{wxgridcellrenderer} and
1742 the \helpref{wxGrid overview}{gridoverview} for more information about cell editors and renderers.
1746 \membersection{wxGrid::SetDefaultColSize}\label{wxgridsetdefaultcolsize}
1748 \func{void}{SetDefaultColSize}{\param{int }{width}, \param{bool }{resizeExistingCols = false}}
1750 Sets the default width for columns in the grid. This will only affect columns subsequently added to
1751 the grid unless resizeExistingCols is true.
1755 \membersection{wxGrid::SetDefaultRowSize}\label{wxgridsetdefaultrowsize}
1757 \func{void}{SetDefaultRowSize}{\param{int }{height}, \param{bool }{resizeExistingRows = false}}
1759 Sets the default height for rows in the grid. This will only affect rows subsequently added
1760 to the grid unless resizeExistingRows is true.
1764 \membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
1766 \func{void}{SetGridCursor}{\param{int }{row}, \param{int }{col}}
1768 Set the grid cursor to the specified cell.
1769 This function calls \helpref{wxGrid::MakeCellVisible}{wxgridmakecellvisible}.
1773 \membersection{wxGrid::SetGridLineColour}\label{wxgridsetgridlinecolour}
1775 \func{void}{SetGridLineColour}{\param{const wxColour\&}{colour}}
1777 Sets the colour used to draw grid lines.
1781 \membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
1783 \func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ colour}}
1785 Sets the background colour for row and column labels.
1789 \membersection{wxGrid::SetLabelFont}\label{wxgridsetlabelfont}
1791 \func{void}{SetLabelFont}{\param{const wxFont\&}{ font}}
1793 Sets the font for row and column labels.
1797 \membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
1799 \func{void}{SetLabelTextColour}{\param{const wxColour\&}{ colour}}
1801 Sets the colour for row and column label text.
1805 \membersection{wxGrid::SetMargins}\label{wxgridsetmargins}
1807 \func{void}{SetMargins}{\param{int }{extraWidth}, \param{int }{extraHeight}}
1809 A grid may occupy more space than needed for its rows/columns. This
1810 function allows to set how big this extra space is
1814 \membersection{wxGrid::SetOrCalcColumnSizes}\label{wxgridsetorcalccolumnsizes}
1816 \func{int}{SetOrCalcColumnSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}}
1818 Common part of AutoSizeColumn/Row() and GetBestSize()
1822 \membersection{wxGrid::SetOrCalcRowSizes}\label{wxgridsetorcalcrowsizes}
1824 \func{int}{SetOrCalcRowSizes}{\param{bool }{calcOnly}, \param{bool }{setAsMin = true}}
1828 \membersection{wxGrid::SetReadOnly}\label{wxgridsetreadonly}
1830 \func{void}{SetReadOnly}{\param{int }{row}, \param{int }{col}, \param{bool }{isReadOnly = true}}
1832 Makes the cell at the specified location read-only or editable.
1833 See also \helpref{wxGrid::IsReadOnly}{wxgridisreadonly}.
1837 \membersection{wxGrid::SetRowAttr}\label{wxgridsetrowattr}
1839 \func{void}{SetRowAttr}{\param{int }{row}, \param{wxGridCellAttr* }{attr}}
1841 Sets the cell attributes for all cells in the specified row.
1842 See the \helpref{wxGridCellAttr}{wxgridcellattr} class for more information
1843 about controlling cell attributes.
1847 \membersection{wxGrid::SetRowLabelAlignment}\label{wxgridsetrowlabelalignment}
1849 \func{void}{SetRowLabelAlignment}{\param{int }{horiz}, \param{int }{vert}}
1851 Sets the horizontal and vertical alignment of row label text.
1853 Horizontal alignment should be one of wxALIGN\_LEFT, wxALIGN\_CENTRE or wxALIGN\_RIGHT.
1855 Vertical alignment should be one of wxALIGN\_TOP, wxALIGN\_CENTRE or wxALIGN\_BOTTOM.
1859 \membersection{wxGrid::SetRowLabelSize}\label{wxgridsetrowlabelsize}
1861 \func{void}{SetRowLabelSize}{\param{int }{width}}
1863 Sets the width of the row labels.
1865 If \arg{width} equals \texttt{wxGRID\_AUTOSIZE} then width is calculated automatically
1866 so that no label is truncated. Note that this could be slow for a large table.
1870 \membersection{wxGrid::SetRowLabelValue}\label{wxgridsetrowlabelvalue}
1872 \func{void}{SetRowLabelValue}{\param{int }{row}, \param{const wxString\&}{ value}}
1874 Set the value for the given row label. If you are using a derived grid table you must
1875 override \helpref{wxGridTableBase::SetRowLabelValue}{wxgridtablebasesetrowlabelvalue}
1876 for this to have any effect.
1880 \membersection{wxGrid::SetRowMinimalHeight}\label{wxgridsetrowminimalheight}
1882 \func{void}{SetRowMinimalHeight}{\param{int }{row}, \param{int }{height}}
1884 Sets the minimal height for the specified row. This should normally be called when creating the grid
1885 because it will not resize a row that is already shorter than the minimal height.
1886 The height argument must be higher than the minimimal acceptable row height, see
1887 \helpref{wxGrid::GetRowMinimalAcceptableHeight}{wxgridgetrowminimalacceptableheight}.
1891 \membersection{wxGrid::SetRowMinimalAcceptableHeight}\label{wxgridsetrowminimalacceptableheight}
1893 \func{void}{SetRowMinimalAcceptableHeight}{\param{int }{height}}
1895 This modifies the minimum row width that can be handled correctly. Specifying a low value here
1896 allows smaller grid cells to be dealt with correctly. Specifying a value here which is much smaller
1897 than the actual minimum size will incur a performance penalty in the functions which perform
1898 grid cell index lookup on the basis of screen coordinates.
1899 This should normally be called when creating the grid because it will not resize existing rows
1900 with sizes smaller than the value specified here.
1904 \membersection{wxGrid::SetRowSize}\label{wxgridsetrowsize}
1906 \func{void}{SetRowSize}{\param{int }{row}, \param{int }{height}}
1908 Sets the height of the specified row.
1910 This function does not refresh the grid. If you are calling it outside of a BeginBatch / EndBatch
1911 block you can use \helpref{wxGrid::ForceRefresh}{wxgridforcerefresh} to see the changes.
1913 Automatically sizes the column to fit its contents. If setAsMin is true the calculated width will
1914 also be set as the minimal width for the column.
1918 wxGrid sets up arrays to store individual row and column sizes when non-default sizes are used.
1919 The memory requirements for this could become prohibitive if your grid is very large.
1923 \membersection{wxGrid::SetScrollLineX}\label{wxgridsetscrolllinex}
1925 \func{void}{SetScrollLineX}{\param{int }{x}}
1927 Sets the number of pixels per horizontal scroll increment. The default is 15.
1928 Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
1929 errors: setting this to 1 can help.
1931 \wxheading{See also}
1933 \helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp
1934 \helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp
1935 \helpref{wxGrid::SetScrollLineY}{wxgridsetscrollliney}
1939 \membersection{wxGrid::SetScrollLineY}\label{wxgridsetscrollliney}
1941 \func{void}{SetScrollLineY}{\param{int }{y}}
1943 Sets the number of pixels per vertical scroll increment. The default is 15.
1944 Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
1945 errors: setting this to 1 can help.
1947 \wxheading{See also}
1949 \helpref{wxGrid::GetScrollLineX}{wxgridgetscrolllinex},\rtfsp
1950 \helpref{wxGrid::GetScrollLineY}{wxgridgetscrollliney},\rtfsp
1951 \helpref{wxGrid::SetScrollLineX}{wxgridsetscrolllinex}
1955 \membersection{wxGrid::SetSelectionBackground}\label{wxgridsetselectionbackground}
1957 \func{void}{SetSelectionBackground}{\param{const wxColour\& }{c}}
1961 \membersection{wxGrid::SetSelectionForeground}\label{wxgridsetselectionforeground}
1963 \func{void}{SetSelectionForeground}{\param{const wxColour\& }{c}}
1967 \membersection{wxGrid::SetSelectionMode}\label{wxgridsetselectionmode}
1969 \func{void}{SetSelectionMode}{\param{wxGrid::wxGridSelectionModes}{ selmode}}
1971 Set the selection behaviour of the grid.
1973 \wxheading{Parameters}
1975 \docparam{wxGrid::wxGridSelectCells}{The default mode where individual cells are selected.}
1977 \docparam{wxGrid::wxGridSelectRows}{Selections will consist of whole rows.}
1979 \docparam{wxGrid::wxGridSelectColumns}{Selections will consist of whole columns.}
1983 \membersection{wxGrid::SetTable}\label{wxgridsettable}
1985 \func{bool}{SetTable}{\param{wxGridTableBase* }{table}, \param{bool }{takeOwnership = false}, \param{wxGrid::wxGridSelectionModes }{selmode = wxGrid::wxGridSelectCells}}
1987 Passes a pointer to a custom grid table to be used by the grid. This should be called
1988 after the grid constructor and before using the grid object. If takeOwnership is set to
1989 true then the table will be deleted by the wxGrid destructor.
1991 Use this function instead of \helpref{wxGrid::CreateGrid}{wxgridcreategrid} when your
1992 application involves complex or non-string data or data sets that are too large to fit
1997 \membersection{wxGrid::ShowCellEditControl}\label{wxgridshowcelleditcontrol}
1999 \func{void}{ShowCellEditControl}{\void}
2001 Displays the in-place cell edit control for the current cell.
2005 \membersection{wxGrid::XToCol}\label{wxgridxtocol}
2007 \constfunc{int}{XToCol}{\param{int }{x}, \param{bool }{clipToMinMax = false}}
2009 \wxheading{Parameters}
2010 \docparam{x}{The x position to evaluate.}
2011 \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.}
2013 \wxheading{Return value}
2014 The grid column that corresponds to the logical x coordinate. Returns
2015 {\tt wxNOT\_FOUND} if there is no column at the x position.
2019 \membersection{wxGrid::XToEdgeOfCol}\label{wxgridxtoedgeofcol}
2021 \constfunc{int}{XToEdgeOfCol}{\param{int }{x}}
2023 Returns the column whose right hand edge is close to the given logical x position.
2024 If no column edge is near to this position {\tt wxNOT\_FOUND} is returned.
2028 \membersection{wxGrid::YToEdgeOfRow}\label{wxgridytoedgeofrow}
2030 \constfunc{int}{YToEdgeOfRow}{\param{int }{y}}
2032 Returns the row whose bottom edge is close to the given logical y position.
2033 If no row edge is near to this position {\tt wxNOT\_FOUND} is returned.
2037 \membersection{wxGrid::YToRow}\label{wxgridytorow}
2039 \constfunc{int}{YToRow}{\param{int }{y}}
2041 Returns the grid row that corresponds to the logical y coordinate. Returns
2042 {\tt wxNOT\_FOUND} if there is no row at the y position.
projects / wxWidgets.git / blob