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

#include <IIndexPageEntryCmdData.h>

Inheritance diagram for IIndexPageEntryCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINDEXPAGEENTRYCMDDATA }
 

Public Member Functions

virtual void GetPageRangeType (IIndexPageEntryData::PageRangeType &type, UID &nextStyleUID, int32 &nParOrPage) const =0
 
virtual void SetPageRangeType (const IIndexPageEntryData::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 (IIndexPageEntryData::MarkerPlace &place) const =0
 
virtual void SetMarkerPlace (const IIndexPageEntryData::MarkerPlace place)=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

Command data interface for creating and editing an index page entry.

See Also
IIndexPageEntryData.

Member Function Documentation

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

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

See Also
IIndexPageEntryData for the definition of marker place.
Parameters
place[OUT] - location of the index marker.
virtual void IIndexPageEntryCmdData::GetPageRange (int32 & startPage,
int32 & endPage 
) const
pure virtual

Retrieves the page range for this entry.

Parameters
startPage[OUT] - the index (0-based) of start page.
endPage[OUT] - the index (0-based) of end page.
virtual void IIndexPageEntryCmdData::GetPageRangeType (IIndexPageEntryData::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 IIndexPageEntryCmdData::GetStyleUID () const
pure virtual

Retrieves the style for the page entry.

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

Sets the location of the index marker.

See Also
IIndexPageEntryData for the definition of marker place.
Parameters
place[IN] - location of the index marker.
virtual void IIndexPageEntryCmdData::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 IIndexPageEntryCmdData::SetPageRangeType (const IIndexPageEntryData::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 IIndexPageEntryCmdData::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.