ProgressBar.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard (was 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 __ProgressBar__
#define __ProgressBar__

#include "IProgressBarManager.h"
#include "IProgressBarControlData.h"

class PMString; // foward decl
class IDrawMgr;
class IDocWindowProgressBar;



class CProgressBar
{
public:
 CProgressBar();
 virtual ~CProgressBar() {}

 virtual bool16 WasCancelled(bool8 setGlobalErrorState = kTrue) = 0;

 virtual void Abort() = 0;

 virtual void DisableChildProgressBars(bool16 disable) = 0;

 virtual bool16 WasRegisterSuccessful() = 0;

 virtual void SetPosition(int32 newPosition);

private:
 int32 nVTTest;
};

class BaseProgressBar: public CProgressBar
{
protected:
 BaseProgressBar( int32 nType,
 const PMString& progressDialogTitle, 
 int32 taskStart, 
 int32 taskEnd, 
 bool8 showImmediate,
 bool8 showCancel, 
 IProgressBarControlData* customProgress, 
 bool32 useTwoBars);

public:
 virtual ~BaseProgressBar();

 bool16 WasCancelled(bool8 setGlobalErrorState = kTrue);

 void Abort();

 void DisableChildProgressBars(bool16 disable);

 bool16 WasRegisterSuccessful();

 void SetPosition(int32 newPosition);

protected:
 IProgressBarManager* fProgressMgr;
 int32 fnBarID;
};

class DocWindowProgressBar: public CProgressBar
{
public:
 DocWindowProgressBar( int32 nStart, int32 nEnd, const PMString& strText, IDrawMgr* pMgr, bool32 bAllowCancel = kTrue, bool32 bShowImmediate = kFalse);
 ~DocWindowProgressBar();

 virtual bool16 WasCancelled(bool8 setGlobalErrorState = kTrue);

 virtual void Abort();

 virtual void DisableChildProgressBars(bool16 disable);

 virtual bool16 WasRegisterSuccessful();

 virtual void SetPosition(int32 newPosition);

private:
 IDocWindowProgressBar* fProgressBarImpl;
};

class TaskProgressBar: public BaseProgressBar
{
public:
 TaskProgressBar(const PMString& title, int32 numTasks, bool8 showImmediate = kFalse, 
 bool8 showCancel = kTrue, IProgressBarControlData* customProgress = nil, bool32 useTwoBars = kFalse);
 virtual ~TaskProgressBar();

 void DoTask(const PMString& displayText = "", int32 advanceNtasks = 1);

 void SetTaskStatus(const PMString& displayText = "");
};

class RangeProgressBar: public BaseProgressBar
{
public:
 RangeProgressBar(const PMString& title, int32 startRange, int32 endRange, bool8 showImmediate = kFalse, 
 bool8 showCancel = kTrue, IProgressBarControlData* customProgress = nil, bool32 useTwoBars = kFalse,std::function<void()> callback=nullptr);
 virtual ~RangeProgressBar();
 
 void SetTaskText(const PMString& text, bool16 forceRedraw = kTrue);
};

class SubTaskFoldupProgressBar: public BaseProgressBar
{
public:
 SubTaskFoldupProgressBar(const PMString& strText,
 int32 startRange, 
 int32 endRange);
 virtual ~SubTaskFoldupProgressBar();

public:
 void SetTaskText(const PMString& strText, bool16 forceRedraw = kTrue);
};

class SuppressProgressBarDisplay
{
 public:
 SuppressProgressBarDisplay(bool16 suppressDisplay = kTrue);
 virtual ~SuppressProgressBarDisplay();

 static bool16 IsSuppressed();
 
 protected:
 IProgressBarManager* fProgressMgr;

};


#endif