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

#include <IGraphicAttrMessage.h>

Inheritance diagram for IGraphicAttrMessage:
SelectionSuiteData

Public Types

enum  MessageType {
  kMsg_DefinitionChanged = 3, kSwapStrokeAndFillMsg = 6, kGraphicStateChangedChangeMsg, kMsg_SelectionChanged = 100,
  kMsg_SelectionAttrChanged = 200, kMsg_ProxyTypeChanged = 300, kMsg_AttrsEnableStateChanged = 400
}
 
- Public Types inherited from SelectionSuiteData
typedef object_type data_type
 

Public Member Functions

virtual MessageType GetMessageType (void) const =0
 
virtual int32 GetClassIDCount (void) const =0
 
virtual ClassID GetClassID (int32 index=0) const =0
 
virtual bool16 IsClassAffected (const ClassID &classID) const =0
 
virtual bool16 NeedClearAllBlocks (void) const =0
 

Detailed Description

A graphic attribute selection suite message. This message will be broadcast whenever selection attributes affecting graphic attributes are changed.

Member Enumeration Documentation

CSB messages for selection and selection attribute changes.
Enumerator
kMsg_DefinitionChanged 

kMsg_DefinitionChanged indicates that the whole or parts of definition changed in one or more ways (nil, one or more attr classes). The class list below can be empty, i.e. ClassID count is 0, then the whole definition changes. If class list is > 0, then only those attributes included are affected.

kSwapStrokeAndFillMsg 

kSwapStrokeAndFillMsg indicates the fill and stroke have been swapped. The class list will be nil.

kGraphicStateChangedChangeMsg 

kGraphicStateChangedChangeMsg indicates the graphic state object is changing. The class list will be nil.

kMsg_SelectionChanged 

kMsg_SelectionChanged indicates a message broadcast from cache to suites. Client code should ignore.

kMsg_SelectionAttrChanged 

kMsg_SelectionChanged indicates a message broadcast from cache to suites. Client code should ignore.

kMsg_ProxyTypeChanged 

kMsg_SelectionChanged indicates a message broadcast from cache to suites. Client code should ignore.

kMsg_AttrsEnableStateChanged 

kMsg_SelectionChanged indicates a message broadcast from cache to suites. Client code should ignore.

Member Function Documentation

virtual ClassID IGraphicAttrMessage::GetClassID (int32 index = 0) const
pure virtual

Returns the nth class ID.

virtual int32 IGraphicAttrMessage::GetClassIDCount (void ) const
pure virtual

Returns the number of attribute class count in the list.

virtual MessageType IGraphicAttrMessage::GetMessageType (void ) const
pure virtual

Returns the message type.

virtual bool16 IGraphicAttrMessage::IsClassAffected (const ClassIDclassID) const
pure virtual

Returns whether or not the specified attribute class ID is affected.

Parameters
classIDspecifies the interested attribute class ID.
Returns
true if class ID is in the list.
virtual bool16 IGraphicAttrMessage::NeedClearAllBlocks (void ) const
pure virtual

Returns true if the result of the attribute changes also required all rendering blocks to be cleared.