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

#include <IGenericTextSelectionSuite.h>

Inheritance diagram for IGenericTextSelectionSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IGENERICTEXTSELECTION_SUITE }
 
enum  ViewType { kStandard, kNote }
 
enum  DrawChoice { kDontDrawSelection, kDrawSelection }
 

Public Member Functions

virtual bool16 SetSelection (RangeData r, const UIDRef &storyRef, SelectionExtension *extendToUIDPair=nil)=0
 
virtual bool16 SetSelectionHmm (RangeData r, const UIDRef &storyRef, SelectionExtension extendToUIDPair, DrawChoice drawIt)=0
 
virtual void DeselectAll ()=0
 
virtual RangeData GetSelection (UIDRef *story=nil) const =0
 
virtual bool16 CanEditText ()=0
 
virtual SelectionExtension GetSelectionIsExtendedToDeletedUID ()=0
 
virtual ITextFocusQueryTextFocus ()=0
 
virtual void SetWidgetParent_ (IPMUnknown *parent)=0
 
virtual ViewType GetSelectionViewType ()=0
 
virtual void TempSetSelectionTextModel (const UIDRef &storyRef)=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

CLASS DECLARATION For Adobe internal use only and should not be used by external developers.

Member Function Documentation

virtual SelectionExtension IGenericTextSelectionSuite::GetSelectionIsExtendedToDeletedUID ()
pure virtual

Method to get track changed deleted text highlight extension information

Returns
SelectionExtension left and right track change extension information values for left and right extension are kInvalidUID if no extension.
virtual bool16 IGenericTextSelectionSuite::SetSelection (RangeData r,
const UIDRefstoryRef,
SelectionExtensionextendToUIDPair = nil 
)
pure virtual

Method to set a text selection.

Parameters
rangeText range to set a text selection on
storyRefUID reference of story to set selection in
extendToUIDPairIf want adjacent track changes to be included in the highlight must set the UID of the track change owned item. this is mainly an internal implementation detail.
Returns
kTrue if selection was set.
virtual bool16 IGenericTextSelectionSuite::SetSelectionHmm (RangeData r,
const UIDRefstoryRef,
SelectionExtension extendToUIDPair,
DrawChoice drawIt 
)
pure virtual

Method to set a text selection (should go away eventually it's not suggested this be used externally)

Parameters
rangeText range to set a text selection on
storyRefUID reference of story to set selection in
extendToUIDPairIf want adjacent track changes to be included in the highlight must set the UID of the track change owned item. this is mainly an internal implementation detail.
drawIttrue if the selection should be drawn
Returns
kTrue if selection was set.