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

#include <ISwatchesPanelAttributes.h>

Inheritance diagram for ISwatchesPanelAttributes:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISWATCHESPANELATTRIBUTES }
 

Public Member Functions

virtual bool16 GetGraphicStateInteraction () const =0
 
virtual bool16 GetShowButtons () const =0
 
virtual bool16 GetListItemsEditable () const =0
 
virtual bool16 GetAddUnnamedColorFlag () const =0
 
virtual bool16 AllowAllReferencedUnnamedColors () const =0
 
virtual bool16 AllowAnySwatchEntry () const =0
 
virtual ClassID GetViewFilterClassID () const =0
 
virtual bool16 ShouldObserveRenderingObjectChange () const =0
 
virtual void SetViewFilterClassID (const ClassID &newClassId)=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

This interface reads a set of attributes from a resource file. These attributes control how the "Swatch List" widget will configure itself (graphic state interaction, button visibility, swatch editability etc.) and which color items in the model it will display. Adding all referenced unnamed colors to color list might have performance issues.

"Any Swatch" entry can be added to swatch list. This entry essentially means no color. This is used for no particular selection.

Member Function Documentation

virtual bool16 ISwatchesPanelAttributes::AllowAllReferencedUnnamedColors () const
pure virtual

Should the "Swatch List" widget show all referenced unnamed colors For large documents there might be performance issues with this.

Returns
kTrue or kFalse
virtual bool16 ISwatchesPanelAttributes::AllowAnySwatchEntry () const
pure virtual

Should the "Swatch List" widget show an entry named "Any Swatch"

Returns
kTrue or kFalse
virtual bool16 ISwatchesPanelAttributes::GetAddUnnamedColorFlag () const
pure virtual

Returns true if swatch list widget is allowed to display the currently selected unnamed swatch.

virtual bool16 ISwatchesPanelAttributes::GetGraphicStateInteraction () const
pure virtual

Returns true if swatch list widget has interaction with the graphic state objects.

virtual bool16 ISwatchesPanelAttributes::GetListItemsEditable () const
pure virtual

Returns true if swatch list item can be edited directly by double-clicking.

virtual bool16 ISwatchesPanelAttributes::GetShowButtons () const
pure virtual

Returns true if swatch list widget should include show swatch buttons.

virtual ClassID ISwatchesPanelAttributes::GetViewFilterClassID () const
pure virtual

Return the rendering object class ID the swatch list widget is filtered with. If kInvalidClass is returned then all rendering types in the swatch list is shown.

virtual void ISwatchesPanelAttributes::SetViewFilterClassID (const ClassIDnewClassId)
pure virtual

Set the swatch list view filter class ID.

Parameters
newClassIdspecifies the new list view filter class ID.
virtual bool16 ISwatchesPanelAttributes::ShouldObserveRenderingObjectChange () const
pure virtual

Returns a bool indicating if this instance of swatches panel should observe IID_IRENDERINGOBJECT protocol. Attaching to this protocol ensures that the swatches list gets updated as soon as we add/delete a swatch