IDrawInterruptContext.h

//========================================================================================
// 
// $File$
// 
// Owner: Chris Jones
// 
// $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.
// 
// 
// Purpose:
// This is the handle shape interface for page item adornments. This interface can
// return trackers just like a normal handle shape. Keep in mind, however, that
// it is the page item which is in the selection, not the adornment. 
// 
//========================================================================================

#ifndef __IDrawInterruptContext__
#define __IDrawInterruptContext__

#include "IPMUnknown.h"
#include "DocFrameworkID.h"

class IWindow;

#define kSecondsOfEasyInterrupt 2

class IDrawInterruptContext: public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDRAWINTERRUPTCONTEXT };

 enum DrawType
 {
 kDocDrawForeground,
 kDocDrawBackground,
 kDocNotDrawing,
 kGraphicPreviewDrawing,
 kImportingInDesignPage
 };

 enum InterruptEventType
 {
 kInterruptCommandPeriod,
 kInterruptCommandSomething,
 kInterruptOtherKeystroke,
 kInterruptMouseClick
 };

public:
 virtual DrawType GetCurrentDrawType() = 0;

 virtual time_t GetCurrentDrawStart() = 0;

 virtual int32 GetRepeatedDrawInterruptCount() = 0;

 virtual bool16 ShouldCancelDrawIf( InterruptEventType nType ) = 0;

 virtual void StartCurrentDraw( DrawType nDraw, IWindow* pWindow ) = 0;

 virtual IWindow* GetCurrentWindow() = 0;

 virtual void IncrementCurrentDrawInterruptCount() = 0;
 virtual void ClearCurrentDrawInterruptCount() = 0;

 virtual void FinishCurrentDraw(bool16 bAborted) = 0;
};

#endif