User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.98.5

Expand All
Contract All

Table of Contents

# wxTreeCtrl

### MODULE

wxTreeCtrl

### MODULE SUMMARY

See external documentation: wxTreeCtrl.

### DESCRIPTION

See external documentation: wxTreeCtrl.

Note: The representation of treeItemId() have changed from the original class implementation to be an semi-opaque type,Equality between TreeItemId's can be tested and zero means that the TreeItem is invalid.

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

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

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

Types:

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

See external documentation.

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

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

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

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::integer()) -> ok

See external documentation.

collapseAndReset(This::wxTreeCtrl(), Item::integer()) -> 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::integer()) -> ok

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

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

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

Types:

Option = {textOnly, bool()}

See external documentation.

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

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

getChildrenCount(This::wxTreeCtrl(), Item::integer(), 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.

getFirstChild(This::wxTreeCtrl(), Item::integer()) -> {integer(), Cookie::integer()}

See external documentation.

getNextChild(This::wxTreeCtrl(), Item::integer(), Cookie::integer()) -> {integer(), Cookie::integer()}

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

Types:

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

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

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

Equivalent to insertItem(This, Parent, Pos, Text, []).

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

Types:

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

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

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

Types:

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

See external documentation.

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

See external documentation.

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

See external documentation.

selectItem(This::wxTreeCtrl(), Item::integer(), 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::integer(), Col::colour() (see module wx)) -> ok

See external documentation.

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

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

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

Types:

Option = {bold, bool()}

See external documentation.

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

See external documentation.

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

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

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

Types:

Option = {highlight, bool()}

See external documentation.

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

See external documentation.

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

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

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

Types:

Option = {has, bool()}

See external documentation.

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

See external documentation.

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

Types:

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

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

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

See external documentation.

setItemTextColour(This::wxTreeCtrl(), Item::integer(), 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::integer()) -> ok

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

Destroys this object, do not use object again