OpenSpace3D libs
OpenSpace 3D libraries for plugITs and OS3D developer
Functions

Functions

 getEdCtrlTreePreviousSelectedItem (ctrlstr)
 Get the previous selected item.
 
 getEdCtrlTreeSelectedItem (ctrlstr)
 Get the current selected item.
 
 getEdCtrlTreeFatherItem (ctrlstr, item)
 Get the father of a tree item.
 
 getEdCtrlTreeSonsItem (ctrlstr, item)
 Get the sons list of a tree item.
 
 getEdCtrlTreeRootItem (ctrlstr)
 Get the root tree item.
 
 isEdCtrlTreeItemSon (ctrlstr, item, father)
 Return 1 if the first item is a son of the second item.
 
 setEdCtrlTreeCbDrag (ctrlstr, cbfun)
 Define the tree item drag callback.
 
 setEdCtrlTreeCbDbClick (ctrlstr, cbfun)
 Define the tree item double click callback.
 
 setEdCtrlTreeCbSelect (ctrlstr, cbfun)
 Define the tree item select callback.
 
 setEdCtrlTreeCbExpand (ctrlstr, cbfun)
 Define the tree item expand callback.
 
 setEdCtrlTreeCbRclick (ctrlstr, cbfun)
 Define the tree item right click callback.
 
 setEdCtrlTreeCbClick (ctrlstr, cbfun)
 Define the tree item click callback.
 
 setEdCtrlTreeCbKeyDown (ctrlstr, cbfun)
 Define the tree item key down callback.
 
 setEdCtrlTreeCbKeyUp (ctrlstr, cbfun)
 Define the tree item key down callback.
 
 setEdCtrlTreeExpandAll (ctrlstr, mode)
 Expand a tree.
 
 setEdCtrlTreeExpandItem (ctrlstr, itemstr, mode, children)
 Expand a tree item.
 
 addEdCtrlTreeItem (ctrlstr, father, name, val, type, bitmappath)
 Add an item to a tree.
 
 removeEdCtrlTreeSons (ctrlstr, item)
 Remove all sons of a tree item.
 
 delEdCtrlTreeItem (ctrlstr, item)
 Remove a tree item and all it's sons.
 
 refreshEdCtrlTreeSons (ctrlstr, item, sort)
 Refresh the sons of a tree item.
 
 setEdCtrlTreeType (ctrlstr, item, type)
 Change an item type.
 
 setEdCtrlTreeValue (ctrlstr, item, value)
 Change an item value.
 
 setEdCtrlTreeLabel (ctrlstr, item, val)
 Change an item label.
 
 moveEdCtrlTreeItem (ctrlstr, item, father)
 Move a tree item to a new father.
 
 changeEdCtrlTreeItemPos (ctrlstr, item, itempos)
 Move a tree item to a new position from a node.
 
 setEdCtrlTreeItemBitmap (ctrlstr, itemstr, bitmappath)
 Set a tree item bitmap.
 
 sizeEdCtrlTree (ctrlstr, x, y, w, h)
 Resize a tree control.
 
 getEdCtrlTreeItemByValue (ctrlstr, val)
 Get a tree item by it's value.
 
 getEdCtrlTreeLabelByItem (ctrlstr, item)
 Get a tree item label.
 
 getEdCtrlTreeValueByItem (ctrlstr, item)
 Get a tree item value and type.
 
 getEdCtrlTreeFullValuesByItem (ctrlstr, item)
 Get a tree item father, value and type.
 
 getEdCtrlTreeFullValuesByValue (ctrlstr, val)
 Get a tree item father, value and type, by an item value.
 
 getEdCtrlTreeBrothers (ctrlstr, item)
 Get the brothers of a tree item.
 
 selEdCtrlTreeItemByValue (ctrlstr, val)
 Select a tree item by it's value.
 
 selEdCtrlTreeItem (ctrlstr, item)
 Select a tree item.
 
 setEdCtrlTreeEnable (ctrlstr, state)
 Enable or disable a tree control.
 
 setEdCtrlTreeFilter (ctrlstr, filter)
 Filter tree items.
 
 resetEdCtrlTree (ctrlstr)
 Reset a tree control.
 
 crEdCtrlTree (winstr, x, y, w, h, resize)
 Create a tree control.
 
 dsEdCtrlTree (ctrlstr)
 Destroy a tree control.
 

Detailed Description

Tree control

Function Documentation

◆ getEdCtrlTreePreviousSelectedItem()

getEdCtrlTreePreviousSelectedItem ( ctrlstr  )

Get the previous selected item.

