search_filter_manager_v2

#include <search_tools.h>

Inheritance diagram for search_filter_manager_v2:

Public Types
enum	{ KFlagAllowSort = 1 << 0, KFlagSuppressNotify = 1 << 1 }
Public Types inherited from service_base
typedef service_base	t_interface

Public Member Functions
virtual search_filter_v2::ptr	create_ex (const char *query, completion_notify::ptr changeNotify, t_uint32 flags)=0
	FB2K_MAKE_SERVICE_INTERFACE (search_filter_manager_v2, search_filter_manager)
virtual void	show_manual ()=0
Public Member Functions inherited from search_filter_manager
virtual search_filter::ptr	create (const char *p_query)=0
	FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (search_filter_manager)
virtual void	get_manual (pfc::string_base &p_out)=0
void	show_manual ()
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 ()

Additional Inherited Members
Protected Member Functions inherited from service_base
	service_base ()
	~service_base ()

Detailed Description

New in 0.9.5.3.

Definition at line 57 of file search_tools.h.

Member Enumeration Documentation

anonymous enum

Enumerator
KFlagAllowSort
KFlagSuppressNotify

Definition at line 59 of file search_tools.h.

         {
        KFlagAllowSort = 1 << 0,
        KFlagSuppressNotify = 1 << 1,
    };

Member Function Documentation

virtual search_filter_v2::ptr search_filter_manager_v2::create_ex ( const char *  query, completion_notify::ptr  changeNotify, t_uint32  flags  )

pure virtual

Creates a search_filter object. Throws an exception on failure (such as an error in the query). It's recommended that you relay the exception message to the user if this function fails.

Parameters

changeNotify

A completion_notify callback object that will get called each time the query's behavior changes as a result of some external event (such as system time change). The caller must refresh query results each time this callback is triggered. The status parameter of its on_completion() parameter is unused and always set to zero.

search_filter_manager_v2::FB2K_MAKE_SERVICE_INTERFACE	(	search_filter_manager_v2	,
		search_filter_manager
	)

virtual void search_filter_manager_v2::show_manual ( )

pure virtual

Opens the search query syntax reference document, typically an external HTML in user's default web browser.

---

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

• foobar2000/SDK/search_tools.h