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

Macros

#define _D4D_DECLARE_SCROLL_BAR(type, name, x, y, cx, cy, radius, pMargin, pRelations, flags, pScheme, pUser, pOnChange, pOnUsrMsg)
 Macro that create the Scroll bar object structure in memory including all substructures. More...
 
#define D4D_DECLARE_SCROLL_BAR(name, x, y, cx, cy, flags, pScheme, pUser, pOnChange, pOnUsrMsg)
 Macro that create the Scroll bar object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
 
#define D4D_DECLARE_STD_SCROLL_BAR(name, x, y, cx, cy, pOnChange)
 Macro that create the Scroll bar 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_RSCROLL_BAR(name, x, y, cx, cy, radius, flags, pScheme, pUser, pOnChange, pOnUsrMsg)
 Macro that create the rounded Scroll bar object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
 
#define D4D_DECLARE_STD_RSCROLL_BAR(name, x, y, cx, cy, radius, pOnChange)
 Macro that create the rounded Scroll bar 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_SCROLL_BAR_INRAM(name, x, y, cx, cy, flags, pScheme, pUser, pOnChange, pOnUsrMsg)
 Same as D4D_DECLARE_SCROLL_BAR, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_STD_SCROLL_BAR_INRAM(name, x, y, cx, cy, pOnChange)
 Same as D4D_DECLARE_STD_SCROLL_BAR, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_RSCROLL_BAR_INRAM(name, x, y, cx, cy, radius, flags, pScheme, pUser, pOnChange, pOnUsrMsg)
 Same as D4D_DECLARE_RSCROLL_BAR, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_STD_RSCROLL_BAR_INRAM(name, x, y, cx, cy, radius, pOnChange)
 Same as D4D_DECLARE_STD_RSCROLL_BAR, 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_SCROLL_BAR (   type,
  name,
  x,
  y,
  cx,
  cy,
  radius,
  pMargin,
  pRelations,
  flags,
  pScheme,
  pUser,
  pOnChange,
  pOnUsrMsg 
)

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

Parameters
type- type of object <D4D_CONST; D4D_NO_CONST>
name- name of scroll bar object
x- coordination of scroll bar in X axis
y- coordination of scroll bar in Y axis
cx- size of scroll bar in X axis (width)
cy- size of scroll bar 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 CHECK BOX Defines masks of check box specific behaviour flags
pScheme- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw scroll bar
pUser- user data of scroll bar
pOnChange- Pointer to an on-change user callback function D4D_SCRLBR_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_SCROLL_BAR structure, including the object data sub structure. Is used to define all properties of scroll bar.

Definition at line 153 of file d4d_scroll_bar.h.

#define D4D_DECLARE_RSCROLL_BAR (   name,
  x,
  y,
  cx,
  cy,
  radius,
  flags,
  pScheme,
  pUser,
  pOnChange,
  pOnUsrMsg 
)

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

Parameters
name- name of scroll bar object
x- coordination of scroll bar in X axis
y- coordination of scroll bar in Y axis
cx- size of scroll bar in X axis (width)
cy- size of scroll bar in Y axis (height)
radius- radius of corners
flags- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D CHECK BOX Defines masks of check box specific behaviour flags
pScheme- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw scroll bar
pUser- user data of scroll bar
pOnChange- Pointer to an on-change user callback function D4D_SCRLBR_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_SCROLL_BAR structure, including the object data sub structure. Is used to define all properties of scroll bar. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SCROLL_BAR instead of this one.

Definition at line 222 of file d4d_scroll_bar.h.

#define D4D_DECLARE_RSCROLL_BAR_INRAM (   name,
  x,
  y,
  cx,
  cy,
  radius,
  flags,
  pScheme,
  pUser,
  pOnChange,
  pOnUsrMsg 
)

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

Definition at line 262 of file d4d_scroll_bar.h.

#define D4D_DECLARE_SCROLL_BAR (   name,
  x,
  y,
  cx,
  cy,
  flags,
  pScheme,
  pUser,
  pOnChange,
  pOnUsrMsg 
)

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

Parameters
name- name of scroll bar object
x- coordination of scroll bar in X axis
y- coordination of scroll bar in Y axis
cx- size of scroll bar in X axis (width)
cy- size of scroll bar in Y axis (height)
flags- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D CHECK BOX Defines masks of check box specific behaviour flags
pScheme- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw scroll bar
pUser- user data of scroll bar
pOnChange- Pointer to an on-change user callback function D4D_SCRLBR_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_SCROLL_BAR structure, including the object data sub structure. Is used to define all properties of scroll bar. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SCROLL_BAR instead of this one.

Definition at line 182 of file d4d_scroll_bar.h.

#define D4D_DECLARE_SCROLL_BAR_INRAM (   name,
  x,
  y,
  cx,
  cy,
  flags,
  pScheme,
  pUser,
  pOnChange,
  pOnUsrMsg 
)

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

Definition at line 248 of file d4d_scroll_bar.h.

#define D4D_DECLARE_STD_RSCROLL_BAR (   name,
  x,
  y,
  cx,
  cy,
  radius,
  pOnChange 
)

Macro that create the rounded Scroll bar 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 scroll bar object
x- coordination of scroll bar in X axis
y- coordination of scroll bar in Y axis
cx- size of scroll bar in X axis (width)
cy- size of scroll bar in Y axis (height)
radius- radius of corners
pOnChange- Pointer to an on-change user callback function D4D_SCRLBR_ON_CHANGE
Note
This macro create complete D4D_SCROLL_BAR structure, including the object data sub structure. Is used to define all properties of scroll bar. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SCROLL_BAR instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 240 of file d4d_scroll_bar.h.

#define D4D_DECLARE_STD_RSCROLL_BAR_INRAM (   name,
  x,
  y,
  cx,
  cy,
  radius,
  pOnChange 
)

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

Definition at line 268 of file d4d_scroll_bar.h.

#define D4D_DECLARE_STD_SCROLL_BAR (   name,
  x,
  y,
  cx,
  cy,
  pOnChange 
)

Macro that create the Scroll bar 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 scroll bar object
x- coordination of scroll bar in X axis
y- coordination of scroll bar in Y axis
cx- size of scroll bar in X axis (width)
cy- size of scroll bar in Y axis (height)
pOnChange- Pointer to an on-change user callback function D4D_SCRLBR_ON_CHANGE
Note
This macro create complete D4D_SCROLL_BAR structure, including the object data sub structure. Is used to define all properties of scroll bar. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_SCROLL_BAR instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 199 of file d4d_scroll_bar.h.

#define D4D_DECLARE_STD_SCROLL_BAR_INRAM (   name,
  x,
  y,
  cx,
  cy,
  pOnChange 
)

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

Definition at line 254 of file d4d_scroll_bar.h.