InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextInset Class Referenceabstract
Inheritance diagram for ITextInset:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTINSET }
 
enum  InsetFlags { kLeft = 1, kTop = 2, kRight = 4, kBottom = 8 }
 

Public Member Functions

virtual void SetInset (PMReal nInset)=0
 
virtual PMReal GetInset () const =0
 
virtual bool16 SetRectInset (const PMRect &insetRect)=0
 
virtual PMRect GetRectInset () const =0
 
virtual PMRect GetEffectiveInset () const =0
 
virtual void SetInsetGeometry (UID nInsetGeo)=0
 
virtual IGeometryQueryInsetGeometry () const =0
 
virtual bool16 UpdateInsetGeometry (bool16 bDynamic=kFalse)=0
 
virtual UID GetInsetGeometry () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual PMRect ITextInset::GetEffectiveInset () const
pure virtual

Returns the effective inset given the rectangle/non-rectangle shape of the Spline. If a rectangle, returns GetRectInset(), otherwise returns GetInset() for all sides.

virtual PMReal ITextInset::GetInset () const
pure virtual

returns the inset value. Notice that QueryInsetGeometry() and GetInset() are independent. You could get an inset geometry even if the inset value was 0.0.

virtual UID ITextInset::GetInsetGeometry () const
pure virtual

returns the UID of the inset. Notice that QueryInsetGeometry() and GetInsetGeometry() are independend. QueryInsetGeometry() returns nil if the pageitem is a rectangle and the inset values are 0. TextInset::Do() calls GetInsetGeometry() to see whether an inset item needs to be created.

virtual IGeometry* ITextInset::QueryInsetGeometry () const
pure virtual

returns nil or the inset geometry. Notice that QueryInsetGeometry() and GetInset()/GetInsetGeometry() are independent. You could get an inset geometry even if the inset value was 0.0.

virtual void ITextInset::SetInset (PMReal nInset)
pure virtual

nInset specifies the distance between this pageitem and the textframe that is a child of this pageitem.

virtual void ITextInset::SetInsetGeometry (UID nInsetGeo)
pure virtual

expects the UID of the standoff pageitem. This is called by TextInset::DoRecalcInset().

virtual bool16 ITextInset::UpdateInsetGeometry (bool16 bDynamic = kFalse)
pure virtual

Updates the InsetGeometry recalculates the inset geometry.

Parameters
bDynamicignored/obsolete
Returns
kTrue (always)