This function is used to scroll a widget in various ways. Using this function, it is possible to scroll a supporting widget in the horizontal direction either a single 'item' at at time, a single 'page' at a time, or to a specified offset on the widget. For most widgets, an 'item' corresponds to a single pixel. This is often customizable using the increment property, specified through IWidget_SetIncrement. The position based scroll types are similar to the IWidget_SetOffsetX and IWidget_SetOffsetY functions; however, they operate on abstract items rather than directly on pixels in some cases, such as characters and/or lines in a text widget.
int IWidget_Scroll(IWidget *pif, uint16 nScrollType, int32 nOffset);
- AEE_SUCCESS : The widget was able to scroll to the specified position or amount. AEE_EFAILED : The widget was unable to scroll to the specified position or amount.
- If successful, the widget will scroll based on the scroll type and possibly offset.