Developer

API Reference

ITRANSITION_Stop()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
ITransition ITRANSITION_Start
Description
This function prematurely terminates a transition effect before its timer has expired. Stopping a transition will immediately freeze whatever visual effect was currently in progress and (if such a callback is registered) trigger the transition completion notifier registered with the transition interface in the call to ITRANSITION_Start().
Parameters
  • p
    []:
    pointer to the ITransition interface object.
Interface
ITRANSITION
Prototype
   void ITRANSITION_Stop(ITransition *p);
Return
None
Side Effect
None
Comment
Stopping a transition effect that is in progress does _not_ remove the transitioning object from the display. For example, an application that wishes manages a fadeout effect for a popup form might call ITRANSITION_Stop() if the user presses the CLEAR button on their devices, intending to dismiss the popup from the display. ITRANSITION_Stop() merely halts the visual effect of the transition -- in this case leaving the popup in some partially faded state. It would then be up to the application to perform whatever operation necessary to remove the object from the display.
  • Follow