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

#include <ITextEditor.h>

Inheritance diagram for ITextEditor:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTEDITOR }
 

Public Member Functions

virtual void ActivateTextEditor (IConcreteSelection *)=0
 
virtual void DeactivateTextEditor ()=0
 
virtual ITextFocus * QueryTextFocus ()=0
 
virtual ITextCaret * QueryTextCaret ()=0
 
virtual ILayoutControlData * QueryLayoutControlData ()=0
 
virtual IFrameList * QueryFrameList ()=0
 
virtual bool16 IsActive ()=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

Interface for kTextEditorBoss, to active/deactivate the text editor and to get text caret information

Member Function Documentation

virtual void ITextEditor::ActivateTextEditor (IConcreteSelection * )
pure virtual

Activate the text editor

Parameters
IConcreteSelection*The IConcreteSelection in the view
virtual void ITextEditor::DeactivateTextEditor ()
pure virtual

Deactivate the text editor

Parameters
none
virtual bool16 ITextEditor::IsActive ()
pure virtual

Is the text editor active?

Parameters
none
Returns
bool16 kTrue means the text editor is active
virtual IFrameList* ITextEditor::QueryFrameList ()
pure virtual

Query the text model's frame list in the text editor

Parameters
none
Returns
IFrameList *
virtual ILayoutControlData* ITextEditor::QueryLayoutControlData ()
pure virtual

Query the layout control data on the text editor

Parameters
none
Returns
*
virtual ITextCaret* ITextEditor::QueryTextCaret ()
pure virtual

Query the text caret on the text editor

Parameters
none
Returns
virtual ITextFocus* ITextEditor::QueryTextFocus ()
pure virtual

Query the text focus on the text editor

Parameters
none
Returns