SnpManipulateTextOnPath Class Reference

Public Member Functions
	SnpManipulateTextOnPath ()
virtual	~SnpManipulateTextOnPath ()
bool16	CanAddTextOnPath (const UIDRef &splineUIDRef)
ErrorCode	AddTextOnPath (const UIDRef &splineUIDRef)
bool16	CanDeleteTextOnPath (const UIDRef &splineUIDRef)
ErrorCode	DeleteTextOnPath (const UIDRef &splineUIDRef)
ErrorCode	InsertTextIntoTextOnPath (const UIDRef &splineUIDRef, const boost::shared_ptr< WideString > &data)

Detailed Description

• How to add text on a path to a spline,
• how to remove text on a path from a spline,
• how to find the story associated with text on a path and insert text into it.

Constructor & Destructor Documentation

SnpManipulateTextOnPath::SnpManipulateTextOnPath ( )

inline

Constructor.

virtual SnpManipulateTextOnPath::~SnpManipulateTextOnPath ( )

inlinevirtual

Destructor

Member Function Documentation

ErrorCode SnpManipulateTextOnPath::AddTextOnPath

(

const UIDRef &

splineUIDRef

)

Adds text on a path to the spline.

Returns

kSuccess on success, kFailure otherwise.

bool16 SnpManipulateTextOnPath::CanAddTextOnPath

(

const UIDRef &

splineUIDRef

)

Return kTrue if text on a path can be associated with the spline, kFalse otherwise.

Returns

kTrue if text on a path can be associated with the spline, kFalse otherwise.

bool16 SnpManipulateTextOnPath::CanDeleteTextOnPath

(

const UIDRef &

splineUIDRef

)

Return kTrue if the spline has text on a path associated and it can be deleted.

Returns

kTrue if the spline has text on a path associated and it can be deleted.

ErrorCode SnpManipulateTextOnPath::DeleteTextOnPath

(

const UIDRef &

splineUIDRef

)

Remove text on a path from the spline.

Returns

kSuccess on success, kFailure otherwise.

ErrorCode SnpManipulateTextOnPath::InsertTextIntoTextOnPath	(	const UIDRef &	splineUIDRef,
		const boost::shared_ptr< WideString > &	data
	)

Insert the given data string into the story associated with the text on a path that is associated with the given spline.