Developer

API Reference

ITRANSITION_StartMover()

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 ITRANSITION_Stop
Description
This function starts a mover transition effect. Prior to starting the transition an application should first initialize the MoverDesc data structure to identify the target of the transition effect and any parameters specific to mover transitions. Once started, the move transition will continue until 'msecs' milliseconds have passed, or until the effect has been stopped by calling ITRANSITION_Stop(). At the conclusion of the mover effect (whether it has run to completion or has been terminated early), the transition completion notification callback passed in 'pfnDone' will be issued, providing the application with an opportunity to perform any special processing at the end of the effect.
Parameters
  • po
    []:
    pointer to the ITransition interface object.
  • pd
    []:
    pointer to the MoverDesc data structure that identifies the widget to be the target of the transition.
  • msecs
    []:
    defines the duration of the movement effect, expressed in milliseconds.
  • pfnDone
    []:
    pointer to the callback function that Brew MP will issue when the move transition has ended.
  • pCxt
    []:
    pointer to private data that is created and owned by the caller.
Interface
ITRANSITION
Prototype
 void ITRANSITION_StartMover(ITransition *po, MoverDesc *pd, uint32 msecs, PFNNOTIFY pfnDone, void *pCtx);
Return
None
Side Effect
None
Comment
The MoverDesc structure should identify the widget to be the target of the transition, as well as the starting and ending coordinates for that widget as it is moved within its managing container.
The duration of the movement effect is expressed in milliseconds. For example, a 2 second movement transition would pass 2000 in this parameter.
The callback function will be called when the transition has ended, whether it has run its entire course to completion, or the effect has been terminated by a call to ITRANSITION_Stop(). Applications that do not wish to receive notification following the completion of a mover transition may pass NULL for 'pfnDone', and no callback will be registered.
The callback function prototype takes the following form...
      typedef void (*PFNNOTIFY)(void * pData);

...where pData is passed to the callback as the same pointer passed into the ITRANSITION_StartMover() function in the pCtx parameter. This is a pointer to data owned and managed entirely by the caller.
  • Follow