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

#include <IOversetInformationExchange.h>

Inheritance diagram for IOversetInformationExchange:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IOVERSETINFORMATIONEXCHANGE }
 

Public Member Functions

virtual int32 FirstOversetFrameIndex (IFrameList *frameList)=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

An interface that is used to exchange information about which frame constitutes the start of overset text. It is expected that someone who want's to use this will implement a service and that an implementation of this interface will be provided in the service providers boss. At proper times this interface will be called to ask which frame the overset text starts on. This interface and service is provide so that third parties can add a overset text frame and the internal InCopy code will respect this frame for text statistics calculations.

Author
Kevin Van Wiel

Member Enumeration Documentation

anonymous enum

Standard enum to for use with GetDefaultIID() method.

Member Function Documentation

virtual int32 IOversetInformationExchange::FirstOversetFrameIndex (IFrameList * frameList)
pure virtual

Return the index of the first frame in the frame list to be considered overset. It is expected that every frame after that frame will be considered overset as well. If there is no overset frame present it is expected that this will return -1.

Parameters
frameLista pointer to the frameList we are interested in getting an index from
Returns
either an index of the first overset frame or -1 if there is no overset frame.