Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.6.1


Expand All
Contract All

Table of Contents

wxListCtrl

MODULE

wxListCtrl

MODULE SUMMARY

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

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

arrange(This) -> boolean()

Types:

This = wxListCtrl()

Equivalent to arrange(This, []).

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

Types:

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

assignImageList(This, ImageList, Which) -> ok

Types:

This = wxListCtrl()
ImageList = wxImageList() (see module wxImageList)
Which = integer()

clearAll(This) -> ok

Types:

This = wxListCtrl()

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

deleteAllItems(This) -> boolean()

Types:

This = wxListCtrl()

deleteColumn(This, Col) -> boolean()

Types:

This = wxListCtrl()
Col = integer()

deleteItem(This, Item) -> boolean()

Types:

This = wxListCtrl()
Item = integer()

editLabel(This, Item) -> wxTextCtrl() (see module wxTextCtrl)

Types:

This = wxListCtrl()
Item = integer()

ensureVisible(This, Item) -> boolean()

Types:

This = wxListCtrl()
Item = integer()

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

Types:

This = wxListCtrl()
Start = integer()
Str = chardata() (see module unicode)

findItem(This, Start, Str, Options::[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)

getColumnCount(This) -> integer()

Types:

This = wxListCtrl()

getColumnWidth(This, Col) -> integer()

Types:

This = wxListCtrl()
Col = integer()

getCountPerPage(This) -> integer()

Types:

This = wxListCtrl()

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

Types:

This = wxListCtrl()

getImageList(This, Which) -> wxImageList() (see module wxImageList)

Types:

This = wxListCtrl()
Which = integer()

getItem(This, Info) -> boolean()

Types:

This = wxListCtrl()
Info = wxListItem() (see module wxListItem)

getItemBackgroundColour(This, Item) -> wx_colour4() (see module wx)

Types:

This = wxListCtrl()
Item = integer()

getItemCount(This) -> integer()

Types:

This = wxListCtrl()

getItemData(This, Item) -> integer()

Types:

This = wxListCtrl()
Item = integer()

getItemFont(This, Item) -> wxFont() (see module wxFont)

Types:

This = wxListCtrl()
Item = integer()

getItemPosition(This, Item) -> Result

Types:

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

getItemRect(This, Item) -> Result

Types:

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

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

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

Types:

This = wxListCtrl()

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

Types:

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

getItemText(This, Item) -> charlist() (see module unicode)

Types:

This = wxListCtrl()
Item = integer()

getItemTextColour(This, Item) -> wx_colour4() (see module wx)

Types:

This = wxListCtrl()
Item = integer()

getNextItem(This, Item) -> integer()

Types:

This = wxListCtrl()
Item = integer()

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

Types:

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

getSelectedItemCount(This) -> integer()

Types:

This = wxListCtrl()

getTextColour(This) -> wx_colour4() (see module wx)

Types:

This = wxListCtrl()

getTopItem(This) -> integer()

Types:

This = wxListCtrl()

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

Types:

This = wxListCtrl()

hitTest(This, Point, Flags) -> integer()

Types:

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

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, Options::[Option]) -> integer()

Types:

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

insertItem(This, Info) -> integer()

Types:

This = wxListCtrl()
Info = wxListItem() (see module wxListItem)

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

refreshItem(This, Item) -> ok

Types:

This = wxListCtrl()
Item = integer()

refreshItems(This, ItemFrom, ItemTo) -> ok

Types:

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

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

Types:

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

setBackgroundColour(This, Colour) -> boolean()

Types:

This = wxListCtrl()
Colour = wx_colour() (see module wx)

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

Types:

This = wxListCtrl()
Col = integer()
Item = wxListItem() (see module wxListItem)

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

Types:

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

setImageList(This, ImageList, Which) -> ok

Types:

This = wxListCtrl()
ImageList = wxImageList() (see module wxImageList)
Which = integer()

setItem(This, Info) -> boolean()

Types:

This = wxListCtrl()
Info = wxListItem() (see module wxListItem)

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

Types:

This = wxListCtrl()
Index = integer()
Col = integer()
Label = chardata() (see module unicode)

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

Types:

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

setItemBackgroundColour(This, Item, Col) -> ok

Types:

This = wxListCtrl()
Item = integer()
Col = wx_colour() (see module wx)

setItemCount(This, Count) -> ok

Types:

This = wxListCtrl()
Count = integer()

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

Types:

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

setItemFont(This, Item, F) -> ok

Types:

This = wxListCtrl()
Item = integer()
F = wxFont() (see module wxFont)

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

Types:

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

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

Types:

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

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

Types:

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

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

Types:

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

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

Types:

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

setItemText(This, Item, Str) -> ok

Types:

This = wxListCtrl()
Item = integer()
Str = chardata() (see module unicode)

setItemTextColour(This, Item, Col) -> ok

Types:

This = wxListCtrl()
Item = integer()
Col = wx_colour() (see module wx)

setSingleStyle(This, Style) -> ok

Types:

This = wxListCtrl()
Style = integer()

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

Types:

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

setTextColour(This, Col) -> ok

Types:

This = wxListCtrl()
Col = wx_colour() (see module wx)

setWindowStyleFlag(This, Style) -> ok

Types:

This = wxListCtrl()
Style = integer()

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