wxListCtrl

(wx)

See external documentation: wxListCtrl.

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

new(Parent) -> wxListCtrl()

Parent = wxWindow:wxWindow()

new(Parent, Options::[Option]) -> wxListCtrl()

Parent = wxWindow:wxWindow()
Option = {winid, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx_object()} | {onGetItemText, function()} | {onGetItemAttr, function()} | {onGetItemColumnImage, function()}

Creates a listctrl with optional callback functions:

OnGetItemText = (This, Item, Column) -> unicode:charlist() OnGetItemAttr = (This, Item) -> wxListItemAttr:wxListItemAttr() OnGetItemColumnImage = (This, Item, Column) -> integer()

See external documentation.

arrange(This) -> boolean()

This = wxListCtrl()

Equivalent to arrange(This, []).

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

This = wxListCtrl()
Option = {flag, integer()}

See external documentation.

assignImageList(This, ImageList, Which) -> ok

This = wxListCtrl()
ImageList = wxImageList:wxImageList()
Which = integer()

See external documentation.

clearAll(This) -> ok

This = wxListCtrl()

See external documentation.

create(This, Parent) -> wxListCtrl()

This = wxWindow:wxWindow()
Parent = wxWindow:wxWindow()

Equivalent to create(This, Parent, []).

create(This, Parent, Options::[Option]) -> wxListCtrl()

This = wxWindow:wxWindow()
Parent = wxWindow:wxWindow()
Option = {winid, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx_object()} | {onGetItemText, function()} | {onGetItemAttr, function()} | {onGetItemColumnImage, function()}

See external documentation.

deleteAllItems(This) -> boolean()

This = wxListCtrl()

See external documentation.

deleteColumn(This, Col) -> boolean()

This = wxListCtrl()
Col = integer()

See external documentation.

deleteItem(This, Item) -> boolean()

This = wxListCtrl()
Item = integer()

See external documentation.

editLabel(This, Item) -> wxTextCtrl:wxTextCtrl()

This = wxListCtrl()
Item = integer()

See external documentation.

ensureVisible(This, Item) -> boolean()

This = wxListCtrl()
Item = integer()

See external documentation.

findItem(This, Start, Str) -> integer()

This = wxListCtrl()
Start = integer()
Str = unicode:chardata()

Equivalent to findItem(This, Start, Str, []).

findItem(This, Start, Str, Options::[Option]) -> integer()

This = wxListCtrl()
Start = integer()
Str = unicode:chardata()
Option = {partial, boolean()}

See external documentation.
Also:
findItem(This, Start, Pt, Direction) -> integer() when
This::wxListCtrl(), Start::integer(), Pt::{X::integer(), Y::integer()}, Direction::integer().

getColumn(This, Col, Item) -> boolean()

This = wxListCtrl()
Col = integer()
Item = wxListItem:wxListItem()

See external documentation.

getColumnCount(This) -> integer()

This = wxListCtrl()

See external documentation.

getColumnWidth(This, Col) -> integer()

This = wxListCtrl()
Col = integer()

See external documentation.

getCountPerPage(This) -> integer()

This = wxListCtrl()

See external documentation.

getEditControl(This) -> wxTextCtrl:wxTextCtrl()

This = wxListCtrl()

See external documentation.

getImageList(This, Which) -> wxImageList:wxImageList()

This = wxListCtrl()
Which = integer()

See external documentation.

getItem(This, Info) -> boolean()

This = wxListCtrl()
Info = wxListItem:wxListItem()

See external documentation.

getItemBackgroundColour(This, Item) -> wx:wx_colour4()

This = wxListCtrl()
Item = integer()

See external documentation.

getItemCount(This) -> integer()

This = wxListCtrl()

See external documentation.

getItemData(This, Item) -> integer()

This = wxListCtrl()
Item = integer()

See external documentation.

getItemFont(This, Item) -> wxFont:wxFont()

This = wxListCtrl()
Item = integer()

See external documentation.

getItemPosition(This, Item) -> Result

Result = {Res::boolean(), Pos::{X::integer(), Y::integer()}}
This = wxListCtrl()
Item = integer()

See external documentation.

getItemRect(This, Item) -> Result

Result = {Res::boolean(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}}
This = wxListCtrl()
Item = integer()

Equivalent to getItemRect(This, Item, []).

getItemRect(This, Item, Options::[Option]) -> Result

Result = {Res::boolean(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}}
This = wxListCtrl()
Item = integer()
Option = {code, integer()}

See external documentation.

getItemSpacing(This) -> {W::integer(), H::integer()}

This = wxListCtrl()

See external documentation.

getItemState(This, Item, StateMask) -> integer()

This = wxListCtrl()
Item = integer()
StateMask = integer()

See external documentation.

getItemText(This, Item) -> unicode:charlist()

This = wxListCtrl()
Item = integer()

See external documentation.

getItemTextColour(This, Item) -> wx:wx_colour4()

