IPropertyTable Class Reference

#include <IPropertyTable.h>

Inheritance diagram for IPropertyTable:

Public Types
enum	{ kDefaultIID = IID_IPROPERTYTABLE }

Public Member Functions
virtual void	StoreItemProperty (UID item, IPMUnknown *propertyValue)=0
virtual IPMUnknown *	QueryItemProperty (UID item)=0
virtual bool16	DeleteItemProperty (UID item)=0
virtual PMString	GetItemPropertyAsString (UID item)=0
virtual int32	GetPropertyComparatorCount () const =0
virtual PMString	GetNthPropertyComparatorName (int32 compareIndex) const =0
virtual bool16	IsComparatorNegative (int32 compareIndex) const =0
virtual void	Delete ()=0
virtual void	GetItemsMatchingCriteria (PropUIDList &items, int32 whichComparator, IPMUnknown *propertyValue, PropUIDList *fromList=nil)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

An interface for storing property instances of a given storage class. Used for library asset properties.

See Also

IProperty

IPropertyMgr

Member Function Documentation

virtual void IPropertyTable::Delete ( )

pure virtual

Delete the property. This allows the property to delete any UIDs it owns.

virtual bool16 IPropertyTable::DeleteItemProperty ( UID  item )

pure virtual

Delete the property for a given item.

Parameters

item	IN the UID of the item whose property is being deleted

Returns

kTrue if deleted, kFalse if not found

virtual PMString IPropertyTable::GetItemPropertyAsString ( UID  item )

pure virtual

Create a string rendition of the property, if possible

Parameters

item	IN the UID of the item whose property is being deleted

Returns

a PMString form of the property, or an empty string

virtual void IPropertyTable::GetItemsMatchingCriteria ( PropUIDList &  items, int32  whichComparator, IPMUnknown *  propertyValue, PropUIDList *  fromList = nil  )

pure virtual

Get a list of items matching some criteria

Parameters

items	OUT the matching items
whichComparator	IN the index of the comparator to use
propertyValue	IN an interface to the criteria value to compare against
IN	the items to compare (use all existing properties if nil)

virtual PMString IPropertyTable::GetNthPropertyComparatorName ( int32  compareIndex ) const

pure virtual

Get the name of a comparator

Parameters

compareIndex

IN the index of the comparator

Returns

the name of this comparator

virtual int32 IPropertyTable::GetPropertyComparatorCount ( ) const

pure virtual

Return the number of comparators supported by the property

Returns

the number of comparators the property supports

virtual bool16 IPropertyTable::IsComparatorNegative ( int32  compareIndex ) const

pure virtual

Whether the comparator is negative (e.g., "Not equal")

Parameters

compareIndex

IN the index of the comparator

Returns

kTrue for a negative comparator; kFalse otherwise

virtual IPMUnknown* IPropertyTable::QueryItemProperty ( UID  item )

pure virtual

Query the property of an item.

Parameters

item	IN the UID of the item whose property is being sought

Returns

an interface pointer on the property found, or nil if none found

virtual void IPropertyTable::StoreItemProperty ( UID  item, IPMUnknown *  propertyValue  )

pure virtual

Store an instance of a property.

Parameters

item	IN the UID of the item this property is associated with (e.g., library asset)
propertyValue	IN an interface pointer on the property being stored