wxGrid

See external documentation: wxGrid.

See external documentation: wxGrid.

This class is derived (and can use functions) from:
wxScrolledWindow
wxPanel
wxWindow
wxEvtHandler

DATA TYPES

wxGrid()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

Functions


new() -> wxGrid()

See external documentation.

new(Parent::wxWindow() (see module wxWindow), Id::integer()) -> wxGrid()

Equivalent to new(Parent, Id, []).

new(Parent::wxWindow() (see module wxWindow), X::integer(), X::integer() | term()) -> wxGrid()

See external documentation.
Alternatives:

new(Parent::wxWindow:wxWindow(), X::integer(), Y::integer()) -> new(Parent,X,Y, [])

new(Parent::wxWindow:wxWindow(), Id::integer(), [Option]) -> wxGrid()
Option = {pos, {X::integer(),Y::integer()}} | {size, {W::integer(),H::integer()}} | {style, integer()}

new(Parent::wxWindow() (see module wxWindow), X::integer(), Y::integer(), Options::[Option]) -> wxGrid()

  • Option = {w, integer()} | {h, integer()} | {style, integer()}

See external documentation.

appendCols(This::wxGrid()) -> bool()

Equivalent to appendCols(This, []).

appendCols(This::wxGrid(), Options::[Option]) -> bool()

  • Option = {numCols, integer()} | {updateLabels, bool()}

See external documentation.

appendRows(This::wxGrid()) -> bool()

Equivalent to appendRows(This, []).

appendRows(This::wxGrid(), Options::[Option]) -> bool()

  • Option = {numRows, integer()} | {updateLabels, bool()}

See external documentation.

autoSize(This::wxGrid()) -> ok

See external documentation.

autoSizeColumn(This::wxGrid(), Col::integer()) -> ok

autoSizeColumn(This::wxGrid(), Col::integer(), Options::[Option]) -> ok

  • Option = {setAsMin, bool()}

See external documentation.

autoSizeColumns(This::wxGrid()) -> ok

Equivalent to autoSizeColumns(This, []).

autoSizeColumns(This::wxGrid(), Options::[Option]) -> ok

  • Option = {setAsMin, bool()}

See external documentation.

autoSizeRow(This::wxGrid(), Row::integer()) -> ok

autoSizeRow(This::wxGrid(), Row::integer(), Options::[Option]) -> ok

  • Option = {setAsMin, bool()}

See external documentation.

autoSizeRows(This::wxGrid()) -> ok

Equivalent to autoSizeRows(This, []).

autoSizeRows(This::wxGrid(), Options::[Option]) -> ok

  • Option = {setAsMin, bool()}

See external documentation.

beginBatch(This::wxGrid()) -> ok

See external documentation.