Prototype: fun [EdControl] EdTreeItem

Parameters
EdControl: tree control structure
Returns
EdTreeItem : nil

◆ getEdCtrlTreeSelectedItem()

getEdCtrlTreeSelectedItem ( ctrlstr  )

Get the current selected item.

Prototype: fun [EdControl] EdTreeItem

Parameters
EdControl: tree control structure
Returns
EdTreeItem : nil

◆ getEdCtrlTreeFatherItem()

getEdCtrlTreeFatherItem ( ctrlstr  ,
item   
)

Get the father of a tree item.

Prototype: fun [EdControl EdTreeItem] EdTreeItem

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
EdTreeItem : nil

◆ getEdCtrlTreeSonsItem()

getEdCtrlTreeSonsItem ( ctrlstr  ,
item   
)

Get the sons list of a tree item.

Prototype: fun [EdControl EdTreeItem] [EdTreeItem r1]

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
[EdTreeItem r1] : nil

◆ getEdCtrlTreeRootItem()

getEdCtrlTreeRootItem ( ctrlstr  )

Get the root tree item.

Prototype: fun [EdControl] EdTreeItem

Parameters
EdControl: tree control structure
Returns
EdTreeItem : nil

◆ isEdCtrlTreeItemSon()

isEdCtrlTreeItemSon ( ctrlstr  ,
item  ,
father   
)

Return 1 if the first item is a son of the second item.

Prototype: fun [EdControl EdTreeItem EdTreeItem] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item to search
EdTreeItem: father tree item
Returns
1 : 0

◆ setEdCtrlTreeCbDrag()

setEdCtrlTreeCbDrag ( ctrlstr  ,
cbfun   
)

Define the tree item drag callback.

Prototype: fun [EdControl fun [EdControl [EdTreeItem EdTreeItem S I] [EdTreeItem EdTreeItem S I]] u0] I

Parameters
EdControl: tree control structure
fun[EdControl [EdTreeItem EdTreeItem S I] [EdTreeItem EdTreeItem S I]] u0 : callback function
-EdControl : tree control structure
-[EdTreeItem EdTreeItem S I] : first item father, item, item value, item type
-[EdTreeItem EdTreeItem S I] : second item father, item, item value, item type
Returns
0

◆ setEdCtrlTreeCbDbClick()

setEdCtrlTreeCbDbClick ( ctrlstr  ,
cbfun   
)

Define the tree item double click callback.

Prototype: fun [EdControl fun [EdControl EdTreeItem EdTreeItem S I I I] u0] I

Parameters
EdControl: tree control structure
fun[EdControl EdTreeItem EdTreeItem S I I I] u0: callback function
-EdControl : tree control structure
-EdTreeItem : item father
-EdTreeItem : clicked item
-S : item value
-I : item type
-I : click X coordinate
-I : click Y coordinate
Returns
0

◆ setEdCtrlTreeCbSelect()

setEdCtrlTreeCbSelect ( ctrlstr  ,
cbfun   
)

Define the tree item select callback.

Prototype: fun [EdControl fun [EdControl EdTreeItem EdTreeItem S I] u0] I

Parameters
EdControl: tree control structure
fun[EdControl EdTreeItem EdTreeItem S I] u0: callback function
-EdControl : tree control structure
-EdTreeItem : item father
-EdTreeItem : selected item
-S : item value
-I : item type
Returns
0

◆ setEdCtrlTreeCbExpand()

setEdCtrlTreeCbExpand ( ctrlstr  ,
cbfun   
)

Define the tree item expand callback.

Prototype: fun [EdControl fun [EdControl EdTreeItem EdTreeItem S I I I] u0] I

Parameters
EdControl: tree control structure
fun[EdControl EdTreeItem EdTreeItem S I I I I] u0: callback function
-EdControl : tree control structure
-EdTreeItem : item father
-EdTreeItem : clicked item
-S : item value
-I : item type
-I : state
Returns
0

◆ setEdCtrlTreeCbRclick()

setEdCtrlTreeCbRclick ( ctrlstr  ,
cbfun   
)

Define the tree item right click callback.

Prototype: fun [EdControl fun [EdControl EdTreeItem EdTreeItem S I I I] u0] I

Parameters
EdControl: tree control structure
fun[EdControl EdTreeItem EdTreeItem S I I I] u0: callback function
-EdControl : tree control structure
-EdTreeItem : item father
-EdTreeItem : clicked item
-S : item value
-I : item type
-I : click X coordinate
-I : click Y coordinate
Returns
0

◆ setEdCtrlTreeCbClick()

