d4d_icon.h File Reference

This graph shows which files directly or indirectly include this file:

Macros
#define	D4D_ICON_F_DEFAULT
	This is icon init flags. If not defined, it sets to (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED) as a default. More...
#define	D4D_ICON_TXT_PRTY_DEFAULT
	This is icon init text properties. If not defined, it sets to (D4D_ALIGN_H_CENTER_MASK | D4D_ALIGN_V_CENTER_MASK) as a default. More...
#define	D4D_ICON_FNT_PRTY_DEFAULT
	This is icon init font properties. If not defined, it sets to ( 0 ) as a default. More...
#define	D4D_ICON_ENABLE_ANIMATION
	This is icon enable code for icon animation support If not defined, it sets to D4D_TRUE as a default. More...
#define	D4D_ICON_ANIMATION_TICK_COUNTER
	This is icon animation time tick timeout (in ticks of eGUI time ticks - D4D_TimeTickPut), it can be changed in runtime. If not defined, it sets to ( 4 ) as a default. More...
#define	D4D_GET_ICON(pObj)
#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...
#define	D4D_DECLARE_STD_ICON1(name, text, x, y, cx, cy, tx, ty, pBmp0, font, onvalch)
#define	D4D_DECLARE_STD_ICON2(name, text, x, y, cx, cy, tx, ty, pBmp1, pBmp0, font, onvalch)
#define	D4D_DECLARE_STD_ICON1_INRAM(name, text, x, y, cx, cy, tx, ty, pBmp0, font, onvalch)
#define	D4D_DECLARE_STD_ICON2_INRAM(name, text, x, y, cx, cy, tx, ty, pBmp1, pBmp0, font, onvalch)
#define	D4D_IconSetText

Typedefs
typedef void(*	D4D_ICON_ON_CHANGE )(D4D_OBJECT *pThis)
	Type definition of icon on change callback function. More...
typedef Byte	D4D_ICON_INDEX
	This is icon index variable, it used in API functions to choose the active icon in the list. More...
typedef D4D_BMP	D4D_ICON_BMPS

Functions
void	D4D_IconSetIndex (D4D_OBJECT_PTR pThis, D4D_ICON_INDEX index)
	Function sets the new bitmap of icon by icon index. More...
void	D4D_IconChangeIndex (D4D_OBJECT_PTR pThis, sByte incr)
	Function sets the new bitmap of icon by icon index difference. More...
D4D_ICON_INDEX	D4D_IconGetIndex (D4D_OBJECT_PTR pThis)
	Function returns current visible bitmap index. More...
void	D4D_IconAnimationStart (D4D_OBJECT_PTR pThis)
	Function starts the animation of icon. More...
void	D4D_IconAnimationStop (D4D_OBJECT_PTR pThis)
	Function stops the animation of icon. More...
void	D4D_IconAnimationSetCounts (D4D_OBJECT_PTR pThis, Word cnt)
	Function sets the time tick tresholds for animation speed. More...
D4D_ICON_INDEX	D4D_IconGetBmpCount (D4D_OBJECT_PTR pThis)
	Function returns the icon bitmap count. More...

Variables
const D4D_OBJECT_SYS_FUNCTION	d4d_iconSysFunc

Detailed Description

D4D Driver icon object header file.

Author

Petr Gargulak

Version

0.0.46.0

Date

Jan-14-2014

Definition in file d4d_icon.h.

Macro Definition Documentation

#define D4D_DECLARE_STD_ICON1	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			pBmp0,
			font,
			onvalch
	)

Definition at line 402 of file d4d_icon.h.

#define D4D_DECLARE_STD_ICON1_INRAM	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			pBmp0,
			font,
			onvalch
	)

Definition at line 413 of file d4d_icon.h.

#define D4D_DECLARE_STD_ICON2	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			pBmp1,
			pBmp0,
			font,
			onvalch
	)

Definition at line 407 of file d4d_icon.h.

#define D4D_DECLARE_STD_ICON2_INRAM	(		name,
			text,
			x,
			y,
			cx,
			cy,
			tx,
			ty,
			pBmp1,
			pBmp0,
			font,
			onvalch
	)

Definition at line 418 of file d4d_icon.h.

#define D4D_GET_ICON

(

pObj

)

Definition at line 149 of file d4d_icon.h.

#define D4D_IconSetText

Definition at line 449 of file d4d_icon.h.

Typedef Documentation

typedef D4D_BMP D4D_ICON_BMPS

Definition at line 119 of file d4d_icon.h.

Variable Documentation

const D4D_OBJECT_SYS_FUNCTION d4d_iconSysFunc

Definition at line 53 of file d4d_icon.c.