wxListCtrl(3)

MODULE
wxListCtrl - See external documentation: wxListCtrl.

DESCRIPTION

See external documentation: wxListCtrl <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlwxlistctrl>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlwxlistctrl>.

arrange(This::wxListCtrl()) -> bool()

    Equivalent to arrange(This, []).

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

    Types
        Option = {flag, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlarrange>.

assignImageList(This::wxListCtrl(), ImageList::wxImageList() (see module wxImageList), Which::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlassignimagelist>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlclearall>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlcreate>.

deleteAllItems(This::wxListCtrl()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrldeleteallitems>.

deleteColumn(This::wxListCtrl(), Col::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrldeletecolumn>.

deleteItem(This::wxListCtrl(), Item::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrldeleteitem>.

editLabel(This::wxListCtrl(), Item::integer()) -> wxTextCtrl() (see module wxTextCtrl)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrleditlabel>.

ensureVisible(This::wxListCtrl(), Item::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlensurevisible>.

findItem(This::wxListCtrl(), Start::integer(), Str::string()) -> integer()

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

findItem(This::wxListCtrl(), Start::integer(), X::string() | term(), X::term() | integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlfinditem>.
     Alternatives:

    findItem(This::wxListCtrl(), Start::integer(), Str::string(), [Option]) -> integer()
     Option = {partial, bool()}

    findItem(This::wxListCtrl(), Start::integer(), Pt::{X::integer(), Y::integer()}, Direction::integer()) -> integer()

getColumn(This::wxListCtrl(), Col::integer(), Item::wxListItem() (see module wxListItem)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetcolumn>.

getColumnCount(This::wxListCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetcolumncount>.

getColumnWidth(This::wxListCtrl(), Col::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetcolumnwidth>.

getCountPerPage(This::wxListCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetcountperpage>.

getImageList(This::wxListCtrl(), Which::integer()) -> wxImageList() (see module wxImageList)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetimagelist>.

getItem(This::wxListCtrl(), Info::wxListItem() (see module wxListItem)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitem>.

getItemBackgroundColour(This::wxListCtrl(), Item::integer()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitembackgroundcolour>.

getItemCount(This::wxListCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemcount>.

getItemData(This::wxListCtrl(), Item::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemdata>.

getItemFont(This::wxListCtrl(), Item::integer()) -> wxFont() (see module wxFont)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemfont>.

getItemPosition(This::wxListCtrl(), Item::integer(), Pos::{X::integer(), Y::integer()}) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemposition>.

getItemRect(This::wxListCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool()

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

getItemRect(This::wxListCtrl(), Item::integer(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, Options::[Option]) -> bool()

    Types
        Option = {code, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemrect>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemspacing>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemstate>.

getItemText(This::wxListCtrl(), Item::integer()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemtext>.

getItemTextColour(This::wxListCtrl(), Item::integer()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetitemtextcolour>.

getNextItem(This::wxListCtrl(), Item::integer()) -> integer()

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

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

    Types
        Option = {geometry, integer()} | {state, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetnextitem>.

getSelectedItemCount(This::wxListCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetselecteditemcount>.

getTextColour(This::wxListCtrl()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgettextcolour>.

getTopItem(This::wxListCtrl()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgettopitem>.

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlgetviewrect>.

hitTest(This::wxListCtrl(), Point::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlhittest>.

insertColumn(This::wxListCtrl(), Col::integer(), X::string() | term()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlinsertcolumn>.
     Alternatives:

    insertColumn(This::wxListCtrl(), Col::integer(), Heading::string()) -> insertColumn(This, Col, Heading, [])

    insertColumn(This::wxListCtrl(), Col::integer(), Info::wxListItem:wxListItem()) -> integer()

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

    Types
        Option = {format, integer()} | {width, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlinsertcolumn>.

insertItem(This::wxListCtrl(), Info::wxListItem() (see module wxListItem)) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlinsertitem>.

insertItem(This::wxListCtrl(), Index::integer(), X::integer() | string()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlinsertitem>.
     Alternatives:

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

    insertItem(This::wxListCtrl(), Index::integer(), Label::string()) -> integer()

insertItem(This::wxListCtrl(), Index::integer(), Label::string(), ImageIndex::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlinsertitem>.

refreshItem(This::wxListCtrl(), Item::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlrefreshitem>.

refreshItems(This::wxListCtrl(), ItemFrom::integer(), ItemTo::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlrefreshitems>.

scrollList(This::wxListCtrl(), Dx::integer(), Dy::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlscrolllist>.

setBackgroundColour(This::wxListCtrl(), Colour::colour() (see module wx)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetbackgroundcolour>.

setColumn(This::wxListCtrl(), Col::integer(), Item::wxListItem() (see module wxListItem)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetcolumn>.

setColumnWidth(This::wxListCtrl(), Col::integer(), Width::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetcolumnwidth>.

setImageList(This::wxListCtrl(), ImageList::wxImageList() (see module wxImageList), Which::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetimagelist>.

setItem(This::wxListCtrl(), Info::wxListItem() (see module wxListItem)) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitem>.

setItem(This::wxListCtrl(), Index::integer(), Col::integer(), Label::string()) -> integer()

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

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

    Types
        Option = {imageId, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitem>.

setItemBackgroundColour(This::wxListCtrl(), Item::integer(), Col::colour() (see module wx)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitembackgroundcolour>.

setItemCount(This::wxListCtrl(), Count::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemcount>.

setItemData(This::wxListCtrl(), Item::integer(), Data::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemdata>.

setItemFont(This::wxListCtrl(), Item::integer(), F::wxFont() (see module wxFont)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemfont>.

setItemImage(This::wxListCtrl(), Item::integer(), Image::integer()) -> bool()

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

setItemImage(This::wxListCtrl(), Item::integer(), Image::integer(), Options::[Option]) -> bool()

    Types
        Option = {selImage, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemimage>.

setItemColumnImage(This::wxListCtrl(), Item::integer(), Column::integer(), Image::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemcolumnimage>.

setItemPosition(This::wxListCtrl(), Item::integer(), Pos::{X::integer(), Y::integer()}) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemposition>.

setItemState(This::wxListCtrl(), Item::integer(), State::integer(), StateMask::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemstate>.

setItemText(This::wxListCtrl(), Item::integer(), Str::string()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemtext>.

setItemTextColour(This::wxListCtrl(), Item::integer(), Col::colour() (see module wx)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetitemtextcolour>.

setSingleStyle(This::wxListCtrl(), Style::integer()) -> ok

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

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

    Types
        Option = {add, bool()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetsinglestyle>.

setTextColour(This::wxListCtrl(), Col::colour() (see module wx)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsettextcolour>.

setWindowStyleFlag(This::wxListCtrl(), Style::integer()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxlistctrl.html#wxlistctrlsetwindowstyleflag>.

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

    Sort the items in the list control

    SortCalBack(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 processes.

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

    Destroys this object, do not use object again