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

Public Member Functions

 _SnpRunnerContentDropper ()
 
virtual ~_SnpRunnerContentDropper ()
 
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 SnpContentDropper available to the SnippetRunner framework.

Constructor & Destructor Documentation

_SnpRunnerContentDropper::_SnpRunnerContentDropper ()

This constructor describes your snippet to the framework.

_SnpRunnerContentDropper::~_SnpRunnerContentDropper ()
virtual

Destructor.

Member Function Documentation

bool16 _SnpRunnerContentDropper::CanRun (ISnpRunnableContextrunnableContext)
virtual

Return kTrue if the snippet can run.

Parameters
runnableContextsee ISnpRunnableContext for documentation.
Returns
kTrue if snippet can run, kFalse otherwise

Implements SnpRunnable.

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

get the snippet context

Returns
eSnpRunContextType for this snippet

Implements SnpRunnable.

ErrorCode _SnpRunnerContentDropper::Run (ISnpRunnableContextrunnableContext)
virtual

Run the snippet.

Parameters
runnableContextsee ISnpRunnableContext for documentation.
Returns
kSuccess on success, other ErrorCode otherwise.

Implements SnpRunnable.