wxGrid

(wx)

See external documentation: wxGrid.

See external documentation: wxGrid.

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

Functions

new() -> wxGrid()

See external documentation.

new(Parent, Id) -> wxGrid()

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

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

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

  • Parent = wxWindow:wxWindow()
  • X = integer()
  • Y = integer()
  • Option = {w, integer()} | {h, integer()} | {style, integer()}

See external documentation.

appendCols(This) -> boolean()

Equivalent to appendCols(This, []).

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

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

See external documentation.

appendRows(This) -> boolean()

Equivalent to appendRows(This, []).

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

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

See external documentation.

autoSize(This) -> ok

See external documentation.

autoSizeColumn(This, Col) -> ok

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

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

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

See external documentation.

autoSizeColumns(This) -> ok

Equivalent to autoSizeColumns(This, []).

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

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

See external documentation.

autoSizeRow(This, Row) -> ok

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

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

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

See external documentation.

autoSizeRows(This) -> ok

Equivalent to autoSizeRows(This, []).

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

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

See external documentation.

beginBatch(This) -> ok

See external documentation.

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

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

See external documentation.

canDragColSize(This) -> boolean()

See external documentation.

canDragRowSize(This) -> boolean()

See external documentation.

canDragGridSize(This) -> boolean()

See external documentation.

canEnableCellControl(This) -> boolean()

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

clearGrid(This) -> ok

See external documentation.

clearSelection(This) -> ok

See external documentation.

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

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

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

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

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

deleteCols(This) -> boolean()

Equivalent to deleteCols(This, []).

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

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

See external documentation.

deleteRows(This) -> boolean()

Equivalent to deleteRows(This, []).

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

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

See external documentation.

disableCellEditControl(This) -> ok

See external documentation.

disableDragColSize(This) -> ok

See external documentation.

disableDragGridSize(This) -> ok

See external documentation.

disableDragRowSize(This) -> ok

See external documentation.

enableCellEditControl(This) -> ok

Equivalent to enableCellEditControl(This, []).

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

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

See external documentation.

enableDragColSize(This) -> ok

Equivalent to enableDragColSize(This, []).

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

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

See external documentation.

enableDragGridSize(This) -> ok

Equivalent to enableDragGridSize(This, []).

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

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

See external documentation.

enableDragRowSize(This) -> ok

Equivalent to enableDragRowSize(This, []).

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

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

See external documentation.

enableEditing(This, Edit) -> ok

See external documentation.

enableGridLines(This) -> ok

Equivalent to enableGridLines(This, []).

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

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

See external documentation.

endBatch(This) -> ok

See external documentation.

fit(This) -> ok

See external documentation.

forceRefresh(This) -> ok

See external documentation.

getBatchCount(This) -> integer()

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

See external documentation.

getColLabelSize(This) -> integer()

See external documentation.

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

See external documentation.

getColMinimalAcceptableWidth(This) -> integer()

See external documentation.

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

See external documentation.

getDefaultCellBackgroundColour(This) -> wx:wx_colour4()

See external documentation.

getDefaultCellFont(This) -> wxFont:wxFont()

See external documentation.

getDefaultCellTextColour(This) -> wx:wx_colour4()

See external documentation.

getDefaultColLabelSize(This) -> integer()

See external documentation.

getDefaultColSize(This) -> integer()

See external documentation.

getDefaultEditor(This) -> wxGridCellEditor:wxGridCellEditor()

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

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

See external documentation.

getDefaultRenderer(This) -> wxGridCellRenderer:wxGridCellRenderer()

See external documentation.

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

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

See external documentation.

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

See external documentation.

getDefaultRowLabelSize(This) -> integer()

See external documentation.

getDefaultRowSize(This) -> integer()

See external documentation.

getGridCursorCol(This) -> integer()

See external documentation.

getGridCursorRow(This) -> integer()

See external documentation.

getGridLineColour(This) -> wx:wx_colour4()

See external documentation.

gridLinesEnabled(This) -> boolean()

See external documentation.

getLabelBackgroundColour(This) -> wx:wx_colour4()

See external documentation.

getLabelFont(This) -> wxFont:wxFont()

See external documentation.

getLabelTextColour(This) -> wx:wx_colour4()

See external documentation.

getNumberCols(This) -> integer()

See external documentation.

getNumberRows(This) -> integer()

See external documentation.

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

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

See external documentation.

getRowMinimalAcceptableHeight(This) -> integer()

See external documentation.

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

See external documentation.

getRowLabelSize(This) -> integer()

See external documentation.

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

See external documentation.

getRowSize(This, Row) -> integer()

See external documentation.

getScrollLineX(This) -> integer()

See external documentation.

getScrollLineY(This) -> integer()

See external documentation.

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

See external documentation.

getSelectedCols(This) -> [integer()]

See external documentation.

getSelectedRows(This) -> [integer()]

See external documentation.

getSelectionBackground(This) -> wx:wx_colour4()

See external documentation.

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

See external documentation.

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

See external documentation.

getSelectionForeground(This) -> wx:wx_colour4()

See external documentation.

getViewWidth(This) -> integer()

See external documentation.

getGridWindow(This) -> wxWindow:wxWindow()

See external documentation.

getGridRowLabelWindow(This) -> wxWindow:wxWindow()

See external documentation.

