Public Member Functions
	SnpManipulateTextFrame ()

virtual	~SnpManipulateTextFrame ()

ErrorCode	InspectTextFrame (const UIDRef &graphicFrameUIDRef)

ErrorCode	InspectFrameList (const UIDRef &graphicFrameUIDRef)

ErrorCode	InspectTextInFrame (const UIDRef &graphicFrameUIDRef)

ErrorCode	InspectThreadedTextFrames (const UIDRef &graphicFrameUIDRef)

UIDRef	CreateAndThreadTextFrame (const UIDRef &fromGraphicFrameUIDRef)

ErrorCode	DeleteTextFrame (const UIDRef &graphicFrameUIDRef)

bool16	CanThreadTextFrames (IDataBase *database, const UID &fromGraphicFrameUID, const UID &toGraphicFrameUID)

ErrorCode	ThreadTextFrames (IDataBase *database, const UID &fromGraphicFrameUID, const UID &toGraphicFrameUID)

bool16	CanUnthreadTextFrame (const UIDRef &graphicFrameUIDRef)

ErrorCode	UnthreadTextFrame (const UIDRef &graphicFrameUIDRef)

ErrorCode	IncrementNumberOfColumns (const UIDRef &graphicFrameUIDRef)

ErrorCode	IncrementTextInset (const UIDRef &graphicFrameUIDRef, const PMReal &increment)

ErrorCode	ChangeTextWrapMode (const UIDRef &graphicFrameUIDRef, IStandOff::mode mode)

ErrorCode	SelectTextInFrame (const UIDRef &graphicFrameUIDRef, ISelectionManager *selectionManager)

ErrorCode	SelectFrameDisplayingTextIndex (const UIDRef &graphicFrameUIDRef, ISelectionManager *selectionManager)

ErrorCode	CreateLinkedStory (const UIDRef &sourceTextFrameRef)

ErrorCode	SelectTextAtTextIndex (const UIDRef &graphicFrameUIDRef, ISelectionManager *selectionManager)

bool16	ActivateTextEditor ()

bool16	IsTextFrame (const UIDRef &graphicFrameUIDRef)

UID	GetTextContentUID (const UIDRef &graphicFrameUIDRef)

bool16	IsThreadedTextFrame (const UIDRef &graphicFrameUIDRef)

UIDRef	GetNextGraphicFrame (const UIDRef &graphicFrameUIDRef)

UIDRef	GetPreviousGraphicFrame (const UIDRef &graphicFrameUIDRef)

UIDRef	GetGraphicFrameRef (const InterfacePtr< ITextFrameColumn > &textFrameColumn, const bool16 isTOPFrameAllowed)

InDesign::TextRange	GetTextFrameTextRange (IMultiColumnTextFrame *mcf)

InDesign::TextRange	GetFrameTextRange (const UIDRef &graphicFrameUIDRef)

WideString	GetWideStringFromTextFrame (IMultiColumnTextFrame *mcf)

ITextFrameColumn *	QueryTextFrameContaining (ITextModel *textModel, const TextIndex at)

Detailed Description

How to inspect the structure and properties of a text frame,
how to create and delete a text frame,
how to link text frames together so that text flows between them and how to unlink them,
how change the properties of a text frame such as number of columns, the text inset, the text wrap mode,
how to make sure text is composed and discover the range of text displayed by a text frame,
how to estimate the composed depth of text in a frame,
how to select text displayed in a frame.
how to create linked story.

Integrated the following 2.x code snippets in here so far. SnipNudgeNumTextCols.cpp SnipTextLinkCmd.cpp

Constructor & Destructor Documentation

SnpManipulateTextFrame::SnpManipulateTextFrame ( )

inline

Constructor.

virtual SnpManipulateTextFrame::~SnpManipulateTextFrame ( )

inlinevirtual

Destructor

Member Function Documentation

bool16 SnpManipulateTextFrame::ActivateTextEditor ( )

Activate kIBeamToolBoss if a text tool is not already active.

Returns: kTrue on success, kFalse otherwise.

bool16 SnpManipulateTextFrame::CanThreadTextFrames	(	IDataBase *	database,
		const UID &	fromGraphicFrameUID,
		const UID &	toGraphicFrameUID
	)

Return kTrue if the given text frames can be threaded so that text flows between them, kFalse otherwise. There are a few checks made:

