ITextRanges Class Reference

Inheritance diagram for ITextRanges:

Public Types
enum	{ kDefaultIID = IID_ITEXTRANGES }

Public Member Functions
virtual K2Vector < InDesign::TextRange > *	CreateTextRanges ()=0
virtual K2Vector < InDesign::TextRange > *	CreateThreadSafeTextRanges ()=0
virtual bool16	HasMultipleTextRanges ()=0
virtual InDesign::TextRange	GetFirstTextRange ()=0
virtual UIDList	GetSelectedStories ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual K2Vector<InDesign::TextRange>* ITextRanges::CreateTextRanges ( )

pure virtual

Creates a Vector of TextRanges. Resulting ranges may cross story thread boundaries.

Returns

a vector of text ranges. The caller is responsible for delete'ing the memory allocated for this K2Vector.

virtual K2Vector<InDesign::TextRange>* ITextRanges::CreateThreadSafeTextRanges ( )

pure virtual

Creates a Vector of TextRanges. Resulting ranges will not cross story thread boundaries.

Returns

a vector of text ranges. The caller is responsible for delete'ing the memory allocated for this K2Vector.

virtual InDesign::TextRange ITextRanges::GetFirstTextRange ( )

pure virtual

Return a single text range the represents the first part of the selection.

Returns

whatever the implementation calls the first text range.

virtual UIDList ITextRanges::GetSelectedStories ( )

pure virtual

Return a list of all TextModel UIDs in the selected ranges. @ return a UIDList of all TextModel UIDs.

virtual bool16 ITextRanges::HasMultipleTextRanges ( )

pure virtual

An easier way to determine there are multiple ranges than asking for them all. The definition of multiple text ranges is somewhat up to the implementation. For example, if you select text across 2 frames, you have 1 selection, but if you select 2 text frames you have 2.

Returns

whether there are multiple text ranges.