IProperty Class Reference

#include <IProperty.h>

Inheritance diagram for IProperty:

Public Types
enum	{ kDefaultIID = IID_IPROPERTY }

Public Member Functions
virtual void	SetName (const PMString &name)=0
virtual PMString	GetName () const =0
virtual bool16	CanSearchFor () const =0
virtual void	SetCanSearchFor (bool16 canSearchFor)=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

A generic interface for keeping a piece of descriptive information. A property is like a type; for example, a name property, or a description property. A property also has a storage class, such as string. Properties are managed for a catalog by the IID_IPROPERTYMGR interface. Instances of properties are kept in IID_IPROPERTYTABLE, where each table stores the properties of a given storage class. The IID_IPROPERTY interface and IID_IPROPERTYTABLE interface are aggregated on the same boss, so that the IID_IPROPERTY tells the name of the property, and the IID_IPROPERTYTABLE holds instances of that property. For example, there exists a boss in the library catalog for the name string property, and another for the description string property. The IID_IPROPERTYMGR keeps track of each of these bosses. Used for library asset properties.

See Also

IPropertyMgr

IPropertyTable

Member Function Documentation

virtual bool16 IProperty::CanSearchFor ( ) const

pure virtual

Get whether the property can be searched for. An example of a non-searchable property might be a thumbnail image.

Returns

kTrue for a searchable property; kFalse for a non-searchable property

virtual PMString IProperty::GetName ( ) const

pure virtual

Get the name of the property.

Returns

the name of the property.

virtual void IProperty::SetCanSearchFor ( bool16  canSearchFor )

pure virtual

Set whether the property can be searched for.

Parameters

canSearchFor

IN kTrue for searchable; kFalse otherwise

virtual void IProperty::SetName ( const PMString &  name )

pure virtual

Set the name of a property.

Parameters

name	IN the name to give the property