#include <IPathPointScriptUtils.h>

Inheritance diagram for IPathPointScriptUtils:

Public Types
enum	{ kDefaultIID = IID_IPATHPOINTSCRIPTUTILS }

Public Member Functions
virtual IScript *	QueryNthPath (const IScriptRequestData data, IScript pageitem, int32 n) const =0

virtual IScript *	QueryNthPoint (const IScriptRequestData data, IScript path, int32 n) const =0

virtual IPMUnknown *	QueryParentForInterface (IScript *script, PMIID iid, const RequestContext &context) const =0

virtual int32	GetPathIndex (IScript *pathOrPoint) const =0

virtual int32	GetPointIndex (IScript *point) const =0

virtual ErrorCode	AccessPoint_Get (IScriptRequestData data, IPathGeometry pathGeom, int32 pathIndex, int32 pointIndex, PathPointIndex ptIndex, const PMPoint &offsetPoint, ScriptData &scriptData) const =0

virtual ErrorCode	AccessPoint_Set (IScriptRequestData data, IPathGeometry pathGeom, int32 pathIndex, int32 pointIndex, PathPointIndex ptIndex, const PMPoint &offsetPoint, const ScriptData &scriptData) const =0

virtual ICommand *	CreateModifyTypeCmd (IPathGeometry *pathGeom, int32 pathIndex, int32 pointIndex, PMPathPointType type, bool16 symmetrical=kFalse) const =0

virtual ICommand *	CreateModifyPointCmd (IPathGeometry *pathGeom, int32 pathIndex, int32 pointIndex, PathPointIndex ptIndex, const PBPMPoint &pt) const =0

virtual ICommand *	CreateSetPathAnchorsCmd (IScriptRequestData data, IPathGeometry pathGeom, int32 pathIndex, const PMPoint &offsetPoint, ScriptListData &listData) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Utility methods related to path and path point proxy objects in scripting.


Utils<IPathPointScriptUtils>()->QueryNthPath(...) ;

Member Function Documentation

virtual ErrorCode IPathPointScriptUtils::AccessPoint_Get	(	IScriptRequestData *	data,
		IPathGeometry *	pathGeom,
		int32	pathIndex,
		int32	pointIndex,
		PathPointIndex	ptIndex,
		const PMPoint &	offsetPoint,
		ScriptData &	scriptData
	)		const

pure virtual

Get the coordinates of a path point

Parameters

data	is the script event data
pathGeom	is the page item IN
pathIndex	is the path index IN
pointIndex	is the point index IN
ptIndex	is the handle within the point IN
offsetPoint	is the spread offset IN
scriptData	is the coordinates of the path point OUT

Returns: kSuccess if the coordinates were found, kFailure otherwise

virtual ErrorCode IPathPointScriptUtils::AccessPoint_Set	(	IScriptRequestData *	data,
		IPathGeometry *	pathGeom,
		int32	pathIndex,
		int32	pointIndex,
		PathPointIndex	ptIndex,
		const PMPoint &	offsetPoint,
		const ScriptData &	scriptData
	)		const

pure virtual

Set the coordinates of a path point

Parameters

data	is the script event data
pathGeom	is the page item IN
pathIndex	is the path index IN
pointIndex	is the point index IN
ptIndex	is the handle within the point IN
offsetPoint	is the spread offset IN
scriptData	is the coordinates of the path point IN

Returns: the return code of the command to set the coordinates

virtual ICommand* IPathPointScriptUtils::CreateModifyPointCmd	(	IPathGeometry *	pathGeom,
		int32	pathIndex,
		int32	pointIndex,
		PathPointIndex	ptIndex,
		const PBPMPoint &	pt
	)		const

pure virtual

Create a command to modify the coordinates of a path point

Parameters

pathGeom	is the page item IN
pathIndex	is the path index IN
pointIndex	is the point index IN
ptIndex	is the handle within the point IN
pt	is the new coordinates IN

Returns: the unexecuted command

virtual ICommand* IPathPointScriptUtils::CreateModifyTypeCmd	(	IPathGeometry *	pathGeom,
		int32	pathIndex,
		int32	pointIndex,
		PMPathPointType	type,
		bool16	symmetrical = `kFalse`
	)		const

pure virtual

Create a command to modify a path point's type

Parameters

pathGeom	is the page item IN
pathIndex	is the path index IN
pointIndex	is the point index IN
type	is the new type IN
symmetrical	if kTrue and type is kCS, the make the two direction lines the same length IN

Returns: the unexecuted command

virtual ICommand* IPathPointScriptUtils::CreateSetPathAnchorsCmd	(	IScriptRequestData *	data,
		IPathGeometry *	pathGeom,
		int32	pathIndex,
		const PMPoint &	offsetPoint,
		ScriptListData &	listData
	)		const

pure virtual

Create a command to modify all the points on a path

Parameters

data	is the script event data
pathGeom	is the page item IN
pathIndex	is the path index IN
offsetPoint	is the spread offset IN
listData	is the new coordinates for the path's points IN

Returns: the unexecuted command

virtual int32 IPathPointScriptUtils::GetPathIndex ( IScript * pathOrPoint ) const

pure virtual

Determine the 0-based index of the path that is represented by a proxy script object

Parameters

pathOrPoint is the proxy script object

Returns: the index

virtual int32 IPathPointScriptUtils::GetPointIndex ( IScript * point ) const

pure virtual

Determine the 0-based index of the path point that is represented by a proxy script object

Parameters

point is the proxy script object

Returns: the index

virtual IScript* IPathPointScriptUtils::QueryNthPath	(	const IScriptRequestData *	data,
		IScript *	pageitem,
		int32	n
	)		const

pure virtual

Create a new path proxy object

Parameters

data	is the script event data
pageitem	is the parent page item
n	is the 0-based index of the path

Returns: the new proxy path object

virtual IScript* IPathPointScriptUtils::QueryNthPoint	(	const IScriptRequestData *	data,
		IScript *	path,
		int32	n
	)		const

pure virtual

Create a new path point proxy object

Parameters

data	is the script event data
path	is the parent path
n	is the 0-based index of the path point

Returns: the new proxy path point object

virtual IPMUnknown* IPathPointScriptUtils::QueryParentForInterface	(	IScript *	script,
		PMIID	iid,
		const RequestContext &	context
	)		const

pure virtual

Query parents up the hierarchy until a specified interface is found

See Also: IHierarchy

Parameters

script	is the child object of which to query the parents
iid	is the desired interface
context	provides the scripting context for this request IN

Returns: the desired interface on a parent, or nil if no parent with the specified interface is found

Public Types

Public Member Functions

Detailed Description

Member Function Documentation