_SnpRunnerPerformTextAttrTateChuYoko Class Reference

Inheritance diagram for _SnpRunnerPerformTextAttrTateChuYoko:

Public Types
enum	eSnipTateChuYokoOpcode {   kInspect, kApplyTateChuYoko, kRemoveTateChuYoko, kApplyAutomaticTateChuYoko,   kRemoveAutomaticTateChuYoko, kCancelled }

Public Member Functions
	_SnpRunnerPerformTextAttrTateChuYoko ()
virtual	~_SnpRunnerPerformTextAttrTateChuYoko ()
bool16	CanRun (ISnpRunnableContext *runnableContext)
ErrorCode	Run (ISnpRunnableContext *runnableContext)
bool16	CanLoad () const
virtual ISnipRunSuite::eSnpRunContextType	GetContext (void)
eSnipTateChuYokoOpcode	GetParameters (const InDesign::TextRange &textRange, SnpTateChuYokoSttings &TCYData)
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 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)

Member Enumeration Documentation

enum _SnpRunnerPerformTextAttrTateChuYoko::eSnipTateChuYokoOpcode

Indicates the type of operation, as specified by the SnippetRunner parameters.

Enumerator
kInspect	"inspect" operation
kApplyTateChuYoko	"apply" operation
kRemoveTateChuYoko	"remove" operation
kApplyAutomaticTateChuYoko	"apply" automatic tatechuyoko operation on paragraph
kRemoveAutomaticTateChuYoko	"remove" automatic tatechuyoko operation on paragraph
kCancelled	Cancelled

Constructor & Destructor Documentation

_SnpRunnerPerformTextAttrTateChuYoko::_SnpRunnerPerformTextAttrTateChuYoko

(

)

Constructor.

_SnpRunnerPerformTextAttrTateChuYoko::~_SnpRunnerPerformTextAttrTateChuYoko ( )

virtual

Destructor.

Member Function Documentation

bool16 _SnpRunnerPerformTextAttrTateChuYoko::CanLoad ( void  ) const

virtual

Only present this snippet in the framework's UI if the language feature set is Japanese and the product is not InCopy.

Returns

kTrue if the snippet can be loaded, kFalse otherwise.

Reimplemented from SnpRunnable.

bool16 _SnpRunnerPerformTextAttrTateChuYoko::CanRun ( ISnpRunnableContext *  runnableContext )

virtual

Return kTrue if the snippet can run.

Parameters

runnableContext

see ISnpRunnableContext for documentation.

Returns

kTrue if snippet can run, kFalse otherwise

Implements SnpRunnable.

virtual ISnipRunSuite::eSnpRunContextType _SnpRunnerPerformTextAttrTateChuYoko::GetContext ( void  )

inlinevirtual

get the snippet context

Returns

eSnpRunContextType for this snippet

Implements SnpRunnable.

_SnpRunnerPerformTextAttrTateChuYoko::eSnipTateChuYokoOpcode _SnpRunnerPerformTextAttrTateChuYoko::GetParameters	(	const InDesign::TextRange &	textRange,
		SnpTateChuYokoSttings &	TCYData
	)

Get parameters and populates the SnpTateChuYokoSttings.

Parameters

textRange	(in) The text range to use as a basis for some TateChuYoko settings.
TCYData	(out) The filled out SnpTateChuYokoSttings structure.

Returns

The operation type indicated by the parameters.

ErrorCode _SnpRunnerPerformTextAttrTateChuYoko::Run ( ISnpRunnableContext *  runnableContext )

virtual

Run the snippet.

Parameters

runnableContext

see ISnpRunnableContext for documentation.

Returns

kSuccess on success, other ErrorCode otherwise.

Implements SnpRunnable.