Collaboration diagram for D4D BUTTON API Macro's Specification:

Macros
#define	_D4D_DECLARE_BUTTON(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)
	Macro that create the Button object structure in memory including all substructures. More...

#define	D4D_DECLARE_BUTTON(name, text, x, y, cx, cy, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)
	Macro that create the Button object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_BUTTON(name, text, x, y, cx, cy, pBmpN, pBmpF, fontId, onclick)
	Macro that create the Button 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_TXT_BUTTON(name, text, x, y, cx, cy, fontId, onclick)
	Macro that create the only text Button 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_RBUTTON(name, text, x, y, cx, cy, radius, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)
	Macro that create the round Button object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_RBUTTON(name, text, x, y, cx, cy, radius, pBmpN, pBmpF, fontId, onclick)
	Macro that create the round Button 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_TXT_RBUTTON(name, text, x, y, cx, cy, radius, fontId, onclick)
	Macro that create the only text round Button 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_BUTTON_INRAM(name, text, x, y, cx, cy, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)
	Same as D4D_DECLARE_BUTTON, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_BUTTON_INRAM(name, text, x, y, cx, cy, bmpN, bmpF, fontId, onclick)
	Same as D4D_DECLARE_STD_BUTTON, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_TXT_BUTTON_INRAM(name, text, x, y, cx, cy, fontId, onclick)
	Same as D4D_DECLARE_TXT_BUTTON, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RBUTTON_INRAM(name, text, x, y, cx, cy, radius, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)
	Same as D4D_DECLARE_RBUTTON, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RBUTTON_INRAM(name, text, x, y, cx, cy, radius, bmpN, bmpF, fontId, onclick)
	Same as D4D_DECLARE_STD_RBUTTON, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_TXT_RBUTTON_INRAM(name, text, x, y, cx, cy, radius, fontId, onclick)
	Same as D4D_DECLARE_TXT_RBUTTON, 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_BUTTON	(	type,
		name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		flags,
		pBmpN,
		pBmpF,
		pScheme,
		fontId,
		pUser,
		onclick,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of button object
text	- title text of button
x	- coordination of button in X axis
y	- coordination of button in Y axis
cx	- size of button in X axis (width)
cy	- size of button 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 and D4D BUTTON Defines masks of button specific behaviour flags
pBmpN	- pointer to a bitmap that is shown in a normal state of the button (Could be NULL)
pBmpF	- pointer to a bitmap that is shown in a focus state of the button (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
onclick	- Pointer to an on-click user callback function D4D_BTN_ON_CLICK
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_BUTTON structure, including the object data sub structure. Is used to define all properties of Button.

Definition at line 198 of file d4d_button.h.

#define D4D_DECLARE_BUTTON	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pBmpN,
		pBmpF,
		pScheme,
		fontId,
		pUser,
		onclick,
		pOnUsrMsg
	)

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

Parameters

name	- name of button object
text	- title text of button
x	- coordination of button in X axis
y	- coordination of button in Y axis
cx	- size of button in X axis (width)
cy	- size of button in Y axis (height)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D BUTTON Defines masks of button specific behaviour flags
pBmpN	- pointer to a bitmap that is shown in a normal state of the button (Could be NULL)
pBmpF	- pointer to a bitmap that is shown in a focus state of the button (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
onclick	- Pointer to an on-click user callback function D4D_BTN_ON_CLICK
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_BUTTON structure, including the object data sub structure. Is used to define all properties of Button. 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 234 of file d4d_button.h.

#define D4D_DECLARE_BUTTON_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pBmpN,
		pBmpF,
		pScheme,
		fontId,
		pUser,
		onclick,
		pOnUsrMsg
	)

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

Definition at line 353 of file d4d_button.h.

#define D4D_DECLARE_RBUTTON	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pBmpN,
		pBmpF,
		pScheme,
		fontId,
		pUser,
		onclick,
		pOnUsrMsg
	)

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

Parameters

