1wxGrid(3) Erlang Module Definition wxGrid(3)
2
6 wxGrid - Functions for wxGrid class
7
9 wxGrid and its related classes are used for displaying and editing tab‐
10 ular data. They provide a rich set of features for display, editing,
11 and interacting with a variety of data sources. For simple applica‐
12 tions, and to help you get started, wxGrid is the only class you need
13 to refer to directly. It will set up default instances of the other
14 classes and manage them for you. For more complex applications you can
15 derive your own classes for custom grid views, grid data tables, cell
16 editors and renderers. The overview_grid has examples of simple and
17 more complex applications, explains the relationship between the vari‐
18 ous grid classes and has a summary of the keyboard shortcuts and mouse
19 functions provided by wxGrid.
20 A wxGridTableBase (not implemented in wx) class holds the actual data
22 to be displayed by a wxGrid class. One or more wxGrid classes may act
23 as a view for one table class. The default table class is called wx‐
24 GridStringTable (not implemented in wx) and holds an array of strings.
25 An instance of such a class is created by createGrid/4.
26 wxGridCellRenderer is the abstract base class for rendering contents in
28 a cell. The following renderers are predefined:
29 The look of a cell can be further defined using wxGridCellAttr. An ob‐
31 ject of this type may be returned by wxGridTableBase::GetAttr() (not
32 implemented in wx).
33 wxGridCellEditor is the abstract base class for editing the value of a
35 cell. The following editors are predefined:
36 Please see wxGridEvent, wxGridSizeEvent (not implemented in wx), wx‐
38 GridRangeSelectEvent (not implemented in wx), and wxGridEditorCreatedE‐
39 vent (not implemented in wx) for the documentation of all event types
40 you can use with wxGrid.
41 See: Overview grid, wxGridUpdateLocker (not implemented in wx)
43 This class is derived (and can use functions) from: wxScrolledWindow
45 wxPanel wxWindow wxEvtHandler
46 wxWidgets docs: wxGrid
48
50 wxGrid() = wx:wx_object()
51
53 new() -> wxGrid()
54 Default constructor.
56 You must call Create() (not implemented in wx) to really create
58 the grid window and also call createGrid/4 or SetTable() (not
59 implemented in wx) or AssignTable() (not implemented in wx) to
60 initialize its contents.
61 new(Parent, Id) -> wxGrid()
63 Types:
65 Parent = wxWindow:wxWindow()
67 Id = integer()
68 new(Parent, Id, Options :: [Option]) -> wxGrid()
70 Types:
72 Parent = wxWindow:wxWindow()
74 Id = integer()
75 Option =
76 {pos, {X :: integer(), Y :: integer()}} |
77 {size, {W :: integer(), H :: integer()}} |
78 {style, integer()}
79 Constructor creating the grid window.
81 You must call either createGrid/4 or SetTable() (not implemented
83 in wx) or AssignTable() (not implemented in wx) to initialize
84 the grid contents before using it.
85 destroy(This :: wxGrid()) -> ok
87 Destructor.
89 This will also destroy the associated grid table unless you
91 passed a table object to the grid and specified that the grid
92 should not take ownership of the table (see SetTable() (not im‐
93 plemented in wx)).
94 appendCols(This) -> boolean()
96 Types:
98 This = wxGrid()
100 appendCols(This, Options :: [Option]) -> boolean()
102 Types:
104 This = wxGrid()
106 Option = {numCols, integer()} | {updateLabels, boolean()}
107 Appends one or more new columns to the right of the grid.
109 The updateLabels argument is not used at present. If you are us‐
111 ing a derived grid table class you will need to override wx‐
112 GridTableBase::AppendCols() (not implemented in wx). See insert‐
113 Cols/2 for further information.
114 Return: true on success or false if appending columns failed.
116 appendRows(This) -> boolean()
118 Types:
120 This = wxGrid()
122 appendRows(This, Options :: [Option]) -> boolean()
124 Types:
126 This = wxGrid()
128 Option = {numRows, integer()} | {updateLabels, boolean()}
129 Appends one or more new rows to the bottom of the grid.
131 The updateLabels argument is not used at present. If you are us‐
133 ing a derived grid table class you will need to override wx‐
134 GridTableBase::AppendRows() (not implemented in wx). See in‐
135 sertRows/2 for further information.
136 Return: true on success or false if appending rows failed.
138 autoSize(This) -> ok
140 Types:
142 This = wxGrid()
144 Automatically sets the height and width of all rows and columns
146 to fit their contents.
147 autoSizeColumn(This, Col) -> ok
149 Types:
151 This = wxGrid()
153 Col = integer()
154 autoSizeColumn(This, Col, Options :: [Option]) -> ok
156 Types:
158 This = wxGrid()
160 Col = integer()
161 Option = {setAsMin, boolean()}
162 Automatically sizes the column to fit its contents.
164 If setAsMin is true the calculated width will also be set as the
166 minimal width for the column.
167 autoSizeColumns(This) -> ok
169 Types:
171 This = wxGrid()
173 autoSizeColumns(This, Options :: [Option]) -> ok
175 Types:
177 This = wxGrid()
179 Option = {setAsMin, boolean()}
180 Automatically sizes all columns to fit their contents.
182 If setAsMin is true the calculated widths will also be set as
184 the minimal widths for the columns.
185 autoSizeRow(This, Row) -> ok
187 Types:
189 This = wxGrid()
191 Row = integer()
192 autoSizeRow(This, Row, Options :: [Option]) -> ok
194 Types:
196 This = wxGrid()
198 Row = integer()
199 Option = {setAsMin, boolean()}
200 Automatically sizes the row to fit its contents.
202 If setAsMin is true the calculated height will also be set as
204 the minimal height for the row.
205 autoSizeRows(This) -> ok
207 Types:
209 This = wxGrid()
211 autoSizeRows(This, Options :: [Option]) -> ok
213 Types:
215 This = wxGrid()
217 Option = {setAsMin, boolean()}
218 Automatically sizes all rows to fit their contents.
220 If setAsMin is true the calculated heights will also be set as
222 the minimal heights for the rows.
223 beginBatch(This) -> ok
225 Types:
227 This = wxGrid()
229 Increments the grid's batch count.
231 When the count is greater than zero repainting of the grid is
233 suppressed. Each call to BeginBatch must be matched by a later
234 call to endBatch/1. Code that does a lot of grid modification
235 can be enclosed between beginBatch/1 and endBatch/1 calls to
236 avoid screen flicker. The final endBatch/1 call will cause the
237 grid to be repainted.
238 Notice that you should use wxGridUpdateLocker (not implemented
240 in wx) which ensures that there is always a matching endBatch/1
241 call for this beginBatch/1 if possible instead of calling this
242 method directly.
243 blockToDeviceRect(This, TopLeft, BottomRight) ->
245 {X :: integer(),
246 Y :: integer(),
247 W :: integer(),
248 H :: integer()}
249 Types:
251 This = wxGrid()
253 TopLeft = BottomRight = {R :: integer(), C :: integer()}
254 Convert grid cell coordinates to grid window pixel coordinates.
256 This function returns the rectangle that encloses the block of
258 cells limited by topLeft and bottomRight cell in device coords
259 and clipped to the client size of the grid window.
260 Since: 3.1.3 Parameter gridWindow has been added.
262 See: cellToRect/3
264 canDragCell(This) -> boolean()
266 Types:
268 This = wxGrid()
270 Return true if the dragging of cells is enabled or false other‐
272 wise.
273 canDragColMove(This) -> boolean()
275 Types:
277 This = wxGrid()
279 Returns true if columns can be moved by dragging with the mouse.
281 Columns can be moved by dragging on their labels.
283 canDragGridRowEdges(This) -> boolean()
285 Types:
287 This = wxGrid()
289 Return true if row edges inside the grid can be dragged to re‐
291 size the rows.
292 See: canDragGridSize/1, canDragRowSize/2
294 Since: 3.1.4
296 canDragColSize(This, Col) -> boolean()
298 Types:
300 This = wxGrid()
302 Col = integer()
303 Returns true if the given column can be resized by dragging with
305 the mouse.
306 This function returns true if resizing the columns interactively
308 is globally enabled, i.e. if disableDragColSize/1 hadn't been
309 called, and if this column wasn't explicitly marked as non-re‐
310 sizable with DisableColResize() (not implemented in wx).
311 canDragRowSize(This, Row) -> boolean()
313 Types:
315 This = wxGrid()
317 Row = integer()
318 Returns true if the given row can be resized by dragging with
320 the mouse.
321 This is the same as canDragColSize/2 but for rows.
323 canDragGridSize(This) -> boolean()
325 Types:
327 This = wxGrid()
329 Return true if the dragging of grid lines to resize rows and
331 columns is enabled or false otherwise.
332 canEnableCellControl(This) -> boolean()
334 Types:
336 This = wxGrid()
338 Returns true if the in-place edit control for the current grid
340 cell can be used and false otherwise.
341 This function always returns false for the read-only cells.
343 cellToRect(This, Coords) ->
345 {X :: integer(),
346 Y :: integer(),
347 W :: integer(),
348 H :: integer()}
349 Types:
351 This = wxGrid()
353 Coords = {R :: integer(), C :: integer()}
354 Return the rectangle corresponding to the grid cell's size and
356 position in logical coordinates.
357 See: blockToDeviceRect/3
359 cellToRect(This, Row, Col) ->
361 {X :: integer(),
362 Y :: integer(),
363 W :: integer(),
364 H :: integer()}
365 Types:
367 This = wxGrid()
369 Row = Col = integer()
370 Return the rectangle corresponding to the grid cell's size and
372 position in logical coordinates.
373 See: blockToDeviceRect/3
375 clearGrid(This) -> ok
377 Types:
379 This = wxGrid()
381 Clears all data in the underlying grid table and repaints the
383 grid.
384 The table is not deleted by this function. If you are using a
386 derived table class then you need to override wxGridTable‐
387 Base::Clear() (not implemented in wx) for this function to have
388 any effect.
389 clearSelection(This) -> ok
391 Types:
393 This = wxGrid()
395 Deselects all cells that are currently selected.
397 createGrid(This, NumRows, NumCols) -> boolean()
399 Types:
401 This = wxGrid()
403 NumRows = NumCols = integer()
404 createGrid(This, NumRows, NumCols, Options :: [Option]) ->
406 boolean()
407 Types:
409 This = wxGrid()
411 NumRows = NumCols = integer()
412 Option = {selmode, wx:wx_enum()}
413 Creates a grid with the specified initial number of rows and
415 columns.
416 Call this directly after the grid constructor. When you use this
418 function wxGrid will create and manage a simple table of string
419 values for you. All of the grid data will be stored in memory.
420 For applications with more complex data types or relationships,
422 or for dealing with very large datasets, you should derive your
423 own grid table class and pass a table object to the grid with
424 SetTable() (not implemented in wx) or AssignTable() (not imple‐
425 mented in wx).
426 deleteCols(This) -> boolean()
428 Types:
430 This = wxGrid()
432 deleteCols(This, Options :: [Option]) -> boolean()
434 Types:
436 This = wxGrid()
438 Option =
439 {pos, integer()} |
440 {numCols, integer()} |
441 {updateLabels, boolean()}
442 Deletes one or more columns from a grid starting at the speci‐
444 fied position.
445 The updateLabels argument is not used at present. If you are us‐
447 ing a derived grid table class you will need to override wx‐
448 GridTableBase::DeleteCols() (not implemented in wx). See insert‐
449 Cols/2 for further information.
450 Return: true on success or false if deleting columns failed.
452 deleteRows(This) -> boolean()
454 Types:
456 This = wxGrid()
458 deleteRows(This, Options :: [Option]) -> boolean()
460 Types:
462 This = wxGrid()
464 Option =
465 {pos, integer()} |
466 {numRows, integer()} |
467 {updateLabels, boolean()}
468 Deletes one or more rows from a grid starting at the specified
470 position.
471 The updateLabels argument is not used at present. If you are us‐
473 ing a derived grid table class you will need to override wx‐
474 GridTableBase::DeleteRows() (not implemented in wx). See in‐
475 sertRows/2 for further information.
476 Return: true on success or false if deleting rows failed.
478 disableCellEditControl(This) -> ok
480 Types:
482 This = wxGrid()
484 Disables in-place editing of grid cells.
486 Equivalent to calling EnableCellEditControl(false).
488 disableDragColSize(This) -> ok
490 Types:
492 This = wxGrid()
494 Disables column sizing by dragging with the mouse.
496 Equivalent to passing false to enableDragColSize/2.
498 disableDragGridSize(This) -> ok
500 Types:
502 This = wxGrid()
504 Disable mouse dragging of grid lines to resize rows and columns.
506 Equivalent to passing false to enableDragGridSize/2
508 disableDragRowSize(This) -> ok
510 Types:
512 This = wxGrid()
514 Disables row sizing by dragging with the mouse.
516 Equivalent to passing false to enableDragRowSize/2.
518 enableCellEditControl(This) -> ok
520 Types:
522 This = wxGrid()
524 enableCellEditControl(This, Options :: [Option]) -> ok
526 Types:
528 This = wxGrid()
530 Option = {enable, boolean()}
531 Enables or disables in-place editing of grid cell data.
533 Enabling in-place editing generates wxEVT_GRID_EDITOR_SHOWN and,
535 if it isn't vetoed by the application, shows the in-place editor
536 which allows the user to change the cell value.
537 Disabling in-place editing does nothing if the in-place editor
539 isn't currently shown, otherwise the wxEVT_GRID_EDITOR_HIDDEN
540 event is generated but, unlike the "shown" event, it can't be
541 vetoed and the in-place editor is dismissed unconditionally.
542 Note that it is an error to call this function if the current
544 cell is read-only, use canEnableCellControl/1 to check for this
545 precondition.
546 enableDragColSize(This) -> ok
548 Types:
550 This = wxGrid()
552 enableDragColSize(This, Options :: [Option]) -> ok
554 Types:
556 This = wxGrid()
558 Option = {enable, boolean()}
559 Enables or disables column sizing by dragging with the mouse.
561 See: DisableColResize() (not implemented in wx)
563 enableDragGridSize(This) -> ok
565 Types:
567 This = wxGrid()
569 enableDragGridSize(This, Options :: [Option]) -> ok
571 Types:
573 This = wxGrid()
575 Option = {enable, boolean()}
576 Enables or disables row and column resizing by dragging grid‐
578 lines with the mouse.
579 enableDragRowSize(This) -> ok
581 Types:
583 This = wxGrid()
585 enableDragRowSize(This, Options :: [Option]) -> ok
587 Types:
589 This = wxGrid()
591 Option = {enable, boolean()}
592 Enables or disables row sizing by dragging with the mouse.
594 See: DisableRowResize() (not implemented in wx)
596 enableEditing(This, Edit) -> ok
598 Types:
600 This = wxGrid()
602 Edit = boolean()
603 Makes the grid globally editable or read-only.
605 If the edit argument is false this function sets the whole grid
607 as read-only. If the argument is true the grid is set to the de‐
608 fault state where cells may be editable. In the default state
609 you can set single grid cells and whole rows and columns to be
610 editable or read-only via wxGridCellAttr:setReadOnly/2. For sin‐
611 gle cells you can also use the shortcut function setReadOnly/4.
612 For more information about controlling grid cell attributes see
614 the wxGridCellAttr class and the overview_grid.
615 enableGridLines(This) -> ok
617 Types:
619 This = wxGrid()
621 enableGridLines(This, Options :: [Option]) -> ok
623 Types:
625 This = wxGrid()
627 Option = {enable, boolean()}
628 Turns the drawing of grid lines on or off.
630 endBatch(This) -> ok
632 Types:
634 This = wxGrid()
636 Decrements the grid's batch count.
638 When the count is greater than zero repainting of the grid is
640 suppressed. Each previous call to beginBatch/1 must be matched
641 by a later call to endBatch/1. Code that does a lot of grid mod‐
642 ification can be enclosed between beginBatch/1 and endBatch/1
643 calls to avoid screen flicker. The final endBatch/1 will cause
644 the grid to be repainted.
645 See: wxGridUpdateLocker (not implemented in wx)
647 fit(This) -> ok
649 Types:
651 This = wxGrid()
653 Overridden wxWindow method.
655 forceRefresh(This) -> ok
657 Types:
659 This = wxGrid()
661 Causes immediate repainting of the grid.
663 Use this instead of the usual wxWindow:refresh/2.
665 getBatchCount(This) -> integer()
667 Types:
669 This = wxGrid()
671 Returns the number of times that beginBatch/1 has been called
673 without (yet) matching calls to endBatch/1.
674 While the grid's batch count is greater than zero the display
676 will not be updated.
677 getCellAlignment(This, Row, Col) ->
679 {Horiz :: integer(), Vert :: integer()}
680 Types:
682 This = wxGrid()
684 Row = Col = integer()
685 Sets the arguments to the horizontal and vertical text alignment
687 values for the grid cell at the specified location.
688 Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE
690 or wxALIGN_RIGHT.
691 Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or
693 wxALIGN_BOTTOM.
694 getCellBackgroundColour(This, Row, Col) -> wx:wx_colour4()
696 Types:
698 This = wxGrid()
700 Row = Col = integer()
701 Returns the background colour of the cell at the specified loca‐
703 tion.
704 getCellEditor(This, Row, Col) ->
706 wxGridCellEditor:wxGridCellEditor()
707 Types:
709 This = wxGrid()
711 Row = Col = integer()
712 Returns a pointer to the editor for the cell at the specified
714 location.
715 See wxGridCellEditor and the overview_grid for more information
717 about cell editors and renderers.
718 The caller must call DecRef() on the returned pointer.
720 getCellFont(This, Row, Col) -> wxFont:wxFont()
722 Types:
724 This = wxGrid()
726 Row = Col = integer()
727 Returns the font for text in the grid cell at the specified lo‐
729 cation.
730 getCellRenderer(This, Row, Col) ->
732 wxGridCellRenderer:wxGridCellRenderer()
733 Types:
735 This = wxGrid()
737 Row = Col = integer()
738 Returns a pointer to the renderer for the grid cell at the spec‐
740 ified location.
741 See wxGridCellRenderer and the overview_grid for more informa‐
743 tion about cell editors and renderers.
744 The caller must call DecRef() on the returned pointer.
746 getCellTextColour(This, Row, Col) -> wx:wx_colour4()
748 Types:
750 This = wxGrid()
752 Row = Col = integer()
753 Returns the text colour for the grid cell at the specified loca‐
755 tion.
756 getCellValue(This, Coords) -> unicode:charlist()
758 Types:
760 This = wxGrid()
762 Coords = {R :: integer(), C :: integer()}
763 Returns the string contained in the cell at the specified loca‐
765 tion.
766 For simple applications where a grid object automatically uses a
768 default grid table of string values you use this function to‐
769 gether with setCellValue/4 to access cell values. For more com‐
770 plex applications where you have derived your own grid table
771 class that contains various data types (e.g. numeric, boolean or
772 user-defined custom types) then you only use this function for
773 those cells that contain string values.
774 See wxGridTableBase::CanGetValueAs() (not implemented in wx) and
776 the overview_grid for more information.
777 getCellValue(This, Row, Col) -> unicode:charlist()
779 Types:
781 This = wxGrid()
783 Row = Col = integer()
784 Returns the string contained in the cell at the specified loca‐
786 tion.
787 For simple applications where a grid object automatically uses a
789 default grid table of string values you use this function to‐
790 gether with setCellValue/4 to access cell values. For more com‐
791 plex applications where you have derived your own grid table
792 class that contains various data types (e.g. numeric, boolean or
793 user-defined custom types) then you only use this function for
794 those cells that contain string values.
795 See wxGridTableBase::CanGetValueAs() (not implemented in wx) and
797 the overview_grid for more information.
798 getColLabelAlignment(This) ->
800 {Horiz :: integer(), Vert :: integer()}
801 Types:
803 This = wxGrid()
805 Sets the arguments to the current column label alignment values.
807 Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE
809 or wxALIGN_RIGHT.
810 Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or
812 wxALIGN_BOTTOM.
813 getColLabelSize(This) -> integer()
815 Types:
817 This = wxGrid()
819 Returns the current height of the column labels.
821 getColLabelValue(This, Col) -> unicode:charlist()
823 Types:
825 This = wxGrid()
827 Col = integer()
828 Returns the specified column label.
830 The default grid table class provides column labels of the form
832 A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table
833 you can override wxGridTableBase::GetColLabelValue() (not imple‐
834 mented in wx) to provide your own labels.
835 getColMinimalAcceptableWidth(This) -> integer()
837 Types:
839 This = wxGrid()
841 Returns the minimal width to which a column may be resized.
843 Use setColMinimalAcceptableWidth/2 to change this value globally
845 or setColMinimalWidth/3 to do it for individual columns.
846 See: getRowMinimalAcceptableHeight/1
848 getDefaultCellAlignment(This) ->
850 {Horiz :: integer(), Vert :: integer()}
851 Types:
853 This = wxGrid()
855 Returns the default cell alignment.
857 Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE
859 or wxALIGN_RIGHT.
860 Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or
862 wxALIGN_BOTTOM.
863 See: setDefaultCellAlignment/3
865 getDefaultCellBackgroundColour(This) -> wx:wx_colour4()
867 Types:
869 This = wxGrid()
871 Returns the current default background colour for grid cells.
873 getDefaultCellFont(This) -> wxFont:wxFont()
875 Types:
877 This = wxGrid()
879 Returns the current default font for grid cell text.
881 getDefaultCellTextColour(This) -> wx:wx_colour4()
883 Types:
885 This = wxGrid()
887 Returns the current default colour for grid cell text.
889 getDefaultColLabelSize(This) -> integer()
891 Types:
893 This = wxGrid()
895 Returns the default height for column labels.
897 getDefaultColSize(This) -> integer()
899 Types:
901 This = wxGrid()
903 Returns the current default width for grid columns.
905 getDefaultEditor(This) -> wxGridCellEditor:wxGridCellEditor()
907 Types:
909 This = wxGrid()
911 Returns a pointer to the current default grid cell editor.
913 See wxGridCellEditor and the overview_grid for more information
915 about cell editors and renderers.
916 getDefaultEditorForCell(This, C) ->
918 wxGridCellEditor:wxGridCellEditor()
919 Types:
921 This = wxGrid()
923 C = {R :: integer(), C :: integer()}
924 Returns the default editor for the specified cell.
926 The base class version returns the editor appropriate for the
928 current cell type but this method may be overridden in the de‐
929 rived classes to use custom editors for some cells by default.
930 Notice that the same may be achieved in a usually simpler way by
932 associating a custom editor with the given cell or cells.
933 The caller must call DecRef() on the returned pointer.
935 getDefaultEditorForCell(This, Row, Col) ->
937 wxGridCellEditor:wxGridCellEditor()
938 Types:
940 This = wxGrid()
942 Row = Col = integer()
943 Returns the default editor for the specified cell.
945 The base class version returns the editor appropriate for the
947 current cell type but this method may be overridden in the de‐
948 rived classes to use custom editors for some cells by default.
949 Notice that the same may be achieved in a usually simpler way by
951 associating a custom editor with the given cell or cells.
952 The caller must call DecRef() on the returned pointer.
954 getDefaultEditorForType(This, TypeName) ->
956 wxGridCellEditor:wxGridCellEditor()
957 Types:
959 This = wxGrid()
961 TypeName = unicode:chardata()
962 Returns the default editor for the cells containing values of
964 the given type.
965 The base class version returns the editor which was associated
967 with the specified typeName when it was registered register‐
968 DataType/4 but this function may be overridden to return some‐
969 thing different. This allows overriding an editor used for one
970 of the standard types.
971 The caller must call DecRef() on the returned pointer.
973 getDefaultRenderer(This) ->
975 wxGridCellRenderer:wxGridCellRenderer()
976 Types:
978 This = wxGrid()
980 Returns a pointer to the current default grid cell renderer.
982 See wxGridCellRenderer and the overview_grid for more informa‐
984 tion about cell editors and renderers.
985 The caller must call DecRef() on the returned pointer.
987 getDefaultRendererForCell(This, Row, Col) ->
989 wxGridCellRenderer:wxGridCellRenderer()
990 Types:
992 This = wxGrid()
994 Row = Col = integer()
995 Returns the default renderer for the given cell.
997 The base class version returns the renderer appropriate for the
999 current cell type but this method may be overridden in the de‐
1000 rived classes to use custom renderers for some cells by default.
1001 The caller must call DecRef() on the returned pointer.
1003 getDefaultRendererForType(This, TypeName) ->
1005 wxGridCellRenderer:wxGridCellRenderer()
1006 Types:
1008 This = wxGrid()
1010 TypeName = unicode:chardata()
1011 Returns the default renderer for the cell containing values of
1013 the given type.
1014 See: getDefaultEditorForType/2
1016 getDefaultRowLabelSize(This) -> integer()
1018 Types:
1020 This = wxGrid()
1022 Returns the default width for the row labels.
1024 getDefaultRowSize(This) -> integer()
1026 Types:
1028 This = wxGrid()
1030 Returns the current default height for grid rows.
1032 getGridCursorCol(This) -> integer()
1034 Types:
1036 This = wxGrid()
1038 Returns the current grid cell column position.
1040 See: GetGridCursorCoords() (not implemented in wx)
1042 getGridCursorRow(This) -> integer()
1044 Types:
1046 This = wxGrid()
1048 Returns the current grid cell row position.
1050 See: GetGridCursorCoords() (not implemented in wx)
1052 getGridLineColour(This) -> wx:wx_colour4()
1054 Types:
1056 This = wxGrid()
1058 Returns the colour used for grid lines.
1060 See: GetDefaultGridLinePen() (not implemented in wx)
1062 gridLinesEnabled(This) -> boolean()
1064 Types:
1066 This = wxGrid()
1068 Returns true if drawing of grid lines is turned on, false other‐
1070 wise.
1071 getLabelBackgroundColour(This) -> wx:wx_colour4()
1073 Types:
1075 This = wxGrid()
1077 Returns the colour used for the background of row and column la‐
1079 bels.
1080 getLabelFont(This) -> wxFont:wxFont()
1082 Types:
1084 This = wxGrid()
1086 Returns the font used for row and column labels.
1088 getLabelTextColour(This) -> wx:wx_colour4()
1090 Types:
1092 This = wxGrid()
1094 Returns the colour used for row and column label text.
1096 getNumberCols(This) -> integer()
1098 Types:
1100 This = wxGrid()
1102 Returns the total number of grid columns.
1104 This is the same as the number of columns in the underlying grid
1106 table.
1107 getNumberRows(This) -> integer()
1109 Types:
1111 This = wxGrid()
1113 Returns the total number of grid rows.
1115 This is the same as the number of rows in the underlying grid
1117 table.
1118 getOrCreateCellAttr(This, Row, Col) ->
1120 wxGridCellAttr:wxGridCellAttr()
1121 Types:
1123 This = wxGrid()
1125 Row = Col = integer()
1126 Returns the attribute for the given cell creating one if neces‐
1128 sary.
1129 If the cell already has an attribute, it is returned. Otherwise
1131 a new attribute is created, associated with the cell and re‐
1132 turned. In any case the caller must call DecRef() on the re‐
1133 turned pointer.
1134 Prefer to use GetOrCreateCellAttrPtr() (not implemented in wx)
1136 to avoid the need to call DecRef() on the returned pointer.
1137 This function may only be called if CanHaveAttributes() (not im‐
1139 plemented in wx) returns true.
1140 getRowMinimalAcceptableHeight(This) -> integer()
1142 Types:
1144 This = wxGrid()
1146 Returns the minimal size to which rows can be resized.
1148 Use setRowMinimalAcceptableHeight/2 to change this value glob‐
1150 ally or setRowMinimalHeight/3 to do it for individual cells.
1151 See: getColMinimalAcceptableWidth/1
1153 getRowLabelAlignment(This) ->
1155 {Horiz :: integer(), Vert :: integer()}
1156 Types:
1158 This = wxGrid()
1160 Returns the alignment used for row labels.
1162 Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE
1164 or wxALIGN_RIGHT.
1165 Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or
1167 wxALIGN_BOTTOM.
1168 getRowLabelSize(This) -> integer()
1170 Types:
1172 This = wxGrid()
1174 Returns the current width of the row labels.
1176 getRowLabelValue(This, Row) -> unicode:charlist()
1178 Types:
1180 This = wxGrid()
1182 Row = integer()
1183 Returns the specified row label.
1185 The default grid table class provides numeric row labels. If you
1187 are using a custom grid table you can override wxGridTable‐
1188 Base::GetRowLabelValue() (not implemented in wx) to provide your
1189 own labels.
1190 getRowSize(This, Row) -> integer()
1192 Types:
1194 This = wxGrid()
1196 Row = integer()
1197 Returns the height of the specified row.
1199 getScrollLineX(This) -> integer()
1201 Types:
1203 This = wxGrid()
1205 Returns the number of pixels per horizontal scroll increment.
1207 The default is 15.
1209 See: getScrollLineY/1, setScrollLineX/2, setScrollLineY/2
1211 getScrollLineY(This) -> integer()
1213 Types:
1215 This = wxGrid()
1217 Returns the number of pixels per vertical scroll increment.
1219 The default is 15.
1221 See: getScrollLineX/1, setScrollLineX/2, setScrollLineY/2
1223 getSelectedCells(This) -> [{R :: integer(), C :: integer()}]
1225 Types:
1227 This = wxGrid()
1229 Returns an array of individually selected cells.
1231 Notice that this array does not contain all the selected cells
1233 in general as it doesn't include the cells selected as part of
1234 column, row or block selection. You must use this method, getSe‐
1235 lectedCols/1, getSelectedRows/1 and getSelectionBlockTopLeft/1
1236 and getSelectionBlockBottomRight/1 methods to obtain the entire
1237 selection in general.
1238 Please notice this behaviour is by design and is needed in order
1240 to support grids of arbitrary size (when an entire column is se‐
1241 lected in a grid with a million of columns, we don't want to
1242 create an array with a million of entries in this function, in‐
1243 stead it returns an empty array and getSelectedCols/1 returns an
1244 array containing one element).
1245 The function can be slow for the big grids, use GetSelected‐
1247 Blocks() (not implemented in wx) in the new code.
1248 getSelectedCols(This) -> [integer()]
1250 Types:
1252 This = wxGrid()
1254 Returns an array of selected columns.
1256 Please notice that this method alone is not sufficient to find
1258 all the selected columns as it contains only the columns which
1259 were individually selected but not those being part of the block
1260 selection or being selected in virtue of all of their cells be‐
1261 ing selected individually, please see getSelectedCells/1 for
1262 more details.
1263 The function can be slow for the big grids, use GetSelected‐
1265 Blocks() (not implemented in wx) in the new code.
1266 getSelectedRows(This) -> [integer()]
1268 Types:
1270 This = wxGrid()
1272 Returns an array of selected rows.
1274 Please notice that this method alone is not sufficient to find
1276 all the selected rows as it contains only the rows which were
1277 individually selected but not those being part of the block se‐
1278 lection or being selected in virtue of all of their cells being
1279 selected individually, please see getSelectedCells/1 for more
1280 details.
1281 The function can be slow for the big grids, use GetSelected‐
1283 Blocks() (not implemented in wx) in the new code.
1284 getSelectionBackground(This) -> wx:wx_colour4()
1286 Types:
1288 This = wxGrid()
1290 Returns the colour used for drawing the selection background.
1292 getSelectionBlockTopLeft(This) ->
1294 [{R :: integer(), C :: integer()}]
1295 Types:
1297 This = wxGrid()
1299 Returns an array of the top left corners of blocks of selected
1301 cells.
1302 Please see getSelectedCells/1 for more information about the se‐
1304 lection representation in wxGrid.
1305 The function can be slow for the big grids, use GetSelected‐
1307 Blocks() (not implemented in wx) in the new code.
1308 See: getSelectionBlockBottomRight/1
1310 getSelectionBlockBottomRight(This) ->
1312 [{R :: integer(), C :: integer()}]
1313 Types:
1315 This = wxGrid()
1317 Returns an array of the bottom right corners of blocks of se‐
1319 lected cells.
1320 Please see getSelectedCells/1 for more information about the se‐
1322 lection representation in wxGrid.
1323 The function can be slow for the big grids, use GetSelected‐
1325 Blocks() (not implemented in wx) in the new code.
1326 See: getSelectionBlockTopLeft/1
1328 getSelectionForeground(This) -> wx:wx_colour4()
1330 Types:
1332 This = wxGrid()
1334 Returns the colour used for drawing the selection foreground.
1336 getGridWindow(This) -> wxWindow:wxWindow()
1338 Types:
1340 This = wxGrid()
1342 Return the main grid window containing the grid cells.
1344 This window is always shown.
1346 getGridRowLabelWindow(This) -> wxWindow:wxWindow()
1348 Types:
1350 This = wxGrid()
1352 Return the row labels window.
1354 This window is not shown if the row labels were hidden using
1356 HideRowLabels() (not implemented in wx).
1357 getGridColLabelWindow(This) -> wxWindow:wxWindow()
1359 Types:
1361 This = wxGrid()
1363 Return the column labels window.
1365 This window is not shown if the columns labels were hidden using
1367 HideColLabels() (not implemented in wx).
1368 Depending on whether UseNativeColHeader() (not implemented in
1370 wx) was called or not this can be either a wxHeaderCtrl (not im‐
1371 plemented in wx) or a plain wxWindow. This function returns a
1372 valid window pointer in either case but in the former case you
1373 can also use GetGridColHeader() (not implemented in wx) to ac‐
1374 cess it if you need wxHeaderCtrl-specific functionality.
1375 getGridCornerLabelWindow(This) -> wxWindow:wxWindow()
1377 Types:
1379 This = wxGrid()
1381 Return the window in the top left grid corner.
1383 This window is shown only of both columns and row labels are
1385 shown and normally doesn't contain anything. Clicking on it is
1386 handled by wxGrid however and can be used to select the entire
1387 grid.
1388 hideCellEditControl(This) -> ok
1390 Types:
1392 This = wxGrid()
1394 Hides the in-place cell edit control.
1396 insertCols(This) -> boolean()
1398 Types:
1400 This = wxGrid()
1402 insertCols(This, Options :: [Option]) -> boolean()
1404 Types:
1406 This = wxGrid()
1408 Option =
1409 {pos, integer()} |
1410 {numCols, integer()} |
1411 {updateLabels, boolean()}
1412 Inserts one or more new columns into a grid with the first new
1414 column at the specified position.
1415 Notice that inserting the columns in the grid requires grid ta‐
1417 ble cooperation: when this method is called, grid object begins
1418 by requesting the underlying grid table to insert new columns.
1419 If this is successful the table notifies the grid and the grid
1420 updates the display. For a default grid (one where you have
1421 called createGrid/4) this process is automatic. If you are using
1422 a custom grid table (specified with SetTable() (not implemented
1423 in wx) or AssignTable() (not implemented in wx)) then you must
1424 override wxGridTableBase::InsertCols() (not implemented in wx)
1425 in your derived table class.
1426 Return: true if the columns were successfully inserted, false if
1428 an error occurred (most likely the table couldn't be updated).
1429 insertRows(This) -> boolean()
1431 Types:
1433 This = wxGrid()
1435 insertRows(This, Options :: [Option]) -> boolean()
1437 Types:
1439 This = wxGrid()
1441 Option =
1442 {pos, integer()} |
1443 {numRows, integer()} |
1444 {updateLabels, boolean()}
1445 Inserts one or more new rows into a grid with the first new row
1447 at the specified position.
1448 Notice that you must implement wxGridTableBase::InsertRows()
1450 (not implemented in wx) if you use a grid with a custom table,
1451 please see insertCols/2 for more information.
1452 Return: true if the rows were successfully inserted, false if an
1454 error occurred (most likely the table couldn't be updated).
1455 isCellEditControlEnabled(This) -> boolean()
1457 Types:
1459 This = wxGrid()
1461 Returns true if the in-place edit control is currently enabled.
1463 isCurrentCellReadOnly(This) -> boolean()
1465 Types:
1467 This = wxGrid()
1469 Returns true if the current cell is read-only.
1471 See: setReadOnly/4, isReadOnly/3
1473 isEditable(This) -> boolean()
1475 Types:
1477 This = wxGrid()
1479 Returns false if the whole grid has been set as read-only or
1481 true otherwise.
1482 See enableEditing/2 for more information about controlling the
1484 editing status of grid cells.
1485 isInSelection(This, Coords) -> boolean()
1487 Types:
1489 This = wxGrid()
1491 Coords = {R :: integer(), C :: integer()}
1492 Returns true if the given cell is selected.
1494 isInSelection(This, Row, Col) -> boolean()
1496 Types:
1498 This = wxGrid()
1500 Row = Col = integer()
1501 Returns true if the given cell is selected.
1503 isReadOnly(This, Row, Col) -> boolean()
1505 Types:
1507 This = wxGrid()
1509 Row = Col = integer()
1510 Returns true if the cell at the specified location can't be
1512 edited.
1513 See: setReadOnly/4, isCurrentCellReadOnly/1
1515 isSelection(This) -> boolean()
1517 Types:
1519 This = wxGrid()
1521 Returns true if there are currently any selected cells, rows,
1523 columns or blocks.
1524 isVisible(This, Coords) -> boolean()
1526 Types:
1528 This = wxGrid()
1530 Coords = {R :: integer(), C :: integer()}
1531 isVisible(This, Row, Col) -> boolean()
1533 isVisible(This, Coords, Col :: [Option]) -> boolean()
1535 Types:
1537 This = wxGrid()
1539 Coords = {R :: integer(), C :: integer()}
1540 Option = {wholeCellVisible, boolean()}
1541 Returns true if a cell is either entirely or at least partially
1543 visible in the grid window.
1544 By default, the cell must be entirely visible for this function
1546 to return true but if wholeCellVisible is false, the function
1547 returns true even if the cell is only partially visible.
1548 isVisible(This, Row, Col, Options :: [Option]) -> boolean()
1550 Types:
1552 This = wxGrid()
1554 Row = Col = integer()
1555 Option = {wholeCellVisible, boolean()}
1556 Returns true if a cell is either entirely or at least partially
1558 visible in the grid window.
1559 By default, the cell must be entirely visible for this function
1561 to return true but if wholeCellVisible is false, the function
1562 returns true even if the cell is only partially visible.
1563 makeCellVisible(This, Coords) -> ok
1565 Types:
1567 This = wxGrid()
1569 Coords = {R :: integer(), C :: integer()}
1570 Brings the specified cell into the visible grid cell area with
1572 minimal scrolling.
1573 Does nothing if the cell is already visible.
1575 makeCellVisible(This, Row, Col) -> ok
1577 Types:
1579 This = wxGrid()
1581 Row = Col = integer()
1582 Brings the specified cell into the visible grid cell area with
1584 minimal scrolling.
1585 Does nothing if the cell is already visible.
1587 moveCursorDown(This, ExpandSelection) -> boolean()
1589 Types:
1591 This = wxGrid()
1593 ExpandSelection = boolean()
1594 Moves the grid cursor down by one row.
1596 If a block of cells was previously selected it will expand if
1598 the argument is true or be cleared if the argument is false.
1599 moveCursorLeft(This, ExpandSelection) -> boolean()
1601 Types:
1603 This = wxGrid()
1605 ExpandSelection = boolean()
1606 Moves the grid cursor left by one column.
1608 If a block of cells was previously selected it will expand if
1610 the argument is true or be cleared if the argument is false.
1611 moveCursorRight(This, ExpandSelection) -> boolean()
1613 Types:
1615 This = wxGrid()
1617 ExpandSelection = boolean()
1618 Moves the grid cursor right by one column.
1620 If a block of cells was previously selected it will expand if
1622 the argument is true or be cleared if the argument is false.
1623 moveCursorUp(This, ExpandSelection) -> boolean()
1625 Types:
1627 This = wxGrid()
1629 ExpandSelection = boolean()
1630 Moves the grid cursor up by one row.
1632 If a block of cells was previously selected it will expand if
1634 the argument is true or be cleared if the argument is false.
1635 moveCursorDownBlock(This, ExpandSelection) -> boolean()
1637 Types:
1639 This = wxGrid()
1641 ExpandSelection = boolean()
1642 Moves the grid cursor down in the current column such that it
1644 skips to the beginning or end of a block of non-empty cells.
1645 If a block of cells was previously selected it will expand if
1647 the argument is true or be cleared if the argument is false.
1648 moveCursorLeftBlock(This, ExpandSelection) -> boolean()
1650 Types:
1652 This = wxGrid()
1654 ExpandSelection = boolean()
1655 Moves the grid cursor left in the current row such that it skips
1657 to the beginning or end of a block of non-empty cells.
1658 If a block of cells was previously selected it will expand if
1660 the argument is true or be cleared if the argument is false.
1661 moveCursorRightBlock(This, ExpandSelection) -> boolean()
1663 Types:
1665 This = wxGrid()
1667 ExpandSelection = boolean()
1668 Moves the grid cursor right in the current row such that it
1670 skips to the beginning or end of a block of non-empty cells.
1671 If a block of cells was previously selected it will expand if
1673 the argument is true or be cleared if the argument is false.
1674 moveCursorUpBlock(This, ExpandSelection) -> boolean()
1676 Types:
1678 This = wxGrid()
1680 ExpandSelection = boolean()
1681 Moves the grid cursor up in the current column such that it
1683 skips to the beginning or end of a block of non-empty cells.
1684 If a block of cells was previously selected it will expand if
1686 the argument is true or be cleared if the argument is false.
1687 movePageDown(This) -> boolean()
1689 Types:
1691 This = wxGrid()
1693 Moves the grid cursor down by some number of rows so that the
1695 previous bottom visible row becomes the top visible row.
1696 movePageUp(This) -> boolean()
1698 Types:
1700 This = wxGrid()
1702 Moves the grid cursor up by some number of rows so that the pre‐
1704 vious top visible row becomes the bottom visible row.
1705 registerDataType(This, TypeName, Renderer, Editor) -> ok
1707 Types:
1709 This = wxGrid()
1711 TypeName = unicode:chardata()
1712 Renderer = wxGridCellRenderer:wxGridCellRenderer()
1713 Editor = wxGridCellEditor:wxGridCellEditor()
1714 Register a new data type.
1716 The data types allow to naturally associate specific renderers
1718 and editors to the cells containing values of the given type.
1719 For example, the grid automatically registers a data type with
1720 the name wxGRID_VALUE_STRING which uses wxGridCellStringRenderer
1721 and wxGridCellTextEditor as its renderer and editor respectively
1722 - this is the data type used by all the cells of the default wx‐
1723 GridStringTable (not implemented in wx), so this renderer and
1724 editor are used by default for all grid cells.
1725 However if a custom table returns wxGRID_VALUE_BOOL from its wx‐
1727 GridTableBase::GetTypeName() (not implemented in wx) method,
1728 then wxGridCellBoolRenderer and wxGridCellBoolEditor are used
1729 for it because the grid also registers a boolean data type with
1730 this name.
1731 And as this mechanism is completely generic, you may register
1733 your own data types using your own custom renderers and editors.
1734 Just remember that the table must identify a cell as being of
1735 the given type for them to be used for this cell.
1736 saveEditControlValue(This) -> ok
1738 Types:
1740 This = wxGrid()
1742 Sets the value of the current grid cell to the current in-place
1744 edit control value.
1745 This is called automatically when the grid cursor moves from the
1747 current cell to a new cell. It is also a good idea to call this
1748 function when closing a grid since any edits to the final cell
1749 location will not be saved otherwise.
1750 selectAll(This) -> ok
1752 Types:
1754 This = wxGrid()
1756 Selects all cells in the grid.
1758 selectBlock(This, TopLeft, BottomRight) -> ok
1760 Types:
1762 This = wxGrid()
1764 TopLeft = BottomRight = {R :: integer(), C :: integer()}
1765 selectBlock(This, TopLeft, BottomRight, Options :: [Option]) -> ok
1767 Types:
1769 This = wxGrid()
1771 TopLeft = BottomRight = {R :: integer(), C :: integer()}
1772 Option = {addToSelected, boolean()}
1773 Selects a rectangular block of cells.
1775 If addToSelected is false then any existing selection will be
1777 deselected; if true the column will be added to the existing se‐
1778 lection.
1779 selectBlock(This, TopRow, LeftCol, BottomRow, RightCol) -> ok
1781 Types:
1783 This = wxGrid()
1785 TopRow = LeftCol = BottomRow = RightCol = integer()
1786 selectBlock(This, TopRow, LeftCol, BottomRow, RightCol,
1788 Options :: [Option]) ->
1789 ok
1790 Types:
1792 This = wxGrid()
1794 TopRow = LeftCol = BottomRow = RightCol = integer()
1795 Option = {addToSelected, boolean()}
1796 Selects a rectangular block of cells.
1798 If addToSelected is false then any existing selection will be
1800 deselected; if true the column will be added to the existing se‐
1801 lection.
1802 selectCol(This, Col) -> ok
1804 Types:
1806 This = wxGrid()
1808 Col = integer()
1809 selectCol(This, Col, Options :: [Option]) -> ok
1811 Types:
1813 This = wxGrid()
1815 Col = integer()
1816 Option = {addToSelected, boolean()}
1817 Selects the specified column.
1819 If addToSelected is false then any existing selection will be
1821 deselected; if true the column will be added to the existing se‐
1822 lection.
1823 This method won't select anything if the current selection mode
1825 is wxGridSelectRows.
1826 selectRow(This, Row) -> ok
1828 Types:
1830 This = wxGrid()
1832 Row = integer()
1833 selectRow(This, Row, Options :: [Option]) -> ok
1835 Types:
1837 This = wxGrid()
1839 Row = integer()
1840 Option = {addToSelected, boolean()}
1841 Selects the specified row.
1843 If addToSelected is false then any existing selection will be
1845 deselected; if true the row will be added to the existing selec‐
1846 tion.
1847 This method won't select anything if the current selection mode
1849 is wxGridSelectColumns.
1850 setCellAlignment(This, Row, Col, Horiz, Vert) -> ok
1852 Types:
1854 This = wxGrid()
1856 Row = Col = Horiz = Vert = integer()
1857 Sets the horizontal and vertical alignment for grid cell text at
1859 the specified location.
1860 Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CEN‐
1862 TRE or wxALIGN_RIGHT.
1863 Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE
1865 or wxALIGN_BOTTOM.
1866 setCellBackgroundColour(This, Row, Col, Colour) -> ok
1868 Types:
1870 This = wxGrid()
1872 Row = Col = integer()
1873 Colour = wx:wx_colour()
1874 Set the background colour for the given cell or all cells by de‐
1876 fault.
1877 setCellEditor(This, Row, Col, Editor) -> ok
1879 Types:
1881 This = wxGrid()
1883 Row = Col = integer()
1884 Editor = wxGridCellEditor:wxGridCellEditor()
1885 Sets the editor for the grid cell at the specified location.
1887 The grid will take ownership of the pointer.
1889 See wxGridCellEditor and the overview_grid for more information
1891 about cell editors and renderers.
1892 setCellFont(This, Row, Col, Font) -> ok
1894 Types:
1896 This = wxGrid()
1898 Row = Col = integer()
1899 Font = wxFont:wxFont()
1900 Sets the font for text in the grid cell at the specified loca‐
1902 tion.
1903 setCellRenderer(This, Row, Col, Renderer) -> ok
1905 Types:
1907 This = wxGrid()
1909 Row = Col = integer()
1910 Renderer = wxGridCellRenderer:wxGridCellRenderer()
1911 Sets the renderer for the grid cell at the specified location.
1913 The grid will take ownership of the pointer.
1915 See wxGridCellRenderer and the overview_grid for more informa‐
1917 tion about cell editors and renderers.
1918 setCellTextColour(This, Row, Col, Colour) -> ok
1920 Types:
1922 This = wxGrid()
1924 Row = Col = integer()
1925 Colour = wx:wx_colour()
1926 Sets the text colour for the given cell.
1928 setCellValue(This, Coords, S) -> ok
1930 Types:
1932 This = wxGrid()
1934 Coords = {R :: integer(), C :: integer()}
1935 S = unicode:chardata()
1936 Sets the string value for the cell at the specified location.
1938 For simple applications where a grid object automatically uses a
1940 default grid table of string values you use this function to‐
1941 gether with getCellValue/3 to access cell values. For more com‐
1942 plex applications where you have derived your own grid table
1943 class that contains various data types (e.g. numeric, boolean or
1944 user-defined custom types) then you only use this function for
1945 those cells that contain string values.
1946 See wxGridTableBase::CanSetValueAs() (not implemented in wx) and
1948 the overview_grid for more information.
1949 setCellValue(This, Row, Col, S) -> ok
1951 Types:
1953 This = wxGrid()
1955 Row = Col = integer()
1956 S = unicode:chardata()
1957 Sets the string value for the cell at the specified location.
1959 For simple applications where a grid object automatically uses a
1961 default grid table of string values you use this function to‐
1962 gether with getCellValue/3 to access cell values. For more com‐
1963 plex applications where you have derived your own grid table
1964 class that contains various data types (e.g. numeric, boolean or
1965 user-defined custom types) then you only use this function for
1966 those cells that contain string values.
1967 See wxGridTableBase::CanSetValueAs() (not implemented in wx) and
1969 the overview_grid for more information.
1970 setColAttr(This, Col, Attr) -> ok
1972 Types:
1974 This = wxGrid()
1976 Col = integer()
1977 Attr = wxGridCellAttr:wxGridCellAttr()
1978 Sets the cell attributes for all cells in the specified column.
1980 For more information about controlling grid cell attributes see
1982 the wxGridCellAttr cell attribute class and the overview_grid.
1983 setColFormatBool(This, Col) -> ok
1985 Types:
1987 This = wxGrid()
1989 Col = integer()
1990 Sets the specified column to display boolean values.
1992 See: setColFormatCustom/3
1994 setColFormatNumber(This, Col) -> ok
1996 Types:
1998 This = wxGrid()
2000 Col = integer()
2001 Sets the specified column to display integer values.
2003 See: setColFormatCustom/3
2005 setColFormatFloat(This, Col) -> ok
2007 Types:
2009 This = wxGrid()
2011 Col = integer()
2012 setColFormatFloat(This, Col, Options :: [Option]) -> ok
2014 Types:
2016 This = wxGrid()
2018 Col = integer()
2019 Option = {width, integer()} | {precision, integer()}
2020 Sets the specified column to display floating point values with
2022 the given width and precision.
2023 See: setColFormatCustom/3
2025 setColFormatCustom(This, Col, TypeName) -> ok
2027 Types:
2029 This = wxGrid()
2031 Col = integer()
2032 TypeName = unicode:chardata()
2033 Sets the specified column to display data in a custom format.
2035 This method provides an alternative to defining a custom grid
2037 table which would return typeName from its GetTypeName() method
2038 for the cells in this column: while it doesn't really change the
2039 type of the cells in this column, it does associate the renderer
2040 and editor used for the cells of the specified type with them.
2041 See the overview_grid for more information on working with cus‐
2043 tom data types.
2044 setColLabelAlignment(This, Horiz, Vert) -> ok
2046 Types:
2048 This = wxGrid()
2050 Horiz = Vert = integer()
2051 Sets the horizontal and vertical alignment of column label text.
2053 Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CEN‐
2055 TRE or wxALIGN_RIGHT. Vertical alignment should be one of wx‐
2056 ALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
2057 setColLabelSize(This, Height) -> ok
2059 Types:
2061 This = wxGrid()
2063 Height = integer()
2064 Sets the height of the column labels.
2066 If height equals to wxGRID_AUTOSIZE then height is calculated
2068 automatically so that no label is truncated. Note that this
2069 could be slow for a large table.
2070 setColLabelValue(This, Col, Value) -> ok
2072 Types:
2074 This = wxGrid()
2076 Col = integer()
2077 Value = unicode:chardata()
2078 Set the value for the given column label.
2080 If you are using a custom grid table you must override wx‐
2082 GridTableBase::SetColLabelValue() (not implemented in wx) for
2083 this to have any effect.
2084 setColMinimalWidth(This, Col, Width) -> ok
2086 Types:
2088 This = wxGrid()
2090 Col = Width = integer()
2091 Sets the minimal width for the specified column col.
2093 It is usually best to call this method during grid creation as
2095 calling it later will not resize the column to the given minimal
2096 width even if it is currently narrower than it.
2097 width must be greater than the minimal acceptable column width
2099 as returned by getColMinimalAcceptableWidth/1.
2100 setColMinimalAcceptableWidth(This, Width) -> ok
2102 Types:
2104 This = wxGrid()
2106 Width = integer()
2107 Sets the minimal width to which the user can resize columns.
2109 See: getColMinimalAcceptableWidth/1
2111 setColSize(This, Col, Width) -> ok
2113 Types:
2115 This = wxGrid()
2117 Col = Width = integer()
2118 Sets the width of the specified column.
2120 setDefaultCellAlignment(This, Horiz, Vert) -> ok
2122 Types:
2124 This = wxGrid()
2126 Horiz = Vert = integer()
2127 Sets the default horizontal and vertical alignment for grid cell
2129 text.
2130 Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CEN‐
2132 TRE or wxALIGN_RIGHT. Vertical alignment should be one of wx‐
2133 ALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
2134 setDefaultCellBackgroundColour(This, Colour) -> ok
2136 Types:
2138 This = wxGrid()
2140 Colour = wx:wx_colour()
2141 Sets the default background colour for grid cells.
2143 setDefaultCellFont(This, Font) -> ok
2145 Types:
2147 This = wxGrid()
2149 Font = wxFont:wxFont()
2150 Sets the default font to be used for grid cell text.
2152 setDefaultCellTextColour(This, Colour) -> ok
2154 Types:
2156 This = wxGrid()
2158 Colour = wx:wx_colour()
2159 Sets the current default colour for grid cell text.
2161 setDefaultEditor(This, Editor) -> ok
2163 Types:
2165 This = wxGrid()
2167 Editor = wxGridCellEditor:wxGridCellEditor()
2168 Sets the default editor for grid cells.
2170 The grid will take ownership of the pointer.
2172 See wxGridCellEditor and the overview_grid for more information
2174 about cell editors and renderers.
2175 setDefaultRenderer(This, Renderer) -> ok
2177 Types:
2179 This = wxGrid()
2181 Renderer = wxGridCellRenderer:wxGridCellRenderer()
2182 Sets the default renderer for grid cells.
2184 The grid will take ownership of the pointer.
2186 See wxGridCellRenderer and the overview_grid for more informa‐
2188 tion about cell editors and renderers.
2189 setDefaultColSize(This, Width) -> ok
2191 Types:
2193 This = wxGrid()
2195 Width = integer()
2196 setDefaultColSize(This, Width, Options :: [Option]) -> ok
2198 Types:
2200 This = wxGrid()
2202 Width = integer()
2203 Option = {resizeExistingCols, boolean()}
2204 Sets the default width for columns in the grid.
2206 This will only affect columns subsequently added to the grid un‐
2208 less resizeExistingCols is true.
2209 If width is less than getColMinimalAcceptableWidth/1, then the
2211 minimal acceptable width is used instead of it.
2212 setDefaultRowSize(This, Height) -> ok
2214 Types:
2216 This = wxGrid()
2218 Height = integer()
2219 setDefaultRowSize(This, Height, Options :: [Option]) -> ok
2221 Types:
2223 This = wxGrid()
2225 Height = integer()
2226 Option = {resizeExistingRows, boolean()}
2227 Sets the default height for rows in the grid.
2229 This will only affect rows subsequently added to the grid unless
2231 resizeExistingRows is true.
2232 If height is less than getRowMinimalAcceptableHeight/1, then the
2234 minimal acceptable height is used instead of it.
2235 setGridCursor(This, Coords) -> ok
2237 Types:
2239 This = wxGrid()
2241 Coords = {R :: integer(), C :: integer()}
2242 Set the grid cursor to the specified cell.
2244 The grid cursor indicates the current cell and can be moved by
2246 the user using the arrow keys or the mouse.
2247 Calling this function generates a wxEVT_GRID_SELECT_CELL event
2249 and if the event handler vetoes this event, the cursor is not
2250 moved.
2251 This function doesn't make the target call visible, use GoTo‐
2253 Cell() (not implemented in wx) to do this.
2254 setGridCursor(This, Row, Col) -> ok
2256 Types:
2258 This = wxGrid()
2260 Row = Col = integer()
2261 Set the grid cursor to the specified cell.
2263 The grid cursor indicates the current cell and can be moved by
2265 the user using the arrow keys or the mouse.
2266 Calling this function generates a wxEVT_GRID_SELECT_CELL event
2268 and if the event handler vetoes this event, the cursor is not
2269 moved.
2270 This function doesn't make the target call visible, use GoTo‐
2272 Cell() (not implemented in wx) to do this.
2273 setGridLineColour(This, Colour) -> ok
2275 Types:
2277 This = wxGrid()
2279 Colour = wx:wx_colour()
2280 Sets the colour used to draw grid lines.
2282 setLabelBackgroundColour(This, Colour) -> ok
2284 Types:
2286 This = wxGrid()
2288 Colour = wx:wx_colour()
2289 Sets the background colour for row and column labels.
2291 setLabelFont(This, Font) -> ok
2293 Types:
2295 This = wxGrid()
2297 Font = wxFont:wxFont()
2298 Sets the font for row and column labels.
2300 setLabelTextColour(This, Colour) -> ok
2302 Types:
2304 This = wxGrid()
2306 Colour = wx:wx_colour()
2307 Sets the colour for row and column label text.
2309 setMargins(This, ExtraWidth, ExtraHeight) -> ok
2311 Types:
2313 This = wxGrid()
2315 ExtraWidth = ExtraHeight = integer()
2316 Sets the extra margins used around the grid area.
2318 A grid may occupy more space than needed for its data display
2320 and this function allows setting how big this extra space is
2321 setReadOnly(This, Row, Col) -> ok
2323 Types:
2325 This = wxGrid()
2327 Row = Col = integer()
2328 setReadOnly(This, Row, Col, Options :: [Option]) -> ok
2330 Types:
2332 This = wxGrid()
2334 Row = Col = integer()
2335 Option = {isReadOnly, boolean()}
2336 Makes the cell at the specified location read-only or editable.
2338 See: isReadOnly/3
2340 setRowAttr(This, Row, Attr) -> ok
2342 Types:
2344 This = wxGrid()
2346 Row = integer()
2347 Attr = wxGridCellAttr:wxGridCellAttr()
2348 Sets the cell attributes for all cells in the specified row.
2350 The grid takes ownership of the attribute pointer.
2352 See the wxGridCellAttr class for more information about control‐
2354 ling cell attributes.
2355 setRowLabelAlignment(This, Horiz, Vert) -> ok
2357 Types:
2359 This = wxGrid()
2361 Horiz = Vert = integer()
2362 Sets the horizontal and vertical alignment of row label text.
2364 Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CEN‐
2366 TRE or wxALIGN_RIGHT. Vertical alignment should be one of wx‐
2367 ALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
2368 setRowLabelSize(This, Width) -> ok
2370 Types:
2372 This = wxGrid()
2374 Width = integer()
2375 Sets the width of the row labels.
2377 If width equals wxGRID_AUTOSIZE then width is calculated auto‐
2379 matically so that no label is truncated. Note that this could be
2380 slow for a large table.
2381 setRowLabelValue(This, Row, Value) -> ok
2383 Types:
2385 This = wxGrid()
2387 Row = integer()
2388 Value = unicode:chardata()
2389 Sets the value for the given row label.
2391 If you are using a derived grid table you must override wx‐
2393 GridTableBase::SetRowLabelValue() (not implemented in wx) for
2394 this to have any effect.
2395 setRowMinimalHeight(This, Row, Height) -> ok
2397 Types:
2399 This = wxGrid()
2401 Row = Height = integer()
2402 Sets the minimal height for the specified row.
2404 See setColMinimalWidth/3 for more information.
2406 setRowMinimalAcceptableHeight(This, Height) -> ok
2408 Types:
2410 This = wxGrid()
2412 Height = integer()
2413 Sets the minimal row height used by default.
2415 See setColMinimalAcceptableWidth/2 for more information.
2417 setRowSize(This, Row, Height) -> ok
2419 Types:
2421 This = wxGrid()
2423 Row = Height = integer()
2424 Sets the height of the specified row.
2426 See setColSize/3 for more information.
2428 setScrollLineX(This, X) -> ok
2430 Types:
2432 This = wxGrid()
2434 X = integer()
2435 Sets the number of pixels per horizontal scroll increment.
2437 The default is 15.
2439 See: getScrollLineX/1, getScrollLineY/1, setScrollLineY/2
2441 setScrollLineY(This, Y) -> ok
2443 Types:
2445 This = wxGrid()
2447 Y = integer()
2448 Sets the number of pixels per vertical scroll increment.
2450 The default is 15.
2452 See: getScrollLineX/1, getScrollLineY/1, setScrollLineX/2
2454 setSelectionBackground(This, C) -> ok
2456 Types:
2458 This = wxGrid()
2460 C = wx:wx_colour()
2461 Set the colour to be used for drawing the selection background.
2463 setSelectionForeground(This, C) -> ok
2465 Types:
2467 This = wxGrid()
2469 C = wx:wx_colour()
2470 Set the colour to be used for drawing the selection foreground.
2472 setSelectionMode(This, Selmode) -> ok
2474 Types:
2476 This = wxGrid()
2478 Selmode = wx:wx_enum()
2479 Set the selection behaviour of the grid.
2481 The existing selection is converted to conform to the new mode
2483 if possible and discarded otherwise (e.g. any individual se‐
2484 lected cells are deselected if the new mode allows only the se‐
2485 lection of the entire rows or columns).
2486 showCellEditControl(This) -> ok
2488 Types:
2490 This = wxGrid()
2492 Displays the active in-place cell edit control for the current
2494 cell after it was hidden.
2495 This method should only be called after calling hideCellEditCon‐
2497 trol/1, to start editing the current grid cell use enableCellEd‐
2498 itControl/2 instead.
2499 xToCol(This, X) -> integer()
2501 Types:
2503 This = wxGrid()
2505 X = integer()
2506 xToCol(This, X, Options :: [Option]) -> integer()
2508 Types:
2510 This = wxGrid()
2512 X = integer()
2513 Option = {clipToMinMax, boolean()}
2514 Returns the column at the given pixel position depending on the
2516 window.
2517 Return: The column index or wxNOT_FOUND.
2519 xToEdgeOfCol(This, X) -> integer()
2521 Types:
2523 This = wxGrid()
2525 X = integer()
2526 Returns the column whose right hand edge is close to the given
2528 logical x position.
2529 If no column edge is near to this position wxNOT_FOUND is re‐
2531 turned.
2532 yToEdgeOfRow(This, Y) -> integer()
2534 Types:
2536 This = wxGrid()
2538 Y = integer()
2539 Returns the row whose bottom edge is close to the given logical
2541 y position.
2542 If no row edge is near to this position wxNOT_FOUND is returned.
2544 yToRow(This, Y) -> integer()
2546 Types:
2548 This = wxGrid()
2550 Y = integer()
2551 yToRow(This, Y, Options :: [Option]) -> integer()
2553 Types:
2555 This = wxGrid()
2557 Y = integer()
2558 Option = {clipToMinMax, boolean()}
2559 Returns the grid row that corresponds to the logical y coordi‐
2561 nate.
2562 The parameter gridWindow is new since wxWidgets 3.1.3. If it is
2564 specified, i.e. non-NULL, only the cells of this window are con‐
2565 sidered, i.e. the function returns wxNOT_FOUND if y is out of
2566 bounds.
2567 If gridWindow is NULL, the function returns wxNOT_FOUND only if
2569 there is no row at all at the y position.
2570wxWidgets team. wx 2.3.1 wxGrid(3)