OpenSpace3D libs
OpenSpace 3D libraries for plugITs and OS3D developer
Functions
List control
OpenSpace3D high level 2D library

Functions

 getEdCtrlListNbElems (ctrlstr)
 Get the number of elements of a list control.
 
 getEdCtrlListElemByName (ctrlstr, name)
 Get an element of a list control by name.
 
 getEdCtrlListElemByPos (ctrlstr, pos)
 Get an element of a list control by position.
 
 fillEdCtrlList (ctrlstr, lparam)
 Fill a list control with a list of elements.
 
 addEdCtrlList (ctrlstr, name, lval, type)
 Add an element to a list control.
 
 getEdCtrlListElems (ctrlstr)
 Get the elements of a list control.
 
 getEdCtrlListElem (ctrlstr, elt)
 Get parameters and type from an element name of a list control.
 
 refreshEdCtrlList (ctrlstr)
 Refresh a list control.
 
 renameEdCtrlListElement (ctrlstr, oldname, newname)
 Rename a list control element.
 
 renameEdCtrlListElementByPos (ctrlstr, pos, newname)
 Rename a list control element.
 
 moveEdCtrlListElementUp (ctrlstr, name)
 Move a list control element up in the list.
 
 moveEdCtrlListElementDown (ctrlstr, name)
 Move a list control element down in the list.
 
 moveEdCtrlListElementUpByPos (ctrlstr, pos)
 Move a list control element up in the list.
 
 moveEdCtrlListElementDownByPos (ctrlstr, pos)
 Move a list control element down in the list.
 
 delEdCtrlList (ctrlstr, elt)
 Remove an element from a list control.
 
 resetEdCtrlList (ctrlstr)
 Reset a list control.
 
 selectEdCtrlList (ctrlstr, name)
 Select an element from a list control.
 
 selectEdCtrlListByPos (ctrlstr, pos)
 Select an element from a list control using it's position.
 
 selectEdCtrlListByParams (ctrlstr, params)
 Select an element from a list control using it's parameters.
 
 getSelectedEdCtrlList (ctrlstr)
 Get the current selected element from a list control.
 
 getSelectedEdCtrlList2 (ctrlstr)
 Get the current selected element from a list control.
 
 getSelectedEdCtrlListExt (ctrlstr)
 Get the current selected element from a list control.
 
 getMultiSelectedEdCtrlList (ctrlstr)
 Get the current selected elements from a list control.
 
 setEdCtrlListEnable (ctrlstr, state)
 Enable or disable a list control.
 
 setEdCtrlListCbDbClick (ctrlstr, cbfun)
 Set the callback on list control double click.
 
 setEdCtrlListCbClick (ctrlstr, cbfun)
 Set the callback on list control click.
 
 setEdCtrlListCbKeyDown (ctrlstr, cbfun)
 Set the callback on list control key down.
 
 setEdCtrlListCbKeyUp (ctrlstr, cbfun)
 Set the callback on list control key up.
 
 crEdCtrlList (winstr, x, y, w, h, flags, resize)
 Create a list control.
 
 dsEdCtrlList (ctrlstr)
 Destroy a list control.
 

Detailed Description

List control

Function Documentation

◆ getEdCtrlListNbElems()

getEdCtrlListNbElems ( ctrlstr  )

Get the number of elements of a list control.

Prototype: fun [EdControl] I

Parameters
EdControl: list control structure
Returns
I : the number of elements

◆ getEdCtrlListElemByName()

getEdCtrlListElemByName ( ctrlstr  ,
name   
)

Get an element of a list control by name.

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

Parameters
EdControl: list control structure
S: name of the element
Returns
[I [S [[S r1] I]]] : the tuple of the list element

◆ getEdCtrlListElemByPos()

getEdCtrlListElemByPos ( ctrlstr  ,
pos   
)

Get an element of a list control by position.

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

Parameters
EdControl: list control structure
I: position of the element
Returns
[I [S [[S r1] I]]] : the tuple of the list element

