wxErlang

Reference Manual

Version 1.9

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

Types

Parent = wxWindow:wxWindow()

Equivalent to new(Parent, []).

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

Types

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

See external documentation.

addRoot(This, Text) -> integer()

Types

This = wxTreeCtrl()
Text = unicode:chardata()

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

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

Types

This = wxTreeCtrl()
Text = unicode:chardata()
Option = {image, integer()} | {selectedImage, integer()} | {data, term()}

See external documentation.

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

Types

This = wxTreeCtrl()
Parent = integer()
Text = unicode:chardata()

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

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

Types

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

See external documentation.

assignImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()
ImageList = wxImageList:wxImageList()

See external documentation.

assignStateImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()
ImageList = wxImageList:wxImageList()

See external documentation.

collapse(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

collapseAndReset(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

create(This, Parent) -> boolean()

Types

This = wxTreeCtrl()
Parent = wxWindow:wxWindow()

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

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

Types

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

See external documentation.

delete(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

deleteAllItems(This) -> ok

Types

This = wxTreeCtrl()

See external documentation.

deleteChildren(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

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

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

ensureVisible(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

expand(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getBoundingRect(This, Item) -> Result

Types

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

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

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

See external documentation.

getChildrenCount(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

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

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

Types

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

See external documentation.

getCount(This) -> integer()

Types

This = wxTreeCtrl()

See external documentation.

getEditControl(This) -> wxTextCtrl:wxTextCtrl()

Types

This = wxTreeCtrl()

See external documentation.

getFirstChild(This, Item) -> Result

Types

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

See external documentation.

getNextChild(This, Item, Cookie) -> Result

Types

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

See external documentation.

getFirstVisibleItem(This) -> integer()

Types

This = wxTreeCtrl()

See external documentation.

getImageList(This) -> wxImageList:wxImageList()

Types

This = wxTreeCtrl()

See external documentation.

getIndent(This) -> integer()

Types

This = wxTreeCtrl()

See external documentation.

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

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getItemData(This, Item) -> term()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

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

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getItemImage(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

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

See external documentation.

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

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getLastChild(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getNextSibling(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getNextVisible(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getItemParent(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getPrevSibling(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getPrevVisible(This, Item) -> integer()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

getRootItem(This) -> integer()

Types

This = wxTreeCtrl()

See external documentation.

getSelection(This) -> integer()

Types

This = wxTreeCtrl()

See external documentation.

getSelections(This) -> Result

Types

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

See external documentation.

getStateImageList(This) -> wxImageList:wxImageList()

Types

This = wxTreeCtrl()

See external documentation.

hitTest(This, Point) -> Result

Types

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

See external documentation.

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

Types

This = wxTreeCtrl()
Parent = integer()
Pos = integer()
Text = unicode:chardata()

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

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

Types

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

See external documentation.

isBold(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

isExpanded(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

isSelected(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

isVisible(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

itemHasChildren(This, Item) -> boolean()

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

isTreeItemIdOk(Id) -> boolean()

Types

Id = integer()

See external documentation.

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

Types

This = wxTreeCtrl()
Parent = integer()
Text = unicode:chardata()

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

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

Types

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

See external documentation.

scrollTo(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

selectItem(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

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

Types

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

See external documentation.

setIndent(This, Indent) -> ok

Types

This = wxTreeCtrl()
Indent = integer()

See external documentation.

setImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()
ImageList = wxImageList:wxImageList()

See external documentation.

setItemBackgroundColour(This, Item, Col) -> ok

Types

This = wxTreeCtrl()
Item = integer()
Col = wx:wx_colour()

See external documentation.

setItemBold(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

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

Types

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

See external documentation.

setItemData(This, Item, Data) -> ok

Types

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

See external documentation.

setItemDropHighlight(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

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

Types

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

See external documentation.

setItemFont(This, Item, Font) -> ok

Types

This = wxTreeCtrl()
Item = integer()
Font = wxFont:wxFont()

See external documentation.

setItemHasChildren(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

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

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

Types

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

See external documentation.

setItemImage(This, Item, Image) -> ok

Types

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

See external documentation.

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()
Text = unicode:chardata()

See external documentation.

setItemTextColour(This, Item, Col) -> ok

Types

This = wxTreeCtrl()
Item = integer()
Col = wx:wx_colour()

See external documentation.

setStateImageList(This, ImageList) -> ok

Types

This = wxTreeCtrl()
ImageList = wxImageList:wxImageList()

See external documentation.

setWindowStyle(This, Styles) -> ok

Types

This = wxTreeCtrl()
Styles = integer()

See external documentation.

sortChildren(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

toggle(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

toggleItemSelection(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

unselect(This) -> ok

Types

This = wxTreeCtrl()

See external documentation.

unselectAll(This) -> ok

Types

This = wxTreeCtrl()

See external documentation.

unselectItem(This, Item) -> ok

Types

This = wxTreeCtrl()
Item = integer()

See external documentation.

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

Destroys this object, do not use object again

Copyright © 2009-2020 Ericsson AB. All Rights Reserved.