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

#include <IDeleteTopicEntryCmdData.h>

Inheritance diagram for IDeleteTopicEntryCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDELETETOPICENTRYCMDDATA }
 

Public Member Functions

virtual const UIDRef & GetTopicListUIDRef () const =0
 
virtual void SetTopicListUIDRef (const UIDRef &topicListUIDRef)=0
 
virtual const UIDRef & GetTopicSectionUIDRef () const =0
 
virtual void SetTopicSectionUIDRef (const UIDRef &topicSectionUIDRef)=0
 
virtual void SetTopicSectionId (int32 topicSectionId)=0
 
virtual int32 GetTopicSectionId () const =0
 
virtual const IndexTopicEntry & GetTopicEntry () const =0
 
virtual void SetTopicEntry (const IndexTopicEntry &topicEntry)=0
 
virtual int32 GetTopicNodeId () const =0
 
virtual void SetTopicNodeId (int32 indexTopicNodeId)=0
 
virtual bool16 GetDoNotifyFlag () const =0
 
virtual void SetDoNotifyFlag (bool16 notify)=0
 
virtual const K2Vector< int32 > & GetDeletedTopicNodeIdList () const =0
 
virtual void SetDeletedTopicNodeIdList (K2Vector< int32 > &deletedNodeIdList)=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 for deleting a topic entry.

Member Function Documentation

virtual const K2Vector<int32>& IDeleteTopicEntryCmdData::GetDeletedTopicNodeIdList () const
pure virtual

Retrieves the list of the deleted topic nodes. This list is set by the command and is valid only after the command is done.

Returns
array of ids of deleted topic nodes.
virtual bool16 IDeleteTopicEntryCmdData::GetDoNotifyFlag () const
pure virtual

Retrieves the "notify" flag.

Returns
the value of the flag.
virtual const IndexTopicEntry& IDeleteTopicEntryCmdData::GetTopicEntry () const
pure virtual

Retrieves the topic entry set in the command's data.

Returns
the topic entry stored in the command's data.
virtual const UIDRef& IDeleteTopicEntryCmdData::GetTopicListUIDRef () const
pure virtual

Retrieves the topic list property.

Returns
UIDRef of the topic list.
virtual int32 IDeleteTopicEntryCmdData::GetTopicNodeId () const
pure virtual

Retrieves the topic node id. This method should be used only by the index panel.

Returns
the topic node id.
virtual int32 IDeleteTopicEntryCmdData::GetTopicSectionId () const
pure virtual

Retrieves the topic section id.

Returns
the id of the topic section.
virtual const UIDRef& IDeleteTopicEntryCmdData::GetTopicSectionUIDRef () const
pure virtual

Retrieves the topic section UIDRef property.

Returns
UIDRef of the topic section.
virtual void IDeleteTopicEntryCmdData::SetDeletedTopicNodeIdList (K2Vector< int32 > & deletedNodeIdList)
pure virtual

Sets the list of the deleted topic nodes. This method should be called only by the command (DeleteTopicEntryCmd).

Parameters
deletedNodeIdList[IN] - list of ids of deleted topic nodes.
virtual void IDeleteTopicEntryCmdData::SetDoNotifyFlag (bool16 notify)
pure virtual

Sets the "notify" flag.

Parameters
notify[IN] - value of the flag.
virtual void IDeleteTopicEntryCmdData::SetTopicEntry (const IndexTopicEntry & topicEntry)
pure virtual

Sets the topic entry data.

Parameters
topicEntry[IN] - the topic entry.
virtual void IDeleteTopicEntryCmdData::SetTopicListUIDRef (const UIDRef & topicListUIDRef)
pure virtual

Sets the topic list property.

Parameters
topicListUIDRef[IN] - UIDRef of the topic list.
virtual void IDeleteTopicEntryCmdData::SetTopicNodeId (int32 indexTopicNodeId)
pure virtual

Sets the topic node id. This method should be used only by the index panel.

Parameters
indexTopicNodeId[IN] - the topic node id.
virtual void IDeleteTopicEntryCmdData::SetTopicSectionId (int32 topicSectionId)
pure virtual

Sets the topic section id property.

Parameters
topicSectionId[IN] - the topic section id.
virtual void IDeleteTopicEntryCmdData::SetTopicSectionUIDRef (const UIDRef & topicSectionUIDRef)
pure virtual

Sets the topic section UIDRef property.

Parameters
topicSectionUIDRef[IN] - UIDRef of the topic section.