Provided by: erlang-manpages_20.2.2+dfsg-1ubuntu2_all 
NAME
wxListCtrl - See external documentation: wxListCtrl.
DESCRIPTION
See external documentation: wxListCtrl.
This class is derived (and can use functions) from:
wxControl
wxWindow
wxEvtHandler
DATA TYPES
wxListCtrl():
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() -> wxListCtrl()
See external documentation.
new(Parent) -> wxListCtrl()
Types:
Parent = wxWindow:wxWindow()
new(Parent, Options::[Option]) -> wxListCtrl()
Types:
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()
Types:
This = wxListCtrl()
Equivalent to arrange(This, []).
arrange(This, Options::[Option]) -> boolean()
Types:
This = wxListCtrl()
Option = {flag, integer()}
See external documentation.
assignImageList(This, ImageList, Which) -> ok
Types:
This = wxListCtrl()
ImageList = wxImageList:wxImageList()
Which = integer()
See external documentation.
clearAll(This) -> ok
Types:
This = wxListCtrl()
See external documentation.
create(This, Parent) -> wxListCtrl()
Types:
This = wxWindow:wxWindow()
Parent = wxWindow:wxWindow()
Equivalent to create(This, Parent, []).
create(This, Parent, Options::[Option]) -> wxListCtrl()
Types:
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()
Types:
This = wxListCtrl()
See external documentation.
deleteColumn(This, Col) -> boolean()
Types:
This = wxListCtrl()
Col = integer()
See external documentation.
deleteItem(This, Item) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
editLabel(This, Item) -> wxTextCtrl:wxTextCtrl()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
ensureVisible(This, Item) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
findItem(This, Start, Str) -> integer()
Types:
This = wxListCtrl()
Start = integer()
Str = unicode:chardata()
Equivalent to findItem(This, Start, Str, []).
findItem(This, Start, Str, Options::[Option]) -> integer()
Types:
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()
Types:
This = wxListCtrl()
Col = integer()
Item = wxListItem:wxListItem()
See external documentation.
getColumnCount(This) -> integer()
Types:
This = wxListCtrl()
See external documentation.
getColumnWidth(This, Col) -> integer()
Types:
This = wxListCtrl()
Col = integer()
See external documentation.
getCountPerPage(This) -> integer()
Types:
This = wxListCtrl()
See external documentation.
getEditControl(This) -> wxTextCtrl:wxTextCtrl()
Types:
This = wxListCtrl()
See external documentation.
getImageList(This, Which) -> wxImageList:wxImageList()
Types:
This = wxListCtrl()
Which = integer()
See external documentation.
getItem(This, Info) -> boolean()
Types:
This = wxListCtrl()
Info = wxListItem:wxListItem()
See external documentation.
getItemBackgroundColour(This, Item) -> wx:wx_colour4()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
getItemCount(This) -> integer()
Types:
This = wxListCtrl()
See external documentation.
getItemData(This, Item) -> integer()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
getItemFont(This, Item) -> wxFont:wxFont()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
getItemPosition(This, Item) -> Result
Types:
Result = {Res::boolean(), Pos::{X::integer(), Y::integer()}}
This = wxListCtrl()
Item = integer()
See external documentation.
getItemRect(This, Item) -> Result
Types:
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
Types:
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()}
Types:
This = wxListCtrl()
See external documentation.
getItemState(This, Item, StateMask) -> integer()
Types:
This = wxListCtrl()
Item = integer()
StateMask = integer()
See external documentation.
getItemText(This, Item) -> unicode:charlist()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
getItemTextColour(This, Item) -> wx:wx_colour4()
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
getNextItem(This, Item) -> integer()
Types:
This = wxListCtrl()
Item = integer()
Equivalent to getNextItem(This, Item, []).
getNextItem(This, Item, Options::[Option]) -> integer()
Types:
This = wxListCtrl()
Item = integer()
Option = {geometry, integer()} | {state, integer()}
See external documentation.
getSelectedItemCount(This) -> integer()
Types:
This = wxListCtrl()
See external documentation.
getTextColour(This) -> wx:wx_colour4()
Types:
This = wxListCtrl()
See external documentation.
getTopItem(This) -> integer()
Types:
This = wxListCtrl()
See external documentation.
getViewRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()}
Types:
This = wxListCtrl()
See external documentation.
hitTest(This, Point) -> Result
Types:
Result = {Res::integer(), Flags::integer(), PSubItem::integer()}
This = wxListCtrl()
Point = {X::integer(), Y::integer()}
See external documentation.
insertColumn(This, Col, Heading) -> integer()
Types:
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()
Types:
This = wxListCtrl()
Col = integer()
Heading = unicode:chardata()
Option = {format, integer()} | {width, integer()}
See external documentation.
insertItem(This, Info) -> integer()
Types:
This = wxListCtrl()
Info = wxListItem:wxListItem()
See external documentation.
insertItem(This, Index, ImageIndex) -> integer()
Types:
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()
Types:
This = wxListCtrl()
Index = integer()
Label = unicode:chardata()
ImageIndex = integer()
See external documentation.
refreshItem(This, Item) -> ok
Types:
This = wxListCtrl()
Item = integer()
See external documentation.
refreshItems(This, ItemFrom, ItemTo) -> ok
Types:
This = wxListCtrl()
ItemFrom = integer()
ItemTo = integer()
See external documentation.
scrollList(This, Dx, Dy) -> boolean()
Types:
This = wxListCtrl()
Dx = integer()
Dy = integer()
See external documentation.
setBackgroundColour(This, Colour) -> boolean()
Types:
This = wxListCtrl()
Colour = wx:wx_colour()
See external documentation.
setColumn(This, Col, Item) -> boolean()
Types:
This = wxListCtrl()
Col = integer()
Item = wxListItem:wxListItem()
See external documentation.
setColumnWidth(This, Col, Width) -> boolean()
Types:
This = wxListCtrl()
Col = integer()
Width = integer()
See external documentation.
setImageList(This, ImageList, Which) -> ok
Types:
This = wxListCtrl()
ImageList = wxImageList:wxImageList()
Which = integer()
See external documentation.
setItem(This, Info) -> boolean()
Types:
This = wxListCtrl()
Info = wxListItem:wxListItem()
See external documentation.
setItem(This, Index, Col, Label) -> integer()
Types:
This = wxListCtrl()
Index = integer()
Col = integer()
Label = unicode:chardata()
Equivalent to setItem(This, Index, Col, Label, []).
setItem(This, Index, Col, Label, Options::[Option]) -> integer()
Types:
This = wxListCtrl()
Index = integer()
Col = integer()
Label = unicode:chardata()
Option = {imageId, integer()}
See external documentation.
setItemBackgroundColour(This, Item, Col) -> ok
Types:
This = wxListCtrl()
Item = integer()
Col = wx:wx_colour()
See external documentation.
setItemCount(This, Count) -> ok
Types:
This = wxListCtrl()
Count = integer()
See external documentation.
setItemData(This, Item, Data) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Data = integer()
See external documentation.
setItemFont(This, Item, F) -> ok
Types:
This = wxListCtrl()
Item = integer()
F = wxFont:wxFont()
See external documentation.
setItemImage(This, Item, Image) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Image = integer()
Equivalent to setItemImage(This, Item, Image, []).
setItemImage(This, Item, Image, Options::[Option]) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Image = integer()
Option = {selImage, integer()}
See external documentation.
setItemColumnImage(This, Item, Column, Image) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Column = integer()
Image = integer()
See external documentation.
setItemPosition(This, Item, Pos) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Pos = {X::integer(), Y::integer()}
See external documentation.
setItemState(This, Item, State, StateMask) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
State = integer()
StateMask = integer()
See external documentation.
setItemText(This, Item, Str) -> ok
Types:
This = wxListCtrl()
Item = integer()
Str = unicode:chardata()
See external documentation.
setItemTextColour(This, Item, Col) -> ok
Types:
This = wxListCtrl()
Item = integer()
Col = wx:wx_colour()
See external documentation.
setSingleStyle(This, Style) -> ok
Types:
This = wxListCtrl()
Style = integer()
Equivalent to setSingleStyle(This, Style, []).
setSingleStyle(This, Style, Options::[Option]) -> ok
Types:
This = wxListCtrl()
Style = integer()
Option = {add, boolean()}
See external documentation.
setTextColour(This, Col) -> ok
Types:
This = wxListCtrl()
Col = wx:wx_colour()
See external documentation.
setWindowStyleFlag(This, Style) -> ok
Types:
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
AUTHORS
<>
wx 1.8.3 wxListCtrl(3erl)