name	- name of button object
text	- title text of button
x	- coordination of button in X axis
y	- coordination of button in Y axis
cx	- size of button in X axis (width)
cy	- size of button in Y axis (height)
radius	- radius of corners
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D BUTTON Defines masks of button specific behaviour flags
pBmpN	- pointer to a bitmap that is shown in a normal state of the button (Could be NULL)
pBmpF	- pointer to a bitmap that is shown in a focus state of the button (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
onclick	- Pointer to an on-click user callback function D4D_BTN_ON_CLICK
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_BUTTON structure, including the object data sub structure. Is used to define all properties of Button. 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 303 of file d4d_button.h.

#define D4D_DECLARE_RBUTTON_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pBmpN,
		pBmpF,
		pScheme,
		fontId,
		pUser,
		onclick,
		pOnUsrMsg
	)

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

Definition at line 373 of file d4d_button.h.

#define D4D_DECLARE_STD_BUTTON	(	name,
		text,
		x,
		y,
		cx,
		cy,
		pBmpN,
		pBmpF,
		fontId,
		onclick
	)

Macro that create the Button 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 button object
text	- title text of button
x	- coordination of button in X axis
y	- coordination of button in Y axis
cx	- size of button in X axis (width)
cy	- size of button in Y axis (height)
pBmpN	- pointer to a bitmap that is shown in a normal state of the button (Could be NULL)
pBmpF	- pointer to a bitmap that is shown in a focus state of the button (Could be NULL)
fontId	- Identification number of the used title text font
onclick	- Pointer to an on-click user callback function D4D_BTN_ON_CLICK

Note: This macro create complete D4D_BUTTON structure, including the object data sub structure. 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 255 of file d4d_button.h.

#define D4D_DECLARE_STD_BUTTON_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		bmpN,
		bmpF,
		fontId,
		onclick
	)

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

Definition at line 359 of file d4d_button.h.

#define D4D_DECLARE_STD_RBUTTON	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pBmpN,
		pBmpF,
		fontId,
		onclick
	)

Macro that create the round Button 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 button object
text	- title text of button
x	- coordination of button in X axis
y	- coordination of button in Y axis
cx	- size of button in X axis (width)
cy	- size of button in Y axis (height)
radius	- radius of corners
pBmpN	- pointer to a bitmap that is shown in a normal state of the button (Could be NULL)
pBmpF	- pointer to a bitmap that is shown in a focus state of the button (Could be NULL)
fontId	- Identification number of the used title text font
onclick	- Pointer to an on-click user callback function D4D_BTN_ON_CLICK

Note: This macro create complete D4D_BUTTON structure, including the object data sub structure. 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 325 of file d4d_button.h.

#define D4D_DECLARE_STD_RBUTTON_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		bmpN,
		bmpF,
		fontId,
		onclick
	)

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

Definition at line 379 of file d4d_button.h.

#define D4D_DECLARE_TXT_BUTTON	(	name,
		text,
		x,
		y,
		cx,
		cy,
		fontId,
		onclick
	)

Macro that create the only text Button 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 button object
text	- title text of button
x	- coordination of button in X axis
y	- coordination of button in Y axis
cx	- size of button in X axis (width)
cy	- size of button in Y axis (height)
fontId	- Identification number of the used title text font
onclick	- Pointer to an on-click user callback function D4D_BTN_ON_CLICK

Note: This macro create complete D4D_BUTTON structure, including the object data sub structure. 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 274 of file d4d_button.h.

#define D4D_DECLARE_TXT_BUTTON_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		fontId,
		onclick
	)

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

Definition at line 365 of file d4d_button.h.

#define D4D_DECLARE_TXT_RBUTTON	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		fontId,
		onclick
	)

Macro that create the only text round Button 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 button object
text	- title text of button
x	- coordination of button in X axis
y	- coordination of button in Y axis
cx	- size of button in X axis (width)
cy	- size of button in Y axis (height)
radius	- radius of corners
fontId	- Identification number of the used title text font
onclick	- Pointer to an on-click user callback function D4D_BTN_ON_CLICK

Note: This macro create complete D4D_BUTTON structure, including the object data sub structure. 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 345 of file d4d_button.h.

#define D4D_DECLARE_TXT_RBUTTON_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		fontId,
		onclick
	)

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

Definition at line 385 of file d4d_button.h.

Macros

Detailed Description

Macro Definition Documentation