the stories associated with the frames must be unlocked,
if the story underlying toGraphicFrameUID is empty we can link the frame anywhere in the frame list, otherwise we must be appending toGraphicFrameUID onto the end of the frame list underlying fromGraphicFrameUID.

Parameters

database	containing frames to be threaded.
fromGraphicFrameUID	reference to source text frame
toGraphicFrameUID	reference to destination text frame.

Returns: kTrue if the given text frames can be threaded so that text flows between them, kFalse otherwise.

bool16 SnpManipulateTextFrame::CanUnthreadTextFrame ( const UIDRef & graphicFrameUIDRef )

Return kTrue if the given text frames can be unthreaded so that text no longer flows between them, kFalse otherwise.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kTrue if the given text frames can be unthreaded so that text no longer flows between them, kFalse otherwise.

ErrorCode SnpManipulateTextFrame::ChangeTextWrapMode	(	const UIDRef &	graphicFrameUIDRef,
		IStandOff::mode	mode
	)

Adjust the stand off mode of the given frame using ITextWrapFacade.

Parameters

graphicFrameUIDRef	reference to the frame object (kSplineItemBoss).
mode	the kind of stand off to be applied.

Returns: kSuccess on success, other ErrorCode otherwise.

See Also: ITextWrapFacade; ITextWrapSuite; kStandOffModeCmdBoss, kStandOffFormCmdBoss, kStandOffMarginCmdBoss

UIDRef SnpManipulateTextFrame::CreateAndThreadTextFrame ( const UIDRef & fromGraphicFrameUIDRef )

Create a new text frame and thread the out-port of the given text frame to the in-port of the new text frame.

Parameters

fromGraphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::CreateLinkedStory ( const UIDRef & sourceTextFrameRef )

Create an internal or external linked story for the text diaplayed by the given frame.

Parameters

sourceTextFrameRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::DeleteTextFrame ( const UIDRef & graphicFrameUIDRef )

Delete the given text frame.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

InDesign::TextRange SnpManipulateTextFrame::GetFrameTextRange ( const UIDRef & graphicFrameUIDRef )

Return the range of text displayed by the given text frame.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: the range of text displayed by the given frame.

UIDRef SnpManipulateTextFrame::GetGraphicFrameRef	(	const InterfacePtr< ITextFrameColumn > &	textFrameColumn,
		const bool16	isTOPFrameAllowed
	)

Return reference to the text frame's kSplineItemBoss object.

Parameters

textFrameColumn
isTOPFrameAllowed	if kTrue and the given textFrameColumn is a text on a path frame then the kTOPSplineItemBoss reference will be returned, otherwise a kSplineItemBoss reference will be returned.

Returns: reference to the text frame's kSplineItemBoss object.

UIDRef SnpManipulateTextFrame::GetNextGraphicFrame ( const UIDRef & graphicFrameUIDRef )

Return reference to the frame(kSplineItemBoss) into which text from the given frame flows, UIDRef::gNull if there is no next frame.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: reference to the frame(kSplineItemBoss) into which text from the given frame flows, UIDRef::gNull if there is no next frame.

UIDRef SnpManipulateTextFrame::GetPreviousGraphicFrame ( const UIDRef & graphicFrameUIDRef )

Return reference to the frame(kSplineItemBoss) from which text flows into the given frame, UIDRef::gNull if there is no previous frame.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: reference to the frame(kSplineItemBoss) from which text flows into the given frame, UIDRef::gNull if there is no previous frame.

UID SnpManipulateTextFrame::GetTextContentUID ( const UIDRef & graphicFrameUIDRef )

Return UID of the multi-column item (kMultiColumnItemBoss) associated with the given text frame, kInvalidUID if none.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: UID of the multi-column item (kMultiColumnItemBoss) associated with the given text frame, kInvalidUID if none.

InDesign::TextRange SnpManipulateTextFrame::GetTextFrameTextRange ( IMultiColumnTextFrame * mcf )

Return the range of text displayed by the given text frame.

Parameters

mcf

Returns: the range of text displayed by the given frame.

WideString SnpManipulateTextFrame::GetWideStringFromTextFrame ( IMultiColumnTextFrame * mcf )

Return string containing the text displayed in the given text frame.

Parameters

