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

#include <ISwatchesRIDXNotificationData.h>

Inheritance diagram for ISwatchesRIDXNotificationData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISWATCHESRIDXNOTIFICATIONDATA }
 

Public Member Functions

virtual void SetDeleteSwatchReplacement (const UIDRef &replacementRef)=0
 
virtual UIDRef GetDeleteSwatchReplacement (void) const =0
 
virtual void SetDeleteSwatchList (const UIDList &deleteSwatchList)=0
 
virtual const UIDListGetDeleteSwatchList (void) const =0
 
virtual void SetSwatchReferencedOption (const ISwatchUtils::SwatchUsageType &usageType)=0
 
virtual
ISwatchUtils::SwatchUsageType 
GetSwatchReferencedOption (void) const =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

A data interface that specifies the data and options for each of the notification type. Used in conjunction with all IRIDXNotifierHandler that are interested in the swatches.

See Also
IRIDXNotifierHandler.h

Member Function Documentation

virtual const UIDList& ISwatchesRIDXNotificationData::GetDeleteSwatchList (void ) const
pure virtual

Returns the list of swatches being deleted.

Returns
the list of swatches being deleted.
virtual UIDRef ISwatchesRIDXNotificationData::GetDeleteSwatchReplacement (void ) const
pure virtual

Returns the swatch replacement for the swatch being deleted.

Returns
the swatch replacment. If returned UIDRef is UIDRef::gNull, then the swatch being deleted should be converted to local (unnamed) swatch.
virtual ISwatchUtils::SwatchUsageType ISwatchesRIDXNotificationData::GetSwatchReferencedOption (void ) const
pure virtual

Return the swatch referenced option. This is the option with which the swatch references are computed.

Returns
the reference option.
virtual void ISwatchesRIDXNotificationData::SetDeleteSwatchList (const UIDListdeleteSwatchList)
pure virtual

Set the list of swatches being deleted.

Parameters
deleteSwatchListthe list of swatches being deleted.
virtual void ISwatchesRIDXNotificationData::SetDeleteSwatchReplacement (const UIDRefreplacementRef)
pure virtual

Set the swatch replacement for the swatch being deleted.

Parameters
replacementRefthe swatch replacment. If replacment is set to UIDRef::gNull, then the swatch being deleted should be converted to local (unnamed) swatch.
virtual void ISwatchesRIDXNotificationData::SetSwatchReferencedOption (const ISwatchUtils::SwatchUsageTypeusageType)
pure virtual

Set the swatch referenced option. This is the option with which the swatch references are computed.

Parameters
usageTypethe swatch usage type as defined in ISwatchUtils.h
See Also
ISwatchUtils.h