![]() |
Rogue Wave Views Manager Package API Reference Guide |
Rogue Wave Views Documentation Home |
Transition scheduler class. More...
#include <ilviews/manager/transition.h>
Public Member Functions | |
| IlvManagerTransitionScheduler (IlvView *view, IlvManagerTransitionHandler &handler, IlUInt duration, IlBoolean isSteps=IlFalse, IlUInt delay=0, IlBoolean owner=IlTrue) | |
| Constructor. More... | |
| void | composeTo (const IlvTransformer &t) |
| Composes the current transformer of the view with the specified parameter. More... | |
| const IlvTransformer & | getFrom () const |
| Returns the source transformer of the transition. More... | |
| IlvManager * | getManager () const |
| Returns the manager connected to this scheduler. More... | |
| const IlvTransformer & | getTo () const |
| Returns the destination transformer of the transition. More... | |
| IlvManagerTransitionHandler & | getTransitionHandler () |
| Returns the manager transition handler of this scheduler. More... | |
| IlvView * | getView () const |
| Returns the manager view connected to this scheduler. More... | |
| void | setTransformers (const IlvTransformer &from, const IlvTransformer &to) |
| Sets the source and destination transformers of this scheduler. More... | |
Transition scheduler class.
Library: ilvmgr
This class is a scheduler for IlvManagerTransitionHandler objects.
IlvManagerTransitionHandler | IlvManagerTransitionScheduler::IlvManagerTransitionScheduler | ( | IlvView * | view, |
| IlvManagerTransitionHandler & | handler, | ||
| IlUInt | duration, | ||
| IlBoolean | isSteps = IlFalse, |
||
| IlUInt | delay = 0, |
||
| IlBoolean | owner = IlTrue |
||
| ) |
Constructor.
Initializes a new instance of the IlvManagerTransitionScheduler class.
| view | The manager view. The view must be connected to a manager. |
| handler | The manager transition handler. |
| duration | If the next parameter isSteps is IlTrue, this parameter is the number of steps that the scheduler will trigger to complete the transition. Otherwise, it represents the duration in milliseconds that the transition will take. |
| isSteps | Specifies whether the previous parameter duration is a number of steps or a duration. |
| delay | This parameter controls the frequency at which the scheduler will trigger transition. If delay is 0, the scheduler will use an idle proc. If delay is -1, the scheduler will be synchrone, that is, calling IlvTransitionScheduler::start will return when the transition is finished. Otherwise, the scheduler will use a timer with a period of delay. |
| owner | A Boolean value that specifies whether the scheduler is the owner of the transition handler. If owner is IlTrue, the transition handler will be deleted when the scheduler is deleted. |
| void IlvManagerTransitionScheduler::composeTo | ( | const IlvTransformer & | t | ) |
Composes the current transformer of the view with the specified parameter.
This method calls the IlvManagerTransitionScheduler::setTransformers method with the current view transformer as first parameter, and the composition of the current view transformer with t as the second parameter.
| const IlvTransformer& IlvManagerTransitionScheduler::getFrom | ( | ) | const |
Returns the source transformer of the transition.
| IlvManager* IlvManagerTransitionScheduler::getManager | ( | ) | const |
Returns the manager connected to this scheduler.
| const IlvTransformer& IlvManagerTransitionScheduler::getTo | ( | ) | const |
Returns the destination transformer of the transition.
| IlvManagerTransitionHandler& IlvManagerTransitionScheduler::getTransitionHandler | ( | ) |
Returns the manager transition handler of this scheduler.
| IlvView* IlvManagerTransitionScheduler::getView | ( | ) | const |
Returns the manager view connected to this scheduler.
| void IlvManagerTransitionScheduler::setTransformers | ( | const IlvTransformer & | from, |
| const IlvTransformer & | to | ||
| ) |
Sets the source and destination transformers of this scheduler.
| from | The source transformer. |
| to | The destination transformer. |
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.