wxGrid

Description

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.

Exports

new() -> wxGrid()

See external documentation.

new(Parent, Id) -> wxGrid()

Types

Parent = wxWindow:wxWindow()

Id = integer()

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

new(Parent, X, Y) -> wxGrid()

Types

Parent = wxWindow:wxWindow()

X = integer()

Y = integer()

See external documentation.
Also:
new(Parent, Id, [Option]) -> wxGrid() when
Parent::wxWindow:wxWindow(), Id::integer(),
Option :: {'pos', {X::integer(), Y::integer()}}
| {'size', {W::integer(), H::integer()}}
| {'style', integer()}.

new(Parent, X, Y, Options::[Option]) -> wxGrid()

Types

Parent = wxWindow:wxWindow()

X = integer()

Y = integer()

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

See external documentation.

appendCols(This) -> boolean()

Types

This = wxGrid()

Equivalent to appendCols(This, []).

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

Types

This = wxGrid()

Option = {numCols, integer()} | {updateLabels, boolean()}

See external documentation.

appendRows(This) -> boolean()

Types

This = wxGrid()

Equivalent to appendRows(This, []).

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

Types

This = wxGrid()

Option = {numRows, integer()} | {updateLabels, boolean()}

See external documentation.

autoSize(This) -> ok

Types

This = wxGrid()

See external documentation.

autoSizeColumn(This, Col) -> ok

Types

This = wxGrid()

Col = integer()

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

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

Types

This = wxGrid()

Col = integer()

Option = {setAsMin, boolean()}

See external documentation.

autoSizeColumns(This) -> ok

Types

This = wxGrid()

Equivalent to autoSizeColumns(This, []).

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

Types

This = wxGrid()

Option = {setAsMin, boolean()}

See external documentation.

autoSizeRow(This, Row) -> ok

Types

This = wxGrid()

Row = integer()

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

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

Types

This = wxGrid()

Row = integer()

Option = {setAsMin, boolean()}

See external documentation.

autoSizeRows(This) -> ok

Types

This = wxGrid()

Equivalent to autoSizeRows(This, []).

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

Types

This = wxGrid()

Option = {setAsMin, boolean()}

See external documentation.

beginBatch(This) -> ok

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

TopLeft = {R::integer(), C::integer()}

BottomRight = {R::integer(), C::integer()}

See external documentation.

canDragColSize(This) -> boolean()

Types

This = wxGrid()

See external documentation.

canDragRowSize(This) -> boolean()

Types

This = wxGrid()

See external documentation.

canDragGridSize(This) -> boolean()

Types

This = wxGrid()

See external documentation.

canEnableCellControl(This) -> boolean()

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

Coords = {R::integer(), C::integer()}

See external documentation.

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

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

clearGrid(This) -> ok

Types

This = wxGrid()

See external documentation.

clearSelection(This) -> ok

Types

This = wxGrid()

See external documentation.

createGrid(This, NumRows, NumCols) -> boolean()

Types

This = wxGrid()

NumRows = integer()

NumCols = integer()

Equivalent to createGrid(This, NumRows, NumCols, []).

createGrid(This, NumRows, NumCols, Options::[Option]) -> boolean()

Types

This = wxGrid()

NumRows = integer()

NumCols = integer()

Option = {selmode, wx:wx_enum()}

See external documentation.
Selmode = ?wxGrid_wxGridSelectCells | ?wxGrid_wxGridSelectRows | ?wxGrid_wxGridSelectColumns

deleteCols(This) -> boolean()

Types

This = wxGrid()

Equivalent to deleteCols(This, []).

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

Types

This = wxGrid()

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

See external documentation.

deleteRows(This) -> boolean()

Types

This = wxGrid()

Equivalent to deleteRows(This, []).

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

Types

This = wxGrid()

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

See external documentation.

disableCellEditControl(This) -> ok

Types

This = wxGrid()

See external documentation.

disableDragColSize(This) -> ok

Types

This = wxGrid()

See external documentation.

disableDragGridSize(This) -> ok

Types

This = wxGrid()

See external documentation.

disableDragRowSize(This) -> ok

Types

This = wxGrid()

See external documentation.

enableCellEditControl(This) -> ok

Types

This = wxGrid()

Equivalent to enableCellEditControl(This, []).

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

Types

This = wxGrid()

Option = {enable, boolean()}

See external documentation.

enableDragColSize(This) -> ok

Types

This = wxGrid()

