Developer

API Reference

IWidget_SetScrollText()

Brew Release
Brew MP 1.0.2
Description
This function is used to initiate scrolling text. The structure passed in contains all the fields required to set up the parameters of the scrolling. The structure is defined as follows:
   struct ScrollText{
      uint16      nScrollAmount; // step size (pixels)
      uint16      nScrollDelay;  // scroll speed (msec)
      uint16      nStartDelay;   // start delay (msec)
      uint16      nEndDelay;     // end delay (msec)
      uint16      nRepeat;       // number of times to repeat (zero means infinite)
   };
Parameters
  • po
    []:
    [in] Pointer to the IWidget object.
  • pscrollText
    []:
    [in] Pointer to the ScrollText structure.
Interface
Prototype
   int IWidget_SetScrollText(IWidget* po, const ScrollText* pscrollText);
Return
   AEE_SUCCESS - If the static widget is able to successfully set the scroll text.
   AEE_EFAILED - Failed to initialize the scrolling.
Side Effect
Calling IWidget_SetScrollText will begin the callback timer that will animate the scroll.
Comment
None
  • Follow