foobar2000 SDK  2015-08-03
Public Member Functions | Protected Member Functions
search_filterabstract

#include <search_tools.h>

+ Inheritance diagram for search_filter:

Public Member Functions

 FB2K_MAKE_SERVICE_INTERFACE (search_filter, service_base)
 
virtual void test_multi (metadb_handle_list_cref data, bool *out)=0
 
- Public Member Functions inherited from service_base
template<typename outPtr_t >
bool cast (outPtr_t &outPtr)
 
virtual int service_add_ref ()=0 throw ()
 
virtual bool service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
 
template<class T >
bool service_query_t (service_ptr_t< T > &p_out)
 
virtual int service_release ()=0 throw ()
 

Protected Member Functions

virtual bool test_locked (const metadb_handle_ptr &p_item, const file_info *p_info)=0
 
- Protected Member Functions inherited from service_base
 service_base ()
 
 ~service_base ()
 

Additional Inherited Members

- Public Types inherited from service_base
typedef service_base t_interface
 

Detailed Description

Instance of a search filter object. New in 0.9.5.
This object contains a preprocessed search query; used to perform filtering similar to Media Library Search or Album List's "filter" box.
Use search_filter_manager API to instantiate search_filter objects.

Definition at line 4 of file search_tools.h.

Member Function Documentation

search_filter::FB2K_MAKE_SERVICE_INTERFACE ( search_filter  ,
service_base   
)
virtual bool search_filter::test_locked ( const metadb_handle_ptr p_item,
const file_info p_info 
)
protectedpure virtual

For backwards compatibility with older (0.9.5 alpha) revisions of this API. Do not call.

virtual void search_filter::test_multi ( metadb_handle_list_cref  data,
bool *  out 
)
pure virtual

Use this to run this filter on a group of items.

Parameters
dataItems to test.
outPointer to a buffer (size at least equal to number of items in the source list) receiving the results.

The documentation for this class was generated from the following file: