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

Developer

API Reference

IWIDGET_GETSCROLLHANDLERECT()

Brew Release
Brew MP 1.0.2
See Also
- IWidget_GetVScrollHandleRect() - IWidget_GetHScrollHandleRect()
Description
This function retrieve the rectangle of the scrollbar 'handle'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_GetScrollHandleRect(IWidget *pif, AEERect *prc)   
    
Return
  •    AEE_SUCCESS - The widget was able to successfully retrieve the scrollbar handle rectangle.
       AEE_EFAILED - The widget was unable to retrieve the scrollbar handle rectangle.
    
Side Effect
  • None.
Comments
IWidget_GetScrollHandleRect will fail when called on a scrollbar widget with the layout style set to SCROLL_BOTH.