D4D PROGRESS BAR API Macro's Specification

Collaboration diagram for D4D PROGRESS BAR API Macro's Specification:

Macros
#define	_D4D_DECLARE_PROGRESS_BAR(type, name, x, y, cx, cy, radius, pMargin, pRelations, flags, pScheme, pUser, pOnUsrMsg)
	Macro that create the Progress bar object structure in memory including all substructures. More...
#define	D4D_DECLARE_PROGRESS_BAR(name, x, y, cx, cy, radius, flags, pScheme, pUser, pOnUsrMsg)
	Macro that create the Progress bar object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
#define	D4D_DECLARE_STD_PROGRESS_BAR(name, x, y, cx, cy, radius)
	Macro that create the Progress bar 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_PROGRESS_BAR_INRAM(name, x, y, cx, cy, radius, flags, pScheme, pUser, pOnUsrMsg)
	Same as D4D_DECLARE_PROGRESS_BAR, but is created in RAM instead of the ROM memory. More...
#define	D4D_DECLARE_STD_PROGRESS_BAR_INRAM(name, x, y, cx, cy, radius)
	Same as D4D_DECLARE_STD_PROGRESS_BAR, 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_PROGRESS_BAR	(		type,
			name,
			x,
			y,
			cx,
			cy,
			radius,
			pMargin,
			pRelations,
			flags,
			pScheme,
			pUser,
			pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of progress bar object
x	- coordination of progress bar in X axis
y	- coordination of progress bar in Y axis
cx	- size of progress bar in X axis (width)
cy	- size of progress bar 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)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
pUser	- user data of object
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_PROGRESS_BAR structure, including the object data sub structure. Is used to define all properties of progress bar.

Definition at line 181 of file d4d_progress_bar.h.

#define D4D_DECLARE_PROGRESS_BAR	(		name,
			x,
			y,
			cx,
			cy,
			radius,
			flags,
			pScheme,
			pUser,
			pOnUsrMsg
	)

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

Parameters

name	- name of progress bar object
x	- coordination of progress bar in X axis
y	- coordination of progress bar in Y axis
cx	- size of progress bar in X axis (width)
cy	- size of progress bar in Y axis (height) (with hidden list box)
radius	- radius of corners
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
pUser	- user data of object
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_PROGRESS_BAR structure, including the object data sub structure. Is used to define all properties of progress bar. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_PROGRESS_BAR instead of this one.

Definition at line 209 of file d4d_progress_bar.h.

#define D4D_DECLARE_PROGRESS_BAR_INRAM	(		name,
			x,
			y,
			cx,
			cy,
			radius,
			flags,
			pScheme,
			pUser,
			pOnUsrMsg
	)

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

Definition at line 234 of file d4d_progress_bar.h.

#define D4D_DECLARE_STD_PROGRESS_BAR	(		name,
			x,
			y,
			cx,
			cy,
			radius
	)

Macro that create the Progress bar 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 progress bar object
x	- coordination of progress bar in X axis
y	- coordination of progress bar in Y axis
cx	- size of progress bar in X axis (width)
cy	- size of progress bar in Y axis (height) (with hidden list box)
radius	- radius of corners

Note

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

Definition at line 226 of file d4d_progress_bar.h.

#define D4D_DECLARE_STD_PROGRESS_BAR_INRAM	(		name,
			x,
			y,
			cx,
			cy,
			radius
	)

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

Definition at line 240 of file d4d_progress_bar.h.