D4D ICON API Macro's Specification

Collaboration diagram for D4D ICON API Macro's Specification:

Macros
#define	_D4D_DECLARE_ICON_BEGIN(type, name, text, x, y, cx, cy, tx, ty, radius, pMargin, pRelations, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)
	Macro that create the Icon object structure in memory including all substructures. More...
#define	D4D_DECLARE_ICON_BMP(pBmp)
	Macro that adds one bitmap to icon object list. More...
#define	D4D_DECLARE_ICON_END()
	Macro that ends the icon object declaration. More...
#define	D4D_DECLARE_ICON_BEGIN(name, text, x, y, cx, cy, tx, ty, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)
	Macro that create the Icon object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
#define	D4D_DECLARE_STD_ICON_BEGIN(name, text, x, y, cx, cy, tx, ty, fontId, pOnValch)
	Macro that create the Icon 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_RICON_BEGIN(name, text, x, y, cx, cy, tx, ty, radius, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)
	Macro that create the rounded Icon object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
#define	D4D_DECLARE_STD_RICON_BEGIN(name, text, x, y, cx, cy, tx, ty, radius, fontId, pOnValch)
	Macro that create the rounded Icon 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_ICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)
	Same as D4D_DECLARE_ICON_BEGIN, but is created in RAM instead of the ROM memory. More...
#define	D4D_DECLARE_STD_ICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, fontId, onvalch)
	Same as D4D_DECLARE_STD_ICON_BEGIN, but is created in RAM instead of the ROM memory. More...
#define	D4D_DECLARE_RICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, radius, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)
	Same as _D4D_DECLARE_ICON_BEGIN, but is created in RAM instead of the ROM memory. More...
#define	D4D_DECLARE_STD_RICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, radius, fontId, onvalch)
	Same as D4D_DECLARE_RICON_BEGIN, 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_ICON_BEGIN	(		type,
			name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			radius,
			pMargin,
			pRelations,
			flags,
			pScheme,
			fontId,
			pUser,
			pOnValch,
			pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of icon object
text	- title text of icon
x	- coordination of icon in X axis
y	- coordination of icon in Y axis
cx	- size of icon in X axis (width)
cy	- size of icon in Y axis (height)
tx	- offset of icon text from top left corner in axis X
ty	- offset of icon text from top left corner in axis Y
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
fontId	- Identification number of the used title text font
pUser	- user data of object
pOnValch	- Pointer to an on-change user callback function D4D_ICON_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_ICON structure, including the object data sub structure. Is used to define all properties of icon. The code example:

_D4D_DECLARE_ICON_BEGIN(D4D_CONST, my_icon, D4D_DEFSTR("My Icon"), 10, 10, 120, 120, 100, 100, 6, NULL, NULL, (D4D_ICON_F_DEFAULT), NULL, MY_FONT, NULL, NULL, NULL)
  D4D_DECLARE_ICON_BMP(&my_IconBmp1)
  D4D_DECLARE_ICON_BMP(&my_IconBmp2)
  D4D_DECLARE_ICON_BMP(&my_IconBmp3)
D4D_DECLARE_ICON_END()

Definition at line 192 of file d4d_icon.h.

#define D4D_DECLARE_ICON_BEGIN	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			flags,
			pScheme,
			fontId,
			pUser,
			pOnValch,
			pOnUsrMsg
	)

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

Parameters

name	- name of icon object
text	- title text of icon
x	- coordination of icon in X axis
y	- coordination of icon in Y axis
cx	- size of icon in X axis (width)
cy	- size of icon in Y axis (height)
tx	- offset of icon text from top left corner in axis X
ty	- offset of icon text from top left corner in axis Y
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
fontId	- Identification number of the used title text font
pUser	- user data of object
pOnValch	- Pointer to an on-change user callback function D4D_ICON_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_ICON structure, including the object data sub structure. Is used to define all properties of icon.If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_ICON_BEGIN instead of this one. The code example:

D4D_DECLARE_ICON_BEGIN(my_icon, D4D_DEFSTR("My Icon"), 10, 10, 120, 120, 100, 100, (D4D_ICON_F_DEFAULT), NULL, MY_FONT, NULL, NULL, NULL)
  D4D_DECLARE_ICON_BMP(&my_IconBmp1)
  D4D_DECLARE_ICON_BMP(&my_IconBmp2)
  D4D_DECLARE_ICON_BMP(&my_IconBmp3)
D4D_DECLARE_ICON_END()

Definition at line 270 of file d4d_icon.h.

#define D4D_DECLARE_ICON_BEGIN_INRAM	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			flags,
			pScheme,
			fontId,
			pUser,
			pOnValch,
			pOnUsrMsg
	)

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

Definition at line 376 of file d4d_icon.h.

#define D4D_DECLARE_ICON_BMP

(

pBmp

)

Macro that adds one bitmap to icon object list.

Parameters

pBmp	- pointer to the bitmap

Note

This macro is used with D4D_DECLARE_ICON_BEGIN & D4D_DECLARE_ICON_END to create the complete ICON object declaration Here is an example demonstrating how to used it.

      _D4D_DECLARE_ICON_BEGIN(D4D_CONST, my_icon, D4D_DEFSTR("My Icon"), 10, 10, 120, 120, 100, 100, 6, NULL, NULL, (D4D_ICON_F_DEFAULT), NULL, MY_FONT, NULL, NULL, NULL)
        D4D_DECLARE_ICON_BMP(&my_IconBmp1)
        D4D_DECLARE_ICON_BMP(&my_IconBmp2)
        D4D_DECLARE_ICON_BMP(&my_IconBmp3)
      D4D_DECLARE_ICON_END()
