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

Developer

API Reference

IWIDGET_SCROLLHV()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IWidget IWidget_ScrollHV IWidget_SetOffsetX IWidget_SetOffsetY IWidget_GetOffsetX IWidget_GetOffsetY IWidget_GetStartLine IWidget_GetNextLine IWidget_GetPreviousLine IWidget_GetCaretPos
Description

This function is used to scroll the widget to a particular x and y item offset in a widget. For most widgets, the concept of an abstract item collapses to 'pixel', but it is possible for an item to unify with a different unit of measurement, such as a character or a line.
Params
pif
[]:
[in] Pointer to the IWidget interface object.
x
[]:
[in] The horizontal item position to which the widget should scroll.
y
[]:
[in] The vertical item position to which the widget should scroll.
Interface
Prototype
  •    int IWidget_ScrollHV(IWidget* pif, int x, int y);
    
Return
  • AEE_SUCCESS : The widget was able to scroll to the specified position. AEE_EFAILED : The widget was unable to scroll to the specified position.
Side Effect
  • If successful, the widget will scroll to the specified position.
Comments
If you are only scrolling the widget in one direction, you should look into IWidget_Scroll, IWidget_SetOffsetX, or IWidget_SetOffsetY instead to more accurately convey your meaning.