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

#include <ICapitalizeTopicEntryCmdData.h>

Inheritance diagram for ICapitalizeTopicEntryCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICAPITALIZETOPICENTRYCMDDATA }
 
enum  CapitalizeOption { kSelected, kSelectedAndChildren, kAllLevel1, kAll }
 

Public Member Functions

virtual const CapitalizeOption & GetCapitalizeOption () const =0
 
virtual void SetCapitalizeOption (const CapitalizeOption &capitalizeOption)=0
 
virtual const UIDRef & GetTopicListUIDRef () const =0
 
virtual void SetTopicListUIDRef (const UIDRef &topicListUIDRef)=0
 
virtual const UIDRef & GetSelectedTopicSectionUIDRef () const =0
 
virtual void SetSelectedTopicSectionUIDRef (const UIDRef &selectedTopicSectionUIDRef)=0
 
virtual const int32 GetSelectedTopicId () const =0
 
virtual void SetSelectedTopicId (const int32 selectedTopicId)=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 to capitalize a topic entry.

Member Enumeration Documentation

enum ICapitalizeTopicEntryCmdData::CapitalizeOption

Options for capitalization.

Member Function Documentation

virtual const CapitalizeOption& ICapitalizeTopicEntryCmdData::GetCapitalizeOption () const
pure virtual

Retrieves the capitalization option.

Returns
capitalization option
virtual const int32 ICapitalizeTopicEntryCmdData::GetSelectedTopicId () const
pure virtual

Retrieves the target topic id.

Returns
id of the target topic.
virtual const UIDRef& ICapitalizeTopicEntryCmdData::GetSelectedTopicSectionUIDRef () const
pure virtual

Retrieves the target topic section.

Returns
UIDRef of the target topic section.
virtual const UIDRef& ICapitalizeTopicEntryCmdData::GetTopicListUIDRef () const
pure virtual

Retrieves the target topic list.

Returns
UIDRef of the target topic list.
virtual void ICapitalizeTopicEntryCmdData::SetCapitalizeOption (const CapitalizeOption & capitalizeOption)
pure virtual

Sets the capitalization option.

Parameters
capitalizeOption[IN]- capitalization option
virtual void ICapitalizeTopicEntryCmdData::SetSelectedTopicId (const int32 selectedTopicId)
pure virtual

Sets the target topic id.

Parameters
selectedTopicId[IN]- id of the target topic.
virtual void ICapitalizeTopicEntryCmdData::SetSelectedTopicSectionUIDRef (const UIDRef & selectedTopicSectionUIDRef)
pure virtual

Sets the target topic section.

Parameters
selectedTopicSectionUIDRef[IN]- UIDRef of the target topic section.
virtual void ICapitalizeTopicEntryCmdData::SetTopicListUIDRef (const UIDRef & topicListUIDRef)
pure virtual

Sets the target topic list.

Parameters
topicListUIDRef[IN]- UIDRef of the target topic list.