* 

Definition at line 223 of file d4d_icon.h.

#define D4D_DECLARE_ICON_END

(

)

Macro that ends the icon object declaration.

Note

This macro is used with D4D_DECLARE_ICON_BEGIN & D4D_DECLARE_ICON_BMP to create the complete ICON object declaration Here is an example demonstrating how to used it.

      _D4D_DECLARE_ICON_BEGIN(D4D_CONST, my_icon, D4D_DEFSTR("My Icon"), 10, 10, 120, 120, 100, 100, 6, NULL, NULL, (D4D_ICON_F_DEFAULT), NULL, MY_FONT, NULL, NULL, NULL)
        D4D_DECLARE_ICON_BMP(&my_IconBmp1)
        D4D_DECLARE_ICON_BMP(&my_IconBmp2)
        D4D_DECLARE_ICON_BMP(&my_IconBmp3)
      D4D_DECLARE_ICON_END()
* 

Definition at line 237 of file d4d_icon.h.

#define D4D_DECLARE_RICON_BEGIN	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			radius,
			flags,
			pScheme,
			fontId,
			pUser,
			pOnValch,
			pOnUsrMsg
	)

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

Parameters

name	- name of icon object
text	- title text of icon
x	- coordination of icon in X axis
y	- coordination of icon in Y axis
cx	- size of icon in X axis (width)
cy	- size of icon in Y axis (height)
tx	- offset of icon text from top left corner in axis X
ty	- offset of icon text from top left corner in axis Y
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
fontId	- Identification number of the used title text font
pUser	- user data of object
pOnValch	- Pointer to an on-change user callback function D4D_ICON_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_ICON structure, including the object data sub structure. Is used to define all properties of icon.If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_ICON_BEGIN instead of this one. The code example:

D4D_DECLARE_RICON_BEGIN(my_icon, D4D_DEFSTR("My Icon"), 10, 10, 120, 120, 100, 100, 6, (D4D_ICON_F_DEFAULT), NULL, MY_FONT, NULL, NULL, NULL)
  D4D_DECLARE_ICON_BMP(&my_IconBmp1)
  D4D_DECLARE_ICON_BMP(&my_IconBmp2)
  D4D_DECLARE_ICON_BMP(&my_IconBmp3)
D4D_DECLARE_ICON_END()

Definition at line 337 of file d4d_icon.h.

#define D4D_DECLARE_RICON_BEGIN_INRAM	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			radius,
			flags,
			pScheme,
			fontId,
			pUser,
			pOnValch,
			pOnUsrMsg
	)

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

Definition at line 390 of file d4d_icon.h.

#define D4D_DECLARE_STD_ICON_BEGIN	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			fontId,
			pOnValch
	)

Macro that create the Icon 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 icon object
text	- title text of icon
x	- coordination of icon in X axis
y	- coordination of icon in Y axis
cx	- size of icon in X axis (width)
cy	- size of icon in Y axis (height)
tx	- offset of icon text from top left corner in axis X
ty	- offset of icon text from top left corner in axis Y
fontId	- Identification number of the used title text font
pOnValch	- Pointer to an on-change user callback function D4D_ICON_ON_CHANGE

Note

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

D4D_DECLARE_STD_ICON_BEGIN(my_icon, D4D_DEFSTR("My Icon"), 10, 10, 120, 120, 100, 100, MY_FONT, NULL)
  D4D_DECLARE_ICON_BMP(&my_IconBmp1)
  D4D_DECLARE_ICON_BMP(&my_IconBmp2)
  D4D_DECLARE_ICON_BMP(&my_IconBmp3)
D4D_DECLARE_ICON_END()

Definition at line 300 of file d4d_icon.h.

#define D4D_DECLARE_STD_ICON_BEGIN_INRAM	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			fontId,
			onvalch
	)

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

Definition at line 382 of file d4d_icon.h.

#define D4D_DECLARE_STD_RICON_BEGIN	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			radius,
			fontId,
			pOnValch
	)

Macro that create the rounded Icon 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 icon object
text	- title text of icon
x	- coordination of icon in X axis
y	- coordination of icon in Y axis
cx	- size of icon in X axis (width)
cy	- size of icon in Y axis (height)
tx	- offset of icon text from top left corner in axis X
ty	- offset of icon text from top left corner in axis Y
radius	- radius of corners
fontId	- Identification number of the used title text font
pOnValch	- Pointer to an on-change user callback function D4D_ICON_ON_CHANGE

Note

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

D4D_DECLARE_STD_RICON_BEGIN(my_icon, D4D_DEFSTR("My Icon"), 10, 10, 120, 120, 100, 100, 6, MY_FONT, NULL)
  D4D_DECLARE_ICON_BMP(&my_IconBmp1)
  D4D_DECLARE_ICON_BMP(&my_IconBmp2)
  D4D_DECLARE_ICON_BMP(&my_IconBmp3)
D4D_DECLARE_ICON_END()

Definition at line 368 of file d4d_icon.h.

#define D4D_DECLARE_STD_RICON_BEGIN_INRAM	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			radius,
			fontId,
			onvalch
	)

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

Definition at line 396 of file d4d_icon.h.