wxErlang

Reference Manual

Version 1.8.3

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

new(Parent) -> wxTreeCtrl()

Types

Equivalent to new(Parent, []).

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

Types

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

addRoot(This, Text) -> integer()

Types

This = wxTreeCtrl()

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

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

Types

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

appendItem(This, Parent, Text) -> integer()

Types

This = wxTreeCtrl()
Parent = integer()

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

Types

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

assignImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()

assignStateImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()

collapse(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

collapseAndReset(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

create(This, Parent) -> boolean()

Types

This = wxTreeCtrl()

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

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

Types

This = wxTreeCtrl()
Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx:wx_object()}

delete(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

deleteAllItems(This) -> ok

Types

This = wxTreeCtrl()

deleteChildren(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()

ensureVisible(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

expand(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

getBoundingRect(This, Item) -> Result

Types

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

getBoundingRect(This, Item, Options::[Option]) -> Result

Types

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

getChildrenCount(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()
Option = {recursively, boolean()}

getCount(This) -> integer()

Types

This = wxTreeCtrl()

getEditControl(This) -> wxTextCtrl:wxTextCtrl()

Types

This = wxTreeCtrl()

getFirstChild(This, Item) -> Result

Types

Result = {Res::integer(), Cookie::integer()}
This = wxTreeCtrl()
Item = integer()

getNextChild(This, Item, Cookie) -> Result

Types

Result = {Res::integer(), Cookie::integer()}
This = wxTreeCtrl()
Item = integer()
Cookie = integer()

getFirstVisibleItem(This) -> integer()

Types

This = wxTreeCtrl()

getImageList(This) -> wxImageList:wxImageList()

Types

This = wxTreeCtrl()

getIndent(This) -> integer()

Types

This = wxTreeCtrl()

getItemBackgroundColour(This, Item) -> wx:wx_colour4()

Types

This = wxTreeCtrl()
Item = integer()

getItemData(This, Item) -> term()

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()

getItemImage(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()
Option = {which, wx:wx_enum()}

See external documentation.
Which = ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max

getItemText(This, Item) -> unicode:charlist()

Types

This = wxTreeCtrl()
Item = integer()

getItemTextColour(This, Item) -> wx:wx_colour4()

Types

This = wxTreeCtrl()
Item = integer()

getLastChild(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

getNextSibling(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

getNextVisible(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

getItemParent(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

getPrevSibling(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

getPrevVisible(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

getRootItem(This) -> integer()

Types

This = wxTreeCtrl()

getSelection(This) -> integer()

Types

This = wxTreeCtrl()

getSelections(This) -> Result

Types

Result = {Res::integer(), Val::[integer()]}
This = wxTreeCtrl()

getStateImageList(This) -> wxImageList:wxImageList()

Types

This = wxTreeCtrl()

hitTest(This, Point) -> Result

Types

Result = {Res::integer(), Flags::integer()}
This = wxTreeCtrl()
Point = {X::integer(), Y::integer()}

insertItem(This, Parent, Pos, Text) -> integer()

Types

This = wxTreeCtrl()
Parent = integer()
Pos = integer()

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

Types

This = wxTreeCtrl()
Parent = integer()
Pos = integer()
Option = {image, integer()} | {selImage, integer()} | {data, term()}

isBold(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

isExpanded(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

isSelected(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

isVisible(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

itemHasChildren(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

isTreeItemIdOk(Id) -> boolean()

Types

Id = integer()

prependItem(This, Parent, Text) -> integer()

Types

This = wxTreeCtrl()
Parent = integer()

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

Types

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

scrollTo(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

selectItem(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()
Option = {select, boolean()}

setIndent(This, Indent) -> ok

Types

This = wxTreeCtrl()
Indent = integer()

setImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()

setItemBackgroundColour(This, Item, Col) -> ok

Types

This = wxTreeCtrl()
Item = integer()

setItemBold(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()
Option = {bold, boolean()}

setItemData(This, Item, Data) -> ok

Types

This = wxTreeCtrl()
Item = integer()
Data = term()

setItemDropHighlight(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()
Option = {highlight, boolean()}

setItemFont(This, Item, Font) -> ok

Types

This = wxTreeCtrl()
Item = integer()

setItemHasChildren(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

Types

This = wxTreeCtrl()
Item = integer()
Option = {has, boolean()}

setItemImage(This, Item, Image) -> ok

Types

This = wxTreeCtrl()
Item = integer()
Image = integer()

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

Types

This = wxTreeCtrl()
Item = integer()
Image = integer()
Option = {which, wx:wx_enum()}

See external documentation.
Which = ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wxTreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wxTreeItemIcon_Max

setItemText(This, Item, Text) -> ok

Types

This = wxTreeCtrl()
Item = integer()

setItemTextColour(This, Item, Col) -> ok

Types

This = wxTreeCtrl()
Item = integer()

setStateImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()

setWindowStyle(This, Styles) -> ok

Types

This = wxTreeCtrl()
Styles = integer()

sortChildren(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

toggle(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

toggleItemSelection(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

unselect(This) -> ok

Types

This = wxTreeCtrl()

unselectAll(This) -> ok

Types

This = wxTreeCtrl()

unselectItem(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

Destroys this object, do not use object again