SnipRunSuiteCSB Class Reference

Inheritance diagram for SnipRunSuiteCSB:

Public Member Functions
	SnipRunSuiteCSB (IPMUnknown *boss)
virtual	~SnipRunSuiteCSB ()
virtual void	GetSnippetNames (SnippetNames &snippetNames) const
virtual bool16	IsRegistered (const SnippetName &snippetName) const
virtual void	GetCategories (const SnippetName &snippetName, K2Vector< PMString > &categories) const
virtual void	GetDescription (const SnippetName &snippetName, PMString &description) const
virtual void	GetPreconditions (const SnippetName &snippetName, PMString &preconditions) const
virtual bool16	CanRun (const SnippetName &snippetName) const
ErrorCode	Run (const SnippetName &snippetName, PMString &parameters, bool16 enableParameterDialog) const
virtual ErrorCode	SetupContext (const SnippetName &snippetName)
Public Member Functions inherited from CPMUnknown< ISnipRunSuite >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete
Public Member Functions inherited from ISnipRunSuite
virtual void	GetCategories (const SnippetName &snippetName, Categories &categories) const =0

Additional Inherited Members
Public Types inherited from ISnipRunSuite
enum	{ kDefaultIID = IID_ISNIPRUNSUITE }
enum	eSnpRunContextType {   kSnpRunNoContext, kSnpRunWorkspaceContext, kSnpRunFrontDocContext, kSnpRunLayoutTargetContext,   kSnpRunTextTargetContext, kSnpRunTextSelectionTargetContext, kSnpRunTableTargetContext, kSnpRunCustomContext }
typedef PMString	SnippetName
typedef K2Vector< SnippetName >	SnippetNames
typedef PMString	Category
typedef K2Vector< Category >	Categories
Protected Member Functions inherited from CPMUnknown< ISnipRunSuite >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< ISnipRunSuite >
HelperInterface	fHelperInterface

Detailed Description

ISnipRunSuite concrete selection boss(CSB) suite implementation, aggregated onto each CSB supported by the appication. Uses SnipRunManager to find and call the requested snippet.

See Also

ISnipRunSuite

Constructor & Destructor Documentation

SnipRunSuiteCSB::SnipRunSuiteCSB

(

IPMUnknown *

boss

)

Constructor.

SnipRunSuiteCSB::~SnipRunSuiteCSB ( )

virtual

Destructor.

Member Function Documentation

bool16 SnipRunSuiteCSB::CanRun ( const SnippetName &  snippetName ) const

virtual

Uses SnipRunManager to get hold of the requested snippet, sets up the context and calls the snippet. See ISnipRunSuite::CanRun for more documentation.

Implements ISnipRunSuite.

void SnipRunSuiteCSB::GetCategories ( const SnippetName &  snippetName, K2Vector< PMString > &  categories  ) const

virtual

See ISnipRunSuite::GetCategories.

void SnipRunSuiteCSB::GetDescription ( const SnippetName &  snippetName, PMString &  description  ) const

virtual

See ISnipRunSuite::GetDescription.

Implements ISnipRunSuite.

void SnipRunSuiteCSB::GetPreconditions ( const SnippetName &  snippetName, PMString &  preconditions  ) const

virtual

See ISnipRunSuite::GetPreconditions.

Implements ISnipRunSuite.

void SnipRunSuiteCSB::GetSnippetNames ( SnippetNames &  snippetNames ) const

virtual

See ISnipRunSuite::GetSnippetNames.

Implements ISnipRunSuite.

bool16 SnipRunSuiteCSB::IsRegistered ( const SnippetName &  snippetName ) const

virtual

See ISnipRunSuite::IsRegistered.

Implements ISnipRunSuite.

ErrorCode SnipRunSuiteCSB::Run ( const SnippetName &  snippetName, PMString &  parameters, bool16  enableParameterDialog  ) const

virtual

Uses SnipRunManager to get hold of the requested snippet, sets up the context and calls the snippet. See ISnipRunSuite::Run for more documentation.

Implements ISnipRunSuite.

ErrorCode SnipRunSuiteCSB::SetupContext ( const SnippetName &  snippetName )

virtual

Set up the proper InDesign context for the snippert so that it can be run.

Parameters

runnableContext

Returns

kSuccess on success, other ErrorCode otherwise

Implements ISnipRunSuite.