Scol functions definition

Typedefs
typedef int	BlocObj
	Scol Bloc Object It allows simple operations like getting and setting its attributes.
Functions
int	_GETblocValue (mmachine m)
	_GETblocValue : Get the value of the Bloc object
int	_SETblocValue (mmachine m)
	_SETblocValue : Set the value of the bloc
int	_GETblocName (mmachine m)
	_GETblocName : Get the name of the bloc
int	_SETblocName (mmachine m)
	_SETblocName : Set the name of the bloc
int	_CRbloc (mmachine m)
	_CRbloc : Open, initialize Bloc object
int	_DSbloc (mmachine m)
	_DSbloc : Destroy bloc object
int	_CBblocChangeValue (mmachine m)
	_CBblocChangeValue : This function sets the callback to be executed when Bloc value change event happens

---

Detailed Description

User Scol functions definition

---

Typedef Documentation

typedef int BlocObj

Scol Bloc Object It allows simple operations like getting and setting its attributes.

BlocObj is set here as a type (an int) for doxygen documentation

Definition at line 65 of file template.cpp.

---

Function Documentation

int _CBblocChangeValue

(

mmachine

m

)

_CBblocChangeValue : This function sets the callback to be executed when Bloc value change event happens

Prototype: fun [BlocObj fun [ObjBloc u0 I S] u1 u0] BlocObj

Parameters:

	BlocObj	: Bloc Object whose value has changed
	fun	[ObjBloc u0 I S] u1 : The callback to call when the event occurs. I : int value of the object S : name value of the object
	u0	: User parameter

Returns:

BlocObj : The Bloc object whose value has changed

Definition at line 354 of file template.cpp.

int _CRbloc

(

mmachine

m

)

_CRbloc : Open, initialize Bloc object

Prototype: fun [Chn] BlocObj

Parameters:

Chn

: current channel

Returns:

BlocObj : Bloc object if success, NIL otherwise

Definition at line 255 of file template.cpp.

int _DSbloc

(

mmachine

m

)

_DSbloc : Destroy bloc object

Prototype: fun [BlocObj] I

Parameters:

BlocObj

: Bloc Object to destroy

Returns:

I : 0 if success, NIL otherwise

Definition at line 322 of file template.cpp.

int _GETblocName

(

mmachine

m

)

_GETblocName : Get the name of the bloc

Prototype: fun [BlocObj] S

Parameters:

BlocObj

: bloc object

Returns:

S : The name of the bloc if success, NIL otherwise

Definition at line 150 of file template.cpp.

int _GETblocValue

(

mmachine

m

)

_GETblocValue : Get the value of the Bloc object

Prototype: fun [BlocObj] I

Parameters:

BlocObj

: bloc object

Returns:

I : return bloc value, nil otherwise

Definition at line 77 of file template.cpp.

int _SETblocName

(

mmachine

m

)

_SETblocName : Set the name of the bloc

Prototype: fun [BlocObj S] I

Parameters:

	BlocObj	: bloc object
	S	: New name

Returns:

I : 0 if success, -1 otherwise

Definition at line 187 of file template.cpp.

int _SETblocValue

(

mmachine

m

)

_SETblocValue : Set the value of the bloc

Prototype: fun [BlocObj I] I

Parameters:

	BlocObj	: bloc object
	I	: New value

Returns:

I : 0 if success, -1 otherwise

Definition at line 111 of file template.cpp.