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

#include <ITLAdornmentUtils.h>

Inheritance diagram for ITLAdornmentUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITLADORNUTILS }
 

Public Member Functions

virtual void AddTextLockAdornment (UIDList *list, UIDRef &docRef)=0
 
virtual void AddFrameListTextLockAdornment (IFrameList *list, UIDRef &docRef)=0
 
virtual void RemoveTextLockAdornment (UIDList *list, UIDRef &docRef)=0
 
virtual void RemoveFrameListTextLockAdornment (IFrameList *list, UIDRef &docRef)=0
 
virtual bool16 HasTextLockAdornment (IFrameList *list)=0
 
virtual bool16 HasTextLockAdornment (UIDRef objectRef)=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

This utility adding/removing the Lock adornment (represents the InCopy story) to/from the objects.

Member Function Documentation

virtual void ITLAdornmentUtils::AddFrameListTextLockAdornment (IFrameListlist,
UIDRefdocRef 
)
pure virtual

Adding the Lock adornment If ICBridgeAdornmentUtils is present, adding the adornment (kICBridgeTextLockAdornmentBoss) to objects (GraphicFrame). otherwise adding adornment (kTextLockAdornmentBoss) to the objects (MultiColumnFrame)

Parameters
listThe objects that the adornment is added to
docRefThe document contains the objects
virtual void ITLAdornmentUtils::AddTextLockAdornment (UIDListlist,
UIDRefdocRef 
)
pure virtual

Adding the Lock adornment If ICBridgeAdornmentUtils is present, adding the adornment (kICBridgeTextLockAdornmentBoss) to objects (GraphicFrame). otherwise adding adornment (kTextLockAdornmentBoss) to the objects (MultiColumnFrame)

Parameters
listThe objects that the adornment is added to
docRefThe document contains the objects
virtual bool16 ITLAdornmentUtils::HasTextLockAdornment (IFrameListlist)
pure virtual

Check if this IFrameList has Lock adornment

Parameters
list
Returns
bool16 kTrue means this IFrameList already has Lock adornment
virtual bool16 ITLAdornmentUtils::HasTextLockAdornment (UIDRef objectRef)
pure virtual

Check if this object has Lock adornment

Parameters
objectRef(Text or Graphic)
Returns
bool16 kTrue means this objectRef already has Lock adornment
virtual void ITLAdornmentUtils::RemoveFrameListTextLockAdornment (IFrameListlist,
UIDRefdocRef 
)
pure virtual

Remove Lock adornment

Parameters
listThe objects that the adornment is removed
docRefThe document contains the objects
virtual void ITLAdornmentUtils::RemoveTextLockAdornment (UIDListlist,
UIDRefdocRef 
)
pure virtual

Remove Lock adornment

Parameters
listThe objects that the adornment is removed
docRefThe document contains the objects