◆ fillEdCtrlList()

fillEdCtrlList ( ctrlstr  ,
lparam   
)

Fill a list control with a list of elements.

Prototype: fun [EdControl [S r1]] I

Parameters
EdControl: list control structure
[Sr1] : list of elements
Returns
I : 0

◆ addEdCtrlList()

addEdCtrlList ( ctrlstr  ,
name  ,
lval  ,
type   
)

Add an element to a list control.

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

Parameters
EdControl: list control structure
S: the element to add
[Sr1] : list of parameters associated to the element
I: a user flag to set a type on the element
Returns
I : 0

◆ getEdCtrlListElems()

getEdCtrlListElems ( ctrlstr  )

Get the elements of a list control.

Prototype: fun [EdControl] [S r1]

Parameters
EdControl: list control structure
Returns
[S r1] : list of elements

◆ getEdCtrlListElem()

getEdCtrlListElem ( ctrlstr  ,
elt   
)

Get parameters and type from an element name of a list control.

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

Parameters
EdControl: list control structure
S: element name
Returns
[[S r1] I] : tuple with parameters list and the element type

◆ refreshEdCtrlList()

refreshEdCtrlList ( ctrlstr  )

Refresh a list control.

Prototype: fun [EdControl] I

Parameters
EdControl: list control structure
Returns
I : 0

◆ renameEdCtrlListElement()

renameEdCtrlListElement ( ctrlstr  ,
oldname  ,
newname   
)

Rename a list control element.

Prototype: fun [EdControl S S] I

Parameters
EdControl: list control structure
S: the name of the element
S: the new name of the element
Returns
I : 0

◆ renameEdCtrlListElementByPos()

renameEdCtrlListElementByPos ( ctrlstr  ,
pos  ,
newname   
)

Rename a list control element.

Prototype: fun [EdControl I S] I

Parameters
EdControl: list control structure
I: the position of the element
S: the new name of the element
Returns
I : 0

◆ moveEdCtrlListElementUp()

moveEdCtrlListElementUp ( ctrlstr  ,
name   
)

Move a list control element up in the list.

Prototype: fun [EdControl S] I

Parameters
EdControl: list control structure
S: the name of the element to move
Returns
I : 0

◆ moveEdCtrlListElementDown()

moveEdCtrlListElementDown ( ctrlstr  ,
name   
)

Move a list control element down in the list.

Prototype: fun [EdControl S] I

Parameters
EdControl: list control structure
S: the name of the element to move
Returns
I : 0

◆ moveEdCtrlListElementUpByPos()

moveEdCtrlListElementUpByPos ( ctrlstr  ,
pos   
)

Move a list control element up in the list.

Prototype: fun [EdControl I] I

Parameters
EdControl: list control structure
I: the position of the element to move
Returns
I : 0

◆ moveEdCtrlListElementDownByPos()

moveEdCtrlListElementDownByPos ( ctrlstr  ,
pos   
)

Move a list control element down in the list.

Prototype: fun [EdControl I] I

Parameters
EdControl: list control structure
I: the position of the element to move
Returns
I : 0

◆ delEdCtrlList()

delEdCtrlList ( ctrlstr  ,
elt   
)

Remove an element from a list control.

Prototype: fun [EdControl S] I

Parameters
EdControl: list control structure
S: element name
Returns
I : 0

◆ resetEdCtrlList()

resetEdCtrlList ( ctrlstr  )

Reset a list control.

Prototype: fun [EdControl] I

Parameters
EdControl: list control structure
Returns
I : 0

◆ selectEdCtrlList()

selectEdCtrlList ( ctrlstr  ,
name   
)

Select an element from a list control.

Prototype: fun [EdControl S] I

Parameters
EdControl: list control structure
S: element name
Returns
I : 0

◆ selectEdCtrlListByPos()

selectEdCtrlListByPos ( ctrlstr  ,
pos   
)

