Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.8


Expand All
Contract All

Table of Contents

wxGrid

MODULE

wxGrid

MODULE SUMMARY

See external documentation: 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()

new(Parent, Id) -> wxGrid()

Types:

Id = integer()

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

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

Types:

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:

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

appendCols(This) -> boolean()

Types:

This = wxGrid()

Equivalent to appendCols(This, []).

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

Types:

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

appendRows(This) -> boolean()

Types:

This = wxGrid()

Equivalent to appendRows(This, []).

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

Types:

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

autoSize(This) -> ok

Types:

This = wxGrid()

autoSizeColumn(This, Col) -> ok

Types:

This = wxGrid()
Col = integer()

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

Types:

This = wxGrid()
Col = integer()
Option = {setAsMin, boolean()}

autoSizeColumns(This) -> ok

Types:

This = wxGrid()

Equivalent to autoSizeColumns(This, []).

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

Types:

This = wxGrid()
Option = {setAsMin, boolean()}

autoSizeRow(This, Row) -> ok

Types:

This = wxGrid()
Row = integer()

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

Types:

This = wxGrid()
Row = integer()
Option = {setAsMin, boolean()}

autoSizeRows(This) -> ok

Types:

This = wxGrid()

Equivalent to autoSizeRows(This, []).

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

Types:

This = wxGrid()
Option = {setAsMin, boolean()}

beginBatch(This) -> ok

Types:

This = wxGrid()

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()}

canDragColSize(This) -> boolean()

Types:

This = wxGrid()

canDragRowSize(This) -> boolean()

Types:

This = wxGrid()

canDragGridSize(This) -> boolean()

Types:

This = wxGrid()

canEnableCellControl(This) -> boolean()

Types:

This = wxGrid()

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

Types:

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

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

clearGrid(This) -> ok

Types:

This = wxGrid()

clearSelection(This) -> ok

Types:

This = wxGrid()

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

Types:

This = wxGrid()
NumRows = integer()
NumCols = integer()

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()}

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()}

disableCellEditControl(This) -> ok

Types:

This = wxGrid()

disableDragColSize(This) -> ok

Types:

This = wxGrid()

disableDragGridSize(This) -> ok

Types:

This = wxGrid()

disableDragRowSize(This) -> ok

Types:

This = wxGrid()

enableCellEditControl(This) -> ok

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Option = {enable, boolean()}

enableDragColSize(This) -> ok

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Option = {enable, boolean()}

enableDragGridSize(This) -> ok

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Option = {enable, boolean()}

enableDragRowSize(This) -> ok

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Option = {enable, boolean()}

enableEditing(This, Edit) -> ok

Types:

This = wxGrid()
Edit = boolean()

enableGridLines(This) -> ok

Types:

This = wxGrid()

Equivalent to enableGridLines(This, []).

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

Types:

This = wxGrid()
Option = {enable, boolean()}

endBatch(This) -> ok

Types:

This = wxGrid()

fit(This) -> ok

Types:

This = wxGrid()

forceRefresh(This) -> ok

Types:

This = wxGrid()

getBatchCount(This) -> integer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

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

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()

getColLabelSize(This) -> integer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Col = integer()

getColMinimalAcceptableWidth(This) -> integer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()

getDefaultCellBackgroundColour(This) -> wx:wx_colour4()

Types:

This = wxGrid()

getDefaultCellFont(This) -> wxFont:wxFont()

Types:

This = wxGrid()

getDefaultCellTextColour(This) -> wx:wx_colour4()

Types:

This = wxGrid()

getDefaultColLabelSize(This) -> integer()

Types:

This = wxGrid()

getDefaultColSize(This) -> integer()

Types:

This = wxGrid()

getDefaultEditor(This) -> wxGridCellEditor:wxGridCellEditor()

Types:

This = wxGrid()

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

Types:

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

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
TypeName = unicode:chardata()

getDefaultRenderer(This) -> wxGridCellRenderer:wxGridCellRenderer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
TypeName = unicode:chardata()

getDefaultRowLabelSize(This) -> integer()

Types:

This = wxGrid()

getDefaultRowSize(This) -> integer()

Types:

This = wxGrid()

getGridCursorCol(This) -> integer()

Types:

This = wxGrid()

getGridCursorRow(This) -> integer()

Types:

This = wxGrid()

getGridLineColour(This) -> wx:wx_colour4()

Types:

This = wxGrid()

gridLinesEnabled(This) -> boolean()

Types:

This = wxGrid()

