Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Transition Scheduler class. More...
#include <ilviews/util/transition.h>
Public Member Functions | |
IlvTransitionScheduler (IlvDisplay *display, IlvTransitionHandler &handler, IlUInt duration, IlBoolean isSteps=IlFalse, IlUInt delay=0, IlBoolean owner=IlTrue) | |
Constructor. More... | |
IlBoolean | finishBeforeStopping () const |
Returns IlTrue if the scheduler must finish its job before stopping. More... | |
void | finishBeforeStopping (IlBoolean finish=IlTrue) |
Tells the scheduler to finish its job or not before stopping. More... | |
IlvDisplay * | getDisplay () const |
Returns the display connection of this scheduler. More... | |
IlUInt | getDuration () const |
Returns the duration of the scheduler. More... | |
IlUInt | getSteps () const |
Returns the number of steps of the scheduler. More... | |
IlvTransitionHandler & | getTransitionHandler () |
Returns the transition handler connected to this scheduler. More... | |
IlBoolean | isRunning () const |
Returns IlTrue if the scheduler is running. More... | |
virtual void | nextTransition () |
Is called by the scheduler to go from a transition to the next one. | |
void | setDuration (IlUInt duration) |
Sets the duration of the scheduler. More... | |
void | setSteps (IlUInt steps) |
Sets the number of steps of the scheduler. More... | |
virtual void | start () |
Starts the scheduler. More... | |
virtual void | stop () |
Stops the scheduler. More... | |
Transition Scheduler class.
Library: views
This class is a scheduler for IlvTransitionHandler
objects. It calls the IlvTransitionHandler::doTransition
until the transition is finished. It's possible to tell the scheduler to execute the transition using a fixed number of steps, or within a fixed delay.
IlvTransitionHandler
IlvTransitionScheduler::IlvTransitionScheduler | ( | IlvDisplay * | display, |
IlvTransitionHandler & | handler, | ||
IlUInt | duration, | ||
IlBoolean | isSteps = IlFalse , |
||
IlUInt | delay = 0 , |
||
IlBoolean | owner = IlTrue |
||
) |
Constructor.
Initializes a new instance of the IlvTransitionScheduler
class.
display | The display connection. |
handler | The 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 | Tell whether or not 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 specify whether the scheduler is the owner of the transition handler or not. If owner is IlTrue , the transition handler will be deleted when the scheduler is deleted. |
IlBoolean IlvTransitionScheduler::finishBeforeStopping | ( | ) | const |
Returns IlTrue
if the scheduler must finish its job before stopping.
IlTrue
if the scheduler must finish its job before stopping. Tells the scheduler to finish its job or not before stopping.
finish | The Boolean value. |
IlvDisplay* IlvTransitionScheduler::getDisplay | ( | ) | const |
Returns the display connection of this scheduler.
IlUInt IlvTransitionScheduler::getDuration | ( | ) | const |
Returns the duration of the scheduler.
IlUInt IlvTransitionScheduler::getSteps | ( | ) | const |
Returns the number of steps of the scheduler.
This value is not used if IlvTransitionScheduler::getDuration
returns a value different of 0
.
IlvTransitionHandler& IlvTransitionScheduler::getTransitionHandler | ( | ) |
Returns the transition handler connected to this scheduler.
IlBoolean IlvTransitionScheduler::isRunning | ( | ) | const |
Returns IlTrue
if the scheduler is running.
IlTrue
if the scheduler is running. Returns IlFalse
otherwise. void IlvTransitionScheduler::setDuration | ( | IlUInt | duration | ) |
Sets the duration of the scheduler.
This methods sets the total amount of time that the scheduler will take to complete the transition.
duration | The duration of the scheduler. If duration is 0 , then the scheduler will use the value returned by IlvTransitionScheduler::getSteps to complete the transition using a fixed number of steps. |
void IlvTransitionScheduler::setSteps | ( | IlUInt | steps | ) |
Sets the number of steps of the scheduler.
This value is not used if IlvTransitionScheduler::getDuration
returns a value different of 0
.
steps | The number of steps the scheduler will take to complete the transition. |
|
virtual |
Starts the scheduler.
|
virtual |
Stops the scheduler.
This method is automatically called when the transition is completed, but it can also be called by the user to stop the scheduler. In this case, if the IlvTransitionScheduler::finishBeforeStopping
has been called with IlTrue
, the scheduler will finish the transition before stopping.
© 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.