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

#include <IRecomposedFrames.h>

Inheritance diagram for IRecomposedFrames:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IRECOMPOSEDFRAMES }
 

Public Member Functions

virtual void AddFrameToList (UID frameUID)=0
 
virtual void RemoveFrameFromList (UID frameUID)=0
 
virtual UID GetNthFrameUID (int32 i)=0
 
virtual int32 GetFrameCount ()=0
 
virtual void BroadcastRecompositionComplete ()=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

IRecomposedFrames is used to buffer up a list of text frames that have undergone some kind of recomposition, so that at the end of the composition operation, we can broadcast on all of them at once. Things like the paragraph composer, keeps fuctionality, and footnotes can all cause more frames to be operated on than initially expected. Each IFrameList has this interface.

See Also
IFrameList

Member Function Documentation

virtual void IRecomposedFrames::AddFrameToList (UID frameUID)
pure virtual

Add the specified text frame to the list of frames affected by composition.

Parameters
frameUIDis the UID of the text frame that was affected.
virtual void IRecomposedFrames::BroadcastRecompositionComplete ()
pure virtual

Broadcast the recomposition message for the frames and clear the list. Also may do the screen inval.

virtual int32 IRecomposedFrames::GetFrameCount ()
pure virtual

Used for iteration through the list, get the number of text frames.

Returns
the number of text frame UIDs on this list.
virtual UID IRecomposedFrames::GetNthFrameUID (int32 i)
pure virtual

Used for iteration through the list, get an indexed text frame. May not handle bad indices.

Parameters
iis the index within this interface's list.
Returns
the correct Text Frame's UID.
virtual void IRecomposedFrames::RemoveFrameFromList (UID frameUID)
pure virtual

Remove a text frame from the list, if it is there. Generally used when text frames are deleted, since the broadcast clears the normal case.

Parameters
frameUIDis the text frame to remove.