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

#include <IObjectAttributeList.h>

Inheritance diagram for IObjectAttributeList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IOBJECTATTRIBUTELIST }
 

Public Member Functions

virtual int32 CountBosses () const =0
 
virtual ClassID GetClassN (int32 n) const =0
 
virtual const IPMUnknownQueryBossN (int32 n, PMIID id) const =0
 
virtual const IPMUnknownQueryByClassID (ClassID c, PMIID prop) const =0
 
virtual void ApplyAttribute (const IPMUnknown *newone, ClassID attrCls=kInvalidClass)=0
 
virtual void ApplyAttributes (const AttributeBossList *other)=0
 
virtual void ClearOverride (ClassID id)=0
 
virtual void ClearOverrides (const AttributeBossList *list)=0
 
virtual void ClearAllOverrides ()=0
 
virtual bool16 ContainsAttribute (ClassID classID) const =0
 
virtual const AttributeBossListGetBossList () 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 interface provides methods for accessing, apply and clear attributes.

Member Function Documentation

virtual void IObjectAttributeList::ApplyAttribute (const IPMUnknownnewone,
ClassID attrCls = kInvalidClass 
)
pure virtual

Apply the attribute.

Parameters
newoneIN the interface that contains the attribute data to apply.
attrClsIN the attribute's ClassID.
virtual void IObjectAttributeList::ApplyAttributes (const AttributeBossListother)
pure virtual

Apply the passed in attribute list.

Parameters
otherIN the attributes to apply.
virtual void IObjectAttributeList::ClearAllOverrides ()
pure virtual

Clear all the attributes.

virtual void IObjectAttributeList::ClearOverride (ClassID id)
pure virtual

Clear specific attribute determined by passed in ClassID.

Parameters
idIN the ClassID of the attribute to be cleared.
virtual void IObjectAttributeList::ClearOverrides (const AttributeBossListlist)
pure virtual

Clear the attributes determined by passed in attribute list.

Parameters
listIN the attribute list that is to be cleared.
virtual bool16 IObjectAttributeList::ContainsAttribute (ClassID classID) const
pure virtual

Check if the attribute list contains the passed in attribute or not.

Parameters
classIDIN the ClassID of the attribute we check.
Returns
bool16 kTrue indicates the attribute exists, otherwise return kFalse.
virtual int32 IObjectAttributeList::CountBosses () const
pure virtual

Get the number of total attributes.

Returns
number of attributes.
virtual const AttributeBossList* IObjectAttributeList::GetBossList () const
pure virtual

Get the attribute list.

Returns
const AttributeBossList the attribute list.
virtual ClassID IObjectAttributeList::GetClassN (int32 n) const
pure virtual

Get nth attribute's ClassID.

Parameters
nIN index of attribute.
Returns
nth attribute's ClassID.
virtual const IPMUnknown* IObjectAttributeList::QueryBossN (int32 n,
PMIID id 
) const
pure virtual

Query attribute's specific interface by the attribute's index and interfae id.

Parameters
nIN index of attribute.
idIN specific interface id.
Returns
the requested interface.
virtual const IPMUnknown* IObjectAttributeList::QueryByClassID (ClassID c,
PMIID prop 
) const
pure virtual

Query attribute's specific interface by the attribute's ClassID and interface id.

Parameters
cIN ClassID of attribute.
idIN specific interface id.
Returns
the requested interface.