IIdleTaskMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: Shawn Sheridan
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IIdleTaskMgr__
#define __IIdleTaskMgr__

#include "IPMUnknown.h"
#include "ShuksanID.h"

class IIdleTask;

/*
 The IdleTaskMgr maintains a queue of active tasks and a queue of suspended tasks 
 to run when its RunOverdueTasks method is called from the main event loop. The active
 tasks are prioritized on the time they want to run.

 Idle tasks are a cheap version of threads. They have no stack space of their own, 
 so the memory footprint is very small.

 The only way to check if a task is installed using the IdleTaskMgr directly
 is to remove and re-add it like this:

 <pre>
 uint32 when = RemoveTask(task);
 if( when != IIdleTask::kEndOfTime){
 //was installed so put it back
 AddTask( task, when);
 }else{
 //wasn't currently installed
 }
 </pre>
*/
class IIdleTaskMgr : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IIDLETASKMGR };
 enum IdleTaskEvents {SleepEvent, WakeEvent, MouseClickEvent, KeyEvent, AppOutOfFocus, AppInFocus};

 typedef enum ApplicationStateFlags { //these will likely move to the app
 kInBackground = 1,
 kModalDialogUp = 2,
 kMenuUp = 4,
 kMouseTracking = 8,
 kUserActive = 16,
 kApplicationMinimized = 32,
 kMainThreadTaskQueued = 64
 } ApplicationStateFlags;
 virtual void SetApplicationState(uint32 flags) = 0;
 virtual uint32 GetApplicationState() = 0;

 virtual void AddTask(IIdleTask *newTask, uint32 initialMillisecondDelay = 0) = 0;

 virtual uint32 RemoveTask(IIdleTask *taskToRemove) = 0;

 virtual uint32 RunOverdueTasks( const char* (*EventsPendingFunction)()) = 0;
 uint32 RunAllTasks( const char* (*EventsPendingFunction)()){ return RunOverdueTasks(EventsPendingFunction);} //name change until clients updated

 virtual void Shutdown() = 0;

 virtual IPMUnknown* QueryRunningTask( PMIID iid ) = 0;
 
 virtual bool16 GetSleepFlag() = 0;
 
 virtual void SetSleepFlag(bool16 sleepFlag) = 0;
 
 virtual void SetSleepFlagOnEvents(IdleTaskEvents idleTaskEvent) = 0;
};

#endif // __IIdleTaskMgr__