Inheritance diagram for IDrawInterruptContext:

Public Types
enum	{ kDefaultIID = IID_IDRAWINTERRUPTCONTEXT }

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

enum	InterruptEventType { kInterruptCommandPeriod, kInterruptCommandSomething, kInterruptOtherKeystroke, kInterruptMouseClick }

Public Member Functions
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

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual void IDrawInterruptContext::FinishCurrentDraw ( bool16 bAborted )

pure virtual

Used to indicate that the draw of this document has completed.

virtual time_t IDrawInterruptContext::GetCurrentDrawStart ( )

pure virtual

Returns when the document began its current draw, or zero if it is not Currently being drawn.

virtual DrawType IDrawInterruptContext::GetCurrentDrawType ( )

pure virtual

Returns whether the doc is drawing in the background, in the forground, Or not at all.

virtual IWindow* IDrawInterruptContext::GetCurrentWindow ( )

pure virtual

Gets the window currently being drawn, or nil if now window is being drawn.

virtual int32 IDrawInterruptContext::GetRepeatedDrawInterruptCount ( )

pure virtual

Returns the number of times so far the draw has been interrupted. When a document does a full, non-interrupted draw, this value is reset to zero. Each time we interrupt in the middle of the draw, the value is incremented by 1.

virtual void IDrawInterruptContext::IncrementCurrentDrawInterruptCount ( )

pure virtual

Sets the value for repeated draw interrupt count.

virtual bool16 IDrawInterruptContext::ShouldCancelDrawIf ( InterruptEventType nType )

pure virtual

This method is used to determine whether a given draw can be cancelled based on: A. The type of event that is supposed to cancel it. B. Whether the document is in the background or the forground. C. How long it has been since the draw started. It is called by the internal code that decides whether to cancel draws. It is not much use unless you are trying to predict whether a draw will be cancelled.

virtual void IDrawInterruptContext::StartCurrentDraw	(	DrawType	nDraw,
		IWindow *	pWindow
	)

pure virtual

Sets the value for GetCurrentDrawType.

Public Types

Public Member Functions

Member Function Documentation