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

#include <ISpellingDataStrand.h>

Inheritance diagram for ISpellingStateData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISPELLINGSTATECMDDATA }
 

Public Member Functions

virtual void Set (UIDRef &spellingDataStrandRef, UIDRef &modelRef, SpellingState spellingState, TextIndex start, int32 length)=0
 
virtual void GetSpellingStrandRef (UIDRef &ref)=0
 
virtual void GetModelRef (UIDRef &ref)=0
 
virtual void GetSpellingState (SpellingState &spellingState)=0
 
virtual void GetStartTextIndex (TextIndex &start)=0
 
virtual void GetLength (int32 &length)=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

Interface for getting/setting the Spelling State data in the Spelling Data Strand

Member Function Documentation

virtual void ISpellingStateData::GetLength (int32 & length)
pure virtual

Get the state data's length

Parameters
lengthOUT: character length
virtual void ISpellingStateData::GetModelRef (UIDRefref)
pure virtual

Get the state data's textmodel's UIDRef

Parameters
refOUT: text model's UIDRef
virtual void ISpellingStateData::GetSpellingState (SpellingState & spellingState)
pure virtual

Get the state data's SpellingState

Parameters
nOUT: spelling state: spelling state
virtual void ISpellingStateData::GetSpellingStrandRef (UIDRefref)
pure virtual

Get the state data's spelling strand's UIDRef

Parameters
refOUT: UIDRef of the spelling data strand
virtual void ISpellingStateData::GetStartTextIndex (TextIndex & start)
pure virtual

Get the state data's starting text index

Parameters
startOUT: start index
virtual void ISpellingStateData::Set (UIDRefspellingDataStrandRef,
UIDRefmodelRef,
SpellingState spellingState,
TextIndex start,
int32 length 
)
pure virtual

Set the spelling state data

Parameters
spellingDataStrandRefspelling data strand UIDRef
modelReftextmodel UIDRef
spellingStatespelling state
startstarting text index
lengthlength of data