getGridColLabelWindow(This) -> wxWindow:wxWindow()

See external documentation.

getGridCornerLabelWindow(This) -> wxWindow:wxWindow()

See external documentation.

hideCellEditControl(This) -> ok

See external documentation.

insertCols(This) -> boolean()

Equivalent to insertCols(This, []).

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

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

See external documentation.

insertRows(This) -> boolean()

Equivalent to insertRows(This, []).

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

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

See external documentation.

isCellEditControlEnabled(This) -> boolean()

See external documentation.

isCurrentCellReadOnly(This) -> boolean()

See external documentation.

isEditable(This) -> boolean()

See external documentation.

isInSelection(This, Coords) -> boolean()

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

isSelection(This) -> boolean()

See external documentation.

isVisible(This, Coords) -> boolean()

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

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

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

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

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

See external documentation.

makeCellVisible(This, Coords) -> ok

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

See external documentation.

makeCellVisible(This, Row, Col) -> ok

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

See external documentation.

moveCursorDown(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

moveCursorLeft(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

moveCursorRight(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

moveCursorUp(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

moveCursorDownBlock(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

moveCursorLeftBlock(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

moveCursorRightBlock(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

moveCursorUpBlock(This, ExpandSelection) -> boolean()

  • This = wxGrid()
  • ExpandSelection = boolean()

See external documentation.

movePageDown(This) -> boolean()

See external documentation.

movePageUp(This) -> boolean()

See external documentation.

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

See external documentation.

saveEditControlValue(This) -> ok

See external documentation.

selectAll(This) -> ok

See external documentation.

selectBlock(This, TopLeft, BottomRight) -> ok

  • 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

  • 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

  • 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

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

See external documentation.

selectCol(This, Col) -> ok

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

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

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

See external documentation.

selectRow(This, Row) -> ok

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

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

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

See external documentation.

setCellAlignment(This, Align) -> ok

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

setCellBackgroundColour(This, Col) -> ok

See external documentation.

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

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

See external documentation.

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

See external documentation.

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

See external documentation.

setCellTextColour(This, Col) -> ok

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

setColFormatBool(This, Col) -> ok

See external documentation.

setColFormatNumber(This, Col) -> ok

See external documentation.

setColFormatFloat(This, Col) -> ok

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

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

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

See external documentation.

setColFormatCustom(This, Col, TypeName) -> ok

See external documentation.

setColLabelAlignment(This, Horiz, Vert) -> ok

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

See external documentation.

setColLabelSize(This, Height) -> ok

See external documentation.

setColLabelValue(This, Col, Val) -> ok

See external documentation.

setColMinimalWidth(This, Col, Width) -> ok

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

See external documentation.

setColMinimalAcceptableWidth(This, Width) -> ok

See external documentation.

setColSize(This, Col, Width) -> ok

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

See external documentation.

setDefaultCellAlignment(This, Horiz, Vert) -> ok

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

See external documentation.

setDefaultCellBackgroundColour(This, Val) -> ok

See external documentation.

setDefaultCellFont(This, Val) -> ok

See external documentation.

setDefaultCellTextColour(This, Val) -> ok

See external documentation.

setDefaultEditor(This, Editor) -> ok

See external documentation.

setDefaultRenderer(This, Renderer) -> ok

See external documentation.

setDefaultColSize(This, Width) -> ok

Equivalent to setDefaultColSize(This, Width, []).

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

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

See external documentation.

setDefaultRowSize(This, Height) -> ok

Equivalent to setDefaultRowSize(This, Height, []).

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

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

See external documentation.

setGridCursor(This, Row, Col) -> ok

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

See external documentation.

setGridLineColour(This, Val) -> ok

See external documentation.

setLabelBackgroundColour(This, Val) -> ok

See external documentation.

setLabelFont(This, Val) -> ok

See external documentation.

setLabelTextColour(This, Val) -> ok

See external documentation.

setMargins(This, ExtraWidth, ExtraHeight) -> ok

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

See external documentation.

setReadOnly(This, Row, Col) -> ok

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

Equivalent to setReadOnly(This, Row, Col, []).

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

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

See external documentation.

setRowAttr(This, Row, Attr) -> ok

See external documentation.

setRowLabelAlignment(This, Horiz, Vert) -> ok

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

See external documentation.

setRowLabelSize(This, Width) -> ok

See external documentation.

setRowLabelValue(This, Row, Val) -> ok

See external documentation.

setRowMinimalHeight(This, Row, Width) -> ok

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

See external documentation.

setRowMinimalAcceptableHeight(This, Width) -> ok

See external documentation.

setRowSize(This, Row, Height) -> ok

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

See external documentation.

setScrollLineX(This, X) -> ok

See external documentation.

setScrollLineY(This, Y) -> ok

See external documentation.

setSelectionBackground(This, C) -> ok

See external documentation.

setSelectionForeground(This, C) -> ok

See external documentation.

setSelectionMode(This, Selmode) -> ok

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

showCellEditControl(This) -> ok

See external documentation.

xToCol(This, X) -> integer()

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

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

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

See external documentation.

xToEdgeOfCol(This, X) -> integer()

See external documentation.

yToEdgeOfRow(This, Y) -> integer()

See external documentation.

yToRow(This, Y) -> integer()

See external documentation.

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

Destroys this object, do not use object again