_SnpRunnerPerformNamedGrid Class Reference

Inheritance diagram for _SnpRunnerPerformNamedGrid:

Public Member Functions
ErrorCode	InspectNamedGrid (IWorkspace *workspace, const UID &namedGridUID, SnpNamedGridSettings &data)
ErrorCode	CreateNamedGrid (IWorkspace *workspace, IFilteredCJKGridCmdData *filteredGridData, PMString &gridName)
ErrorCode	InitializeNewCJKGridData (IWorkspace *workspace, IFilteredCJKGridCmdData *filteredGridData, ICJKGridData *gridData)
ErrorCode	DeleteNamedGrid (IWorkspace *workspace, const PMString &name)
K2Vector< PMString >	GetNamedGridList (IStyleNameTable *styleNameTable)
void	ReportNamedGridData (const SnpNamedGridSettings &data)
	_SnpRunnerPerformNamedGrid ()
virtual	~_SnpRunnerPerformNamedGrid ()
bool16	CanRun (ISnpRunnableContext *runnableContext)
ErrorCode	Run (ISnpRunnableContext *runnableContext)
bool16	CanLoad () const
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 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)

Constructor & Destructor Documentation

_SnpRunnerPerformNamedGrid::_SnpRunnerPerformNamedGrid

(

)

Constructor.

_SnpRunnerPerformNamedGrid::~_SnpRunnerPerformNamedGrid ( )

virtual

Destructor.

Member Function Documentation

bool16 _SnpRunnerPerformNamedGrid::CanLoad ( void  ) const

virtual

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

Returns

kTrue if the snippet can be loaded, kFalse otherwise.

Reimplemented from SnpRunnable.

bool16 _SnpRunnerPerformNamedGrid::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.

ErrorCode _SnpRunnerPerformNamedGrid::CreateNamedGrid	(	IWorkspace *	workspace,
		IFilteredCJKGridCmdData *	filteredGridData,
		PMString &	gridName
	)

Creates a new named grid based on default grid data.

Parameters

workspace	IN The workspace that contains the named grid to be created.
filteredGridData	IN A part of ICJKGridData with the change of the selection frame.
gridName	IN/OUT The name for The new named grid. When there is no name, a name is given automatically, and NamedGrid is made.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode _SnpRunnerPerformNamedGrid::DeleteNamedGrid	(	IWorkspace *	workspace,
		const PMString &	name
	)

Delete a named grid.

Parameters

workspace	IN The workspace that contains the named grid to be created.
name	IN The name for the named grid that is to be deleted.

Returns

kSuccess on success, other ErrorCode otherwise.

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

inlinevirtual

get the snippet context

Returns

eSnpRunContextType for this snippet

Implements SnpRunnable.

K2Vector<PMString> _SnpRunnerPerformNamedGrid::GetNamedGridList

(

IStyleNameTable *

styleNameTable

)

Gets the name list of the named grids.

Parameters

styleNameTable

IN The IStyleNameTable interface for named grid on a specific workspace.

Returns

A list of named grids.

ErrorCode _SnpRunnerPerformNamedGrid::InitializeNewCJKGridData	(	IWorkspace *	workspace,
		IFilteredCJKGridCmdData *	filteredGridData,
		ICJKGridData *	gridData
	)

Initialize a grid data. The conditions of InDesign are investigated. Then, the grid data given to it are initialized corresponding to the conditions.

Parameters

workspace	IN The workspace that contains the named grid to be created.
filteredGridData	IN A part of ICJKGridData with the change of the selection frame.
gridData	OUT The Grid data to initialize.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode _SnpRunnerPerformNamedGrid::InspectNamedGrid	(	IWorkspace *	workspace,
		const UID &	namedGridUID,
		SnpNamedGridSettings &	data
	)

Inspect a named grid.

Parameters

workspace	IN The workspace that contains the named grid to be inspected.
namedGridUID	IN The UID for the named grid that is to be inspected.
data	OUT The named grid data for the given UID.

Returns

kSuccess on success, other ErrorCode otherwise.

void _SnpRunnerPerformNamedGrid::ReportNamedGridData

(

const SnpNamedGridSettings &

data

)

Reports the named grid data to SNIPLOG.

Parameters

data	IN The named grid settings to report.

ErrorCode _SnpRunnerPerformNamedGrid::Run ( ISnpRunnableContext *  runnableContext )

virtual

Run the snippet.

Parameters

runnableContext

see ISnpRunnableContext for documentation.

Returns

kSuccess on success, other ErrorCode otherwise.

Implements SnpRunnable.