getLabelBackgroundColour(This) -> wx:wx_colour4()

Types:

This = wxGrid()

getLabelFont(This) -> wxFont:wxFont()

Types:

This = wxGrid()

getLabelTextColour(This) -> wx:wx_colour4()

Types:

This = wxGrid()

getNumberCols(This) -> integer()

Types:

This = wxGrid()

getNumberRows(This) -> integer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

getRowMinimalAcceptableHeight(This) -> integer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()

getRowLabelSize(This) -> integer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Row = integer()

getRowSize(This, Row) -> integer()

Types:

This = wxGrid()
Row = integer()

getScrollLineX(This) -> integer()

Types:

This = wxGrid()

getScrollLineY(This) -> integer()

Types:

This = wxGrid()

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

Types:

This = wxGrid()

getSelectedCols(This) -> [integer()]

Types:

This = wxGrid()

getSelectedRows(This) -> [integer()]

Types:

This = wxGrid()

getSelectionBackground(This) -> wx:wx_colour4()

Types:

This = wxGrid()

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

Types:

This = wxGrid()

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

Types:

This = wxGrid()

getSelectionForeground(This) -> wx:wx_colour4()

Types:

This = wxGrid()

getViewWidth(This) -> integer()

Types:

This = wxGrid()

getGridWindow(This) -> wxWindow:wxWindow()

Types:

This = wxGrid()

getGridRowLabelWindow(This) -> wxWindow:wxWindow()

Types:

This = wxGrid()

getGridColLabelWindow(This) -> wxWindow:wxWindow()

Types:

This = wxGrid()

getGridCornerLabelWindow(This) -> wxWindow:wxWindow()

Types:

This = wxGrid()

hideCellEditControl(This) -> ok

Types:

This = wxGrid()

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()}

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()}

isCellEditControlEnabled(This) -> boolean()

Types:

This = wxGrid()

isCurrentCellReadOnly(This) -> boolean()

Types:

This = wxGrid()

isEditable(This) -> boolean()

Types:

This = wxGrid()

isInSelection(This, Coords) -> boolean()

Types:

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

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

isSelection(This) -> boolean()

Types:

This = wxGrid()

isVisible(This, Coords) -> boolean()

Types:

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

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()}

makeCellVisible(This, Coords) -> ok

Types:

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

makeCellVisible(This, Row, Col) -> ok

Types:

This = wxGrid()
Row = integer()
Col = integer()

