InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IActionIDToUIDData Class Referenceabstract

#include <IActionIDToUIDData.h>

Inheritance diagram for IActionIDToUIDData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IACTIONIDTOUIDDATA }
 

Public Member Functions

virtual int32 Length ()=0
 
virtual UID GetUID (ActionID actionID)=0
 
virtual void RemoveEntry (ActionID actionID)=0
 
virtual void AddEntry (ActionID actionID, UID someObject)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Handy Interface for maintaining a mapping between ActionIDs and UIDs

Member Function Documentation

virtual void IActionIDToUIDData::AddEntry (ActionID actionID,
UID someObject 
)
pure virtual

Add a new entry for an ActionID and associated UID

Parameters
actionIDthe action we want to add an entry for
someObjectthe UID associated with this action
virtual UID IActionIDToUIDData::GetUID (ActionID actionID)
pure virtual

Given an ActionID, return the associated UID

Parameters
actionIDthe action we want to get the UID for
Returns
the UID associated with this action
virtual int32 IActionIDToUIDData::Length ()
pure virtual

Get a count of the entries in our list

Returns
count
virtual void IActionIDToUIDData::RemoveEntry (ActionID actionID)
pure virtual

Remove an action and associated UID from our list

Parameters
actionIDthe action we want to remove