Class IMenuTimer
See Also: Class IMenu , Class IMenuGlobalContext
class IMenuTimer
Description:
This class is available in release 4.0 and later only.
This abstract class represents an interface for a timer and is used internally. Methods that are marked as internal should not be used.
Methods:
public:
Prototype:
virtual bool IsRunning() = 0;
Remarks:
This method is used internally.
This method indicates whether the timer is running or not by returning TRUE or FALSE.
Prototype:
virtual void Start(IMenu* pIMenu, EventParam timingType) = 0;
Remarks:
This method is used internally.
This method starts or restarts a timer for a specified IMenu.
Prototype:
virtual void Stop() = 0;
Remarks:
This method is used internally.
This method will stop the timer.
Prototype:
virtual void CheckTime() = 0;
Remarks:
This method is used internally.
This method instructs the timer to check the time. If the time has elapsed it will notify its IMenu client.
Prototype:
virtual bool HasElapsed() = 0;
Remarks:
This method is used internally.
This method indicates whether the timer has elapsed by returning TRUE or FALSE.
Prototype:
virtual void SetElapseTime(unsigned int elapseTime) = 0;
Remarks:
This method is used internally.
This method allows you to set the elapse time for the timer.
Parameters:
unsigned int elapseTime
The time at which the timer should elapse
Prototype:
virtual unsigned int GetElapseTime() const = 0;
Remarks:
This method is used internally.
This method returns the elapse time that’s been set for the timer.
Prototype:
virtual IMenu* GetIMenu() const = 0;
Remarks:
This method is used internally.
This method returns a pointer to the IMenu client associated with the timer.
Prototype:
virtual EventParam GetTimingType() const = 0;
Remarks:
This method is used internally.
This method returns the timing type for the timer.