moveCursorDown(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

moveCursorLeft(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

moveCursorRight(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

moveCursorUp(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

moveCursorDownBlock(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

moveCursorLeftBlock(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

moveCursorRightBlock(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

moveCursorUpBlock(This, ExpandSelection) -> boolean()

Types:

This = wxGrid()
ExpandSelection = boolean()

movePageDown(This) -> boolean()

Types:

This = wxGrid()

movePageUp(This) -> boolean()

Types:

This = wxGrid()

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

saveEditControlValue(This) -> ok

Types:

This = wxGrid()

selectAll(This) -> ok

Types:

This = wxGrid()

selectBlock(This, TopLeft, BottomRight) -> ok

Types:

This = wxGrid()
TopLeft = {R::integer(), C::integer()}
BottomRight = {R::integer(), C::integer()}

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

Types:

This = wxGrid()
TopLeft = {R::integer(), C::integer()}
BottomRight = {R::integer(), C::integer()}
Option = {addToSelected, boolean()}

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

Types:

This = wxGrid()
TopRow = integer()
LeftCol = integer()
BottomRow = integer()
RightCol = integer()

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

Types:

This = wxGrid()
TopRow = integer()
LeftCol = integer()
BottomRow = integer()
RightCol = integer()
Option = {addToSelected, boolean()}

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()}

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()}

setCellAlignment(This, Align) -> ok

Types:

This = wxGrid()
Align = integer()

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

Types:

This = wxGrid()
Align = integer()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()
Horiz = integer()
Vert = integer()

setCellBackgroundColour(This, Col) -> ok

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

setCellTextColour(This, Col) -> ok

Types:

This = wxGrid()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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()}

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

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Col = integer()

setColFormatBool(This, Col) -> ok

Types:

This = wxGrid()
Col = integer()

setColFormatNumber(This, Col) -> ok

Types:

This = wxGrid()
Col = integer()

setColFormatFloat(This, Col) -> ok

Types:

This = wxGrid()
Col = integer()

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

Types:

This = wxGrid()
Col = integer()
Option = {width, integer()} | {precision, integer()}

setColFormatCustom(This, Col, TypeName) -> ok

Types:

This = wxGrid()
Col = integer()
TypeName = unicode:chardata()

setColLabelAlignment(This, Horiz, Vert) -> ok

Types:

This = wxGrid()
Horiz = integer()
Vert = integer()

setColLabelSize(This, Height) -> ok

Types:

This = wxGrid()
Height = integer()

setColLabelValue(This, Col, Val) -> ok

Types:

This = wxGrid()
Col = integer()

setColMinimalWidth(This, Col, Width) -> ok

Types:

This = wxGrid()
Col = integer()
Width = integer()

setColMinimalAcceptableWidth(This, Width) -> ok

Types:

This = wxGrid()
Width = integer()

setColSize(This, Col, Width) -> ok

Types:

This = wxGrid()
Col = integer()
Width = integer()

setDefaultCellAlignment(This, Horiz, Vert) -> ok

Types:

This = wxGrid()
Horiz = integer()
Vert = integer()

setDefaultCellBackgroundColour(This, Val) -> ok

Types:

This = wxGrid()

setDefaultCellFont(This, Val) -> ok

Types:

This = wxGrid()

setDefaultCellTextColour(This, Val) -> ok

Types:

This = wxGrid()

setDefaultEditor(This, Editor) -> ok

setDefaultRenderer(This, Renderer) -> ok

setDefaultColSize(This, Width) -> ok

Types:

This = wxGrid()
Width = integer()

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

Types:

This = wxGrid()
Width = integer()
Option = {resizeExistingCols, boolean()}

setDefaultRowSize(This, Height) -> ok

Types:

This = wxGrid()
Height = integer()

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

Types:

This = wxGrid()
Height = integer()
Option = {resizeExistingRows, boolean()}

setGridCursor(This, Row, Col) -> ok

Types:

This = wxGrid()
Row = integer()
Col = integer()

setGridLineColour(This, Val) -> ok

Types:

This = wxGrid()

setLabelBackgroundColour(This, Val) -> ok

Types:

This = wxGrid()

setLabelFont(This, Val) -> ok

Types:

This = wxGrid()

setLabelTextColour(This, Val) -> ok

Types:

This = wxGrid()

setMargins(This, ExtraWidth, ExtraHeight) -> ok

Types:

This = wxGrid()
ExtraWidth = integer()
ExtraHeight = integer()

setReadOnly(This, Row, Col) -> ok

Types:

This = wxGrid()
Row = integer()
Col = integer()

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

Types:

This = wxGrid()
Row = integer()
Col = integer()
Option = {isReadOnly, boolean()}

setRowAttr(This, Row, Attr) -> ok

Types:

This = wxGrid()
Row = integer()

setRowLabelAlignment(This, Horiz, Vert) -> ok

Types:

This = wxGrid()
Horiz = integer()
Vert = integer()

setRowLabelSize(This, Width) -> ok

Types:

This = wxGrid()
Width = integer()

setRowLabelValue(This, Row, Val) -> ok

Types:

This = wxGrid()
Row = integer()

setRowMinimalHeight(This, Row, Width) -> ok

Types:

This = wxGrid()
Row = integer()
Width = integer()

setRowMinimalAcceptableHeight(This, Width) -> ok

Types:

This = wxGrid()
Width = integer()

setRowSize(This, Row, Height) -> ok

Types:

This = wxGrid()
Row = integer()
Height = integer()

setScrollLineX(This, X) -> ok

Types:

This = wxGrid()
X = integer()

setScrollLineY(This, Y) -> ok

Types:

This = wxGrid()
Y = integer()

setSelectionBackground(This, C) -> ok

Types:

This = wxGrid()

setSelectionForeground(This, C) -> ok

Types:

This = wxGrid()

setSelectionMode(This, Selmode) -> ok

Types:

This = wxGrid()
Selmode = wx:wx_enum()

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

showCellEditControl(This) -> ok

Types:

This = wxGrid()

xToCol(This, X) -> integer()

Types:

This = wxGrid()
X = integer()

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

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

Types:

This = wxGrid()
X = integer()
Option = {clipToMinMax, boolean()}

xToEdgeOfCol(This, X) -> integer()

Types:

This = wxGrid()
X = integer()

yToEdgeOfRow(This, Y) -> integer()

Types:

This = wxGrid()
Y = integer()

yToRow(This, Y) -> integer()

Types:

This = wxGrid()
Y = integer()

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

Destroys this object, do not use object again