This = wxListCtrl()
Item = integer()

See external documentation.

getNextItem(This, Item) -> integer()

This = wxListCtrl()
Item = integer()

Equivalent to getNextItem(This, Item, []).

getNextItem(This, Item, Options::[Option]) -> integer()

This = wxListCtrl()
Item = integer()
Option = {geometry, integer()} | {state, integer()}

See external documentation.

getSelectedItemCount(This) -> integer()

This = wxListCtrl()

See external documentation.

getTextColour(This) -> wx:wx_colour4()

This = wxListCtrl()

See external documentation.

getTopItem(This) -> integer()

This = wxListCtrl()

See external documentation.

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

This = wxListCtrl()

See external documentation.

hitTest(This, Point) -> Result

Result = {Res::integer(), Flags::integer(), PSubItem::integer()}
This = wxListCtrl()
Point = {X::integer(), Y::integer()}

See external documentation.

insertColumn(This, Col, Heading) -> integer()

This = wxListCtrl()
Col = integer()
Heading = unicode:chardata()

See external documentation.
Also:
insertColumn(This, Col, Info) -> integer() when
This::wxListCtrl(), Col::integer(), Info::wxListItem:wxListItem().

insertColumn(This, Col, Heading, Options::[Option]) -> integer()

This = wxListCtrl()
Col = integer()
Heading = unicode:chardata()
Option = {format, integer()} | {width, integer()}

See external documentation.

insertItem(This, Info) -> integer()

This = wxListCtrl()
Info = wxListItem:wxListItem()

See external documentation.

insertItem(This, Index, ImageIndex) -> integer()

This = wxListCtrl()
Index = integer()
ImageIndex = integer()

See external documentation.
Also:
insertItem(This, Index, Label) -> integer() when
This::wxListCtrl(), Index::integer(), Label::unicode:chardata().

insertItem(This, Index, Label, ImageIndex) -> integer()

This = wxListCtrl()
Index = integer()
Label = unicode:chardata()
ImageIndex = integer()

See external documentation.

refreshItem(This, Item) -> ok

This = wxListCtrl()
Item = integer()

See external documentation.

refreshItems(This, ItemFrom, ItemTo) -> ok

This = wxListCtrl()
ItemFrom = integer()
ItemTo = integer()

See external documentation.

scrollList(This, Dx, Dy) -> boolean()

This = wxListCtrl()
Dx = integer()
Dy = integer()

See external documentation.

setBackgroundColour(This, Colour) -> boolean()

This = wxListCtrl()
Colour = wx:wx_colour()

See external documentation.

setColumn(This, Col, Item) -> boolean()

This = wxListCtrl()
Col = integer()
Item = wxListItem:wxListItem()

See external documentation.

setColumnWidth(This, Col, Width) -> boolean()

This = wxListCtrl()
Col = integer()
Width = integer()

See external documentation.

setImageList(This, ImageList, Which) -> ok

This = wxListCtrl()
ImageList = wxImageList:wxImageList()
Which = integer()

See external documentation.

setItem(This, Info) -> boolean()

This = wxListCtrl()
Info = wxListItem:wxListItem()

See external documentation.

setItem(This, Index, Col, Label) -> integer()

This = wxListCtrl()
Index = integer()
Col = integer()
Label = unicode:chardata()

Equivalent to setItem(This, Index, Col, Label, []).

setItem(This, Index, Col, Label, Options::[Option]) -> integer()

This = wxListCtrl()
Index = integer()
Col = integer()
Label = unicode:chardata()
Option = {imageId, integer()}

See external documentation.

setItemBackgroundColour(This, Item, Col) -> ok

This = wxListCtrl()
Item = integer()
Col = wx:wx_colour()

See external documentation.

setItemCount(This, Count) -> ok

This = wxListCtrl()
Count = integer()

See external documentation.

setItemData(This, Item, Data) -> boolean()

This = wxListCtrl()
Item = integer()
Data = integer()

See external documentation.

setItemFont(This, Item, F) -> ok

This = wxListCtrl()
Item = integer()
F = wxFont:wxFont()

See external documentation.

setItemImage(This, Item, Image) -> boolean()

This = wxListCtrl()
Item = integer()
Image = integer()

Equivalent to setItemImage(This, Item, Image, []).

setItemImage(This, Item, Image, Options::[Option]) -> boolean()

This = wxListCtrl()
Item = integer()
Image = integer()
Option = {selImage, integer()}

See external documentation.

setItemColumnImage(This, Item, Column, Image) -> boolean()

This = wxListCtrl()
Item = integer()
Column = integer()
Image = integer()

See external documentation.

setItemPosition(This, Item, Pos) -> boolean()

This = wxListCtrl()
Item = integer()
Pos = {X::integer(), Y::integer()}

See external documentation.

setItemState(This, Item, State, StateMask) -> boolean()

This = wxListCtrl()
Item = integer()
State = integer()
StateMask = integer()

