sources/template.cpp File Reference

#include <scol.h>
#include "Bloc.h"

Go to the source code of this file.

Defines
#define	NbTplPKG   8
	Nb of Scol functions or types.
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	destroyBlocObj (mmachine m, int handsys, int blocTab)
	Scol object destroy callback.
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
int	getBlocNewData (mmachine m, HWND h, unsigned msg, UINT id, LONG param, int *ret)
	sample function for calling scol reflex defined for BLOC_NEW_DATA_CB
int	LoadBloc (mmachine m)
	Load the Bloc.
Variables
HWND	HScol = NULL
cbmachine	ww
	Scol machine declaration for MM macros.
int	OBJBLOCSCOL
	Bloc Object in Scol.
int	SCOL_BLOC_NEW_DATA_CB = 0
	New data event callback number.
int	BLOC_NEW_DATA_CB
	New data event number.
char *	TplName [NbTplPKG]
int(*	TplFunc [NbTplPKG])(mmachine m)
int	TplNArg [NbTplPKG]
char *	TplType [NbTplPKG]

---

Define Documentation

#define NbTplPKG   8

Nb of Scol functions or types.

Definition at line 396 of file template.cpp.

---

Function Documentation

int destroyBlocObj	(	mmachine	m,
		int	handsys,
		int	blocTab
	)

Scol object destroy callback.

Parameters:

	mmachine	: scol machine structure
	int	: scol object system handle
	int	: scol object stack handle

Returns:

int : 0

Definition at line 225 of file template.cpp.

int getBlocNewData	(	mmachine	m,
		HWND	h,
		unsigned	msg,
		UINT	id,
		LONG	param,
		int *	ret
	)

sample function for calling scol reflex defined for BLOC_NEW_DATA_CB

Parameters:

	mmachine	: scol machine structure
	HWND	: target window handle
	unsigned	msg : window message
	UINT	: callback param
	LONG	: callback param
	int	: return value

Definition at line 371 of file template.cpp.

int LoadBloc

(

mmachine

m

)

Load the Bloc.

Parameters:

mmachine

: scol machine structure

Returns:

int : 0 if succes, error code otherwise

Definition at line 470 of file template.cpp.

---

Variable Documentation

int BLOC_NEW_DATA_CB

New data event number.

Definition at line 51 of file template.cpp.

HWND HScol = NULL

Definition at line 39 of file template.cpp.

int OBJBLOCSCOL

Bloc Object in Scol.

Definition at line 45 of file template.cpp.

int SCOL_BLOC_NEW_DATA_CB = 0

New data event callback number.

Definition at line 48 of file template.cpp.

int(* TplFunc[NbTplPKG])(mmachine m)

Initial value:

{
  NULL, 
  _CRbloc,
        _DSbloc,
        _GETblocValue,
        _GETblocName,
        _SETblocName,
        _SETblocValue,
        _CBblocChangeValue
}

Pointers to C functions that manipulate the VM for each scol function previously defined

Definition at line 418 of file template.cpp.

char* TplName[NbTplPKG]

Initial value:

{       
        "ObjBloc",
        "_CRbloc",
        "_DSbloc",
        "_GETblocValue",
        "_GETblocName",
        "_SETblocName",
        "_SETblocValue",
        "_CBblocChangeValue"
}

Scol function names

Definition at line 402 of file template.cpp.

int TplNArg[NbTplPKG]

Initial value:

{
  TYPTYPE,      
        1,
        1,
  1,
        1,
        2,
        2,
        3
}

Nb of arguments of each scol function

Definition at line 434 of file template.cpp.

char* TplType[NbTplPKG]

Initial value:

{
        NULL,
        "fun [Chn] ObjBloc",                                                               
        "fun [ObjBloc] I",                                                             
        "fun [ObjBloc] I",                                 
        "fun [ObjBloc] S",                                 
        "fun [ObjBloc S] I",                               
        "fun [ObjBloc I] I",                               
        "fun [ObjBloc fun [ObjBloc u0 I S] u1 u0] ObjBloc" 
}

Prototypes of the scol functions

Definition at line 450 of file template.cpp.

cbmachine ww

Scol machine declaration for MM macros.

Definition at line 42 of file template.cpp.