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

#include <IAnchoredObjectAlternateFrameAlign.h>

Inheritance diagram for IAnchoredObjectAlternateFrameAlign:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IANCHOREDOBJECTALTERNATEFRAMEALIGN }
 

Public Member Functions

virtual IHierarchyQueryAlignmentFrame ()=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

IAnchoredObjectAlternateFrameAlign is an interface that allows a third party developer to change the page item that is used for the anchored object align to frame setting. Without this interface, the frame to which an anchored object will be aligned is the one that is the grandparent of the text frame column containing the anchored object marker (i.e. the spline). By adding this interface to the kSplineBoss, a third party can specify that a different ancestor page item be used when the kFrameRelativeV and kFrameRelativeH anchor point objects are in effect. The classic use case for this interface is if a developer wishes to implement a container page item that has one or more spline text frames, and wishes for the anchored object to align to the container page item rather than the child spline text frame. If this interface is present on the kSplineBoss, the implementation must return a non-nil IHierarchy pointer. Note: If the geometry of the alternate page item changes, the anchored object is not guaranteed to be realigned to the new page item geometry. Therefore, somewhere else in their code, implementors of this interface are also responsible for calling IInlineData::InlineChangeDamage() if geometry of the alignment page item frame is modified.

Member Function Documentation

virtual IHierarchy* IAnchoredObjectAlternateFrameAlign::QueryAlignmentFrame ()
pure virtual

Get the IHierarchy interface of page item whose frame the anchored object should be aligned to.

Returns
an AddRef'd IHierarchy interface of the page item.