InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IHidTxtModel Class Referenceabstract
HiddenText

#include <IHidTxtModel.h>

Inheritance diagram for IHidTxtModel:
IPMUnknownCPMUnknown< IHidTxtModel >HidTxtModel

Public Types

enum  { kDefaultIID = IID_IHIDTXTMODEL }
 

Public Member Functions

virtual ITextModel * QueryTextModel () const =0
 
virtual bool16 GetAnchorTextRange (TextIndex &start, int32 &span) const =0
 
virtual bool16 GetHiddenTextRange (TextIndex &start, int32 &span) const =0
 
virtual ErrorCode AttachToTextModel (UID textModelUID, const TextIndex &anchorTextIndex)=0
 
virtual ErrorCode DetachFromTextModel ()=0
 
virtual bool16 GetConnectedToTextContent () const =0
 
virtual void SetConnectedToTextContent (bool16 connected)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

From SDK sample; signature interface for the hidden text model (kHidTxtModelBoss) that manages the hidden text.

Member Enumeration Documentation

anonymous enum

kDefaultIID

Member Function Documentation

virtual ErrorCode IHidTxtModel::AttachToTextModel (UID textModelUID,
const TextIndex & anchorTextIndex 
)
pure virtual

Associate this boss object with the given text model and anchor it on the given TextIndex.

Parameters
textModelUID
anchorTextIndex

Implemented in HidTxtModel.

virtual ErrorCode IHidTxtModel::DetachFromTextModel ()
pure virtual

Disassociate this boss object from the text model.

Implemented in HidTxtModel.

virtual bool16 IHidTxtModel::GetAnchorTextRange (TextIndex & start,
int32 & span 
) const
pure virtual

Provides the range of text in the text model on which the hidden text is anchored.

Parameters
startindex in the text model where the hidden text is anchored.
spancurrently always 1 since hidden text is anchored on a kTextChar_ZeroSpaceNoBreak character.
Returns
kTrue on if data is available, kFalse otherwise.

Implemented in HidTxtModel.

virtual bool16 IHidTxtModel::GetConnectedToTextContent () const
pure virtual
Returns
kTrue if this boss object is associated with hidden text content in the text model, kFalse otherwise.

Implemented in HidTxtModel.

virtual bool16 IHidTxtModel::GetHiddenTextRange (TextIndex & start,
int32 & span 
) const
pure virtual

Provides the range of text in the text model in which the hidden text is stored.

Parameters
startindex in the text model to the first character of hidden text
spannumber of characters of hidden text stored (>= 1 since hidden text is always terminated by a kTextChar_CR character).
Returns
kTrue on if data is available, kFalse otherwise.

Implemented in HidTxtModel.

virtual ITextModel* IHidTxtModel::QueryTextModel () const
pure virtual

Return interface pointer to the text model that stores the hidden text.

Returns
interface pointer to the text model that stores the hidden text, nil if this is not known.

Implemented in HidTxtModel.

virtual void IHidTxtModel::SetConnectedToTextContent (bool16 connected)
pure virtual

Set or clear the ConnectedToTextContent flag; at certain stages during text model operations the hidden text model may not be completely connected to the story thread in the text model that stores the hidden text.

Parameters
connectedkTrue if this boss object is associated with hidden text content in the text model, kFalse otherwise.

Implemented in HidTxtModel.