Developer

API Reference

IWidget_GetGradientStyle()

Brew Release
Brew MP 1.0.2
See Also
Border Background Events IWidget_GetGradientStyle IWidget_SetGradientColor IWidget_SetSelectedGradientColor IWidget_SetActiveGradientColor IWidget_GetActiveGradientColor IWidget_SetInactiveGradientColor IWidget_GetInactiveGradientColor IWidget_SetSelectedActiveGradientColor IWidget_GetSelectedActiveGradientColor IWidget_SetSelectedInactiveGradientColor IWidget_GetSelectedInactiveGradientColor
Description

Retrieves the gradient style of the border of a widget.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object.
  • pnStyle
    []:
    [out] Retrieves the gradient style of the widget
Interface
Prototype
int IWidget_GetGradientStyle(IWidget *pif, uint16* pnStyle)
Return
   AEE_SUCCESS - Successfully retrieved the gradient style
   AEE_EFAILED - Failed to retrieve the gradient style
Side Effect
None.
Comment

The following gradients are supported by widgets who support Border Background Events. GRADIENT_STYLE_VERT: gradient fill vertically (top to bottom) GRADIENT_STYLE_HORZ: gradient fill horizontally (left to right) GRADIENT_STYLE_CENTERVERT: gradient fill from top & bottom vertically to center GRADIENT_STYLE_CENTERHORZ: gradient fill from left & right to center GRADIENT_STYLE_NONE: gradient fill none
The gradient stores the end color of a gradient. The start color of the gradient will use the normal background color of the widget (in this case the unselected active background color). The gradient can be set using the IWidget_SetGradientStyle inline and defaults to GRADIENT_STYLE_NONE.
  • Follow