InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
_SnpRunnerInspectTextModel Class Reference
Inheritance diagram for _SnpRunnerInspectTextModel:
SnpRunnable

Public Member Functions

bool16 CanRun (ISnpRunnableContext *runnableContext)
 
ErrorCode Run (ISnpRunnableContext *runnableContext)
 
virtual
ISnipRunSuite::eSnpRunContextType 
GetContext (void)
 
- Public Member Functions inherited from SnpRunnable
 SnpRunnable (ConstCString name)
 
virtual ~SnpRunnable ()
 
virtual ConstCString GetName () const
 
virtual ConstCString GetDescription () const
 
virtual ConstCString GetPreconditions () const
 
virtual ConstCString GetCategories () const
 
virtual ErrorCode RunUnitTest (ISnpRunnableContext *runnableContext)
 
virtual bool16 CanLoad () const
 
virtual ErrorCode SetupContext (ISnpRunnableContext *runnableContext)
 

Additional Inherited Members

- Protected Member Functions inherited from SnpRunnable
virtual void SetDescription (ConstCString description)
 
virtual void SetPreconditions (ConstCString preconditions)
 
virtual void SetCategories (ConstCString categories)
 

Detailed Description

Makes the snippet SnpInspectTextModel available to the SnippetRunner framework.

Member Function Documentation

bool16 _SnpRunnerInspectTextModel::CanRun (ISnpRunnableContextrunnableContext)
virtual

Can the snippet run? Snippets must implement this method and use the given ISnpRunnableContext to figure out if they can run.

Parameters
runnableContext
Returns
kTrue if preconditions for running are met, kFalse otherwise.

Implements SnpRunnable.

virtual ISnipRunSuite::eSnpRunContextType _SnpRunnerInspectTextModel::GetContext (void )
inlinevirtual

get the snippet context

Returns
eSnpRunContextType for this snippet

Implements SnpRunnable.

ErrorCode _SnpRunnerInspectTextModel::Run (ISnpRunnableContextrunnableContext)
virtual

Run the snippet using the context given by ISnpRunnableContext.

Parameters
runnableContextparameters
Returns
kSuccess on success, other ErrorCode otherwise

Implements SnpRunnable.