Equivalent to enableDragColSize(This, []).

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

Types

This = wxGrid()

Option = {enable, boolean()}

See external documentation.

enableDragGridSize(This) -> ok

Types

This = wxGrid()

Equivalent to enableDragGridSize(This, []).

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

Types

This = wxGrid()

Option = {enable, boolean()}

See external documentation.

enableDragRowSize(This) -> ok

Types

This = wxGrid()

Equivalent to enableDragRowSize(This, []).

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

Types

This = wxGrid()

Option = {enable, boolean()}

See external documentation.

enableEditing(This, Edit) -> ok

Types

This = wxGrid()

Edit = boolean()

See external documentation.

enableGridLines(This) -> ok

Types

This = wxGrid()

Equivalent to enableGridLines(This, []).

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

Types

This = wxGrid()

Option = {enable, boolean()}

See external documentation.

endBatch(This) -> ok

Types

This = wxGrid()

See external documentation.

fit(This) -> ok

Types

This = wxGrid()

See external documentation.

forceRefresh(This) -> ok

Types

This = wxGrid()

See external documentation.

getBatchCount(This) -> integer()

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getCellBackgroundColour(This, Row, Col) -> wx:wx_colour4()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getCellEditor(This, Row, Col) -> wxGridCellEditor:wxGridCellEditor()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getCellFont(This, Row, Col) -> wxFont:wxFont()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getCellRenderer(This, Row, Col) -> wxGridCellRenderer:wxGridCellRenderer()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getCellTextColour(This, Row, Col) -> wx:wx_colour4()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getCellValue(This, Coords) -> unicode:charlist()

Types

This = wxGrid()

Coords = {R::integer(), C::integer()}

See external documentation.

getCellValue(This, Row, Col) -> unicode:charlist()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

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

Types

This = wxGrid()

See external documentation.

getColLabelSize(This) -> integer()

Types

This = wxGrid()

See external documentation.

getColLabelValue(This, Col) -> unicode:charlist()

Types

This = wxGrid()

Col = integer()

See external documentation.

getColMinimalAcceptableWidth(This) -> integer()

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

See external documentation.

getDefaultCellBackgroundColour(This) -> wx:wx_colour4()

Types

This = wxGrid()

See external documentation.

getDefaultCellFont(This) -> wxFont:wxFont()

Types

This = wxGrid()

See external documentation.

getDefaultCellTextColour(This) -> wx:wx_colour4()

Types

This = wxGrid()

See external documentation.

getDefaultColLabelSize(This) -> integer()

Types

This = wxGrid()

See external documentation.

getDefaultColSize(This) -> integer()

Types

This = wxGrid()

See external documentation.

getDefaultEditor(This) -> wxGridCellEditor:wxGridCellEditor()

Types

This = wxGrid()

See external documentation.

getDefaultEditorForCell(This, C) -> wxGridCellEditor:wxGridCellEditor()

Types

This = wxGrid()

C = {R::integer(), C::integer()}

See external documentation.

getDefaultEditorForCell(This, Row, Col) -> wxGridCellEditor:wxGridCellEditor()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getDefaultEditorForType(This, TypeName) -> wxGridCellEditor:wxGridCellEditor()

Types

This = wxGrid()

TypeName = unicode:chardata()

See external documentation.

getDefaultRenderer(This) -> wxGridCellRenderer:wxGridCellRenderer()

Types

This = wxGrid()

See external documentation.

getDefaultRendererForCell(This, Row, Col) -> wxGridCellRenderer:wxGridCellRenderer()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getDefaultRendererForType(This, TypeName) -> wxGridCellRenderer:wxGridCellRenderer()

Types

This = wxGrid()

TypeName = unicode:chardata()

See external documentation.

getDefaultRowLabelSize(This) -> integer()

Types

This = wxGrid()

See external documentation.

getDefaultRowSize(This) -> integer()

Types

This = wxGrid()

See external documentation.

getGridCursorCol(This) -> integer()

Types

This = wxGrid()

See external documentation.

getGridCursorRow(This) -> integer()

Types

This = wxGrid()

See external documentation.

getGridLineColour(This) -> wx:wx_colour4()

Types

This = wxGrid()

See external documentation.

gridLinesEnabled(This) -> boolean()

Types

This = wxGrid()

See external documentation.

getLabelBackgroundColour(This) -> wx:wx_colour4()

Types

This = wxGrid()

See external documentation.

