ILibrarySimpleFilterData Class Reference

#include <ILibraryFilterData.h>

Inheritance diagram for ILibrarySimpleFilterData:

Public Types
enum	EField { Field_Type, Field_Date, Field_Name, Field_Description }
enum	ECondition {   Condition_Equal, Condition_NotEqual, Condition_GreaterThan, Condition_LessThan,   Condition_Contains, Condition_DoesNotContain, Condition_Undefined }

Public Member Functions
virtual void	SetNameFilter (ECondition inCondition, const PMString &inString)=0
virtual void	SetDescriptionFilter (ECondition inCondition, const PMString &inString)=0
virtual void	SetDateFilter (ECondition inCondition, const GlobalTime &inTime)=0
virtual void	SetTypeFilter (ECondition inCondition, ILibraryAssetMetaData::UserType inType)=0
virtual EField	GetFilterField ()=0
virtual void	GetNameFilter (ECondition &outCondition, PMString &outString)=0
virtual void	GetDescriptionFilter (ECondition &outCondition, PMString &outString)=0
virtual void	GetDateFilter (ECondition &outCondition, GlobalTime &outTime)=0
virtual void	GetTypeFilter (ECondition &outCondition, ILibraryAssetMetaData::UserType &outType)=0
virtual bool16	PassFilter (ILibraryAssetMetaData *inAssetData)=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

"SimpleFilter" corresponds to a single search specification line from the Library Show Subset dialog.

Member Enumeration Documentation

enum ILibrarySimpleFilterData::ECondition

Condition used in filter.

Enumerator
Condition_Equal	Equality comparison
Condition_NotEqual	Inequality comparison
Condition_GreaterThan	Greater than comparison
Condition_LessThan	Less than comparison
Condition_Contains	Containment comparison
Condition_DoesNotContain	Exclusion comparison
Condition_Undefined	Sentinal value for storing at the end of arrays

enum ILibrarySimpleFilterData::EField

Type of filter. Need to keep these in sync with order defined by popup menu on dialog.

Enumerator
Field_Type	Type filter
Field_Date	Date filter
Field_Name	Name filter
Field_Description	Description filter

Member Function Documentation

virtual void ILibrarySimpleFilterData::GetDateFilter ( ECondition &  outCondition, GlobalTime &  outTime  )

pure virtual

Get the condition and date value for the date filter.

Parameters

outCondition	OUT the condition used
outTime	OUT the date value used

virtual void ILibrarySimpleFilterData::GetDescriptionFilter ( ECondition &  outCondition, PMString &  outString  )

pure virtual

Get the condition and data for the description filter.

Parameters

outCondition	OUT the condition used
outString	OUT the description used

virtual EField ILibrarySimpleFilterData::GetFilterField ( )

pure virtual

Gets the filter type.

Returns

the type of filter

virtual void ILibrarySimpleFilterData::GetNameFilter ( ECondition &  outCondition, PMString &  outString  )

pure virtual

Get the condition and name for the name filter.

Parameters

outCondition	OUT the condition used
outString	OUT the name value used

virtual void ILibrarySimpleFilterData::GetTypeFilter ( ECondition &  outCondition, ILibraryAssetMetaData::UserType &  outType  )

pure virtual

Get the condition and type for the type filter.

Parameters

outCondition	OUT the condition used
outType	OUT the user type used

virtual bool16 ILibrarySimpleFilterData::PassFilter ( ILibraryAssetMetaData *  inAssetData )

pure virtual

Tests the asset data to see if it passes the filter criteria.

Parameters

inAssetData

IN metadata to test

Returns

kTrue if criteria is met, kFalse otherwise

virtual void ILibrarySimpleFilterData::SetDateFilter ( ECondition  inCondition, const GlobalTime &  inTime  )

pure virtual

Set the filter type to a date filter on the supplied time.

Parameters

inCondition	IN condition to use
inTime	IN value to compare to

virtual void ILibrarySimpleFilterData::SetDescriptionFilter ( ECondition  inCondition, const PMString &  inString  )

pure virtual

Set the filter type to a description filter on the supplied description string.

Parameters

inCondition	IN condition to use
inString	IN value to compare to

virtual void ILibrarySimpleFilterData::SetNameFilter ( ECondition  inCondition, const PMString &  inString  )

pure virtual

Set the filter type to a name filter on the supplied name.

Parameters

inCondition	IN condition to use
inString	IN value to compare to

virtual void ILibrarySimpleFilterData::SetTypeFilter ( ECondition  inCondition, ILibraryAssetMetaData::UserType  inType  )

pure virtual

Set the filter type to a type filter on the supplied type.

Parameters

inCondition	IN condition to use
inType	IN value to compare to