InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IRIDXNotifierUtils Class Referenceabstract
Inheritance diagram for IRIDXNotifierUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IRIDXNOTIFIERUTILS }
 

Public Member Functions

virtual void BeingDeleted (IDataBase *db, UID targetUID, const IPMUnknown *iDataForDeleting) const =0
 
virtual void BeingDeleted (IDataBase *db, const UIDList &targetUIDList, const IPMUnknown *iDataForDeleting) const =0
 
virtual void WillBeModified (IDataBase *db, UID targetUID, const IPMUnknown *iDataForModifying) const =0
 
virtual void WillBeModified (IDataBase *db, const UIDList &targetUIDList, const IPMUnknown *iDataForModifying) const =0
 
virtual bool16 IsActivelyUsed (IDataBase *db, UID targetUID, const IPMUnknown *iOptionData=nil, RIDXNotifierCacheData *pNotifierCache=nil) const =0
 
virtual void SwatchesWillBeConvertedLocalToGlobal (IDataBase *db, const UIDList &targetUIDList, const IPMUnknown *iData) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void IRIDXNotifierUtils::BeingDeleted (IDataBasedb,
UID targetUID,
const IPMUnknowniDataForDeleting 
) const
pure virtual

UIDDeleted: Nofitication sent when this particular UID is being deleted, called HandleUIDDeleted in

Parameters
dbThe database it is being deleted from
targetUIDThe uid being deleted
iDataForDeletingAny data object that may be associated with the target UID being deleted.
virtual void IRIDXNotifierUtils::BeingDeleted (IDataBasedb,
const UIDListtargetUIDList,
const IPMUnknowniDataForDeleting 
) const
pure virtual

UIDDeleted: Nofitication sent when this particular UID is being deleted, called HandleUIDDeleted in

Parameters
dbThe database it is being deleted from
targetUIDListThe uid list being deleted
iDataForDeletingAny data object that may be associated with the target UID being deleted.
virtual bool16 IRIDXNotifierUtils::IsActivelyUsed (IDataBasedb,
UID targetUID,
const IPMUnknowniOptionData = nil,
RIDXNotifierCacheDatapNotifierCache = nil 
) const
pure virtual

UIDIsActivelyUsed: Nofitication sent when the uid is still being actively used by a client, calls UIDIsActivelyUsed in IRIDXNotifierHandler

Parameters
dbThe database it is being deleted from
targetUIDThe uid being modified
iOptionDataAny data object that may help in determining if target UID is referenced.
pNotifierCacheA notifier cache to use when this method is called repeatedly on the same database and with similar target class of target UID. If a cache is not passed in, the process of testing for references will be much slower since we will have to create a RIDX query every time this is called.
virtual void IRIDXNotifierUtils::SwatchesWillBeConvertedLocalToGlobal (IDataBasedb,
const UIDListtargetUIDList,
const IPMUnknowniData 
) const
pure virtual

Swatch UID converted or deleted: Nofitication sent when the swatch UIDs are being converted to global swatch. In some cases, UID is replaced.

Parameters
dbThe database it is being deleted from
targetUIDListThe uid list being modified or deleted
iOptionDataAny data object required by the client.
virtual void IRIDXNotifierUtils::WillBeModified (IDataBasedb,
UID targetUID,
const IPMUnknowniDataForModifying 
) const
pure virtual

WillBeModified: Nofitication sent when the data owned by a particular UID is about to be modifited, called HandleUIDModified in

Parameters
dbThe database it is being deleted from
targetUIDThe uid being modified
iDataForModifyingAny data object that may be associated with the target UID being modified.
virtual void IRIDXNotifierUtils::WillBeModified (IDataBasedb,
const UIDListtargetUIDList,
const IPMUnknowniDataForModifying 
) const
pure virtual

WillBeModified: Nofitication sent when the data owned by a particular UID is about to be modifited, called HandleUIDModified in

Parameters
dbThe database it is being deleted from
targetUIDListThe uid list being modified
iDataForModifyingAny data object that may be associated with the target UID being modified.