Developer

API Reference

IWidget_Animate()

Brew Release
Brew MP 1.0.2
See Also
IWidget IWidget_SetProperty()
Description
This function is used to start or stop an image widget's animation sequence, as specified by the 'bAnim' parameter. If the image contains a sequence of frames, they will be displayed, one after another, in sequential order, with the current animation rate observed between frames.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget object.
  • bAnim
    []:
    [in] Specifies whether or not the widget should start or stop its animation sequence. Pass TRUE to start the animation, FALSE to stop.
Interface
Prototype
   int IWidget_Animate(IWidget *pif, boolean bAnim)
Return
   AEE_SUCCESS - If the widget was able to set the property, PROP_ANIMATE, to the
                 value of 'bAnim'.
   AEE_EFAILED - If the request was not handled by the widget framework.
Side Effect
Calling IWidget_Animate() causes the image widget to be redrawn.
Comment
The animation sequence cannot be paused. That is, each time IWidget_Animate() is called the frame sequence resets itself to the first frame in the animation sequence.
  • Follow