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

wxErlang
Reference Manual
Version 0.98.4


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

Types:

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

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

Equivalent to appendCols(This, []).

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

Types:

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

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

Equivalent to appendRows(This, []).

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

Types:

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

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

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

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

Types:

Option = {setAsMin, bool()}

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

Equivalent to autoSizeColumns(This, []).

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

Types:

Option = {setAsMin, bool()}

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

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

Types:

Option = {setAsMin, bool()}

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

Equivalent to autoSizeRows(This, []).

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

Types:

Option = {setAsMin, bool()}

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

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

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

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

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

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

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

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

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

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

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

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

Types:

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

Types:

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

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

Equivalent to deleteRows(This, []).

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

Types:

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

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

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

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

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

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

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

Types:

Option = {enable, bool()}

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

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

Types:

Option = {enable, bool()}

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

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

Types:

Option = {enable, bool()}

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

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

Types:

Option = {enable, bool()}

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

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

Equivalent to enableGridLines(This, []).

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

Types:

Option = {enable, bool()}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Equivalent to insertCols(This, []).

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

Types:

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

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

Equivalent to insertRows(This, []).

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

Types:

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

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

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

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

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

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

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

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

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

Types:

Option = {wholeCellVisible, bool()}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Types:

Option = {addToSelected, bool()}

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

Types:

Option = {addToSelected, bool()}

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

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

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

Types:

Option = {addToSelected, bool()}

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

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

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

Types:

Option = {addToSelected, bool()}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Types:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Types:

Option = {resizeExistingCols, bool()}

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

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

Types:

Option = {resizeExistingRows, bool()}

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

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

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

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

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

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

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

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

Types:

Option = {isReadOnly, bool()}

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

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

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

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

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

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

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

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

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

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

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

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

Types:

WxGridSelectionModes = integer()

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

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

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

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

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

Types:

Option = {clipToMinMax, bool()}

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

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

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

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

Destroys this object, do not use object again