Select an element from a list control using it's position.

Prototype: fun [EdControl I] I

Parameters
EdControl: list control structure
I: element position
Returns
I : 0

◆ selectEdCtrlListByParams()

selectEdCtrlListByParams ( ctrlstr  ,
params   
)

Select an element from a list control using it's parameters.

Prototype: fun [EdControl [S r1]] I

Parameters
EdControl: list control structure
[Sr1] : element parameters
Returns
I : 0

◆ getSelectedEdCtrlList()

getSelectedEdCtrlList ( ctrlstr  )

Get the current selected element from a list control.

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

Parameters
EdControl: list control structure
Returns
[S [S r1] I] : the selected element tuple, name, parameters and type

◆ getSelectedEdCtrlList2()

getSelectedEdCtrlList2 ( ctrlstr  )

Get the current selected element from a list control.

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

Parameters
EdControl: list control structure
Returns
[I S [S r1] I] : the selected element tuple, pos, name, parameters and type

◆ getSelectedEdCtrlListExt()

getSelectedEdCtrlListExt ( ctrlstr  )

Get the current selected element from a list control.

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

Parameters
EdControl: list control structure
Returns
[I S [S r1] I] : the selected element tuple, pos, name, parameters and type

◆ getMultiSelectedEdCtrlList()

getMultiSelectedEdCtrlList ( ctrlstr  )

Get the current selected elements from a list control.

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

Parameters
EdControl: list control structure
Returns
[[S [S r1] I] r1] : the selected elements list, name, parameters and type

◆ setEdCtrlListEnable()

setEdCtrlListEnable ( ctrlstr  ,
state   
)

Enable or disable a list control.

Prototype: fun [EdControl I] I

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

◆ setEdCtrlListCbDbClick()

setEdCtrlListCbDbClick ( ctrlstr  ,
cbfun   
)

Set the callback on list control double click.

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

Parameters
EdControl: list box control structure
fun[EdControl I S [S r1] I] I : callback
  • EdControl : list control structure
  • I : element position
  • S : element name
  • [S r1] : element parameters
  • I : element type
Returns
I : 0

◆ setEdCtrlListCbClick()

setEdCtrlListCbClick ( ctrlstr  ,
cbfun   
)

Set the callback on list control click.

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

Parameters
EdControl: list box control structure
fun[EdControl I S [S r1] I] I : callback
  • EdControl : list control structure
  • I : element position
  • S : element name
  • [S r1] : element parameters
  • I : element type
Returns
I : 0

◆ setEdCtrlListCbKeyDown()

setEdCtrlListCbKeyDown ( ctrlstr  ,
cbfun   
)

Set the callback on list control key down.

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

Parameters
EdControl: list box control structure
fun[EdControl I S [S r1] I I I] I : callback
  • EdControl : list control structure
  • I : element position
  • S : element name
  • [S r1] : element parameters
  • I : element type
  • I : key code
  • I : ascii code
Returns
I : 0

◆ setEdCtrlListCbKeyUp()

setEdCtrlListCbKeyUp ( ctrlstr  ,
cbfun   
)

Set the callback on list control key up.

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

Parameters
EdControl: list box control structure
fun[EdControl I S [S r1] I I] I : callback
  • EdControl : list control structure
  • I : element position
  • S : element name
  • [S r1] : element parameters
  • I : element type
  • I : key code
Returns
I : 0

◆ crEdCtrlList()

crEdCtrlList ( winstr  ,
x  ,
y  ,
w  ,
h  ,
flags  ,
resize   
)

Create a list control.

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

Parameters
EdWindow: mother window structure
I: X position
I: Y position
I: width
I: height
I: ObjList flags
I: resize flags
Returns
EdControl : new list control

◆ dsEdCtrlList()

dsEdCtrlList ( ctrlstr  )

Destroy a list control.

Prototype: fun [EdControl] I

Parameters
EdControl: list control structure
Returns
I : 0
Generated by doxygen 1.9.8