API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IWIDGET_GETSCROLLBARRECT()

Brew Release
Brew MP 1.0.2
See Also
- IWidget_GetVScrollbarRect() - IWidget_GetHScrollbarRect()
Description
This function retrieve the bounding rectangle of the scrollbar including the arrows, border and padding in cases where PROP_SCROLLSTYLE is either SCROLL_VERT or SCROLL_HORZ. In the case where PROP_SCROLLSTYLE is set to SCROLL_BOTH, use IWidget_GetVScrollbarRect() and IWidget_GetHScrollbarRect() to retrieve the scrollbar rectangles for the vertical and horizontal scrollbars, respectively.
Params
pif
[]:
[in] Pointer to IWidget object (scrollbar widget)
prc
[]:
[out] Pointer to an AEERect data structure.
Interface
Prototype
  •    int IWidget_GetScrollbarRect(IWidget *pif, AEERect *prc)
       
Return
  •    AEE_SUCCESS - The widget was able to successfully retrieve the scrollbar rectangle.
       AEE_EFAILED - The widget was unable to retrieve the scrollbar rectangle.
    
Side Effect
  • None.
Comments
IWidget_GetScrollbarRect will fail when called on a scrollbar widget with the layout style set to SCROLL_BOTH.