InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ILibraryComplexFilterData Class Referenceabstract

#include <ILibraryFilterData.h>

Inheritance diagram for ILibraryComplexFilterData:
IPMUnknown

Public Types

enum  EConjunction { Conjunction_And, Conjunction_Or }
 

Public Member Functions

virtual void SetConjunction (EConjunction inConjunction)=0
 
virtual EConjunction GetConjunction ()=0
 
virtual UIDRef AppendNewSimpleFilter ()=0
 
virtual int32 GetNumSimpleFilters ()=0
 
virtual UIDRef GetSimpleFilterAt (int32 i)=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

"ComplexFilter" is a collection of "SimpleFilters" which corresponds to multiple search specification lines from the Library Show Subset dialog.

See Also
ILibrarySimpleFilterData

Member Enumeration Documentation

enum ILibraryComplexFilterData::EConjunction

Conjunction to join the multiple tests.
Enumerator
Conjunction_And 

Use AND

Conjunction_Or 

Use OR

Member Function Documentation

virtual UIDRef ILibraryComplexFilterData::AppendNewSimpleFilter ()
pure virtual

Create a new Simple Filer and append it to the complex filter. The caller must then initialize the new simple filter with the appropriate data.

Returns
the filter boss UIDRef for a simple filter being added
virtual EConjunction ILibraryComplexFilterData::GetConjunction ()
pure virtual

Get the logical conjuction of the multiple simple filters.

Returns
the conjunction used
virtual int32 ILibraryComplexFilterData::GetNumSimpleFilters ()
pure virtual

Return the number of simple filters in this complex filter.

Returns
the number of simple filters.
virtual UIDRef ILibraryComplexFilterData::GetSimpleFilterAt (int32 i)
pure virtual

Get the UIDRef of the simple filter at the specified index.

Parameters
iIN index of simple filter
Returns
the filter boss UIDRef of the simple filter sought
virtual bool16 ILibraryComplexFilterData::PassFilter (ILibraryAssetMetaData * inAssetData)
pure virtual

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

Parameters
inAssetDataIN metadata to test
Returns
kTrue if criteria met, kFalse otherwise
virtual void ILibraryComplexFilterData::SetConjunction (EConjunction inConjunction)
pure virtual

Set the logical conjuction of the multiple simple filters.

Parameters
inConjunctionIN the conjunction to use