]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/grid.tex
More wxPython docs...
[wxWidgets.git] / docs / latex / wx / grid.tex
1 \section{\class{wxGrid}}\label{wxgrid}
2
3 wxGrid is a class for displaying and editing tabular information.
4
5 \wxheading{Derived from}
6
7 \helpref{wxPanel}{wxpanel}\\
8 \helpref{wxWindow}{wxwindow}\\
9 \helpref{wxEvtHandler}{wxevthandler}\\
10 \helpref{wxObject}{wxobject}
11
12 \wxheading{Include files}
13
14 <wx/grid.h>
15
16 \wxheading{Window styles}
17
18 There are no specific window styles for this class.
19
20 See also \helpref{window styles overview}{windowstyles}.
21
22 \wxheading{See also}
23
24 \helpref{wxGrid classes overview}{gridoverview}
25
26 \latexignore{\rtfignore{\wxheading{Members}}}
27
28 \membersection{wxGrid::wxGrid}\label{wxgridconstr}
29
30 \func{void}{wxGrid}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxPoint\&}{ pos},
31 \rtfsp\param{const wxSize\&}{ size}, \param{long}{ style=0}, \param{const wxString\& }{name="grid"}}
32
33 Constructor. Before using a wxGrid object, you must call CreateGrid to set up the required rows and columns.
34
35 \membersection{wxGrid::AdjustScrollbars}\label{wxgridadjustscrollbars}
36
37 \func{void}{AdjustScrollbars}{\void}
38
39 Call this function whenever a change has been made via the API that might alter the scrollbar characteristics:
40 particularly when adding or deleting rows, or changing row or column dimensions. For example,
41 removing rows might make it unnecessary to show the vertical scrollbar.
42
43 \membersection{wxGrid::AppendCols}\label{wxgridappendcols}
44
45 \func{bool}{AppendCols}{\param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}}
46
47 Appends {\it n} columns to the grid. If {\it updateLabels} is TRUE,
48 the function OnChangeLabels is called to give the application the opportunity to relabel.
49
50 \membersection{wxGrid::AppendRows}\label{wxgridappendrows}
51
52 \func{bool}{AppendRows}{\param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}}
53
54 Appends {\it n} rows to the grid. If {\it updateLabels} is TRUE,
55 the function OnChangeLabels is called to give the application the opportunity to relabel.
56
57 \membersection{wxGrid::BeginBatch}\label{wxgridbeginbatch}
58
59 \func{void}{BeginBatch}{\void}
60
61 Start a BeginBatch/EndBatch pair between which, calls to SetCellValue or
62 SetCellBitmap will not cause a refresh. This allows you to speed up some operations
63 (for example, setting several hundred cell values). You can nest, but not overlap,
64 these two functions.
65
66 See also \helpref{wxGrid::EndBatch}{wxgridendbatch}, \helpref{wxGrid::GetBatchCount}{wxgridgetbatchcount}.
67
68 \membersection{wxGrid::CellHitTest}\label{wxgridcellhittest}
69
70 \func{bool}{CellHitTest}{\param{int}{ x}, \param{int}{ y}, \param{int *}{row}, \param{int *}{col}}
71
72 Returns TRUE if the x, y panel position coincides with a cell. If so, {\it row} and {\it col} are
73 returned.
74
75 \membersection{wxGrid::CreateGrid}\label{wxgridcreategrid}
76
77 \func{bool}{CreateGrid}{\param{int}{ rows}, \param{int}{ cols}, \param{wxString **}{cellValues=NULL},
78 \param{short *}{widths=NULL}, \param{short}{ defaultWidth=wxGRID\_DEFAULT\_CELL\_WIDTH},
79 \param{short}{ defaultHeight=wxGRID\_DEFAULT\_CELL\_HEIGHT}}
80
81 Creates a grid {\it rows} high and {\it cols} wide. You can optionally specify an array of initial values
82 and widths, and/or default cell width and height.
83
84 Call this function after creating the wxGrid object.
85
86 \pythonnote{Currently the \tt{cellValues} and \tt{widths} parameters
87 don't exisit in the wxPython version of this method. So in other
88 words, the definition of the wxPython version of this method looks like this:
89 \begin{verbatim}
90 CreateGrid(rows, cols,
91 defaultWidth = wxGRID_DEFAULT_CELL_WIDTH,
92 defaultHeight = wxGRID_DEFAULT_CELL_HEIGHT)
93 \end{verbatim}
94 }
95
96 \membersection{wxGrid::CurrentCellVisible}\label{wxgridcurrentcellvisible}
97
98 \func{bool}{CurrentCellVisible}{\void}
99
100 Returns TRUE if the currently selected cell is visible, FALSE otherwise.
101
102 \membersection{wxGrid::DeleteCols}\label{wxgriddeletecols}
103
104 \func{bool}{DeleteCols}{\param{int}{ pos=0}, \param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}}
105
106 Deletes {\it n} columns from the grid at position {\it pos}. If {\it updateLabels} is TRUE,
107 the function OnChangeLabels is called to give the application the opportunity to relabel.
108
109 \membersection{wxGrid::DeleteRows}\label{wxgriddeleterows}
110
111 \func{bool}{DeleteRows}{\param{int}{ pos=0}, \param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}}
112
113 Deletes {\it n} rows from the grid at position {\it pos}. If {\it updateLabels} is TRUE,
114 the function OnChangeLabels is called to give the application the opportunity to relabel.
115
116 \membersection{wxGrid::EndBatch}\label{wxgridendbatch}
117
118 \func{void}{EndBatch}{\void}
119
120 End a BeginBatch/EndBatch pair between which, calls to SetCellValue or
121 SetCellBitmap will not cause a refresh. This allows you to speed up some operations
122 (for example, setting several hundred cell values). You can nest, but not overlap,
123 these two functions.
124
125 See also \helpref{wxGrid::BeginBatch}{wxgridbeginbatch}, \helpref{wxGrid::GetBatchCount}{wxgridgetbatchcount}.
126
127 \membersection{wxGrid::GetBatchCount}\label{wxgridgetbatchcount}
128
129 \constfunc{int}{GetBatchCount}{\void}
130
131 Return the level of batch nesting. This is initially zero, and will be incremented
132 every time BeginBatch is called, and decremented when EndBatch is called. When the
133 batch count is more zero, some functions (such as SetCellValue and SetCellBitmap) will
134 not refresh the cell.
135
136 See also \helpref{wxGrid::BeginBatch}{wxgridbeginbatch}, \helpref{wxGrid::EndBatch}{wxgridendbatch}.
137
138 \membersection{wxGrid::GetCell}\label{wxgridgetcell}
139
140 \constfunc{wxGridCell *}{GetCell}{\param{int}{ row}, \param{int}{ col}}
141
142 Returns the grid cell object associated with this position.
143
144 wxGenericGrid implementation only.
145
146 \membersection{wxGrid::GetCellAlignment}\label{wxgridgetcellalignment}
147
148 \constfunc{int}{GetCellAlignment}{\param{int}{ row}, \param{int}{ col}}
149
150 \constfunc{int}{GetCellAlignment}{\void}
151
152 Sets the text alignment for the cell at the given position, or the global alignment value.
153 The return value is wxLEFT, wxRIGHT or wxCENTRE.
154
155 \pythonnote{In place of a single overloaded method name, wxPython
156 implements the following methods:\par
157 \indented{2cm}{\begin{twocollist}
158 \twocolitem{\bf{GetCellAlignment(row, col)}}{}
159 \twocolitem{\bf{GetDefCellAlignment()}}{}
160 \end{twocollist}}
161 }
162
163 \membersection{wxGrid::GetCellBackgroundColour}\label{wxgridgetcellbackgroundcolour}
164
165 \constfunc{wxColour\&}{GetCellBackgroundColour}{\param{int}{ row}, \param{int}{ col}}
166
167 \constfunc{wxColour\&}{GetCellBackgroundColour}{\void}
168
169 Gets the background colour for the cell at the given position, or the global background colour.
170
171 \pythonnote{In place of a single overloaded method name, wxPython
172 implements the following methods:\par
173 \indented{2cm}{\begin{twocollist}
174 \twocolitem{\bf{GetCellBackgroundColour(row, col)}}{}
175 \twocolitem{\bf{GetDefCellBackgroundColourt()}}{}
176 \end{twocollist}}
177 }
178
179 \membersection{wxGrid::GetCells}\label{wxgridgetcells}
180
181 \constfunc{wxGridCell ***}{GetCells}{\void}
182
183 Returns the array of grid cell object associated with this wxGrid.
184
185 \membersection{wxGrid::GetCellTextColour}\label{wxgridgetcelltextcolour}
186
187 \constfunc{wxColour\&}{GetCellTextColour}{\param{int}{ row}, \param{int}{ col}}
188
189 \constfunc{wxColour\&}{GetCellTextColour}{\void}
190
191 Gets the text colour for the cell at the given position, or the global text colour.
192
193 \pythonnote{In place of a single overloaded method name, wxPython
194 implements the following methods:\par
195 \indented{2cm}{\begin{twocollist}
196 \twocolitem{\bf{GetCellTextColour(row, col)}}{}
197 \twocolitem{\bf{GetDefCellTextColour()}}{}
198 \end{twocollist}}
199 }
200
201 \membersection{wxGrid::GetCellTextFont}\label{wxgridgetcelltextfont}
202
203 \constfunc{const wxFont\&}{GetCellTextFont}{\param{int}{ row}, \param{int}{ col}}
204
205 \constfunc{wxFont\&}{GetCellTextFont}{\void}
206
207 Gets the text font for the cell at the given position, or the global text font.
208
209 \pythonnote{In place of a single overloaded method name, wxPython
210 implements the following methods:\par
211 \indented{2cm}{\begin{twocollist}
212 \twocolitem{\bf{GetCellTextFont(row, col)}}{}
213 \twocolitem{\bf{GetDefCellTextFont()}}{}
214 \end{twocollist}}
215 }
216
217 \membersection{wxGrid::GetCellValue}\label{wxgridgetcellvalue}
218
219 \constfunc{wxString\&}{GetCellValue}{\param{int}{ row}, \param{int}{ col}}
220
221 Returns the cell value at the given position.
222
223 \membersection{wxGrid::GetCols}\label{wxgridgetcols}
224
225 \constfunc{int}{GetCols}{\void}
226
227 Returns the number of columns in the grid.
228
229 \membersection{wxGrid::GetColumnWidth}\label{wxgridcolumnwidth}
230
231 \constfunc{int}{GetColumnWidth}{\param{int}{ col}}
232
233 Gets the width in pixels for column {\it col}.
234
235 \membersection{wxGrid::GetCurrentRect}\label{wxgridgetcurrentrect}
236
237 \constfunc{wxRectangle *}{GetCurrentRect}{\void}
238
239 Returns a pointer to the rectangle enclosing the currently selected cell.
240 Do not delete this pointer.
241
242 \membersection{wxGrid::GetCursorColumn}\label{wxgridgetcursorcolumn}
243
244 \constfunc{int}{GetCursorColumn}{\void}
245
246 Returns the column position of the currently selected cell.
247
248 \membersection{wxGrid::GetCursorRow}\label{wxgridgetcursorrow}
249
250 \constfunc{int}{GetCursorRow}{\void}
251
252 Returns the row position of the currently selected cell.
253
254 \membersection{wxGrid::GetEditable}\label{wxgridgeteditable}
255
256 \constfunc{bool}{GetEditable}{\void}
257
258 Returns TRUE if the grid cells can be edited.
259
260 \membersection{wxGrid::GetHorizScrollBar}\label{wxgridgethorizscrollbar}
261
262 \constfunc{wxScrollBar *}{GetHorizScrollBar}{\void}
263
264 Returns a pointer to the horizontal scrollbar.
265
266 \membersection{wxGrid::GetLabelAlignment}\label{wxgridgetlabelalignment}
267
268 \constfunc{int}{GetLabelAlignment}{\param{int}{ orientation}}
269
270 Gets the row or column label alignment. {\it orientation} should
271 be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
272 {\it alignment} should be wxCENTRE, wxLEFT or wxRIGHT.
273
274 \membersection{wxGrid::GetLabelBackgroundColour}\label{wxgridgetlabelbackgroundcolour}
275
276 \constfunc{wxColour\&}{GetLabelBackgroundColour}{\void}
277
278 Gets a row and column label text colour.
279
280 \membersection{wxGrid::GetLabelSize}\label{wxgridgetlabelsize}
281
282 \constfunc{int}{GetLabelSize}{\param{int}{ orientation}}
283
284 Gets the row label height, or column label width, in pixels. {\it orientation} should
285 be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.
286
287 \membersection{wxGrid::GetLabelTextColour}\label{wxgridgetlabeltextcolour}
288
289 \constfunc{wxColour\&}{GetLabelTextColour}{\void}
290
291 Gets a row and column label text colour.
292
293 \membersection{wxGrid::GetLabelTextFont}\label{wxgridgetlabeltextfont}
294
295 \constfunc{wxFont\&}{GetLabelTextFont}{\void}
296
297 Gets the font to be used for the row and column labels.
298
299 \membersection{wxGrid::GetLabelValue}\label{wxgridgetlabelvalue}
300
301 \constfunc{wxString\&}{GetLabelValue}{\param{int}{ orientation}, \param{int}{ pos}}
302
303 Gets a row or column label value. {\it orientation} should
304 be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
305 {\it pos} is the label position.
306
307 \membersection{wxGrid::GetRowHeight}\label{wxgridgetrowheight}
308
309 \constfunc{int}{GetRowHeight}{\param{int}{ row}}
310
311 Gets the height in pixels for row {\it row}.
312
313 \membersection{wxGrid::GetRows}\label{wxgridgetrows}
314
315 \constfunc{int}{GetRows}{\void}
316
317 Returns the number of rows in the grid.
318
319 \membersection{wxGrid::GetScrollPosX}\label{wxgridgetscrollposx}
320
321 \constfunc{int}{GetScrollPosX}{\void}
322
323 Returns the column scroll position.
324
325 \membersection{wxGrid::GetScrollPosY}\label{wxgridgetscrollposy}
326
327 \constfunc{int}{GetScrollPosY}{\void}
328
329 Returns the row scroll position.
330
331 \membersection{wxGrid::GetTextItem}\label{wxgridgettextitem}
332
333 \constfunc{wxText *}{GetTextItem}{\void}
334
335 Returns a pointer to the text item used for entering text into a cell.
336
337 \membersection{wxGrid::GetVertScrollBar}\label{wxgridgetvertscrollbar}
338
339 \constfunc{wxScrollBar *}{GetVertScrollBar}{\void}
340
341 Returns a pointer to the vertical scrollbar.
342
343 \membersection{wxGrid::InsertCols}\label{wxgridinsertcols}
344
345 \func{bool}{InsertCols}{\param{int}{ pos=0}, \param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}}
346
347 Inserts {\it n} number of columns before position {\it pos}. If {\it updateLabels} is TRUE,
348 the function OnChangeLabels is called to give the application the opportunity to relabel.
349
350 \membersection{wxGrid::InsertRows}\label{wxgridinsertrows}
351
352 \func{bool}{InsertRows}{\param{int}{ pos=0}, \param{int}{ n=1}, \param{bool}{ updateLabels=TRUE}}
353
354 Inserts {\it n} number of rows before position {\it pos}. If {\it updateLabels} is TRUE,
355 the function OnChangeLabels is called to give the application the opportunity to relabel.
356
357 \membersection{wxGrid::OnActivate}\label{wxgridonactivate}
358
359 \func{void}{OnActivate}{\param{bool}{ active}}
360
361 Sets the text item to have the focus. Call this function when the wxGrid window should have the
362 focus, for example from wxFrame::OnActivate.
363
364 \membersection{wxGrid::OnChangeLabels}\label{wxgridonchangelabels}
365
366 \func{void}{OnChangeLabels}{\void}
367
368 Called when rows and columns are created or deleted, to allow the application an
369 opportunity to update the labels. By default, columns are labelled alphabetically,
370 and rows numerically.
371
372 \membersection{wxGrid::OnChangeSelectionLabel}\label{wxgridonchangeselectionlabel}
373
374 \func{void}{OnChangeSelectionLabel}{\void}
375
376 Called when a cell is selected, to allow the application an
377 opportunity to update the selection label (the label of the wxText item
378 used for entering cell text). By default, the cell column letter and row
379 number are concatenated to form the selection label.
380
381 \membersection{wxGrid::OnCreateCell}\label{wxgridoncreatecell}
382
383 \func{wxGridCell *}{OnCreateCell}{\void}
384
385 Override this virtual function if you want to replace the normal wxGridCell with a derived
386 class.
387
388 \membersection{wxGrid::OnCellLeftClick}\label{wxgridoncellleftclick}
389
390 \func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
391
392 Virtual function called when the left button is depressed within a cell, just after OnSelectCell is called.
393
394 \membersection{wxGrid::OnCellRightClick}\label{wxgridoncellrightclick}
395
396 \func{void}{OnRightClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
397
398 Virtual function called when the right button is depressed within a cell, just after OnSelectCell is called.
399
400 \membersection{wxGrid::OnLabelLeftClick}\label{wxgridonlabelleftclick}
401
402 \func{void}{OnLeftClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
403
404 Virtual function called when the left button is depressed within a
405 label.
406
407 {\it row} will be {\it -1} if the click is in the top labels.
408
409 {\it col} will be {\it -1} if the click is in the left labels.
410
411 {\it row} and {\it col} will be {\it -1} if the click is in the upper
412 left corner.
413
414 \membersection{wxGrid::OnLabelRightClick}\label{wxgridonlabelrightclick}
415
416 \func{void}{OnRightClick}{\param{int}{ row}, \param{int}{ col}, \param{int}{ x}, \param{int}{ y}, \param{bool}{ control}, \param{bool}{ shift}}
417
418 Virtual function called when the right button is depressed within a label.
419
420 {\it row} will be {\it -1} if the click is in the top labels.
421
422 {\it col} will be {\it -1} if the click is in the left labels.
423
424 {\it row} and {\it col} will be {\it -1} if the click is in the upper
425 left corner.
426
427 \membersection{wxGrid::OnSelectCell}\label{wxgridonselectcell}
428
429 \func{void}{OnSelectCell}{\param{int}{ row}, \param{int}{ col}}
430
431 Virtual function called when the user left-clicks on a cell.
432
433 \membersection{wxGrid::OnSelectCellImplementation}\label{wxgridonselectcellimplementation}
434
435 \func{void}{OnSelectCellImplementation}{\param{wxDC *}{dc}, \param{int}{ row}, \param{int}{ col}}
436
437 Virtual function called when the user left-clicks on a cell. If you override this function,
438 call wxGrid::OnSelectCell to apply the default behaviour.
439
440 \membersection{wxGrid::SetCellAlignment}\label{wxgridsetcellalignment}
441
442 \func{void}{SetCellAlignment}{\param{int}{ alignment}, \param{int}{ row}, \param{int}{ col}}
443
444 \func{void}{SetCellAlignment}{\param{int}{ alignment}}
445
446 Sets the text alignment for the cell at the given position, or for the whole grid. {\it alignment} may be wxLEFT, wxRIGHT or wxCENTRE.
447
448 \pythonnote{In place of a single overloaded method name, wxPython
449 implements the following methods:\par
450 \indented{2cm}{\begin{twocollist}
451 \twocolitem{\bf{SetCellAlignment(alignment, row, col)}}{}
452 \twocolitem{\bf{SetDefCellAlignment(alignment)}}{}
453 \end{twocollist}}
454 }
455
456 \membersection{wxGrid::SetCellBackgroundColour}\label{wxgridsetcellbackgroundcolour}
457
458 \func{void}{SetCellBackgroundColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
459
460 \func{void}{SetCellBackgroundColour}{\param{const wxColour\&}{ colour}}
461
462 Sets the background colour for the cell at the given position, or for the whole grid.
463
464 \pythonnote{In place of a single overloaded method name, wxPython
465 implements the following methods:\par
466 \indented{2cm}{\begin{twocollist}
467 \twocolitem{\bf{SetCellBackgroundColour(colour, row, col)}}{}
468 \twocolitem{\bf{SetDefCellBackgroundColour(colour)}}{}
469 \end{twocollist}}
470 }
471
472 \membersection{wxGrid::SetCellTextColour}\label{wxgridsetcelltextcolour}
473
474 \func{void}{SetCellTextColour}{\param{const wxColour\&}{ colour}, \param{int}{ row}, \param{int}{ col}}
475
476 \func{void}{SetCellTextColour}{\param{const wxColour\&}{ colour}}
477
478 Sets the text colour for the cell at the given position, or for the whole grid.
479
480 \pythonnote{In place of a single overloaded method name, wxPython
481 implements the following methods:\par
482 \indented{2cm}{\begin{twocollist}
483 \twocolitem{\bf{SetCellTextColour(colour, row, col)}}{}
484 \twocolitem{\bf{SetDefCellTextColour(colour)}}{}
485 \end{twocollist}}
486 }
487
488 \membersection{wxGrid::SetCellTextFont}\label{wxgridsetcelltextfont}
489
490 \func{void}{SetCellTextFont}{\param{const wxFont\&}{ font}, \param{int}{ row}, \param{int}{ col}}
491
492 \func{void}{SetCellTextFont}{\param{const wxFont\&}{ font}}
493
494 Sets the text font for the cell at the given position, or for the whole grid.
495
496 \pythonnote{In place of a single overloaded method name, wxPython
497 implements the following methods:\par
498 \indented{2cm}{\begin{twocollist}
499 \twocolitem{\bf{SetCellTextFont(font, row, col)}}{}
500 \twocolitem{\bf{SetDefCellTextFont(font)}}{}
501 \end{twocollist}}
502 }
503
504 \membersection{wxGrid::SetCellValue}\label{wxgridsetcellvalue}
505
506 \func{void}{SetCellValue}{\param{const wxString\&}{ val}, \param{int}{ row}, \param{int}{ col}}
507
508 Sets the cell value at the given position.
509
510 \membersection{wxGrid::SetColumnWidth}\label{wxgridsetcolumnwidth}
511
512 \func{void}{SetColumnWidth}{\param{int}{ col}, \param{int}{ width}}
513
514 Sets the width in pixels for column {\it col}.
515
516 \membersection{wxGrid::SetDividerPen}\label{wxgridsetdividerpen}
517
518 \func{void}{SetDividerPen}{\param{const wxPen\&}{ pen}}
519
520 Specifies the pen to be used for drawing the divisions between cells. The default
521 is a light grey. If NULL is specified, the divisions will not be drawn.
522
523 \membersection{wxGrid::SetEditable}\label{wxgridseteditable}
524
525 \func{void}{SetEditable}{\param{bool}{ editable}}
526
527 If {\it editable} is TRUE (the default), the grid cells will be editable by means of the
528 text edit control. If FALSE, the text edit control will be hidden and the user will not
529 be able to edit the cell contents.
530
531 \membersection{wxGrid::SetGridCursor}\label{wxgridsetgridcursor}
532
533 \func{void}{SetGridCursor}{\param{int }{row}, \param{int}{ col}}
534
535 Sets the position of the selected cell.
536
537 \membersection{wxGrid::SetLabelAlignment}\label{wxgridsetlabelalignment}
538
539 \func{void}{SetLabelAlignment}{\param{int}{ orientation}, \param{int}{ alignment}}
540
541 Sets the row or column label alignment. {\it orientation} should
542 be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
543 {\it alignment} should be wxCENTRE, wxLEFT or wxRIGHT.
544
545 \membersection{wxGrid::SetLabelBackgroundColour}\label{wxgridsetlabelbackgroundcolour}
546
547 \func{void}{SetLabelBackgroundColour}{\param{const wxColour\&}{ value}}
548
549 Sets a row or column label background colour.
550
551 \membersection{wxGrid::SetLabelSize}\label{wxgridsetlabelsize}
552
553 \func{void}{SetLabelSize}{\param{int}{ orientation}, \param{int}{ size}}
554
555 Sets the row label height, or column label width, in pixels. {\it orientation} should
556 be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.
557
558 If a dimension of zero is specified, the row or column labels will not be
559 shown.
560
561 \membersection{wxGrid::SetLabelTextColour}\label{wxgridsetlabeltextcolour}
562
563 \func{void}{SetLabelTextColour}{\param{const wxColour\&}{ value}}
564
565 Sets a row and column label text colour.
566
567 \membersection{wxGrid::SetLabelTextFont}\label{wxgridsetlabeltextfont}
568
569 \func{void}{SetLabelTextFont}{\param{const wxFont\&}{ font}}
570
571 Sets the font to be used for the row and column labels.
572
573 \membersection{wxGrid::SetLabelValue}\label{wxgridsetlabelvalue}
574
575 \func{void}{SetLabelValue}{\param{int}{ orientation}, \param{const wxString\&}{ value}, \param{int}{ pos}}
576
577 Sets a row or column label value. {\it orientation} should
578 be wxHORIZONTAL to specify column label, wxVERTICAL to specify row label.\rtfsp
579 {\it pos} is the label position.
580
581 \membersection{wxGrid::SetRowHeight}\label{wxgridsetrowheight}
582
583 \func{void}{SetRowHeight}{\param{int}{ row}, \param{int}{ height}}
584
585 Sets the height in pixels for row {\it row}.
586
587 \membersection{wxGrid::UpdateDimensions}\label{wxgridupdatedimensions}
588
589 \func{void}{UpdateDimensions}{\void}
590
591 Call this function whenever a change has been made via the API that
592 might alter size characteristics. You may also need to follow it with
593 a call to AdjustScrollbars.
594
595