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

    abstract datatype: 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.

    Function Index

    arrange/1*Equivalent to arrange(This, []).
    arrange/2*See external documentation.
    assignImageList/3*See external documentation.
    clearAll/1*See external documentation.
    create/2*Equivalent to create(This, Parent, []).
    create/3*See external documentation.
    deleteAllItems/1*See external documentation.
    deleteColumn/2*See external documentation.
    deleteItem/2*See external documentation.
    destroy/1*Destroys this object, do not use object again.
    editLabel/2*See external documentation.
    ensureVisible/2*See external documentation.
    findItem/3*Equivalent to findItem(This, Start, Str, []).
    findItem/4*See external documentation.
    getColumn/3*See external documentation.
    getColumnCount/1*See external documentation.
    getColumnWidth/2*See external documentation.
    getCountPerPage/1*See external documentation.
    getImageList/2*See external documentation.
    getItem/2*See external documentation.
    getItemBackgroundColour/2*See external documentation.
    getItemCount/1*See external documentation.
    getItemData/2*See external documentation.
    getItemFont/2*See external documentation.
    getItemPosition/3*See external documentation.
    getItemRect/3*Equivalent to getItemRect(This, Item, Rect, []).
    getItemRect/4*See external documentation.
    getItemSpacing/1*See external documentation.
    getItemState/3*See external documentation.
    getItemText/2*See external documentation.
    getItemTextColour/2*See external documentation.
    getNextItem/2*Equivalent to getNextItem(This, Item, []).
    getNextItem/3*See external documentation.
    getSelectedItemCount/1*See external documentation.
    getTextColour/1*See external documentation.
    getTopItem/1*See external documentation.
    getViewRect/1*See external documentation.
    hitTest/2*See external documentation.
    insertColumn/3*See external documentation.
    insertColumn/4*See external documentation.
    insertItem/2*See external documentation.
    insertItem/3*See external documentation.
    insertItem/4*See external documentation.
    new/0*See external documentation.
    new/1*Equivalent to new(Parent, []).
    new/2*See external documentation.
    refreshItem/2*See external documentation.
    refreshItems/3*See external documentation.
    scrollList/3*See external documentation.
    setBackgroundColour/2*See external documentation.
    setColumn/3*See external documentation.
    setColumnWidth/3*See external documentation.
    setImageList/3*See external documentation.
    setItem/2*See external documentation.
    setItem/4*Equivalent to setItem(This, Index, Col, Label, []).
    setItem/5*See external documentation.
    setItemBackgroundColour/3*See external documentation.
    setItemColumnImage/4*See external documentation.
    setItemCount/2*See external documentation.
    setItemData/3*See external documentation.
    setItemFont/3*See external documentation.
    setItemImage/3*Equivalent to setItemImage(This, Item, Image, []).
    setItemImage/4*See external documentation.
    setItemPosition/3*See external documentation.
    setItemState/4*See external documentation.
    setItemText/3*See external documentation.
    setItemTextColour/3*See external documentation.
    setSingleStyle/2*Equivalent to setSingleStyle(This, Style, []).
    setSingleStyle/3*See external documentation.
    setTextColour/2*See external documentation.
    setWindowStyleFlag/2*See external documentation.

    Function Details

    arrange/1 *

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

    Equivalent to arrange(This, []).

    arrange/2 *

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

    See external documentation.

    assignImageList/3 *

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

    See external documentation.

    clearAll/1 *

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

    See external documentation.

    create/2 *

    create(This::wxListCtrl(), Parent::wxWindow:wxWindow()) -> bool()

    Equivalent to create(This, Parent, []).

    create/3 *

    create(This::wxListCtrl(), Parent::wxWindow:wxWindow(), Options::[Option]) -> bool()

    See external documentation.

    deleteAllItems/1 *

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

    See external documentation.

    deleteColumn/2 *

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

    See external documentation.

    deleteItem/2 *

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

    See external documentation.

    destroy/1 *

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

    Destroys this object, do not use object again

    editLabel/2 *

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

    See external documentation.

    ensureVisible/2 *

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

    See external documentation.

    findItem/3 *

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

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

    findItem/4 *

    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/3 *

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

    See external documentation.

    getColumnCount/1 *

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

    See external documentation.

    getColumnWidth/2 *

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

    See external documentation.

    getCountPerPage/1 *

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

    See external documentation.

    getImageList/2 *

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

    See external documentation.

    getItem/2 *

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

    See external documentation.

    getItemBackgroundColour/2 *

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

    See external documentation.

    getItemCount/1 *

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

    See external documentation.

    getItemData/2 *

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

    See external documentation.

    getItemFont/2 *

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

    See external documentation.

    getItemPosition/3 *

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

    See external documentation.

    getItemRect/3 *

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

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

    getItemRect/4 *

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

    See external documentation.

    getItemSpacing/1 *

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

    See external documentation.

    getItemState/3 *

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

    See external documentation.

    getItemText/2 *

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

    See external documentation.

    getItemTextColour/2 *

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

    See external documentation.

    getNextItem/2 *

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

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

    getNextItem/3 *

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

    See external documentation.

    getSelectedItemCount/1 *

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

    See external documentation.

    getTextColour/1 *

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

    See external documentation.

    getTopItem/1 *

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

    See external documentation.

    getViewRect/1 *

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

    See external documentation.

    hitTest/2 *

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

    See external documentation.

    insertColumn/3 *

    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/4 *

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

    See external documentation.

    insertItem/2 *

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

    See external documentation.

    insertItem/3 *

    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/4 *

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

    See external documentation.

    new/0 *

    new() -> wxListCtrl()

    See external documentation.

    new/1 *

    new(Parent::wxWindow:wxWindow()) -> wxListCtrl()

    Equivalent to new(Parent, []).

    new/2 *

    new(Parent::wxWindow:wxWindow(), Options::[Option]) -> wxListCtrl()

    See external documentation.

    refreshItem/2 *

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

    See external documentation.

    refreshItems/3 *

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

    See external documentation.

    scrollList/3 *

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

    See external documentation.

    setBackgroundColour/2 *

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

    See external documentation.

    setColumn/3 *

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

    See external documentation.

    setColumnWidth/3 *

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

    See external documentation.

    setImageList/3 *

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

    See external documentation.

    setItem/2 *

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

    See external documentation.

    setItem/4 *

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

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

    setItem/5 *

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

    See external documentation.

    setItemBackgroundColour/3 *

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

    See external documentation.

    setItemColumnImage/4 *

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

    See external documentation.

    setItemCount/2 *

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

    See external documentation.

    setItemData/3 *

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

    See external documentation.

    setItemFont/3 *

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

    See external documentation.

    setItemImage/3 *

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

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

    setItemImage/4 *

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

    See external documentation.

    setItemPosition/3 *

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

    See external documentation.

    setItemState/4 *

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

    See external documentation.

    setItemText/3 *

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

    See external documentation.

    setItemTextColour/3 *

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

    See external documentation.

    setSingleStyle/2 *

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

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

    setSingleStyle/3 *

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

    See external documentation.

    setTextColour/2 *

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

    See external documentation.

    setWindowStyleFlag/2 *

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

    See external documentation.


    Generated by EDoc, May 26 2008, 12:35:32.