Scroll to navigation

wxListCtrl(3erl) Erlang Module Definition wxListCtrl(3erl)

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::wxWindow() (see module wxWindow)) -> wxListCtrl()
 
Equivalent to new(Parent, []).
new(Parent::wxWindow() (see module wxWindow), Options::[Option]) -> wxListCtrl()
 
Types:
Option = {winid, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)} | {onGetItemText, OnGetItemText} | {onGetItemAttr, OnGetItemAttr} | {onGetItemColumnImage, OnGetItemColumnImage}
 
OnGetItemText = (This, Item, Column) -> wxString()
 
OnGetItemAttr = (This, Item) -> wxListItemAttr()
 
OnGetItemColumnImage = (This, Item, Column) -> integer()
 
See external documentation.
arrange(This) -> boolean()
 
Types:
This = wxListCtrl()
 
Equivalent to arrange(This, []).
arrange(This, Option::[Option]) -> boolean()
 
Types:
This = wxListCtrl()
 
Option = {flag, integer()}
 
See external documentation.
assignImageList(This, ImageList, Which) -> ok
 
Types:
This = wxListCtrl()
 
ImageList = wxImageList() (see module wxImageList)
 
Which = integer()
 
See external documentation.
clearAll(This) -> ok
 
Types:
This = wxListCtrl()
 
See external documentation.
create(This::wxListCtrl(), Parent::wxWindow() (see module wxWindow)) -> bool()
 
Equivalent to create(This, Parent, []).
create(This::wxListCtrl(), Parent::wxWindow() (see module wxWindow), Options::[Option]) -> bool()
 
Types:
Option = {winid, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)} | {onGetItemText, OnGetItemText} | {onGetItemAttr, OnGetItemAttr} | {onGetItemColumnImage, OnGetItemColumnImage}
 
OnGetItemText = (This, Item, Column) -> wxString()
 
OnGetItemAttr = (This, Item) -> wxListItemAttr()
 
OnGetItemColumnImage = (This, Item, Column) -> integer()
 
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() (see module 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 = chardata() (see module unicode)
 
Equivalent to findItem(This, Start, Str, []).
findItem(This, Start, Str, Option::[Option]) -> integer()
 
Types:
This = wxListCtrl()
 
Start = integer()
 
Str = chardata() (see module unicode)
 
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() (see module 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() (see module wxTextCtrl)
 
Types:
This = wxListCtrl()
 
See external documentation.
getImageList(This, Which) -> wxImageList() (see module wxImageList)
 
Types:
This = wxListCtrl()
 
Which = integer()
 
See external documentation.
getItem(This, Info) -> boolean()
 
Types:
This = wxListCtrl()
 
Info = wxListItem() (see module wxListItem)
 
See external documentation.
getItemBackgroundColour(This, Item) -> wx_colour4() (see module wx)
 
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() (see module 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, Option::[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) -> charlist() (see module unicode)
 
Types:
This = wxListCtrl()
 
Item = integer()
 
See external documentation.
getItemTextColour(This, Item) -> wx_colour4() (see module wx)
 
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, Option::[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_colour4() (see module wx)
 
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, Flags) -> integer()
 
Types:
This = wxListCtrl()
 
Point = {X::integer(), Y::integer()}
 
Flags = integer()
 
See external documentation.
insertColumn(This, Col, Heading) -> integer()
 
Types:
This = wxListCtrl()
 
Col = integer()
 
Heading = chardata() (see module unicode)
 
See external documentation.
 
Also:
 
insertColumn(This, Col, Info) -> integer() when
 
This::wxListCtrl(), Col::integer(), Info::wxListItem:wxListItem().
 
insertColumn(This, Col, Heading, Option::[Option]) -> integer()
 
Types:
This = wxListCtrl()
 
Col = integer()
 
Heading = chardata() (see module unicode)
 
Option = {format, integer()} | {width, integer()}
 
See external documentation.
insertItem(This, Info) -> integer()
 
Types:
This = wxListCtrl()
 
Info = wxListItem() (see module 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 = chardata() (see module unicode)
 
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_colour() (see module wx)
 
See external documentation.
setColumn(This, Col, Item) -> boolean()
 
Types:
This = wxListCtrl()
 
Col = integer()
 
Item = wxListItem() (see module 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() (see module wxImageList)
 
Which = integer()
 
See external documentation.
setItem(This, Info) -> boolean()
 
Types:
This = wxListCtrl()
 
Info = wxListItem() (see module wxListItem)
 
See external documentation.
setItem(This, Index, Col, Label) -> integer()
 
Types:
This = wxListCtrl()
 
Index = integer()
 
Col = integer()
 
Label = chardata() (see module unicode)
 
Equivalent to setItem(This, Index, Col, Label, []).
setItem(This, Index, Col, Label, Option::[Option]) -> integer()
 
Types:
This = wxListCtrl()
 
Index = integer()
 
Col = integer()
 
Label = chardata() (see module unicode)
 
Option = {imageId, integer()}
 
See external documentation.
setItemBackgroundColour(This, Item, Col) -> ok
 
Types:
This = wxListCtrl()
 
Item = integer()
 
Col = wx_colour() (see module wx)
 
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() (see module 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, Option::[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 = chardata() (see module unicode)
 
See external documentation.
setItemTextColour(This, Item, Col) -> ok
 
Types:
This = wxListCtrl()
 
Item = integer()
 
Col = wx_colour() (see module wx)
 
See external documentation.
setSingleStyle(This, Style) -> ok
 
Types:
This = wxListCtrl()
 
Style = integer()
 
Equivalent to setSingleStyle(This, Style, []).
setSingleStyle(This, Style, Option::[Option]) -> ok
 
Types:
This = wxListCtrl()
 
Style = integer()
 
Option = {add, boolean()}
 
See external documentation.
setTextColour(This, Col) -> ok
 
Types:
This = wxListCtrl()
 
Col = wx_colour() (see module wx)
 
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.3.1