getLabelFont(This) -> wxFont:wxFont()

Types

This = wxGrid()

See external documentation.

getLabelTextColour(This) -> wx:wx_colour4()

Types

This = wxGrid()

See external documentation.

getNumberCols(This) -> integer()

Types

This = wxGrid()

See external documentation.

getNumberRows(This) -> integer()

Types

This = wxGrid()

See external documentation.

getOrCreateCellAttr(This, Row, Col) -> wxGridCellAttr:wxGridCellAttr()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

getRowMinimalAcceptableHeight(This) -> integer()

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

See external documentation.

getRowLabelSize(This) -> integer()

Types

This = wxGrid()

See external documentation.

getRowLabelValue(This, Row) -> unicode:charlist()

Types

This = wxGrid()

Row = integer()

See external documentation.

getRowSize(This, Row) -> integer()

Types

This = wxGrid()

Row = integer()

See external documentation.

getScrollLineX(This) -> integer()

Types

This = wxGrid()

See external documentation.

getScrollLineY(This) -> integer()

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

See external documentation.

getSelectedCols(This) -> [integer()]

Types

This = wxGrid()

See external documentation.

getSelectedRows(This) -> [integer()]

Types

This = wxGrid()

See external documentation.

getSelectionBackground(This) -> wx:wx_colour4()

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

See external documentation.

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

Types

This = wxGrid()

See external documentation.

getSelectionForeground(This) -> wx:wx_colour4()

Types

This = wxGrid()

See external documentation.

getViewWidth(This) -> integer()

Types

This = wxGrid()

See external documentation.

getGridWindow(This) -> wxWindow:wxWindow()

Types

This = wxGrid()

See external documentation.

getGridRowLabelWindow(This) -> wxWindow:wxWindow()

Types

This = wxGrid()

See external documentation.

getGridColLabelWindow(This) -> wxWindow:wxWindow()

Types

This = wxGrid()

See external documentation.

getGridCornerLabelWindow(This) -> wxWindow:wxWindow()

Types

This = wxGrid()

See external documentation.

hideCellEditControl(This) -> ok

Types

This = wxGrid()

See external documentation.

insertCols(This) -> boolean()

Types

This = wxGrid()

Equivalent to insertCols(This, []).

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

Types

This = wxGrid()

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

See external documentation.

insertRows(This) -> boolean()

Types

This = wxGrid()

Equivalent to insertRows(This, []).

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

Types

This = wxGrid()

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

See external documentation.

isCellEditControlEnabled(This) -> boolean()

Types

This = wxGrid()

See external documentation.

isCurrentCellReadOnly(This) -> boolean()

Types

This = wxGrid()

See external documentation.

isEditable(This) -> boolean()

Types

This = wxGrid()

See external documentation.

isInSelection(This, Coords) -> boolean()

Types

This = wxGrid()

Coords = {R::integer(), C::integer()}

See external documentation.

isInSelection(This, Row, Col) -> boolean()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

isReadOnly(This, Row, Col) -> boolean()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

isSelection(This) -> boolean()

Types

This = wxGrid()

See external documentation.

isVisible(This, Coords) -> boolean()

Types

This = wxGrid()

Coords = {R::integer(), C::integer()}

Equivalent to isVisible(This, Coords, []).

isVisible(This, Row, Col) -> boolean()

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.
Also:
isVisible(This, Coords, [Option]) -> boolean() when
This::wxGrid(), Coords::{R::integer(), C::integer()},
Option :: {'wholeCellVisible', boolean()}.

isVisible(This, Row, Col, Options::[Option]) -> boolean()

Types

This = wxGrid()

Row = integer()

Col = integer()

Option = {wholeCellVisible, boolean()}

See external documentation.

makeCellVisible(This, Coords) -> ok

Types

This = wxGrid()

Coords = {R::integer(), C::integer()}

See external documentation.

makeCellVisible(This, Row, Col) -> ok

Types

This = wxGrid()

Row = integer()

Col = integer()

See external documentation.

