wxlistctrl(3) - Linux man page

Name

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

Equivalent to arrange(This, []).

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

Types:

Option = {flag, integer()}

See external documentation.

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

See external documentation.

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

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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.
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.

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

See external documentation.

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

See external documentation.

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

See external documentation.

getEditControl(This::wxListCtrl()) -> wxTextCtrl() (see module wxTextCtrl)

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.
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.

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

See external documentation.

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

See external documentation.
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.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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.

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

See external documentation.

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

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

<>