wxTreeCtrl(3)

MODULE
wxTreeCtrl - See external documentation: wxTreeCtrl.

DESCRIPTION

See external documentation: wxTreeCtrl.

This class is derived (and can use functions) from: .br wxControl .br wxWindow .br wxEvtHandler

DATA TYPES

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

    See external documentation.

new(Parent::wxWindow() (see module wxWindow)) -> wxTreeCtrl()

    Equivalent to new(Parent, []).

new(Parent::wxWindow() (see module wxWindow), Options::[Option]) -> wxTreeCtrl()

    Types
        Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)}

    See external documentation.

addRoot(This::wxTreeCtrl(), Text::string()) -> wxTreeItemId()

    Equivalent to addRoot(This, Text, []).

addRoot(This::wxTreeCtrl(), Text::string(), Options::[Option]) -> wxTreeItemId()

    Types
        Option = {image, integer()} | {selectedImage, integer()} | {data, term()}

    See external documentation.

appendItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), Text::string()) -> wxTreeItemId()

    Equivalent to appendItem(This, Parent, Text, []).

appendItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), Text::string(), Options::[Option]) -> wxTreeItemId()

    Types
        Option = {image, integer()} | {selectedImage, integer()} | {data, term()}

    See external documentation.

assignImageList(This::wxTreeCtrl(), ImageList::wxImageList() (see module wxImageList)) -> ok

    See external documentation.

assignStateImageList(This::wxTreeCtrl(), ImageList::wxImageList() (see module wxImageList)) -> ok

    See external documentation.

collapse(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

collapseAndReset(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

create(This::wxTreeCtrl(), Parent::wxWindow() (see module wxWindow)) -> bool()

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

create(This::wxTreeCtrl(), Parent::wxWindow() (see module wxWindow), Options::[Option]) -> bool()

    Types
        Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)}

    See external documentation.

delete(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

deleteAllItems(This::wxTreeCtrl()) -> ok

    See external documentation.

deleteChildren(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

ensureVisible(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

expand(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

getBoundingRect(This::wxTreeCtrl(), Item::wxTreeItemId(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> bool()

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

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

    Types
        Option = {textOnly, bool()}

    See external documentation.

getChildrenCount(This::wxTreeCtrl(), Item::wxTreeItemId()) -> integer()

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

getChildrenCount(This::wxTreeCtrl(), Item::wxTreeItemId(), Options::[Option]) -> integer()

    Types
        Option = {recursively, bool()}

    See external documentation.

getCount(This::wxTreeCtrl()) -> integer()

    See external documentation.

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

    See external documentation.

getFirstVisibleItem(This::wxTreeCtrl()) -> wxTreeItemId()

    See external documentation.

getImageList(This::wxTreeCtrl()) -> wxImageList() (see module wxImageList)

    See external documentation.

getIndent(This::wxTreeCtrl()) -> integer()

    See external documentation.

getItemBackgroundColour(This::wxTreeCtrl(), Item::wxTreeItemId()) -> colour() (see module wx)

    See external documentation.

getItemData(This::wxTreeCtrl(), Item::wxTreeItemId()) -> term()

    See external documentation.

getItemFont(This::wxTreeCtrl(), Item::wxTreeItemId()) -> wxFont() (see module wxFont)

    See external documentation.

getItemImage(This::wxTreeCtrl(), Item::wxTreeItemId()) -> integer()

    See external documentation.

getItemImage(This::wxTreeCtrl(), Item::wxTreeItemId(), Options::[Option]) -> integer()

    Types
        Option = {which, WxTreeItemIcon}
        WxTreeItemIcon = integer()

    See external documentation. .br WxTreeItemIcon is one of ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max

getItemText(This::wxTreeCtrl(), Item::wxTreeItemId()) -> string()

    See external documentation.

getItemTextColour(This::wxTreeCtrl(), Item::wxTreeItemId()) -> colour() (see module wx)

    See external documentation.

getLastChild(This::wxTreeCtrl(), Item::wxTreeItemId()) -> wxTreeItemId()

    See external documentation.

getNextSibling(This::wxTreeCtrl(), Item::wxTreeItemId()) -> wxTreeItemId()

    See external documentation.

getNextVisible(This::wxTreeCtrl(), Item::wxTreeItemId()) -> wxTreeItemId()

    See external documentation.

getItemParent(This::wxTreeCtrl(), Item::wxTreeItemId()) -> wxTreeItemId()

    See external documentation.

getPrevSibling(This::wxTreeCtrl(), Item::wxTreeItemId()) -> wxTreeItemId()

    See external documentation.

getPrevVisible(This::wxTreeCtrl(), Item::wxTreeItemId()) -> wxTreeItemId()

    See external documentation.

getRootItem(This::wxTreeCtrl()) -> wxTreeItemId()

    See external documentation.

getSelection(This::wxTreeCtrl()) -> wxTreeItemId()

    See external documentation.

getSelections(This::wxTreeCtrl()) -> {integer(), Val::[wxTreeItemId()]}

    See external documentation.

getStateImageList(This::wxTreeCtrl()) -> wxImageList() (see module wxImageList)

    See external documentation.

hitTest(This::wxTreeCtrl(), Point::{X::integer(), Y::integer()}) -> wxTreeItemId()

    See external documentation.

insertItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), X::integer() | wxTreeItemId(), Text::string()) -> wxTreeItemId()

    See external documentation. .br Alternatives:

    insertItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), Pos::integer(), Text::string()) -> insertItem(This,Parent,Pos,Text, [])

    insertItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), IdPrevious::wxTreeItemId(), Text::string()) -> insertItem(This,Parent,IdPrevious,Text, [])

insertItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), X::integer() | wxTreeItemId(), Text::string(), Options::[Option]) -> wxTreeItemId()

    See external documentation. .br Alternatives:

    insertItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), Pos::integer(), Text::string(), [Option]) -> wxTreeItemId() .br Option = {image, integer()} | {selImage, integer()} | {data, term()}

    insertItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), IdPrevious::wxTreeItemId(), Text::string(), [Option]) -> wxTreeItemId() .br Option = {image, integer()} | {selectedImage, integer()} | {data, term()}

isBold(This::wxTreeCtrl(), Item::wxTreeItemId()) -> bool()

    See external documentation.

isExpanded(This::wxTreeCtrl(), Item::wxTreeItemId()) -> bool()

    See external documentation.

isSelected(This::wxTreeCtrl(), Item::wxTreeItemId()) -> bool()

    See external documentation.

isVisible(This::wxTreeCtrl(), Item::wxTreeItemId()) -> bool()

    See external documentation.

itemHasChildren(This::wxTreeCtrl(), Item::wxTreeItemId()) -> bool()

    See external documentation.

prependItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), Text::string()) -> wxTreeItemId()

    Equivalent to prependItem(This, Parent, Text, []).

prependItem(This::wxTreeCtrl(), Parent::wxTreeItemId(), Text::string(), Options::[Option]) -> wxTreeItemId()

    Types
        Option = {image, integer()} | {selectedImage, integer()} | {data, term()}

    See external documentation.

scrollTo(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

selectItem(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

selectItem(This::wxTreeCtrl(), Item::wxTreeItemId(), Options::[Option]) -> ok

    Types
        Option = {select, bool()}

    See external documentation.

setIndent(This::wxTreeCtrl(), Indent::integer()) -> ok

    See external documentation.

setImageList(This::wxTreeCtrl(), ImageList::wxImageList() (see module wxImageList)) -> ok

    See external documentation.

setItemBackgroundColour(This::wxTreeCtrl(), Item::wxTreeItemId(), Col::colour() (see module wx)) -> ok

    See external documentation.

setItemBold(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

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

setItemBold(This::wxTreeCtrl(), Item::wxTreeItemId(), Options::[Option]) -> ok

    Types
        Option = {bold, bool()}

    See external documentation.

setItemData(This::wxTreeCtrl(), Item::wxTreeItemId(), Data::term()) -> ok

    See external documentation.

setItemDropHighlight(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

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

setItemDropHighlight(This::wxTreeCtrl(), Item::wxTreeItemId(), Options::[Option]) -> ok

    Types
        Option = {highlight, bool()}

    See external documentation.

setItemFont(This::wxTreeCtrl(), Item::wxTreeItemId(), Font::wxFont() (see module wxFont)) -> ok

    See external documentation.

setItemHasChildren(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

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

setItemHasChildren(This::wxTreeCtrl(), Item::wxTreeItemId(), Options::[Option]) -> ok

    Types
        Option = {has, bool()}

    See external documentation.

setItemImage(This::wxTreeCtrl(), Item::wxTreeItemId(), Image::integer()) -> ok

    See external documentation.

setItemImage(This::wxTreeCtrl(), Item::wxTreeItemId(), Image::integer(), Options::[Option]) -> ok

    Types
        Option = {which, WxTreeItemIcon}
        WxTreeItemIcon = integer()

    See external documentation. .br WxTreeItemIcon is one of ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max

setItemText(This::wxTreeCtrl(), Item::wxTreeItemId(), Text::string()) -> ok

    See external documentation.

setItemTextColour(This::wxTreeCtrl(), Item::wxTreeItemId(), Col::colour() (see module wx)) -> ok

    See external documentation.

setStateImageList(This::wxTreeCtrl(), ImageList::wxImageList() (see module wxImageList)) -> ok

    See external documentation.

setWindowStyle(This::wxTreeCtrl(), Styles::integer()) -> ok

    See external documentation.

sortChildren(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

toggle(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

toggleItemSelection(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

unselect(This::wxTreeCtrl()) -> ok

    See external documentation.

unselectAll(This::wxTreeCtrl()) -> ok

    See external documentation.

unselectItem(This::wxTreeCtrl(), Item::wxTreeItemId()) -> ok

    See external documentation.

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

    Destroys this object, do not use object again