InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
TranFxGraphicAttributeInfo Class Reference
Inheritance diagram for TranFxGraphicAttributeInfo:
CPMUnknown< IGraphicAttributeInfo >IGraphicAttributeInfoIPMUnknown

Public Member Functions

 TranFxGraphicAttributeInfo (IPMUnknown *boss)
 
virtual ~TranFxGraphicAttributeInfo ()
 
virtual PMStringGetName (void) const
 
virtual bool16 IsTextAttribute (void) const
 
virtual bool16 IsGraphicAttribute (void) const
 
virtual bool16 IsTableAttribute (void) const
 
virtual bool16 IsExportAttribute (void) const
 
virtual bool16 IsRequiredGraphicAttr (void) const
 
virtual bool16 AffectsPageItemGeometry (void) const
 
virtual bool16 ObservedByGraphicState (void) const
 
virtual bool16 ObservedByTransparencyAttrSuite (void) const
 
virtual IPMUnknownCreateTextAttribute (void) const
 
virtual IPMUnknownCreateTableAttribute (void) const
 
virtual IPMUnknownDuplicateAttribute (const PMIID &iid) const
 
virtual bool16 IsEqual (const IPMUnknown *otherAttr) const
 
virtual ClassID GetClass (void) const
 
virtual PMString GetValue (const ClassID &attrClass, const IWorkspace *ws) const
 
- Public Member Functions inherited from CPMUnknown< IGraphicAttributeInfo >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from IGraphicAttributeInfo
enum  { kDefaultIID = IID_IGRAPHICATTR_INFO }
 
enum  AttributeKind { kGraphicAttr = 0x0001, kTextAttr = 0x0002, kTableAttr = 0x0004, kExportAttr = 0x0008 }
 
- Protected Member Functions inherited from CPMUnknown< IGraphicAttributeInfo >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IGraphicAttributeInfo >
HelperInterface fHelperInterface
 

Detailed Description

Describes this plug-in's custom graphic attributes.

There is an implementation in the API that is used by all of the application (default) attributes. However, the implementation cannot be re-used; third party attributes have to create their own implementations.

Constructor & Destructor Documentation

TranFxGraphicAttributeInfo::TranFxGraphicAttributeInfo (IPMUnknownboss)

Constructor.

virtual TranFxGraphicAttributeInfo::~TranFxGraphicAttributeInfo ()
inlinevirtual

Destructor.

Member Function Documentation

bool16 TranFxGraphicAttributeInfo::AffectsPageItemGeometry (void ) const
virtual

Returns kTrue if attribute affects page item geometry.

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

Implements IGraphicAttributeInfo.

IPMUnknown * TranFxGraphicAttributeInfo::CreateTableAttribute (void ) const
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.

Implements IGraphicAttributeInfo.

IPMUnknown * TranFxGraphicAttributeInfo::CreateTextAttribute (void ) const
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.

Implements IGraphicAttributeInfo.

IPMUnknown * TranFxGraphicAttributeInfo::DuplicateAttribute (const PMIIDiid) const
virtual

Creates a duplicate attribute and returns the given IID.

Returns
IPMUnknown pointer to the attribute copy object or nil.

Implements IGraphicAttributeInfo.

ClassID TranFxGraphicAttributeInfo::GetClass (void ) const
virtual

Returns the class ID the attribute.

Returns
attribute Class ID.

Implements IGraphicAttributeInfo.

PMString * TranFxGraphicAttributeInfo::GetName (void ) const
virtual

Returns the name of the attribute.

Returns
the PMString pointer to the attribute name.

Implements IGraphicAttributeInfo.

virtual PMString TranFxGraphicAttributeInfo::GetValue (const ClassIDattrClass,
const IWorkspacews 
) const
inlinevirtual

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..

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::IsEqual (const IPMUnknownotherAttribute) const
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.

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::IsExportAttribute (void ) const
virtual

Returns kTrue if attribute is a export attribute.

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

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::IsGraphicAttribute (void ) const
virtual

Returns kTrue if attribute is a graphic attribute.

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

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::IsRequiredGraphicAttr (void ) const
virtual

Returns kTrue if attribute is a required graphic attribute.

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

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::IsTableAttribute (void ) const
virtual

Returns kTrue if attribute is a table attribute.

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

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::IsTextAttribute (void ) const
virtual

Returns kTrue if attribute is a text attribute.

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

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::ObservedByGraphicState (void ) const
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.

Implements IGraphicAttributeInfo.

bool16 TranFxGraphicAttributeInfo::ObservedByTransparencyAttrSuite (void ) const
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.

Implements IGraphicAttributeInfo.