wxGrid
This is a grid control that can be used to display tabular data. It also allows
editing in place by users, similar to a spreadsheet.
Creation Parameters
- atom parent
- atom id [=-1]
- integer x [=-1]
- integer y [=-1]
- integer cx [=-1]
- integer cy [=-1]
- integer style [=0]
- integer rows [=WXGRID_DEFAULT_NUMBER_ROWS]
- integer COLS [=WXGRID_DEFAULT_NUMBER_colS]
It is important to remember that all wxGrid functions and procedures use zero-based
references to all cells (0, 1, 2,...)
Functions/Procedures
- proc append_cols( atom grid, integer cols )
- proc append_rows( atom grid, integer rows )
- proc auotosize_row( atom grid, atom row )
- proc autosize_columns( atom grid )
- proc autosize_grid( atom grid )
- proc autosize_rows( atom grid )
- func batch_count( atom grid )
- proc begin_batch( atom grid )
- func can_drag_grid_col_move( atom grid )
- func can_drag_grid_col_size( atom grid )
- func can_drag_grid_row_size( atom grid )
- func can_drag_grid_size( atom grid )
- func can_enable_cell_control( atom grid )
- proc clear_grid( atom grid )
- proc clear_grid_selection( atom grid )
- proc delete_cols( atom grid, integer pos, integer n, integer relabel )
- proc delete_rows( atom grid, integer pos, integer n, integer relabel )
- proc enable_drag_grid_col_move( atom grid, atom enable )
- proc enable_drag_grid_col_size( atom grid, atom enable )
- proc enable_drag_grid_row_size( atom grid, atom enable )
- proc enable_drag_grid_size( atom grid, integer enable )
- proc enable_grid_cell_edit_control( atom grid, atom enable )
- proc enable_grid_editing( atom grid, atom edit )
- proc enable_grid_lines( atom grid, atom enable )
- proc end_batch( atom grid )
- proc force_refresh_grid( atom grid )
- func get_cell_alignment( atom grid, atom row, atom col )
- func get_cell_background_color( atom grid, atom row, atom col )
- func get_cell_editor( atom grid, sequence cell )
- func get_cell_editor_control( atom grid, object editor )
- func get_cell_font( atom grid, atom row, atom col )
- func get_cell_text_color( atom grid, atom row, atom col )
- func get_cell_value( atom grid, integer row, integer col )
- func get_col_label( atom grid, integer col )
- func get_col_label_size( atom grid )
- func get_col_size( atom grid, integer col)
- func get_default_cell_background_color( atom grid )
- func get_default_cell_font( atom grid )
- func get_default_cell_text_colour( atom grid )
- func get_default_col_label_size( atom grid )
- func get_default_col_size( atom grid )
- func get_default_editor_for_cell( atom grid, atom row, atom col )
- func get_default_grid_editor( atom grid )
- func get_default_row_label_size( atom grid )
- func get_default_row_size( atom grid )
- func get_grid_batch_count( atom grid )
- func get_grid_label_background_color( atom grid )
- func get_grid_label_font( atom grid )
- func get_grid_label_text_color( atom grid )
- func get_grid_lines_enabled( atom grid )
- func get_grid_line_color( atom grid )
- func get_grid_row_label_align( atom grid )
- func get_grid_scroll_line( atom grid )
- func get_grid_selection_background( atom grid )
- func get_grid_selection_foreground( atom grid )
- func get_grid_view_width( atom grid )
- func get_row_label_size( atom grid )
- func get_row_size( atom grid, integer row)
- func grid_cell_to_rect( atom grid, atom row, atom col )
- func grid_event_cell( atom event )
- func grid_pos( atom grid )
- func grid_size( atom grid )
- proc hide_cell_edit_control( atom grid )
- func insert_grid_cols( atom grid, atom pos, atom num_cols )
- func insert_grid_rows( atom grid, atom pos, atom num_rows )
- func is_cell_edit_control_enabled( atom grid )
- func is_cell_read_only( atom grid, atom row, atom col )
- func is_cell_visible( atom grid, integer row, integer col, integer wholly_visible )
- func is_current_cell_read_only( atom grid )
- func is_grid_editable( atom grid )
- func is_in_grid_selection( atom grid, integer row, integer col )
- func is_selection_for_grid( atom grid )
- func last_cell_visible( atom grid )
- proc make_cell_visible( atom grid, atom row, atom col )
- func move_grid_cursor_down( atom grid, atom expand_selection )
- func move_grid_cursor_down_block( atom grid, atom expand_selection )
- func move_grid_cursor_left( atom grid, atom expand_selection )
- func move_grid_cursor_left_block( atom grid, atom expand_selection )
- func move_grid_cursor_right( atom grid, atom expand_selection )
- func move_grid_cursor_right_block( atom grid, atom expand_selection )
- func move_grid_cursor_up( atom grid, atom expand_selection )
- func move_grid_cursor_up_block( atom grid, atom expand_selection )
- func move_grid_page_down( atom grid )
- func move_grid_page_up( atom grid )
- proc save_grid_edit_control_value( atom grid )
- proc select_grid_all( atom grid )
- proc select_grid_block( atom grid, integer top_row, integer left_col, integer bottom_row, integer right_col, integer add_to_selected )
- proc select_grid_cell( atom grid, atom row, atom col )
- proc select_grid_col( atom grid, integer col )
- proc select_grid_row( atom grid, integer row )
- proc set_cell( atom grid, atom row, atom col )
- proc set_cell_alignment( atom grid, atom row, atom col, atom horz, atom vert )
- proc set_cell_background_color( atom grid, atom row, atom col, atom color )
- proc set_cell_editor( atom grid, atom row, atom col, integer ed_type, object data )
- proc set_cell_font( atom grid, atom row, atom col, atom font )
- proc set_cell_readonly( atom grid, atom row, atom col, integer readonly )
- proc set_cell_text_color( atom grid, atom row, atom col, atom color )
- proc set_cell_value( atom grid, object val, integer row, integer col )
- proc set_col_alignment( atom grid, atom col, atom horz, atom vert )
- proc set_col_editor( atom grid, atom col, integer ed_type, object data )
- proc set_col_format_bool( atom grid, atom col )
- proc set_col_format_float( atom grid, atom col, atom width, atom precision )
- proc set_col_format_number( atom grid, atom col )
- proc set_col_label( atom grid, integer col, sequence text )
- proc set_col_label_align( atom grid, atom horiz, atom vert )
- proc set_col_label_size( atom grid, integer height )
- proc set_col_pos( atom grid, atom col_id, atom new_pos )
- proc set_col_readonly( atom grid, atom col, integer readonly )
- func set_col_size( atom grid, atom col, atom size )
- proc set_default_cell_align( atom grid, atom horiz, atom vert )
- proc set_default_cell_background_color( atom grid, atom color )
- proc set_default_cell_font( atom grid, atom font )
- proc set_default_cell_text_color( atom grid, atom color )
- proc set_default_col_size( atom grid, atom width, atom resize_existing )
- proc set_default_grid_editor( atom grid, atom editor )
- proc set_default_row_size( atom grid, atom width, atom resize_existing )
- proc set_editor_choices( atom grid, object cell, sequence choices )
- proc set_grid_editable( atom grid, integer editable )
- proc set_grid_label_background_color( atom grid, atom color )
- proc set_grid_label_font( atom grid, atom font )
- proc set_grid_label_text_color( atom grid, atom color )
- proc set_grid_line_color( atom grid, atom colour )
- proc set_grid_margins( atom grid, atom extra_width, atom extra_height )
- proc set_grid_scroll_line( atom grid, sequence xy )
- proc set_grid_selection_background( atom grid, atom color )
- proc set_grid_selection_foreground( atom grid, atom color )
- proc set_grid_selection_mode( atom grid, integer mode )
- proc set_grid_size( atom grid, atom rows, atom cols )
- proc set_row_label( atom grid, integer row, sequence text )
- proc set_row_label_align( atom grid, atom horiz, atom vert )
- proc set_row_label_size( atom grid, integer width )
- proc set_row_size( atom grid, atom row, atom height )
- proc show_cell_edit_control( atom grid )
Supertopics
Subtopics
wxGrid
Category:
wxGrid
Appends cols columns to the grid.
wxGrid
Category:
wxGrid
Appends rows rows to the grid.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Resizes each column to the minimum size required to display all the data in each column.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Stops updates of the grid until end_batch() is called. This is useful for
when you need to modify a large number of cells.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Deletes all data in the grid.
wxGrid
Category:
wxGrid
wxGrid
[proc]
delete_cols ( atom grid, integer pos, integer n, integer relabel )
Category:
wxGrid
Deletes n columns from the grid at position pos. If relabel is TRUE, the function
OnChangeLabels is called to give the application the opportunity to relabel.
wxGrid
[proc]
delete_rows ( atom grid, integer pos, integer n, integer relabel )
Category:
wxGrid
Deletes n rows from the grid at position pos. If relabel is TRUE, the function
OnChangeLabels is called to give the application the opportunity to relabel.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Resumes updating of the grid after a call to begin_batch(). This is useful for
when you need to modify a large number of cells.
wxGrid
Category:
wxGrid
Causes immediate repainting of the grid. Use this instead of the usual refresh_window.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Returns the wxGridCellEditor for the cell
wxGrid
Category:
wxGrid
Returns the Control belonging to the wxGridCellEditor
If editor is a sequence, then it specifies the { row, column } of
the wxGridCellEditor to be fetched. Otherwise, it is a wxGridCellEditor
(see get_cell_editor).
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
If the cell contains numeric data, you will need to use value(), since all values
returned by get_cell_value() are strings (this is how wxGrid stores everything).
wxGrid
Category:
wxGrid
Returns a sequence which holds the information at the top of
the column specified by 'column'. The first column is 0. The
column index increases as it goes to the right.
wxGrid
Category:
wxGrid
Returns an integer which represents the height of the columns in pixels.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Returns atom
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Returns an integer which represents the width of the rows in pixels.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Call this inside of wxGrid event handlers to get the row and column where the event
is taking place.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
[func]
is_cell_visible ( atom grid, integer row, integer col, integer wholly_visible )
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Scrolls the grid if necessary to make the cell visible.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Returns An integer which will be 1 if successful, 0 if unsuccessful.
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
[proc]
select_grid_block ( atom grid, integer top_row, integer left_col, integer bottom_row, integer right_col, integer add_to_selected )
Category:
wxGrid
wxGrid
Category:
wxGrid
Moves the cursor and selection to the cell specified.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
[proc]
set_cell ( atom grid, atom row, atom col )
Category:
wxGrid
Moves the cursor to the current cell being edited. Does not
alter the selection (see select_grid_cell)
wxGrid
[proc]
set_cell_alignment ( atom grid, atom row, atom col, atom horz, atom vert )
Category:
wxGrid
Set the vertical of horizontal alignment of a cell:
- wxLEFT
- wxRIGHT
- wxCENTER
- wxTOP
- wxBOTTOM
wxGrid
Category:
wxGrid
wxGrid
[proc]
set_cell_editor ( atom grid, atom row, atom col, integer ed_type, object data )
Category:
wxGrid
Allows entries other than the standard text based editor to be used.
The only editors currently supported are:
- wxGridCellBoolEditor: data is ignored
- wxGridCellChoiceEditor: data should be a 2-element sequence:
- sequence of strings to be added to the editor
- flag to indicate whether items other than the list should be allowed
wxGrid
[proc]
set_cell_font ( atom grid, atom row, atom col, atom font )
Category:
wxGrid
wxGrid
[proc]
set_cell_readonly ( atom grid, atom row, atom col, integer readonly )
Category:
wxGrid
Makes the cell read only if readonly is 1, or allows editing if readonly is 0.
wxGrid
Category:
wxGrid
wxGrid
[proc]
set_cell_value ( atom grid, object val, integer row, integer col )
Category:
wxGrid
Sets the contents of a cell. If val is an atom, then the contents of
the cell will be sprint(val).
wxGrid
Category:
wxGrid
Set the vertical of horizontal alignment of a column:
- wxLEFT
- wxRIGHT
- wxCENTER
- wxTOP
- wxBOTTOM
wxGrid
[proc]
set_col_editor ( atom grid, atom col, integer ed_type, object data )
Category:
wxGrid
Allows entries other than the standard text based editor to be used.
The only editors currently supported are:
- wxGridCellBoolEditor: data is ignored
- wxGridCellChoiceEditor: data should be a sequence of strings
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
[proc]
set_col_label ( atom grid, integer col, sequence text )
Category:
wxGrid
Changes the label of a column.
wxGrid
Category:
wxGrid
Use wxLEFT, wxRIGHT and wxTOP, wxBOTTOM (or zero for center)
wxGrid
Category:
wxGrid
wxGrid
[proc]
set_col_pos ( atom grid, atom col_id, atom new_pos )
Category:
wxGrid
wxGrid
Category:
wxGrid
Sets the specified col in the specified grid to be read only if
readonly is 1. Editing will be allowed if readonly is 0.
wxGrid
Category:
wxGrid
Change the size of a grid column. This function does not refresh the grid.
If you are calling it outside of a BeginBatch EndBatch block you can use force_refresh_grid
to see the changes
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Sets the default cell editor control for the grid.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
If cell is an integer, then it refers to an entire column, and the
choices will be set for the column editor. If cell is a sequence,
it refers to the cell by {row, column}, and that cell's editor will
be set.
wxGrid
Category:
wxGrid
Makes the entire grid uneditable by the user is editable is 0, or allows editing
if editable is 1.
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Change the color of the lines in the grid.
wxGrid
[proc]
set_grid_margins ( atom grid, atom extra_width, atom extra_height )
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
wxGrid
Category:
wxGrid
Adds or deletes columns or rows as required.
wxGrid
[proc]
set_row_label ( atom grid, integer row, sequence text )
Category:
wxGrid
Changes the label of a row.
wxGrid
Category:
wxGrid
Use wxLEFT, wxRIGHT and wxTOP, wxBOTTOM (or zero for center)
wxGrid
Category:
wxGrid
This sets the labels of rows in a wxGrid to be 'width' pixels high.
wxGrid
[proc]
set_row_size ( atom grid, atom row, atom height )
Category:
wxGrid
wxGrid
Category:
wxGrid