moveCursorDown(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

moveCursorLeft(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

moveCursorRight(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

moveCursorUp(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

moveCursorDownBlock(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

moveCursorLeftBlock(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

moveCursorRightBlock(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

moveCursorUpBlock(This, ExpandSelection) -> boolean()

Types

This = wxGrid()

ExpandSelection = boolean()

See external documentation.

movePageDown(This) -> boolean()

Types

This = wxGrid()

See external documentation.

movePageUp(This) -> boolean()

Types

This = wxGrid()

See external documentation.

registerDataType(This, TypeName, Renderer, Editor) -> ok

Types

This = wxGrid()

TypeName = unicode:chardata()

Renderer = wxGridCellRenderer:wxGridCellRenderer()

Editor = wxGridCellEditor:wxGridCellEditor()

See external documentation.

saveEditControlValue(This) -> ok

Types

This = wxGrid()

See external documentation.

selectAll(This) -> ok

Types

This = wxGrid()

See external documentation.

selectBlock(This, TopLeft, BottomRight) -> ok

Types

This = wxGrid()

TopLeft = {R::integer(), C::integer()}

BottomRight = {R::integer(), C::integer()}

Equivalent to selectBlock(This, TopLeft, BottomRight, []).

selectBlock(This, TopLeft, BottomRight, Options::[Option]) -> ok

Types

This = wxGrid()

TopLeft = {R::integer(), C::integer()}

BottomRight = {R::integer(), C::integer()}

Option = {addToSelected, boolean()}

See external documentation.

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

Types

This = wxGrid()

TopRow = integer()

LeftCol = integer()

BottomRow = integer()

RightCol = integer()

Equivalent to selectBlock(This, TopRow, LeftCol, BottomRow, RightCol, []).

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

Types

This = wxGrid()

TopRow = integer()

LeftCol = integer()

BottomRow = integer()

RightCol = integer()

Option = {addToSelected, boolean()}

See external documentation.

selectCol(This, Col) -> ok

Types

This = wxGrid()

Col = integer()

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

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

Types

This = wxGrid()

Col = integer()

Option = {addToSelected, boolean()}

See external documentation.

selectRow(This, Row) -> ok

Types

This = wxGrid()

Row = integer()

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

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

Types

This = wxGrid()

Row = integer()

Option = {addToSelected, boolean()}

See external documentation.

setCellAlignment(This, Align) -> ok

Types

This = wxGrid()

Align = integer()

See external documentation.

setCellAlignment(This, Align, Row, Col) -> ok

Types

This = wxGrid()

Align = integer()

Row = integer()

Col = integer()

See external documentation.

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

Types

This = wxGrid()

Row = integer()

Col = integer()

Horiz = integer()

Vert = integer()

See external documentation.

setCellBackgroundColour(This, Col) -> ok

Types

This = wxGrid()

Col = wx:wx_colour()

See external documentation.

setCellBackgroundColour(This, Row, Col, Val) -> ok

Types

This = wxGrid()

Row = integer()

Col = integer()

Val = wx:wx_colour()

See external documentation.
Also:
setCellBackgroundColour(This, Colour, Row, Col) -> 'ok' when
This::wxGrid(), Colour::wx:wx_colour(), Row::integer(), Col::integer().

setCellEditor(This, Row, Col, Editor) -> ok

Types

This = wxGrid()

Row = integer()

Col = integer()

Editor = wxGridCellEditor:wxGridCellEditor()

See external documentation.

setCellFont(This, Row, Col, Val) -> ok

Types

This = wxGrid()

Row = integer()

Col = integer()

Val = wxFont:wxFont()

See external documentation.

setCellRenderer(This, Row, Col, Renderer) -> ok

Types

This = wxGrid()

Row = integer()

Col = integer()

Renderer = wxGridCellRenderer:wxGridCellRenderer()

See external documentation.

setCellTextColour(This, Col) -> ok

Types

This = wxGrid()

Col = wx:wx_colour()

See external documentation.

setCellTextColour(This, Row, Col, Val) -> ok

Types

This = wxGrid()

Row = integer()

Col = integer()

Val = wx:wx_colour()

See external documentation.
Also:
setCellTextColour(This, Val, Row, Col) -> 'ok' when
This::wxGrid(), Val::wx:wx_colour(), Row::integer(), Col::integer().

setCellValue(This, Coords, S) -> ok

Types

This = wxGrid()

Coords = {R::integer(), C::integer()}

S = unicode:chardata()

See external documentation.

setCellValue(This, Row, Col, S) -> ok

Types

This = wxGrid()

Row = integer()

Col = integer()

S = unicode:chardata()

See external documentation.
Also:
setCellValue(This, Val, Row, Col) -> 'ok' when
This::wxGrid(), Val::unicode:chardata(), Row::integer(), Col::integer().

setColAttr(This, Col, Attr) -> ok