wxTreeCtrl(3)

MODULE
wxTreeCtrl - See external documentation: wxTreeCtrl.

DESCRIPTION

See external documentation: wxTreeCtrl <http://www.wxwidgets.org/manuals/stable/wx_wxtreectrl.html>.

This class is derived (and can use functions) from:
wxControl
wxWindow
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 <http://www.wxwidgets.org/manuals/stable/wx_wxtreectrl.html#wxtreectrlwxtreectrl>.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtreectrl.html#wxtreectrlgetitemimage>.
     WxTreeItemIcon is one of ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtreectrl.html#wxtreectrlinsertitem>.
     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 <http://www.wxwidgets.org/manuals/stable/wx_wxtreectrl.html#wxtreectrlinsertitem>.
     Alternatives:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Types
        Option = {select, bool()}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxtreectrl.html#wxtreectrlsetitemimage>.
     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 <http://www.wxwidgets.org/manuals/stable/wx_wxtreectrl.html#wxtreectrlsetitemtext>.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Destroys this object, do not use object again