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

#include <IIndexPageEntryData.h>

Inheritance diagram for IIndexPageEntryData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINDEXPAGEENTRYDATA }
 
enum  PageRangeType {
  kNoPageRange = 0, kCurrentPage = 1, kToNextStyleChange = 2, kToNextUseOfStyle = 3,
  kToEndOfStory = 4, kToEndOfDocument = 5, kToEndOfSection = 6, kForNextNParagraphs = 7,
  kForNextNPages = 8
}
 
enum  MarkerPlace {
  kPage = 1, kPasteboard = 2, kMasterPage = 4, kOverset = 8,
  kHiddenLayer = 16, kUnplacedFrame = 32, kFootnote = 64, kNote = 128,
  kHiddenText = 256, kHiddenState = 512, kDummyValue = 0xFFFFFFFF
}
 

Public Member Functions

virtual void GetPageRangeType (PageRangeType &type, UID &nextStyleUID, int32 &nParOrPage) const =0
 
virtual void SetPageRangeType (const PageRangeType type, const UID nextStyleUID, const int32 nParOrPage)=0
 
virtual UID GetStyleUID () const =0
 
virtual void SetStyleUID (const UID styleUID)=0
 
virtual void GetPageRange (int32 &startPage, int32 &endPage) const =0
 
virtual void SetPageRange (const int32 startPage, const int32 endPage)=0
 
virtual void GetMarkerPlace (MarkerPlace &place) const =0
 
virtual void SetMarkerPlace (const MarkerPlace place)=0
 
virtual uint32 GetMarkerUniqueID () const =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

Data interface that aggregates information about an index page entry.

Member Enumeration Documentation

enum IIndexPageEntryData::MarkerPlace

Specifies the location of the index marker

enum IIndexPageEntryData::PageRangeType

The type of the page range for the entry

Member Function Documentation

virtual void IIndexPageEntryData::GetMarkerPlace (MarkerPlace & place) const
pure virtual

Retrieves the place of the index marker. Used when updating the page entries in the index.

Parameters
place[OUT] - location of the index marker.
virtual uint32 IIndexPageEntryData::GetMarkerUniqueID () const
pure virtual

Gets ID of index marker. This number should be unique within document. It is used to create hyperlink when export index to HTML and EPUB

virtual void IIndexPageEntryData::GetPageRange (int32 & startPage,
int32 & endPage 
) const
pure virtual

Retrieves the page range for this entry.

Parameters
startPage[OUT] - the start page.
endPage[OUT] - the end page.
virtual void IIndexPageEntryData::GetPageRangeType (PageRangeType & type,
UID & nextStyleUID,
int32 & nParOrPage 
) const
pure virtual

Retrieves the type of the page range for the entry.

Parameters
type[OUT] - the page range for this entry.
nextStyleUID[OUT] - the UID of the next style if type is kToNextUseOfStyle.
nParOrPage[OUT] - the number of paragraphs or pages if the type is kForNextNParagraphs or kForNextNPages
virtual UID IIndexPageEntryData::GetStyleUID () const
pure virtual

Retrieves the style for the page entry.

Returns
UID of the style.
virtual void IIndexPageEntryData::SetMarkerPlace (const MarkerPlace place)
pure virtual

Sets the location of the index marker.

Parameters
place[IN] - location of the index marker.
virtual void IIndexPageEntryData::SetPageRange (const int32 startPage,
const int32 endPage 
)
pure virtual

Sets the page range for this entry. This method is used in conjuction with SetPageRangeType.

Parameters
startPage[IN] - the start page.
endPage[IN] - the end page.
virtual void IIndexPageEntryData::SetPageRangeType (const PageRangeType type,
const UID nextStyleUID,
const int32 nParOrPage 
)
pure virtual

Sets the page range type for this entry. This method is used in conjuction with SetPageRange.

Parameters
type[IN] - the page range for this entry.
nextStyleUID[IN] - the UID of the next style if type is kToNextUseOfStyle.
nParOrPage[IN] - the number of paragraphs or pages if the type is kForNextNParagraphs or kForNextNPages
virtual void IIndexPageEntryData::SetStyleUID (const UID styleUID)
pure virtual

Sets the style for the page entry.

Parameters
styleUID[IN] - the UID of the style for the page entry.