IProgressBarManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Joss
// 
// $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 __IProgressBarManager__
#define __IProgressBarManager__

class PMString;
class IProgressBarControlData;

#include "ShuksanID.h"

enum ProgressBarStyle { eFixedRange = 0, eBarberPole, eDocWindow };
#define kProgressTraceID "ProgressBarTrace"

class IProgressBarManager : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IPROGRESSBARMANAGER };
 enum ProgressType
 {
 kTaskProgress = 0x01,
 kRangeProgress = 0x02,
 kFoldupProgress = 0x04
 };

 virtual int32 RegisterTaskSet(int32 nType,
 const PMString& progressDialogTitle, 
 int32 taskStart, 
 int32 taskEnd, 
 bool8 showImmediate = kFalse,
 bool8 showCancel = kTrue, 
 IProgressBarControlData* customProgress = nil, 
 bool32 useTwoBars = kFalse) = 0;
 virtual void UnregisterTaskSet(int32 nBarID = -1) = 0;

 virtual void DoTask(const PMString& displayText, int32 advanceNtasks = 1, int32 nBarID = -1) = 0;

 virtual void SetPosition( int32 newPosition, bool16 fParent = kFalse, int32 nBarID = -1 ) = 0;
 virtual int32 GetPosition( bool16 fParent = kFalse, int32 nBarID = -1 ) = 0;

 virtual void SetTaskText( const PMString& newText, bool16 forceRedraw = kTrue, int32 nBarID = -1) = 0;
 
 virtual bool16 WasCancelled(bool8 setGlobalErrorState = kTrue) = 0;

 virtual void Abort() = 0;

 virtual int32 GetNumTaskSets() = 0;
 virtual void GetTaskSetInfo(int32 taskSetIndex, int32* outTaskStart, int32* outTaskEnd = nil, int32* outCurrentTask = nil, PMString* outCurrentSubTaskName = nil) = 0;
 
 virtual void Cancel() = 0;

 virtual void DisableChildProgressBars(bool16 disable) = 0;

 virtual bool16 SuppressProgressBarDisplay(bool16 suppressDisplay) = 0;

 virtual bool16 IsDisplaySuppressed() = 0;

 virtual bool16 IsRegisterDisabled() = 0;

 virtual void SetTaskStatus(const PMString& statusText, bool16 forceRedraw = kTrue, int32 nBarID = -1) = 0;

 virtual void SetTaskTitle(const PMString& strTitle, bool16 forceRedraw, int32 nBarID = -1) = 0;

 virtual bool SkipCheckingForCancel(bool skip) = 0;
 virtual void RegisterCloseNotifier(std::function<void()> callback) =0;
 //Internal Use only -- notifies on destruction of a notifier 
 virtual void ClearCloseNotifier() =0;
};

#endif