InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnipRunSuiteASB Class Reference
Inheritance diagram for SnipRunSuiteASB:
CPMUnknown< ISnipRunSuite >ISnipRunSuiteIPMUnknown

Public Member Functions

 SnipRunSuiteASB (IPMUnknown *boss)
 
virtual ~SnipRunSuiteASB ()
 
virtual void GetSnippetNames (SnippetNames &snippetNames) const
 
virtual bool16 IsRegistered (const SnippetName &snippetName) const
 
virtual void GetCategories (const SnippetName &snippetName, Categories &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 >
IPMUnknownQueryInterface (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
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

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< SnippetNameSnippetNames
 
typedef PMString Category
 
typedef K2Vector< CategoryCategories
 
- Protected Member Functions inherited from CPMUnknown< ISnipRunSuite >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< ISnipRunSuite >
HelperInterface fHelperInterface
 

Detailed Description

ISnipRunSuite abstract selection boss(ASB) suite implementation.

See Also
ISnipRunSuite

Constructor & Destructor Documentation

SnipRunSuiteASB::SnipRunSuiteASB (IPMUnknownboss)

Constructor.

SnipRunSuiteASB::~SnipRunSuiteASB ()
virtual

Destructor.

Member Function Documentation

bool16 SnipRunSuiteASB::CanRun (const SnippetNamesnippetName) const
virtual
void SnipRunSuiteASB::GetCategories (const SnippetNamesnippetName,
Categoriescategories 
) const
virtual
void SnipRunSuiteASB::GetDescription (const SnippetNamesnippetName,
PMStringdescription 
) const
virtual
void SnipRunSuiteASB::GetPreconditions (const SnippetNamesnippetName,
PMStringpreconditions 
) const
virtual
void SnipRunSuiteASB::GetSnippetNames (SnippetNamessnippetNames) const
virtual
bool16 SnipRunSuiteASB::IsRegistered (const SnippetNamesnippetName) const
virtual
ErrorCode SnipRunSuiteASB::Run (const SnippetNamesnippetName,
PMStringparameters,
bool16 enableParameterDialog 
) const
virtual
ErrorCode SnipRunSuiteASB::SetupContext (const SnippetNamesnippetName)
virtual