eGUI alias D4D  Release 3.0
Reference Manual
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros
D4D PICTURE API Macro's Specification
D4D Picture Widget
Collaboration diagram for D4D PICTURE API Macro's Specification:

Macros

#define _D4D_DECLARE_PICTURE(type, name, x, y, cx, cy, radius, pMargin, pRelations, pBmp, flags, pUser, pOnUsrMsg)
 Macro that create the Picture object structure in memory including all substructures. More...
 
#define D4D_DECLARE_PICTURE(name, x, y, cx, cy, pBmp, flags, pUser, pOnUsrMsg)
 Macro that create the Picture object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
 
#define D4D_DECLARE_STD_PICTURE(name, x, y, cx, cy, pBmp)
 Macro that create the Picture 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_RPICTURE(name, x, y, cx, cy, radius, pBmp, flags, pUser, pOnUsrMsg)
 Macro that create the rounded Picture object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
 
#define D4D_DECLARE_STD_RPICTURE(name, x, y, cx, cy, radius, pBmp)
 Macro that create the rounded Picture 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_PICTURE_INRAM(name, x, y, cx, cy, pBmp, flags, pUser, pOnUsrMsg)
 Same as D4D_DECLARE_PICTURE, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_STD_PICTURE_INRAM(name, x, y, cx, cy, pBmp)
 Same as D4D_DECLARE_STD_PICTURE, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_RPICTURE_INRAM(name, x, y, cx, cy, radius, pBmp, flags, pUser, pOnUsrMsg)
 Same as D4D_DECLARE_RPICTURE, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_STD_RPICTURE_INRAM(name, x, y, cx, cy, radius, pBmp)
 Same as D4D_DECLARE_STD_RPICTURE, 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_PICTURE (   type,
  name,
  x,
  y,
  cx,
  cy,
  radius,
  pMargin,
  pRelations,
  pBmp,
  flags,
  pUser,
  pOnUsrMsg 
)

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

Parameters
type- type of object <D4D_CONST; D4D_NO_CONST>
name- name of picture object
x- coordination of picture in X axis
y- coordination of picture in Y axis
cx- size of picture in X axis (width)
cy- size of picture in Y axis (height) (with hidden list box)
radius- radius of corners
pMargin- pointer to margin structure (*D4D_MARGIN)(Could be NULL)
pRelations- pointer to object relation array (Could be NULL)
pBmp- pointer to bitmap structure D4D_BMP
flags- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pUser- user data of menu
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_PICTURE structure, including the object data sub structure. Is used to define all properties of picture.

Definition at line 118 of file d4d_picture.h.

#define D4D_DECLARE_PICTURE (   name,
  x,
  y,
  cx,
  cy,
  pBmp,
  flags,
  pUser,
  pOnUsrMsg 
)

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

Parameters
name- name of picture object
x- coordination of picture in X axis
y- coordination of picture in Y axis
cx- size of picture in X axis (width)
cy- size of picture in Y axis (height) (with hidden list box)
pBmp- pointer to bitmap structure D4D_BMP
flags- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pUser- user data of menu
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_PICTURE structure, including the object data sub structure. Is used to define all properties of picture. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_PICTURE instead of this one.

Definition at line 143 of file d4d_picture.h.

#define D4D_DECLARE_PICTURE_INRAM (   name,
  x,
  y,
  cx,
  cy,
  pBmp,
  flags,
  pUser,
  pOnUsrMsg 
)

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

Definition at line 208 of file d4d_picture.h.

#define D4D_DECLARE_RPICTURE (   name,
  x,
  y,
  cx,
  cy,
  radius,
  pBmp,
  flags,
  pUser,
  pOnUsrMsg 
)

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

Parameters
name- name of picture object
x- coordination of picture in X axis
y- coordination of picture in Y axis
cx- size of picture in X axis (width)
cy- size of picture in Y axis (height) (with hidden list box)
radius- radius of corners
pBmp- pointer to bitmap structure D4D_BMP
flags- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pUser- user data of menu
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_PICTURE structure, including the object data sub structure. Is used to define all properties of picture. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_PICTURE instead of this one.

Definition at line 182 of file d4d_picture.h.

#define D4D_DECLARE_RPICTURE_INRAM (   name,
  x,
  y,
  cx,
  cy,
  radius,
  pBmp,
  flags,
  pUser,
  pOnUsrMsg 
)

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

Definition at line 221 of file d4d_picture.h.

#define D4D_DECLARE_STD_PICTURE (   name,
  x,
  y,
  cx,
  cy,
  pBmp 
)

Macro that create the Picture 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 picture object
x- coordination of picture in X axis
y- coordination of picture in Y axis
cx- size of picture in X axis (width)
cy- size of picture in Y axis (height) (with hidden list box)
pBmp- pointer to bitmap structure D4D_BMP
Note
This macro create complete D4D_PICTURE structure, including the object data sub structure. Is used to define all properties of picture. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_PICTURE instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 160 of file d4d_picture.h.

#define D4D_DECLARE_STD_PICTURE_INRAM (   name,
  x,
  y,
  cx,
  cy,
  pBmp 
)

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

Definition at line 214 of file d4d_picture.h.

#define D4D_DECLARE_STD_RPICTURE (   name,
  x,
  y,
  cx,
  cy,
  radius,
  pBmp 
)

Macro that create the rounded Picture 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 picture object
x- coordination of picture in X axis
y- coordination of picture in Y axis
cx- size of picture in X axis (width)
cy- size of picture in Y axis (height) (with hidden list box)
radius- radius of corners
pBmp- pointer to bitmap structure D4D_BMP
Note
This macro create complete D4D_PICTURE structure, including the object data sub structure. Is used to define all properties of picture. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_PICTURE instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 200 of file d4d_picture.h.

#define D4D_DECLARE_STD_RPICTURE_INRAM (   name,
  x,
  y,
  cx,
  cy,
  radius,
  pBmp 
)

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

Definition at line 227 of file d4d_picture.h.