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

#include <ILayoutViewLineData.h>

Inheritance diagram for ILayoutViewLineData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILAYOUTVIEWLINEDATA }
 

Public Member Functions

virtual void GenerateNewLineID (IDataBase *docDB)=0
 
virtual uint32 GetLineID ()=0
 
virtual void InvalidateID ()=0
 
virtual void SetLineID (uint32 id)=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 interface is added to each wax line in layout view to give it an id to associate with a corresponding text line in the galley view. This enables the two views to be kept in sync. The method FindIndexOfLineWithID() in ITextLines can be used to locate a line in the galley view corresponding to a waxline in layout view. Note this only applies to galley view. Story view does not need to know this information and it is not maintained.

Member Function Documentation

virtual void ILayoutViewLineData::GenerateNewLineID (IDataBasedocDB)
pure virtual

Used internally DO NOT CALL.

Parameters
docDB- document database.
Returns
none
virtual uint32 ILayoutViewLineData::GetLineID ()
pure virtual

Get a line id for this wax line

Returns
line id value
virtual void ILayoutViewLineData::InvalidateID ()
pure virtual

Used internally DO NOT CALL.

Returns
none
virtual void ILayoutViewLineData::SetLineID (uint32 id)
pure virtual

Directly set a waxline id. Needed for undo support in CS3 and beyond.

Parameters
idvalue to set line date to
Returns
none