InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextStrand Class Referenceabstract

#include <ITextStrand.h>

Inheritance diagram for ITextStrand:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTSTRAND }
 

Public Member Functions

virtual DataWrapper< textchar > FindChunk (TextIndex begin, int32 *len, TextIndex *chunkstart=nil)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Abstract interface that all textstrands must implement.

Member Function Documentation

virtual DataWrapper<textchar> ITextStrand::FindChunk (TextIndex begin,
int32 * len,
TextIndex * chunkstart = nil 
)
pure virtual

Find the contiguous chunk of text stored in the strand (text in strand may be fragmented).

Parameters
beginIN position to look at.
lenOUT number of characters from offset
beginIN to the end of the chunk.
chukstartOUT is the text index where the chunk starts.
Returns
DataWrapper is a reference to the contiguous text chunk which allows iteration over the text one character at a time. Using index 0 gives the character which happens to be at offset begin in the story.