Developer

API Reference

IWidget_GetPropRGB()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IWidget IWidget_GetProperty Widget Events
Description
This function is used to retrieve widget properties that are stored as RGB values, copying the value into the 'prgb' pointer passed to the function as a parameter. The function will return AEE_SUCCESS or AEE_EFAILED depending on whether or not the widget was able to retrieve the requested property.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object.
  • wProp
    []:
    [in] Identifies the property to be retrieved.
  • prgb
    []:
    [out] A pointer to a 32-bit RGBVAL into which the widget will copy the value of the requested property.
Interface
Prototype
   int IWidget_GetPropRGB(IWidget *pif, uint16 wProp, RGBVAL *prgb); 
Return
AEE_SUCCESS : If the widget is able to retrieve the requested property. AEE_EFAILED : If the property could not be retrieved.
The value of the requested RGB property is returned in 'prgb'.
Side Effect
IWidget_GetPropRGB() calls IWidget_GetProperty() and has the net effect of processing an EVT_WDG_GETPROPERTY event.
Comment
Widgets may possess any number of properties, as defined in AEEWidgetProperties.h, and include attributes such as color, border width, shadowing, etc. Examples of widget properties stored as an RGBVAL include PROP_ACTIVE_BORDERCOLOR, PROP_SELECTED_BORDERCOLOR and many others.
RGB values may contain standard red, green and blue components, or may include an alpha component in addition to the standard color values. See the definition of RGBVAL in AEERGBVAL.h for additional information.
  • Follow