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

#include <IGraphicAttributeInfo.h>

Inheritance diagram for IGraphicAttributeInfo:
IPMUnknownCPMUnknown< IGraphicAttributeInfo >CGraphicAttributeInfoTranFxGraphicAttributeInfo

Public Types

enum  { kDefaultIID = IID_IGRAPHICATTR_INFO }
 
enum  AttributeKind { kGraphicAttr = 0x0001, kTextAttr = 0x0002, kTableAttr = 0x0004, kExportAttr = 0x0008 }
 

Public Member Functions

virtual PMStringGetName (void) const =0
 
virtual bool16 IsTextAttribute (void) const =0
 
virtual bool16 IsGraphicAttribute (void) const =0
 
virtual bool16 IsTableAttribute (void) const =0
 
virtual bool16 IsExportAttribute (void) const =0
 
virtual bool16 IsRequiredGraphicAttr (void) const =0
 
virtual bool16 AffectsPageItemGeometry (void) const =0
 
virtual bool16 ObservedByGraphicState (void) const =0
 
virtual IPMUnknownCreateTextAttribute () const =0
 
virtual IPMUnknownCreateTableAttribute () const =0
 
virtual IPMUnknownDuplicateAttribute (const PMIID &iid) const =0
 
virtual bool16 IsEqual (const IPMUnknown *otherAttribute) const =0
 
virtual ClassID GetClass (void) const =0
 
virtual bool16 ObservedByTransparencyAttrSuite (void) const =0
 
virtual PMString GetValue (const ClassID &attrClass, const IWorkspace *ws) 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

This is a required interface for any graphic attributes. This class facilitates in the management of graphic attributes.

Member Enumeration Documentation

Indicates type of attributes. An attribute is usually a graphic attribute but could be a combination of these three types.
Enumerator
kGraphicAttr 

A graphic type attribute.

kTextAttr 

A text type attribute.

kTableAttr 

A table type attribute.

kExportAttr 

A export type attribute

Member Function Documentation

virtual bool16 IGraphicAttributeInfo::AffectsPageItemGeometry (void ) const
pure virtual

Returns kTrue if attribute affects page item geometry.

Returns
kTrue if attribute affects page item geometry; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual IPMUnknown* IGraphicAttributeInfo::CreateTableAttribute () const
pure virtual

Create a table version of this attribute. This method should be implemented if this attribute is also a table attribute.

Returns
IPMUnknown pointer to the table attribute object or nil.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual IPMUnknown* IGraphicAttributeInfo::CreateTextAttribute () const
pure virtual

Create a text version of this attribute. This method should be implemented if this attribute is also a text attribute.

Returns
IPMUnknown pointer to the text attribute object or nil.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual IPMUnknown* IGraphicAttributeInfo::DuplicateAttribute (const PMIIDiid) const
pure virtual

Creates a duplicate attribute and returns the given IID.

Returns
IPMUnknown pointer to the attribute copy object or nil.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual ClassID IGraphicAttributeInfo::GetClass (void ) const
pure virtual

Returns the class ID the attribute.

Returns
attribute Class ID.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual PMString* IGraphicAttributeInfo::GetName (void ) const
pure virtual

Returns the name of the attribute.

Returns
the PMString pointer to the attribute name.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual PMString IGraphicAttributeInfo::GetValue (const ClassIDattrClass,
const IWorkspacews 
) const
pure virtual

Returns the string format of the attribute value.

Parameters
attrClassIN: the ClassID for the attribute.
wsIN: the workspace where we get this attribute value from.
Returns
PMString the string format of the attribute value..

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::IsEqual (const IPMUnknownotherAttribute) const
pure virtual

Compare the two attributes by first checking that the classIDs are the same and then comparing the attribute values. Returns true if equal else false

Returns
kTrue if attributes are equal otherwise kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::IsExportAttribute (void ) const
pure virtual

Returns kTrue if attribute is a export attribute.

Returns
kTrue if attribute is a export attribute; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::IsGraphicAttribute (void ) const
pure virtual

Returns kTrue if attribute is a graphic attribute.

Returns
kTrue if attribute is a graphic attribute; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::IsRequiredGraphicAttr (void ) const
pure virtual

Returns kTrue if attribute is a required graphic attribute.

Returns
kTrue if attribute is a required graphic attribute; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::IsTableAttribute (void ) const
pure virtual

Returns kTrue if attribute is a table attribute.

Returns
kTrue if attribute is a table attribute; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::IsTextAttribute (void ) const
pure virtual

Returns kTrue if attribute is a text attribute.

Returns
kTrue if attribute is a text attribute; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::ObservedByGraphicState (void ) const
pure virtual

Returns kTrue if attribute is observed by the graphic state. Should return kFalse, if plug-in that added the attribute is responsible for managing changes.

Returns
kTrue if attribute is observed by the graphic state; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.

virtual bool16 IGraphicAttributeInfo::ObservedByTransparencyAttrSuite (void ) const
pure virtual

Returns kTrue if attribute is observed by the transparency attribute suite. Should return kFalse, if plug-in that added the attribute is responsible for managing the changes.

Returns
kTrue if attribute is observed by the transparency attribute suite; otherwise returns kFalse.

Implemented in TranFxGraphicAttributeInfo, and CGraphicAttributeInfo.