Collaboration diagram for D4D SLIDER API Macro's Specification:

Macros
#define	_D4D_DECLARE_SLIDER(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the Slider object structure in memory including all substructures. More...

#define	D4D_DECLARE_SLIDER(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the Slider object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_SLIDER(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch)
	Macro that create the Slider 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_SLIDER_AUTOSIZE(name, text, x, y, cx, cy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the Slider object structure in memory including all substructures with restricted count of parameters to simplify definition The internal coordination values are computed automatically to standard. More...

#define	D4D_DECLARE_STD_SLIDER_AUTOSIZE(name, text, x, y, cx, cy, pBmp, fontId, onvalch)
	Macro that create the Slider object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. The internal coordination values are computed automatically to standard. More...

#define	D4D_DECLARE_RSLIDER(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the rounded Slider object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_RSLIDER(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch)
	Macro that create the rounded Slider 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_RSLIDER_AUTOSIZE(name, text, x, y, cx, cy, radius, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Macro that create the rounded Slider object structure in memory including all substructures with restricted count of parameters to simplify definition The internal coordination values are computed automatically to standard. More...

#define	D4D_DECLARE_STD_RSLIDER_AUTOSIZE(name, text, x, y, cx, cy, radius, pBmp, fontId, onvalch)
	Macro that create the rounded Slider object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. The internal coordination values are computed automatically to standard. More...

#define	D4D_DECLARE_SLIDER_INRAM(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Same as D4D_DECLARE_SLIDER, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_SLIDER_INRAM(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch)
	Same as D4D_DECLARE_STD_SLIDER, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_SLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, flags, pBmp, pScheme, font, pUser, onvalch, pOnUsrMsg)
	Same as D4D_DECLARE_SLIDER_AUTOSIZE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_SLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, pBmp, font, onvalch)
	Same as D4D_DECLARE_STD_SLIDER, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RSLIDER_INRAM(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)
	Same as D4D_DECLARE_RSLIDER, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RSLIDER_INRAM(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch)
	Same as D4D_DECLARE_STD_RSLIDER, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RSLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, radius, flags, pBmp, pScheme, font, pUser, onvalch, pOnUsrMsg)
	Same as D4D_DECLARE_RSLIDER_AUTOSIZE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RSLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, radius, pBmp, font, onvalch)
	Same as D4D_DECLARE_STD_RSLIDER_AUTOSIZE, 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_SLIDER	(	type,
		name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider 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	- coordination of slider text in X axis
ty	- coordination of slider text in Y axis
bx	- coordination of slider working bar in X axis
by	- coordination of slider working bar in Y axis
bcx	- size of slider working bar in X axis
bcy	- size of slider working bar in Y axis
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D SLIDER Defines masks of slider specific behaviour flags
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
fontId	- Identification number of the used title text font
pUser	- user data of object
onvalch	- Pointer to an on-change user callback function D4D_SLDR_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_SLIDER structure, including the object data sub structure. Is used to define all properties of slider.

Definition at line 239 of file d4d_slider.h.

#define D4D_DECLARE_RSLIDER	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

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

Parameters

name	- name of slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
radius	- radius of corners
tx	- coordination of slider text in X axis
ty	- coordination of slider text in Y axis
bx	- coordination of slider working bar in X axis
by	- coordination of slider working bar in Y axis
bcx	- size of slider working bar in X axis
bcy	- size of slider working bar in Y axis
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D SLIDER Defines masks of slider specific behaviour flags
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
fontId	- Identification number of the used title text font
pUser	- user data of object
onvalch	- Pointer to an on-change user callback function D4D_SLDR_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_SLIDER structure, including the object data sub structure. Is used to define all properties of slider. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SLIDER instead of this one.

Definition at line 387 of file d4d_slider.h.

#define D4D_DECLARE_RSLIDER_AUTOSIZE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

Macro that create the rounded Slider object structure in memory including all substructures with restricted count of parameters to simplify definition The internal coordination values are computed automatically to standard.

Parameters

name	- name of slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
radius	- radius of corners
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D SLIDER Defines masks of slider specific behaviour flags
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
fontId	- Identification number of the used title text font
pUser	- user data of object
onvalch	- Pointer to an on-change user callback function D4D_SLDR_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_SLIDER structure, including the object data sub structure. Is used to define all properties of slider. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SLIDER instead of this one.

Definition at line 440 of file d4d_slider.h.

#define D4D_DECLARE_RSLIDER_AUTOSIZE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pBmp,
		pScheme,
		font,
		pUser,
		onvalch,
		pOnUsrMsg
	)

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

Definition at line 507 of file d4d_slider.h.

#define D4D_DECLARE_RSLIDER_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

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

Definition at line 495 of file d4d_slider.h.

#define D4D_DECLARE_SLIDER	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

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

Parameters

