Developer

API Reference

IWidget_SetScrollStyle()

Brew Release
Brew MP 1.0.2
See Also
- IWidget_SetProperty()
- IWidget_GetScrollStyle()
Description
This routine sets the layout of the scrollbar/scroll indicator to vertical, horizontal or both.
Scroll type can be
   SCROLL_VERT
   -----------
   When PROP_SCROLLSTYLE is set to SCROLL_VERT, the widget will be laid
   out vertically.  For the scrollbar widget, this usually means that
   the widget will be laid out to the right of the content widget that
   it wraps, indicating that the contents may be scrolled up or down.
   A scroll indicator would also be laid out vertically, either beside
   the content it wraps, or "around" the content widget.  In the latter
   case, the up arrow would be placed above the content widget and 
   the down arrow would be placed below.

   SCROLL_HORZ
   -----------
   When PROP_SCROLLSTYLE is set to SCROLL_HORZ, the widget will be laid
   out horizontally.  For the scrollbar widget, this usually means that
   the widget will be laid out below the content widget that it wraps,
   indicating that the contents may be scrolled left or right.  A scroll
   indicator would also be laid out horizontally, either beside the
   content it wraps, or "around" the content widget.  In the latter case,
   the left arrow would be placed to the left of the content widget and
   the right arrow would be placed to the right.

   SCROLL_BOTH
   -----------
   When PROP_SCROLLSTYLE is set to SCROLL_BOTH, both a vertical and
   horizontal scrollbar or scroll indicator will be wrapped around the
   content widget, laid out as described above for SCROLL_VERT and
   SCROLL_HORZ. When Scrollbar is used in standalone mode(no child mode)
   SCROLL_BOTH cannot be used. 

Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object.
  • nStyle
    []:
    [in] Scrollbar style to be set.
Interface
Prototype
   int IWidget_SetScrollStyle(IWidget *pif, int nStyle);
Return
   AEE_SUCCESS - If the widget is able to set scroll style.
   AEE_EFAILED - If the widget failed to set scroll style.
Side Effect
None
Comment
None.
  • Follow