mcf	specifies the frame whose text is wanted.

Returns: string containing the text displayed in the given text frame.

ErrorCode SnpManipulateTextFrame::IncrementNumberOfColumns ( const UIDRef & graphicFrameUIDRef )

Add a column to the given text frame using kChangeNumberOfColumnsCmdBoss.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

See Also: kChangeNumberOfColumnsCmdBoss

ErrorCode SnpManipulateTextFrame::IncrementTextInset	(	const UIDRef &	graphicFrameUIDRef,
		const PMReal &	increment
	)

Adjust the text inset applied to the given text frame using kSetTextInsetCmdBoss.

Parameters

graphicFrameUIDRef	reference to the text frame's kSplineItemBoss object.
increment	the adjustment to be made to the inset on all sides.

Returns: kSuccess on success, other ErrorCode otherwise.

See Also: kSetTextInsetCmdBoss; ITextFrameOptionsSuite and ITextFrameOptionsData; ITextFrameDialogUtils/ITextFrameOptionsData

ErrorCode SnpManipulateTextFrame::InspectFrameList ( const UIDRef & graphicFrameUIDRef )

Inspect the structure of the frame list and story associated with a text frame.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::InspectTextFrame ( const UIDRef & graphicFrameUIDRef )

Inspect the structure of a text frame.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::InspectTextInFrame ( const UIDRef & graphicFrameUIDRef )

Inspect the characters displayed in a text frame.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::InspectThreadedTextFrames ( const UIDRef & graphicFrameUIDRef )

Inspect the frames that preceed and succeed the given text frame, text can flow between threaded frames.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

bool16 SnpManipulateTextFrame::IsTextFrame ( const UIDRef & graphicFrameUIDRef )

Return kTrue if the given frame is a text frame, kFalse otherwise.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

bool16 SnpManipulateTextFrame::IsThreadedTextFrame ( const UIDRef & graphicFrameUIDRef )

Return kTrue if text flows into the given frame another frame or if text flows out of the given frame into another frame, kFalse otherwise.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

ITextFrameColumn * SnpManipulateTextFrame::QueryTextFrameContaining	(	ITextModel *	textModel,
		const TextIndex	at
	)

Return interface pointer to text frame that displays the given TextIndex or nil if the TextIndex is not displayed.

Parameters

textModel
at

Returns: interface pointer to text frame that displays the given TextIndex or nil if the TextIndex is not displayed.

InterfacePtr<IFrameList> frameList(textModel->QueryFrameList());

ErrorCode SnpManipulateTextFrame::SelectFrameDisplayingTextIndex	(	const UIDRef &	graphicFrameUIDRef,
		ISelectionManager *	selectionManager
	)

Prompt for a TextIndex then select the frame displaying the character at that position.

Parameters

graphicFrameUIDRef	reference to the text frame's kSplineItemBoss object.
selectionManager

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::SelectTextAtTextIndex	(	const UIDRef &	graphicFrameUIDRef,
		ISelectionManager *	selectionManager
	)

Prompt for a TextIndex then select the character at that position.

Parameters

graphicFrameUIDRef	reference to the text frame's kSplineItemBoss object.
selectionManager

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::SelectTextInFrame	(	const UIDRef &	graphicFrameUIDRef,
		ISelectionManager *	selectionManager
	)

Select all of the text displayed by the given frame.

Parameters

graphicFrameUIDRef	reference to the text frame's kSplineItemBoss object.
selectionManager

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::ThreadTextFrames	(	IDataBase *	database,
		const UID &	fromGraphicFrameUID,
		const UID &	toGraphicFrameUID
	)

Connects text flow between text frames using kTextLinkCmdBoss. The out-port of the frame given by parameter fromGraphicFrameUID is linked to the in-port of the frame given by parameter toGraphicFrameUID.

Parameters

database	containing objects to be linked.
fromGraphicFrameUID	reference to source text frame.
toGraphicFrameUID	reference to destination text frame.

Returns: kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateTextFrame::UnthreadTextFrame ( const UIDRef & graphicFrameUIDRef )

Disconnect text flow between text frames using kTextUnlinkCmdBoss.

Parameters

graphicFrameUIDRef reference to the text frame's kSplineItemBoss object.

Returns: kSuccess on success, other ErrorCode otherwise.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation