Collaboration diagram for D4D GAUGE API Macro's Specification:

Macros
#define	_D4D_DECLARE_GAUGE(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the Gauge object structure in memory including all substructures. More...

#define	D4D_DECLARE_GAUGE(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_GAUGE(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, pBmp, fontId, onvalch)
	Macro that create the Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...

#define	D4D_DECLARE_RGAUGE(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the rounded Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_RGAUGE(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, pBmp, fontId, onvalch)
	Macro that create the rounded Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...

#define	D4D_DECLARE_GAUGE_INRAM(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Same as D4D_DECLARE_GAUGE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_GAUGE_INRAM(name, text, x, y, cx, cy, tx, ty, kx, ky, plen, pBmp, fontId, onvalch)
	Same as D4D_DECLARE_STD_GAUGE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RGAUGE_INRAM(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Same as D4D_DECLARE_RGAUGE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RGAUGE_INRAM(name, text, x, y, cx, cy, radius, tx, ty, kx, ky, plen, pBmp, fontId, onvalch)
	Same as D4D_DECLARE_STD_RGAUGE, but is created in RAM instead of the ROM memory. More...

Detailed Description

This section specifies the exact usage for each API macro.

Macro Definition Documentation

#define _D4D_DECLARE_GAUGE	(	type,
		name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		tx,
		ty,
		kx,
		ky,
		plen,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

Macro that create the Gauge object structure in memory including all substructures.

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of gauge object
text	- title text of gauge
x	- coordination of gauge in X axis
y	- coordination of gauge in Y axis
cx	- size of gauge in X axis (width)
cy	- size of gauge in Y axis (height)
radius	- radius of corners
pMargin	- pointer to margin structure (*D4D_MARGIN)(Could be NULL)
pRelations	- pointer to object relation array (Could be NULL)
tx	- offset of gauge text from top left corner in axis X
ty	- offset of gauge text from top left corner in axis Y
kx	- offset of gauge hub from top left corner in axis X
ky	- offset of gauge hub from top left corner in axis Y
plen	- lenght of pointer
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pBmp	- pointer to a bitmap that is shown in background of gauge (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw button
fontId	- Identification number of the used title text font
pUser	- user data of button
onvalch	- Pointer to an on-change user callback function D4D_GAUGE_ON_CHANGE
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_GAUGE structure, including the object data sub structure. Is used to define all properties of gauge.

Definition at line 219 of file d4d_gauge.h.

#define D4D_DECLARE_GAUGE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		kx,
		ky,
		plen,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

Macro that create the Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition.

Parameters

name	- name of gauge object
text	- title text of gauge
x	- coordination of gauge in X axis
y	- coordination of gauge in Y axis
cx	- size of gauge in X axis (width)
cy	- size of gauge in Y axis (height)
tx	- offset of gauge text from top left corner in axis X
ty	- offset of gauge text from top left corner in axis Y
kx	- offset of gauge hub from top left corner in axis X
ky	- offset of gauge hub from top left corner in axis Y
plen	- lenght of pointer
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D BUTTON Defines masks of button specific behaviour flags
pBmp	- pointer to a bitmap that is shown in background of gauge (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw button
fontId	- Identification number of the used title text font
pUser	- user data of button
onvalch	- Pointer to an on-change user callback function D4D_GAUGE_ON_CHANGE
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_GAUGE structure, including the object data sub structure. Is used to define all properties of gauge. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_BUTTON instead of this one.

Definition at line 262 of file d4d_gauge.h.

#define D4D_DECLARE_GAUGE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		kx,
		ky,
		plen,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

Same as D4D_DECLARE_GAUGE, but is created in RAM instead of the ROM memory.

Definition at line 352 of file d4d_gauge.h.

#define D4D_DECLARE_RGAUGE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		kx,
		ky,
		plen,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

Macro that create the rounded Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition.

Parameters

name	- name of gauge object
text	- title text of gauge
x	- coordination of gauge in X axis
y	- coordination of gauge in Y axis
cx	- size of gauge in X axis (width)
cy	- size of gauge in Y axis (height)
radius	- radius of corners
tx	- offset of gauge text from top left corner in axis X
ty	- offset of gauge text from top left corner in axis Y
kx	- offset of gauge hub from top left corner in axis X
ky	- offset of gauge hub from top left corner in axis Y
plen	- lenght of pointer
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D BUTTON Defines masks of button specific behaviour flags
pBmp	- pointer to a bitmap that is shown in background of gauge (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw button
fontId	- Identification number of the used title text font
pUser	- user data of button
onvalch	- Pointer to an on-change user callback function D4D_GAUGE_ON_CHANGE
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_GAUGE structure, including the object data sub structure. Is used to define all properties of gauge. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_BUTTON instead of this one.

Definition at line 318 of file d4d_gauge.h.

#define D4D_DECLARE_RGAUGE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		kx,
		ky,
		plen,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

Same as D4D_DECLARE_RGAUGE, but is created in RAM instead of the ROM memory.

Definition at line 365 of file d4d_gauge.h.

#define D4D_DECLARE_STD_GAUGE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		kx,
		ky,
		plen,
		pBmp,
		fontId,
		onvalch
	)

Macro that create the Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values.

Parameters

name	- name of gauge object
text	- title text of gauge
x	- coordination of gauge in X axis
y	- coordination of gauge in Y axis
cx	- size of gauge in X axis (width)
cy	- size of gauge in Y axis (height)
tx	- offset of gauge text from top left corner in axis X
ty	- offset of gauge text from top left corner in axis Y
kx	- offset of gauge hub from top left corner in axis X
ky	- offset of gauge hub from top left corner in axis Y
plen	- lenght of pointer
pBmp	- pointer to a bitmap that is shown in background of gauge (Could be NULL)
fontId	- Identification number of the used title text font
onvalch	- Pointer to an on-change user callback function D4D_GAUGE_ON_CHANGE

Note: This macro create complete D4D_GAUGE structure, including the object data sub structure. Is used to define all properties of gauge. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_BUTTON instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 287 of file d4d_gauge.h.

#define D4D_DECLARE_STD_GAUGE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		kx,
		ky,
		plen,
		pBmp,
		fontId,
		onvalch
	)

Same as D4D_DECLARE_STD_GAUGE, but is created in RAM instead of the ROM memory.

Definition at line 358 of file d4d_gauge.h.

#define D4D_DECLARE_STD_RGAUGE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		kx,
		ky,
		plen,
		pBmp,
		fontId,
		onvalch
	)

Macro that create the rounded Gauge object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values.

Parameters

name	- name of gauge object
text	- title text of gauge
x	- coordination of gauge in X axis
y	- coordination of gauge in Y axis
cx	- size of gauge in X axis (width)
cy	- size of gauge in Y axis (height)
radius	- radius of corners
tx	- offset of gauge text from top left corner in axis X
ty	- offset of gauge text from top left corner in axis Y
kx	- offset of gauge hub from top left corner in axis X
ky	- offset of gauge hub from top left corner in axis Y
plen	- lenght of pointer
pBmp	- pointer to a bitmap that is shown in background of gauge (Could be NULL)
fontId	- Identification number of the used title text font
onvalch	- Pointer to an on-change user callback function D4D_GAUGE_ON_CHANGE

Note: This macro create complete D4D_GAUGE structure, including the object data sub structure. Is used to define all properties of gauge. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_BUTTON instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 344 of file d4d_gauge.h.

#define D4D_DECLARE_STD_RGAUGE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		kx,
		ky,
		plen,
		pBmp,
		fontId,
		onvalch
	)

Same as D4D_DECLARE_STD_RGAUGE, but is created in RAM instead of the ROM memory.

Definition at line 371 of file d4d_gauge.h.

Macros

Detailed Description

Macro Definition Documentation