IMenuTimer Class Reference

Search for all occurrences

#include <imenus.h>

Inheritance diagram for IMenuTimer:

---

Class Description

See also:

Class IMenu , Class IMenuGlobalContext

Description:

This abstract class represents an interface for a timer and is used internally. Methods that are marked as internal should not be used.

Public Member Functions
virtual	~IMenuTimer ()
virtual bool	IsRunning ()=0
virtual void	Start (IMenu *pIMenu, EventParam timingType)=0
virtual void	Stop ()=0
virtual void	CheckTime ()=0
virtual bool	HasElapsed ()=0
virtual void	SetElapseTime (unsigned int elapseTime)=0
virtual unsigned int	GetElapseTime () const =0
virtual IMenu *	GetIMenu () const =0
virtual EventParam	GetTimingType () const =0

---

Constructor & Destructor Documentation

virtual ~IMenuTimer

(

)

[inline, virtual]

Remarks:

Destructor.

{;}

---

Member Function Documentation

virtual bool IsRunning

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method indicates whether the timer is running or not by returning TRUE or FALSE.

virtual void Start	(	IMenu *	pIMenu,
		EventParam	timingType
	)		[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method starts or restarts a timer for a specified IMenu.

virtual void Stop

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method will stop the timer.

virtual void CheckTime

(

)

[pure virtual]

Search for all occurrences

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.

virtual bool HasElapsed

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method indicates whether the timer has elapsed by returning TRUE or FALSE.

virtual void SetElapseTime

(

unsigned int

elapseTime

)

[pure virtual]

Search for all occurrences

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

virtual unsigned int GetElapseTime

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns the elapse time that's been set for the timer.

virtual IMenu* GetIMenu

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns a pointer to the IMenu client associated with the timer.

virtual EventParam GetTimingType

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method is used internally.

This method returns the timing type for the timer.