See external documentation.

setItemText(This, Item, Str) -> ok

This = wxListCtrl()
Item = integer()
Str = unicode:chardata()

See external documentation.

setItemTextColour(This, Item, Col) -> ok

This = wxListCtrl()
Item = integer()
Col = wx:wx_colour()

See external documentation.

setSingleStyle(This, Style) -> ok

This = wxListCtrl()
Style = integer()

Equivalent to setSingleStyle(This, Style, []).

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

This = wxListCtrl()
Style = integer()
Option = {add, boolean()}

See external documentation.

setTextColour(This, Col) -> ok

This = wxListCtrl()
Col = wx:wx_colour()

See external documentation.

setWindowStyleFlag(This, Style) -> ok

This = wxListCtrl()
Style = integer()

See external documentation.

sortItems(This::wxListCtrl(), SortCallBack::function()) -> boolean()

Sort the items in the list control

SortCallBack(Item1,Item2) -> integer()

SortCallBack receives the client data associated with two items to compare, and should return 0 if the items are equal, a negative value if the first item is less than the second one and a positive value if the first item is greater than the second one.
NOTE: The callback may not call other (wx) processes.

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

Destroys this object, do not use object again

wxListCtrl

See external documentation: wxListCtrl.

Functions

new() -> wxListCtrl()

new(Parent) -> wxListCtrl()

new(Parent, Options::[Option]) -> wxListCtrl()

arrange(This) -> boolean()

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

assignImageList(This, ImageList, Which) -> ok

clearAll(This) -> ok

create(This, Parent) -> wxListCtrl()

create(This, Parent, Options::[Option]) -> wxListCtrl()

deleteAllItems(This) -> boolean()

deleteColumn(This, Col) -> boolean()

deleteItem(This, Item) -> boolean()

editLabel(This, Item) -> wxTextCtrl:wxTextCtrl()

ensureVisible(This, Item) -> boolean()

findItem(This, Start, Str) -> integer()

findItem(This, Start, Str, Options::[Option]) -> integer()

getColumn(This, Col, Item) -> boolean()

getColumnCount(This) -> integer()

getColumnWidth(This, Col) -> integer()

getCountPerPage(This) -> integer()

getEditControl(This) -> wxTextCtrl:wxTextCtrl()

getImageList(This, Which) -> wxImageList:wxImageList()

getItem(This, Info) -> boolean()

getItemBackgroundColour(This, Item) -> wx:wx_colour4()

getItemCount(This) -> integer()

getItemData(This, Item) -> integer()

getItemFont(This, Item) -> wxFont:wxFont()

getItemPosition(This, Item) -> Result

getItemRect(This, Item) -> Result

getItemRect(This, Item, Options::[Option]) -> Result

getItemSpacing(This) -> {W::integer(), H::integer()}

getItemState(This, Item, StateMask) -> integer()

getItemText(This, Item) -> unicode:charlist()

getItemTextColour(This, Item) -> wx:wx_colour4()

getNextItem(This, Item) -> integer()

getNextItem(This, Item, Options::[Option]) -> integer()

getSelectedItemCount(This) -> integer()

getTextColour(This) -> wx:wx_colour4()

getTopItem(This) -> integer()

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

hitTest(This, Point) -> Result

insertColumn(This, Col, Heading) -> integer()

insertColumn(This, Col, Heading, Options::[Option]) -> integer()

insertItem(This, Info) -> integer()

insertItem(This, Index, ImageIndex) -> integer()

insertItem(This, Index, Label, ImageIndex) -> integer()

refreshItem(This, Item) -> ok

refreshItems(This, ItemFrom, ItemTo) -> ok

scrollList(This, Dx, Dy) -> boolean()

setBackgroundColour(This, Colour) -> boolean()

setColumn(This, Col, Item) -> boolean()

setColumnWidth(This, Col, Width) -> boolean()

setImageList(This, ImageList, Which) -> ok

setItem(This, Info) -> boolean()

setItem(This, Index, Col, Label) -> integer()

setItem(This, Index, Col, Label, Options::[Option]) -> integer()

setItemBackgroundColour(This, Item, Col) -> ok

setItemCount(This, Count) -> ok

setItemData(This, Item, Data) -> boolean()

setItemFont(This, Item, F) -> ok

setItemImage(This, Item, Image) -> boolean()

setItemImage(This, Item, Image, Options::[Option]) -> boolean()

setItemColumnImage(This, Item, Column, Image) -> boolean()

setItemPosition(This, Item, Pos) -> boolean()

setItemState(This, Item, State, StateMask) -> boolean()

setItemText(This, Item, Str) -> ok

setItemTextColour(This, Item, Col) -> ok

setSingleStyle(This, Style) -> ok

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

setTextColour(This, Col) -> ok

setWindowStyleFlag(This, Style) -> ok

sortItems(This::wxListCtrl(), SortCallBack::function()) -> boolean()

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