setEdCtrlTreeCbClick ( ctrlstr  ,
cbfun   
)

Define the tree item click callback.

Prototype: fun [EdControl fun [EdControl EdTreeItem EdTreeItem S I [I I] I] u0] I

Parameters
EdControl: tree control structure
fun[EdControl EdTreeItem EdTreeItem S I I I] u0: callback function
-EdControl : tree control structure
-EdTreeItem : item father
-EdTreeItem : clicked item
-S : item value
-I : item type
-[I I] : click X coordinate
-I : btn
Returns
0

◆ setEdCtrlTreeCbKeyDown()

setEdCtrlTreeCbKeyDown ( ctrlstr  ,
cbfun   
)

Define the tree item key down callback.

Prototype: fun [EdControl fun [EdControl EdTreeItem EdTreeItem S I I I] u0] I

Parameters
EdControl: tree control structure
fun[EdControl EdTreeItem EdTreeItem S I I I] u0
-EdControl : tree control structure
-EdTreeItem : item father
-EdTreeItem : clicked item
-S : item value
-I : item type
-I : key
-I : key code
Returns
0

◆ setEdCtrlTreeCbKeyUp()

setEdCtrlTreeCbKeyUp ( ctrlstr  ,
cbfun   
)

Define the tree item key down callback.

Prototype: fun [EdControl fun [EdControl EdTreeItem EdTreeItem S I I] u0] I

Parameters
EdControl: tree control structure
fun[EdControl EdTreeItem EdTreeItem S I I] u0
-EdControl : tree control structure
-EdTreeItem : item father
-EdTreeItem : clicked item
-S : item value
-I : item type
-I : key
Returns
0

◆ setEdCtrlTreeExpandAll()

setEdCtrlTreeExpandAll ( ctrlstr  ,
mode   
)

Expand a tree.

Prototype: fun [EdControl I] I

Parameters
EdControl: tree control structure
I: 1 to expand, 0 to retract
Returns
0

◆ setEdCtrlTreeExpandItem()

setEdCtrlTreeExpandItem ( ctrlstr  ,
itemstr  ,
mode  ,
children   
)

Expand a tree item.

Prototype: fun [EdControl EdTreeItem I I] I

Parameters
EdControl: tree control structure
EdTreeItem: item
I: 1 to expand, 0 to retract
I: 1 to apply on children, 0 otherwise
Returns
0

◆ addEdCtrlTreeItem()

addEdCtrlTreeItem ( ctrlstr  ,
father  ,
name  ,
val  ,
type  ,
bitmappath   
)

Add an item to a tree.

Prototype: fun [EdControl EdTreeItem S S I S] EdTreeItem

Parameters
EdControl: tree control structure
EdTreeItem: father item, nil for root
S: item label
S: item value
I: item type
S: item bitmap path
Returns
0

◆ removeEdCtrlTreeSons()

removeEdCtrlTreeSons ( ctrlstr  ,
item   
)

Remove all sons of a tree item.

Prototype: fun [EdControl EdTreeItem] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
0

◆ delEdCtrlTreeItem()

delEdCtrlTreeItem ( ctrlstr  ,
item   
)

Remove a tree item and all it's sons.

Prototype: fun [EdControl EdTreeItem] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item to remove
Returns
0

◆ refreshEdCtrlTreeSons()

refreshEdCtrlTreeSons ( ctrlstr  ,
item  ,
sort   
)

Refresh the sons of a tree item.

Prototype: fun [EdControl EdTreeItem I] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item
I: 1 to sort the items, 0 otherwise
Returns
0

◆ setEdCtrlTreeType()

setEdCtrlTreeType ( ctrlstr  ,
item  ,
type   
)

Change an item type.

Prototype: fun [EdControl EdTreeItem I] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item
I: the new item type
Returns
0

◆ setEdCtrlTreeValue()

setEdCtrlTreeValue ( ctrlstr  ,
item  ,
value   
)

Change an item value.

Prototype: fun [EdControl EdTreeItem S] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item
S: the new item value
Returns
0

◆ setEdCtrlTreeLabel()

setEdCtrlTreeLabel ( ctrlstr  ,
item  ,
val   
)

Change an item label.

Prototype: fun [EdControl EdTreeItem S] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item
S: the new item label
Returns
0

◆ moveEdCtrlTreeItem()

moveEdCtrlTreeItem ( ctrlstr  ,
item  ,
father   
)

Move a tree item to a new father.

Prototype: fun [EdControl EdTreeItem EdTreeItem] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item to move
EdTreeItem: new father
Returns
0

◆ changeEdCtrlTreeItemPos()

