SnpPerformNamedGrid Class Reference

Public Member Functions
	SnpPerformNamedGrid ()
virtual	~SnpPerformNamedGrid ()
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)

Detailed Description

• Inspects a named grid,
• Creates a new named grid,
• Deletes an existing named grid.

See Also

ICJKGridData

ICJKFrameGridDefaults

ICJKLayoutGridDefaults

ICJKGridSuite

IFilteredCJKGridCmdData

INamedGridInfo

INamedGridUID

IStyleNameTable

IUIDData

kCreateNamedGridCmdBoss

kFilteredCJKGridDataBoss

kDeleteNamedGridCmdBoss

Constructor & Destructor Documentation

SnpPerformNamedGrid::SnpPerformNamedGrid ( )

inline

Constructor.

virtual SnpPerformNamedGrid::~SnpPerformNamedGrid ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpPerformNamedGrid::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 SnpPerformNamedGrid::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.

K2Vector< PMString > SnpPerformNamedGrid::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 SnpPerformNamedGrid::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 SnpPerformNamedGrid::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 SnpPerformNamedGrid::ReportNamedGridData

(

const SnpNamedGridSettings &

data

)

Reports the named grid data to SNIPLOG.

Parameters

data	IN The named grid settings to report.