#include <IDocumentSignalData.h>

Inheritance diagram for IDocumentSignalData:

Public Types
enum	{ kDefaultIID = IID_IDOCUMENTSIGNALDATA }

Public Member Functions
virtual void	Set (ICommand *documentCmd, const IDFile &file, const UIDRef &doc, K2::UIFlags uiflags)=0

virtual ICommand *	GetCommand () const =0

virtual const IDFile &	GetFile () const =0

virtual const UIDRef &	GetDocument () const =0

virtual const K2::UIFlags	GetUIFlags () const =0

virtual void	SetUIFlags (UIFlags uiFlags)=0

virtual bool16	GetDocumentClone () const =0

virtual void	SetDocumentClone (bool16 clonedDocument)=0

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

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Purpose: Data sent with the New document signals (and also Open, Close, Save, Save As, Revert signals). Use by responders to retrieve information during their Respond method in response to various document signals. Typical signals are found in DocumentID.h (kBeforeNewDocSignalResponderService, kDuringNewDocSignalResponderService, etc.) To receive one of these signals you must implement a service provider that returns the signal(s) that you are interested in, then implement a responder that implements the Respond method that will be called at the designated time.

Member Function Documentation

virtual ICommand* IDocumentSignalData::GetCommand ( ) const

pure virtual

Return the command being executed.

Parameters

none

Returns: ICommand

virtual const UIDRef& IDocumentSignalData::GetDocument ( ) const

pure virtual

Return the associated document.

Parameters

none

Returns: const UIDRef& UIDRef of the document. May be UIDRef::gNull.

virtual bool16 IDocumentSignalData::GetDocumentClone ( ) const

pure virtual

Return if document being operated on is a cloned document.

Parameters

none

Returns: kTrue if document being operated on is a cloned document. kFalse for normal document

virtual const IDFile& IDocumentSignalData::GetFile ( ) const

pure virtual

Return the associated file. May be an empty IDFile.

Parameters

none

Returns: const IDFile& a reference to the file.

virtual const K2::UIFlags IDocumentSignalData::GetUIFlags ( ) const

pure virtual

Return the specified UI behavior. Responder may choose to use this it if posts any alerts or warnings.

Parameters

none

Returns: const K2::UIFlags the UI flags in effect.

virtual void IDocumentSignalData::Set	(	ICommand *	documentCmd,
		const IDFile &	file,
		const UIDRef &	doc,
		K2::UIFlags	uiflags
	)

pure virtual

Set up the signal data for the current document signal action.

Parameters

*documentCmd	the command sending the signal, may be nil.
&file	the IDFile for the document in question.
&doc	the UIDRef for the document in question. May be IDRef::gNull.
uiflags

virtual void IDocumentSignalData::SetDocumentClone ( bool16 clonedDocument )

pure virtual

Set the docuemnt clone flags

Parameters

clonedDocument kTrue if document being operated on is a cloned document

virtual void IDocumentSignalData::SetUIFlags ( UIFlags uiFlags )

pure virtual

Set the UI flags

Public Types

Public Member Functions

Detailed Description

Member Function Documentation