Developer

API Reference

IController_SetHorizontalSnapOffsets()

Brew Release
Brew MP 1.0.2
See Also
Description
This function is used to set manual horizontal rubberband offsets on a controller. Controllers use these snap offsets to determine what points in a viewport should be scrolled to when the user ends a scrolling gesture. These offsets should be relative to the widget to which the controller is attached.
Parameters
  • pif
    []:
    [in] Pointer to the IController interface object.
  • pnSOffsetsArray
    []:
    [in] int array that holds snap offsets for horizontal layout
  • nArraySize
    []:
    [in] Snap Offsets array size
Interface
Prototype
int IController_SetHorizontalSnapOffsets(IController *pif, const int* pnSOffsetsArray, int nArraySize);
Return
   AEE_SUCCESS - If the controller is able to set snappoints successfully
   AEE_EFAILED - If the controller is not able to set the snappoints successfully
Side Effect
None
Comment
Setting discrete snap offsets is supported only on ViewportTC.
  • Follow