changeEdCtrlTreeItemPos ( ctrlstr  ,
item  ,
itempos   
)

Move a tree item to a new position from a node.

Prototype: fun [EdControl EdTreeItem EdTreeItem] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item to move
EdTreeItem: node position
Returns
0

◆ setEdCtrlTreeItemBitmap()

setEdCtrlTreeItemBitmap ( ctrlstr  ,
itemstr  ,
bitmappath   
)

Set a tree item bitmap.

Prototype: fun [EdControl EdTreeItem S] EdTreeItem

Parameters
EdControl: tree control structure
EdTreeItem: item
S: item bitmap path
Returns
0

◆ sizeEdCtrlTree()

sizeEdCtrlTree ( ctrlstr  ,
,
,
,
 
)

Resize a tree control.

Prototype: fun [EdControl I I I I] ObjTree

Parameters
EdControl: tree control structure
I: X position
I: Y position
I: width
I: height
Returns
ObjTree

◆ getEdCtrlTreeItemByValue()

getEdCtrlTreeItemByValue ( ctrlstr  ,
val   
)

Get a tree item by it's value.

Prototype: fun [EdControl S] EdTreeItem

Parameters
EdControl: tree control structure
S: the item value
Returns
EdTreeItem : nil

◆ getEdCtrlTreeLabelByItem()

getEdCtrlTreeLabelByItem ( ctrlstr  ,
item   
)

Get a tree item label.

Prototype: fun [EdControl EdTreeItem] S

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
S : item label

◆ getEdCtrlTreeValueByItem()

getEdCtrlTreeValueByItem ( ctrlstr  ,
item   
)

Get a tree item value and type.

Prototype: fun [EdControl EdTreeItem] [S I]

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
[S I] : item value, item type

◆ getEdCtrlTreeFullValuesByItem()

getEdCtrlTreeFullValuesByItem ( ctrlstr  ,
item   
)

Get a tree item father, value and type.

Prototype: fun [EdControl EdTreeItem] [EdTreeItem S I]

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
[EdTreeItem S I] : item father, item value, item type

◆ getEdCtrlTreeFullValuesByValue()

getEdCtrlTreeFullValuesByValue ( ctrlstr  ,
val   
)

Get a tree item father, value and type, by an item value.

Prototype: fun [EdControl S] [EdTreeItem S I]

Parameters
EdControl: tree control structure
S: value to search
Returns
[EdTreeItem S I] : item father, item value, item type, or nil if not found

◆ getEdCtrlTreeBrothers()

getEdCtrlTreeBrothers ( ctrlstr  ,
item   
)

Get the brothers of a tree item.

Prototype: fun [EdControl EdTreeItem] [EdTreeItem r1]

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
[EdTreeItem r1] : list of item brothers

◆ selEdCtrlTreeItemByValue()

selEdCtrlTreeItemByValue ( ctrlstr  ,
val   
)

Select a tree item by it's value.

Prototype: fun [EdControl S] I

Parameters
EdControl: tree control structure
S: item value
Returns
0

◆ selEdCtrlTreeItem()

selEdCtrlTreeItem ( ctrlstr  ,
item   
)

Select a tree item.

Prototype: fun [EdControl EdTreeItem] I

Parameters
EdControl: tree control structure
EdTreeItem: tree item
Returns
0

◆ setEdCtrlTreeEnable()

setEdCtrlTreeEnable ( ctrlstr  ,
state   
)

Enable or disable a tree control.

Prototype: fun [EdControl I] I

Parameters
EdControl: tree control structure
I: state, 0 to disable, 1 to enable
Returns
0

◆ setEdCtrlTreeFilter()

setEdCtrlTreeFilter ( ctrlstr  ,
filter   
)

Filter tree items.

Prototype: fun [EdControl S] I

Parameters
EdControl: tree control structure
S: keyword or nil
Returns
0

◆ resetEdCtrlTree()

resetEdCtrlTree ( ctrlstr  )

Reset a tree control.

Prototype: fun [EdControl] I

Parameters
EdControl: tree control structure
Returns
0

◆ crEdCtrlTree()

crEdCtrlTree ( winstr  ,
,
,
,
,
resize   
)

Create a tree control.

Prototype: fun [EdWindow I I I I I] EdControl

Parameters
EdWindow: parent control window
I: X position
I: Y position
I: width
I: height
I: resize flags
Returns
EdControl

◆ dsEdCtrlTree()

dsEdCtrlTree ( ctrlstr  )

Destroy a tree control.

Prototype: fun [EdControl] I

Parameters
EdControl: tree control structure
Returns
0