name	- name of slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
tx	- coordination of slider text in X axis
ty	- coordination of slider text in Y axis
bx	- coordination of slider working bar in X axis
by	- coordination of slider working bar in Y axis
bcx	- size of slider working bar in X axis
bcy	- size of slider working bar in Y axis
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D SLIDER Defines masks of slider specific behaviour flags
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
fontId	- Identification number of the used title text font
pUser	- user data of object
onvalch	- Pointer to an on-change user callback function D4D_SLDR_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_SLIDER structure, including the object data sub structure. Is used to define all properties of slider. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SLIDER instead of this one.

Definition at line 283 of file d4d_slider.h.

#define D4D_DECLARE_SLIDER_AUTOSIZE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

Macro that create the Slider object structure in memory including all substructures with restricted count of parameters to simplify definition The internal coordination values are computed automatically to standard.

Parameters

name	- name of slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D SLIDER Defines masks of slider specific behaviour flags
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
fontId	- Identification number of the used title text font
pUser	- user data of object
onvalch	- Pointer to an on-change user callback function D4D_SLDR_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_SLIDER structure, including the object data sub structure. Is used to define all properties of slider. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SLIDER instead of this one.

Definition at line 334 of file d4d_slider.h.

#define D4D_DECLARE_SLIDER_AUTOSIZE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pBmp,
		pScheme,
		font,
		pUser,
		onvalch,
		pOnUsrMsg
	)

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

Definition at line 482 of file d4d_slider.h.

#define D4D_DECLARE_SLIDER_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		flags,
		pBmp,
		pScheme,
		fontId,
		pUser,
		onvalch,
		pOnUsrMsg
	)

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

Definition at line 470 of file d4d_slider.h.

#define D4D_DECLARE_STD_RSLIDER	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		pBmp,
		fontId,
		onvalch
	)

Macro that create the rounded Slider 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 slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
radius	- radius of corners
tx	- coordination of slider text in X axis
ty	- coordination of slider text in Y axis
bx	- coordination of slider working bar in X axis
by	- coordination of slider working bar in Y axis
bcx	- size of slider working bar in X axis
bcy	- size of slider working bar in Y axis
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
fontId	- Identification number of the used title text font
onvalch	- Pointer to an on-change user callback function D4D_SLDR_ON_CHANGE

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

Definition at line 414 of file d4d_slider.h.

#define D4D_DECLARE_STD_RSLIDER_AUTOSIZE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pBmp,
		fontId,
		onvalch
	)

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

Parameters

name	- name of slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
radius	- radius of corners
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
fontId	- Identification number of the used title text font
onvalch	- Pointer to an on-change user callback function D4D_SLDR_ON_CHANGE

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

Definition at line 462 of file d4d_slider.h.

#define D4D_DECLARE_STD_RSLIDER_AUTOSIZE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pBmp,
		font,
		onvalch
	)

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

Definition at line 513 of file d4d_slider.h.

#define D4D_DECLARE_STD_RSLIDER_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		pBmp,
		fontId,
		onvalch
	)

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

Definition at line 501 of file d4d_slider.h.

#define D4D_DECLARE_STD_SLIDER	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		pBmp,
		fontId,
		onvalch
	)

Macro that create the Slider 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 slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
tx	- coordination of slider text in X axis
ty	- coordination of slider text in Y axis
bx	- coordination of slider working bar in X axis
by	- coordination of slider working bar in Y axis
bcx	- size of slider working bar in X axis
bcy	- size of slider working bar in Y axis
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
fontId	- Identification number of the used title text font
onvalch	- Pointer to an on-change user callback function D4D_SLDR_ON_CHANGE

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

Definition at line 309 of file d4d_slider.h.

#define D4D_DECLARE_STD_SLIDER_AUTOSIZE	(	name,
		text,
		x,
		y,
		cx,
		cy,
		pBmp,
		fontId,
		onvalch
	)

Macro that create the Slider object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. The internal coordination values are computed automatically to standard.

Parameters

name	- name of slider object
text	- title text of slider
x	- coordination of slider in X axis
y	- coordination of slider in Y axis
cx	- size of slider in X axis (width)
cy	- size of slider in Y axis (height)
pBmp	- pointer to a bitmap that is shown in background (Could be NULL)
fontId	- Identification number of the used title text font
onvalch	- Pointer to an on-change user callback function D4D_SLDR_ON_CHANGE

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

Definition at line 355 of file d4d_slider.h.

#define D4D_DECLARE_STD_SLIDER_AUTOSIZE_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		pBmp,
		font,
		onvalch
	)

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

Definition at line 488 of file d4d_slider.h.

#define D4D_DECLARE_STD_SLIDER_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		tx,
		ty,
		bx,
		by,
		bcx,
		bcy,
		pBmp,
		fontId,
		onvalch
	)

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

Definition at line 476 of file d4d_slider.h.

Macros

Detailed Description

Macro Definition Documentation