blockToDeviceRect(This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

canDragColSize(This::wxGrid()) -> bool()

See external documentation.

canDragRowSize(This::wxGrid()) -> bool()

See external documentation.

canDragGridSize(This::wxGrid()) -> bool()

See external documentation.

canEnableCellControl(This::wxGrid()) -> bool()

See external documentation.

cellToRect(This::wxGrid(), Coords::{R::integer(), C::integer()}) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

cellToRect(This::wxGrid(), Row::integer(), Col::integer()) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

clearGrid(This::wxGrid()) -> ok

See external documentation.

clearSelection(This::wxGrid()) -> ok

See external documentation.

createGrid(This::wxGrid(), NumRows::integer(), NumCols::integer()) -> bool()

createGrid(This::wxGrid(), NumRows::integer(), NumCols::integer(), Options::[Option]) -> bool()

  • Option = {selmode, WxGridSelectionModes}
  • WxGridSelectionModes = integer()

See external documentation.
WxGridSelectionModes is one of ?wxGrid_wxGridSelectCells | ?wxGrid_wxGridSelectRows | ?wxGrid_wxGridSelectColumns

deleteCols(This::wxGrid()) -> bool()

Equivalent to deleteCols(This, []).

deleteCols(This::wxGrid(), Options::[Option]) -> bool()

  • Option = {pos, integer()} | {numCols, integer()} | {updateLabels, bool()}

See external documentation.

deleteRows(This::wxGrid()) -> bool()

Equivalent to deleteRows(This, []).

deleteRows(This::wxGrid(), Options::[Option]) -> bool()

  • Option = {pos, integer()} | {numRows, integer()} | {updateLabels, bool()}

See external documentation.

disableCellEditControl(This::wxGrid()) -> ok

See external documentation.

disableDragColSize(This::wxGrid()) -> ok

See external documentation.

disableDragGridSize(This::wxGrid()) -> ok

See external documentation.

disableDragRowSize(This::wxGrid()) -> ok

See external documentation.

enableCellEditControl(This::wxGrid()) -> ok

enableCellEditControl(This::wxGrid(), Options::[Option]) -> ok

  • Option = {enable, bool()}

See external documentation.

enableDragColSize(This::wxGrid()) -> ok

enableDragColSize(This::wxGrid(), Options::[Option]) -> ok

  • Option = {enable, bool()}

See external documentation.

enableDragGridSize(This::wxGrid()) -> ok

enableDragGridSize(This::wxGrid(), Options::[Option]) -> ok

  • Option = {enable, bool()}

See external documentation.

enableDragRowSize(This::wxGrid()) -> ok

enableDragRowSize(This::wxGrid(), Options::[Option]) -> ok

  • Option = {enable, bool()}

See external documentation.

enableEditing(This::wxGrid(), Edit::bool()) -> ok

See external documentation.

enableGridLines(This::wxGrid()) -> ok

Equivalent to enableGridLines(This, []).

enableGridLines(This::wxGrid(), Options::[Option]) -> ok

  • Option = {enable, bool()}

See external documentation.

endBatch(This::wxGrid()) -> ok

See external documentation.

fit(This::wxGrid()) -> ok

See external documentation.

forceRefresh(This::wxGrid()) -> ok

See external documentation.

getBatchCount(This::wxGrid()) -> integer()

See external documentation.

getCellAlignment(This::wxGrid(), Row::integer(), Col::integer()) -> {Horiz::integer(), Vert::integer()}

See external documentation.

getCellBackgroundColour(This::wxGrid(), Row::integer(), Col::integer()) -> colour() (see module wx)

See external documentation.

getCellEditor(This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellEditor() (see module wxGridCellEditor)

See external documentation.

getCellFont(This::wxGrid(), Row::integer(), Col::integer()) -> wxFont() (see module wxFont)

See external documentation.

getCellRenderer(This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellRenderer() (see module wxGridCellRenderer)

See external documentation.

getCellTextColour(This::wxGrid(), Row::integer(), Col::integer()) -> colour() (see module wx)

See external documentation.

getCellValue(This::wxGrid(), Coords::{R::integer(), C::integer()}) -> string()

See external documentation.

getCellValue(This::wxGrid(), Row::integer(), Col::integer()) -> string()

See external documentation.

getColLabelAlignment(This::wxGrid()) -> {Horiz::integer(), Vert::integer()}

See external documentation.

getColLabelSize(This::wxGrid()) -> integer()

See external documentation.

getColLabelValue(This::wxGrid(), Col::integer()) -> string()

See external documentation.

getColMinimalAcceptableWidth(This::wxGrid()) -> integer()

See external documentation.

getDefaultCellAlignment(This::wxGrid()) -> {Horiz::integer(), Vert::integer()}

See external documentation.

getDefaultCellBackgroundColour(This::wxGrid()) -> colour() (see module wx)

See external documentation.

getDefaultCellFont(This::wxGrid()) -> wxFont() (see module wxFont)

See external documentation.

getDefaultCellTextColour(This::wxGrid()) -> colour() (see module wx)

See external documentation.

getDefaultColLabelSize(This::wxGrid()) -> integer()

See external documentation.

getDefaultColSize(This::wxGrid()) -> integer()

See external documentation.

getDefaultEditor(This::wxGrid()) -> wxGridCellEditor() (see module wxGridCellEditor)

See external documentation.

getDefaultEditorForCell(This::wxGrid(), C::{R::integer(), C::integer()}) -> wxGridCellEditor() (see module wxGridCellEditor)

See external documentation.

getDefaultEditorForCell(This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellEditor() (see module wxGridCellEditor)

See external documentation.

getDefaultEditorForType(This::wxGrid(), TypeName::string()) -> wxGridCellEditor() (see module wxGridCellEditor)

See external documentation.

getDefaultRenderer(This::wxGrid()) -> wxGridCellRenderer() (see module wxGridCellRenderer)

See external documentation.

getDefaultRendererForCell(This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellRenderer() (see module wxGridCellRenderer)

See external documentation.

getDefaultRendererForType(This::wxGrid(), TypeName::string()) -> wxGridCellRenderer() (see module wxGridCellRenderer)

See external documentation.

getDefaultRowLabelSize(This::wxGrid()) -> integer()

See external documentation.

getDefaultRowSize(This::wxGrid()) -> integer()

See external documentation.

getGridCursorCol(This::wxGrid()) -> integer()

See external documentation.

getGridCursorRow(This::wxGrid()) -> integer()

See external documentation.

getGridLineColour(This::wxGrid()) -> colour() (see module wx)

See external documentation.

gridLinesEnabled(This::wxGrid()) -> bool()

See external documentation.

getLabelBackgroundColour(This::wxGrid()) -> colour() (see module wx)

See external documentation.

getLabelFont(This::wxGrid()) -> wxFont() (see module wxFont)

See external documentation.

getLabelTextColour(This::wxGrid()) -> colour() (see module wx)

See external documentation.

getNumberCols(This::wxGrid()) -> integer()

See external documentation.

getNumberRows(This::wxGrid()) -> integer()

See external documentation.

getOrCreateCellAttr(This::wxGrid(), Row::integer(), Col::integer()) -> wxGridCellAttr() (see module wxGridCellAttr)

See external documentation.

getRowMinimalAcceptableHeight(This::wxGrid()) -> integer()

See external documentation.

getRowLabelAlignment(This::wxGrid()) -> {Horiz::integer(), Vert::integer()}

See external documentation.

getRowLabelSize(This::wxGrid()) -> integer()

See external documentation.

getRowLabelValue(This::wxGrid(), Row::integer()) -> string()

See external documentation.

getRowSize(This::wxGrid(), Row::integer()) -> integer()

See external documentation.

getScrollLineX(This::wxGrid()) -> integer()

See external documentation.

getScrollLineY(This::wxGrid()) -> integer()

See external documentation.

getSelectedCells(This::wxGrid()) -> [{R::integer(), C::integer()}]

See external documentation.

getSelectedCols(This::wxGrid()) -> [integer()]

See external documentation.

getSelectedRows(This::wxGrid()) -> [integer()]

See external documentation.

getSelectionBackground(This::wxGrid()) -> colour() (see module wx)

See external documentation.

getSelectionBlockTopLeft(This::wxGrid()) -> [{R::integer(), C::integer()}]

See external documentation.

getSelectionBlockBottomRight(This::wxGrid()) -> [{R::integer(), C::integer()}]

See external documentation.

getSelectionForeground(This::wxGrid()) -> colour() (see module wx)

See external documentation.

getViewWidth(This::wxGrid()) -> integer()

See external documentation.

getGridWindow(This::wxGrid()) -> wxWindow() (see module wxWindow)

See external documentation.

getGridRowLabelWindow(This::wxGrid()) -> wxWindow() (see module wxWindow)

See external documentation.

getGridColLabelWindow(This::wxGrid()) -> wxWindow() (see module wxWindow)

See external documentation.

getGridCornerLabelWindow(This::wxGrid()) -> wxWindow() (see module wxWindow)

See external documentation.

hideCellEditControl(This::wxGrid()) -> ok

See external documentation.

insertCols(This::wxGrid()) -> bool()

Equivalent to insertCols(This, []).

insertCols(This::wxGrid(), Options::[Option]) -> bool()

  • Option = {pos, integer()} | {numCols, integer()} | {updateLabels, bool()}

See external documentation.

insertRows(This::wxGrid()) -> bool()

Equivalent to insertRows(This, []).

insertRows(This::wxGrid(), Options::[Option]) -> bool()

  • Option = {pos, integer()} | {numRows, integer()} | {updateLabels, bool()}

See external documentation.

isCellEditControlEnabled(This::wxGrid()) -> bool()

See external documentation.

isCurrentCellReadOnly(This::wxGrid()) -> bool()

See external documentation.

isEditable(This::wxGrid()) -> bool()

See external documentation.

isInSelection(This::wxGrid(), Coords::{R::integer(), C::integer()}) -> bool()

See external documentation.

isInSelection(This::wxGrid(), Row::integer(), Col::integer()) -> bool()

See external documentation.

isReadOnly(This::wxGrid(), Row::integer(), Col::integer()) -> bool()

See external documentation.

isSelection(This::wxGrid()) -> bool()

See external documentation.

isVisible(This::wxGrid(), Coords::{R::integer(), C::integer()}) -> bool()

isVisible(This::wxGrid(), X::integer() | term(), X::integer() | term()) -> bool()

See external documentation.
Alternatives:

isVisible(This::wxGrid(), Row::integer(), Col::integer()) -> isVisible(This,Row,Col, [])

isVisible(This::wxGrid(), Coords::{R::integer(),C::integer()}, [Option]) -> bool()
Option = {wholeCellVisible, bool()}

isVisible(This::wxGrid(), Row::integer(), Col::integer(), Options::[Option]) -> bool()

  • Option = {wholeCellVisible, bool()}

See external documentation.

makeCellVisible(This::wxGrid(), Coords::{R::integer(), C::integer()}) -> ok

See external documentation.

makeCellVisible(This::wxGrid(), Row::integer(), Col::integer()) -> ok

See external documentation.

moveCursorDown(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

moveCursorLeft(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

moveCursorRight(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

moveCursorUp(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

moveCursorDownBlock(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

moveCursorLeftBlock(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

moveCursorRightBlock(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

moveCursorUpBlock(This::wxGrid(), ExpandSelection::bool()) -> bool()

See external documentation.

movePageDown(This::wxGrid()) -> bool()

See external documentation.

movePageUp(This::wxGrid()) -> bool()

See external documentation.

registerDataType(This::wxGrid(), TypeName::string(), Renderer::wxGridCellRenderer() (see module wxGridCellRenderer), Editor::wxGridCellEditor() (see module wxGridCellEditor)) -> ok

See external documentation.

saveEditControlValue(This::wxGrid()) -> ok

See external documentation.

selectAll(This::wxGrid()) -> ok

See external documentation.

selectBlock(This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}) -> ok

selectBlock(This::wxGrid(), TopLeft::{R::integer(), C::integer()}, BottomRight::{R::integer(), C::integer()}, Options::[Option]) -> ok

  • Option = {addToSelected, bool()}

See external documentation.

selectBlock(This::wxGrid(), TopRow::integer(), LeftCol::integer(), BottomRow::integer(), RightCol::integer()) -> ok

selectBlock(This::wxGrid(), TopRow::integer(), LeftCol::integer(), BottomRow::integer(), RightCol::integer(), Options::[Option]) -> ok

  • Option = {addToSelected, bool()}

See external documentation.

selectCol(This::wxGrid(), Col::integer()) -> ok

Equivalent to selectCol(This, Col, []).

selectCol(This::wxGrid(), Col::integer(), Options::[Option]) -> ok

  • Option = {addToSelected, bool()}

See external documentation.

selectRow(This::wxGrid(), Row::integer()) -> ok

Equivalent to selectRow(This, Row, []).

selectRow(This::wxGrid(), Row::integer(), Options::[Option]) -> ok

  • Option = {addToSelected, bool()}

See external documentation.

setCellAlignment(This::wxGrid(), Align::integer()) -> ok

See external documentation.

setCellAlignment(This::wxGrid(), Align::integer(), Row::integer(), Col::integer()) -> ok

See external documentation.

setCellAlignment(This::wxGrid(), Row::integer(), Col::integer(), Horiz::integer(), Vert::integer()) -> ok

See external documentation.

setCellBackgroundColour(This::wxGrid(), Col::colour() (see module wx)) -> ok

See external documentation.

setCellBackgroundColour(This::wxGrid(), X::integer() | term(), X::integer(), X::term() | integer()) -> ok

See external documentation.
Alternatives:

setCellBackgroundColour(This::wxGrid(), Row::integer(), Col::integer(), Val::wx:colour()) -> ok

setCellBackgroundColour(This::wxGrid(), Colour::wx:colour(), Row::integer(), Col::integer()) -> ok

setCellEditor(This::wxGrid(), Row::integer(), Col::integer(), Editor::wxGridCellEditor() (see module wxGridCellEditor)) -> ok

See external documentation.

setCellFont(This::wxGrid(), Row::integer(), Col::integer(), Val::wxFont() (see module wxFont)) -> ok

See external documentation.

setCellRenderer(This::wxGrid(), Row::integer(), Col::integer(), Renderer::wxGridCellRenderer() (see module wxGridCellRenderer)) -> ok

See external documentation.

setCellTextColour(This::wxGrid(), Col::colour() (see module wx)) -> ok

See external documentation.

setCellTextColour(This::wxGrid(), X::integer() | term(), X::integer(), X::term() | integer()) -> ok

See external documentation.
Alternatives:

setCellTextColour(This::wxGrid(), Row::integer(), Col::integer(), Val::wx:colour()) -> ok

setCellTextColour(This::wxGrid(), Val::wx:colour(), Row::integer(), Col::integer()) -> ok

setCellValue(This::wxGrid(), Coords::{R::integer(), C::integer()}, S::string()) -> ok

See external documentation.

setCellValue(This::wxGrid(), X::integer() | string(), X::integer(), X::string() | integer()) -> ok

See external documentation.
Alternatives:

setCellValue(This::wxGrid(), Row::integer(), Col::integer(), S::string()) -> ok

setCellValue(This::wxGrid(), Val::string(), Row::integer(), Col::integer()) -> ok

setColAttr(This::wxGrid(), Col::integer(), Attr::wxGridCellAttr() (see module wxGridCellAttr)) -> ok

See external documentation.

setColFormatBool(This::wxGrid(), Col::integer()) -> ok

See external documentation.

setColFormatNumber(This::wxGrid(), Col::integer()) -> ok

See external documentation.

setColFormatFloat(This::wxGrid(), Col::integer()) -> ok

setColFormatFloat(This::wxGrid(), Col::integer(), Options::[Option]) -> ok

  • Option = {width, integer()} | {precision, integer()}

See external documentation.

setColFormatCustom(This::wxGrid(), Col::integer(), TypeName::string()) -> ok

See external documentation.

setColLabelAlignment(This::wxGrid(), Horiz::integer(), Vert::integer()) -> ok

See external documentation.

setColLabelSize(This::wxGrid(), Height::integer()) -> ok

See external documentation.

setColLabelValue(This::wxGrid(), Col::integer(), Val::string()) -> ok

See external documentation.

setColMinimalWidth(This::wxGrid(), Col::integer(), Width::integer()) -> ok

See external documentation.

setColMinimalAcceptableWidth(This::wxGrid(), Width::integer()) -> ok

See external documentation.

setColSize(This::wxGrid(), Col::integer(), Width::integer()) -> ok

See external documentation.

setDefaultCellAlignment(This::wxGrid(), Horiz::integer(), Vert::integer()) -> ok

See external documentation.

setDefaultCellBackgroundColour(This::wxGrid(), Val::colour() (see module wx)) -> ok

See external documentation.

setDefaultCellFont(This::wxGrid(), Val::wxFont() (see module wxFont)) -> ok

See external documentation.

setDefaultCellTextColour(This::wxGrid(), Val::colour() (see module wx)) -> ok

See external documentation.

setDefaultEditor(This::wxGrid(), Editor::wxGridCellEditor() (see module wxGridCellEditor)) -> ok

See external documentation.

setDefaultRenderer(This::wxGrid(), Renderer::wxGridCellRenderer() (see module wxGridCellRenderer)) -> ok

See external documentation.

setDefaultColSize(This::wxGrid(), Width::integer()) -> ok

setDefaultColSize(This::wxGrid(), Width::integer(), Options::[Option]) -> ok

  • Option = {resizeExistingCols, bool()}

See external documentation.

setDefaultRowSize(This::wxGrid(), Height::integer()) -> ok

setDefaultRowSize(This::wxGrid(), Height::integer(), Options::[Option]) -> ok

  • Option = {resizeExistingRows, bool()}

See external documentation.

setGridCursor(This::wxGrid(), Row::integer(), Col::integer()) -> ok

See external documentation.

setGridLineColour(This::wxGrid(), Val::colour() (see module wx)) -> ok

See external documentation.

setLabelBackgroundColour(This::wxGrid(), Val::colour() (see module wx)) -> ok

See external documentation.

setLabelFont(This::wxGrid(), Val::wxFont() (see module wxFont)) -> ok

See external documentation.

setLabelTextColour(This::wxGrid(), Val::colour() (see module wx)) -> ok

See external documentation.

setMargins(This::wxGrid(), ExtraWidth::integer(), ExtraHeight::integer()) -> ok

See external documentation.

setReadOnly(This::wxGrid(), Row::integer(), Col::integer()) -> ok

setReadOnly(This::wxGrid(), Row::integer(), Col::integer(), Options::[Option]) -> ok

  • Option = {isReadOnly, bool()}

See external documentation.

setRowAttr(This::wxGrid(), Row::integer(), Attr::wxGridCellAttr() (see module wxGridCellAttr)) -> ok

See external documentation.

setRowLabelAlignment(This::wxGrid(), Horiz::integer(), Vert::integer()) -> ok

See external documentation.

setRowLabelSize(This::wxGrid(), Width::integer()) -> ok

See external documentation.

setRowLabelValue(This::wxGrid(), Row::integer(), Val::string()) -> ok

See external documentation.

setRowMinimalHeight(This::wxGrid(), Row::integer(), Width::integer()) -> ok

See external documentation.

setRowMinimalAcceptableHeight(This::wxGrid(), Width::integer()) -> ok

See external documentation.

setRowSize(This::wxGrid(), Row::integer(), Height::integer()) -> ok

See external documentation.

setScrollLineX(This::wxGrid(), X::integer()) -> ok

See external documentation.

setScrollLineY(This::wxGrid(), Y::integer()) -> ok

See external documentation.

setSelectionBackground(This::wxGrid(), C::colour() (see module wx)) -> ok

See external documentation.

setSelectionForeground(This::wxGrid(), C::colour() (see module wx)) -> ok

See external documentation.

setSelectionMode(This::wxGrid(), Selmode::WxGridSelectionModes) -> ok

  • WxGridSelectionModes = integer()

See external documentation.
WxGridSelectionModes is one of ?wxGrid_wxGridSelectCells | ?wxGrid_wxGridSelectRows | ?wxGrid_wxGridSelectColumns

showCellEditControl(This::wxGrid()) -> ok

See external documentation.

xToCol(This::wxGrid(), X::integer()) -> integer()

Equivalent to xToCol(This, X, []).

xToCol(This::wxGrid(), X::integer(), Options::[Option]) -> integer()

  • Option = {clipToMinMax, bool()}

See external documentation.

xToEdgeOfCol(This::wxGrid(), X::integer()) -> integer()

See external documentation.

yToEdgeOfRow(This::wxGrid(), Y::integer()) -> integer()

See external documentation.

yToRow(This::wxGrid(), Y::integer()) -> integer()

See external documentation.

destroy(This::wxGrid()) -> ok

Destroys this object, do not use object again

View Functions