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

#include <IIndexCmdData.h>

Inheritance diagram for IIndexCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINDEXCMDDATA }
 

Public Member Functions

virtual const UIDRef & GetTargetItemRef () const =0
 
virtual void SetTargetItemRef (const UIDRef &sourceItem)=0
 
virtual void SetTextFrameRef (const UIDRef &textFrameItem)=0
 
virtual UIDRef GetTextFrameRef () const =0
 
virtual const bool16 GetReplaceExistingIndexFlag () const =0
 
virtual void SetReplaceExistingIndexFlag (bool16 replaceExistingIndex)=0
 
virtual const bool16 GetVerticalFlag () const =0
 
virtual void SetVerticalFlag (bool16 bVertical)=0
 
virtual void SetTopicListRef (const UIDRef &topicListRef)=0
 
virtual const UIDRef GetTopicListRef () const =0
 
virtual void SetTextModelRef (const UIDRef &textModelRef)=0
 
virtual const UIDRef GetTextModelRef () const =0
 
virtual const WideString & GetTitle () const =0
 
virtual void SetTitle (const WideString &indexTitle)=0
 
virtual const bool16 & GetIncludeOversetFlag () const =0
 
virtual void SetIncludeOversetFlag (const bool16 &includeOverset)=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 used during index generation.

Member Function Documentation

virtual const bool16& IIndexCmdData::GetIncludeOversetFlag () const
pure virtual

Retrieves the "include overset text" flag.

Returns
the flag value.
virtual const bool16 IIndexCmdData::GetReplaceExistingIndexFlag () const
pure virtual

Retrieves the "replace existing index" flag.

Returns
the flag value.
virtual const UIDRef& IIndexCmdData::GetTargetItemRef () const
pure virtual

Retrieves the target location (usually the doc workspace) where the index will be placed.

Returns
the UIDRef of the target.
virtual UIDRef IIndexCmdData::GetTextFrameRef () const
pure virtual

Retrieves the destination text frame.

Returns
UIDRef of the text frame.
virtual const UIDRef IIndexCmdData::GetTextModelRef () const
pure virtual

Retrieves the text model property.

Returns
UIDRef of the text model.
virtual const WideString& IIndexCmdData::GetTitle () const
pure virtual

Retrieves the title of the index instance.

Returns
the title.
virtual const UIDRef IIndexCmdData::GetTopicListRef () const
pure virtual

Retrieves the topic list used for the index.

Returns
UIDRef of the topic list.
virtual const bool16 IIndexCmdData::GetVerticalFlag () const
pure virtual

Specifies if the index frame should be vertical or horizontal (default). Used for the J version of InDesign.

See Also
IIndexOptions::FrameType
Returns
kTrue if the index frame is vertical.
virtual void IIndexCmdData::SetIncludeOversetFlag (const bool16 & includeOverset)
pure virtual

Sets the "include overset text" flag.

Parameters
includeOverset[IN] - the flag value.
virtual void IIndexCmdData::SetReplaceExistingIndexFlag (bool16 replaceExistingIndex)
pure virtual

Sets the "replace existing index" flag. A kTrue value will cause an existing index to be replaced with the new one.

Parameters
replaceExistingIndex[IN] - flag value.
virtual void IIndexCmdData::SetTargetItemRef (const UIDRef & sourceItem)
pure virtual

Sets the target location (usually the doc workspace) of the index.

Parameters
sourceItem[IN] - UIDRef of the target.
virtual void IIndexCmdData::SetTextFrameRef (const UIDRef & textFrameItem)
pure virtual

Specifies the destination text frame. Used by GenerateIndexCmd after it creates the new text frame.

Parameters
textFrameItem[IN] - the UIDRef of the text frame.
virtual void IIndexCmdData::SetTextModelRef (const UIDRef & textModelRef)
pure virtual

Sets the text model property.

Parameters
textModelRef[IN] - UIDRef of the text model.
virtual void IIndexCmdData::SetTitle (const WideString & indexTitle)
pure virtual

Sets the title of the index instance.

Parameters
indexTitle[IN] - the new title.
virtual void IIndexCmdData::SetTopicListRef (const UIDRef & topicListRef)
pure virtual

Sets the topic list used for the index.

Parameters
topicListRef[IN] - the UIDRef of the topic list.
virtual void IIndexCmdData::SetVerticalFlag (bool16 bVertical)
pure virtual

Specifies if the index frame should be vertical or horizontal (default). Used for the J version of InDesign.

See Also
IIndexOptions::FrameType
Parameters
bVertical[IN] - flag value.