LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
IFinder Class Referenceabstract

Base class for search providers. More...

#include "ifinder.h"

Public Member Functions

virtual ~IFinder ()
 
virtual QStringList GetCategories () const =0
 Returns the plugin's categories. More...
 
virtual QList< IFindProxy_ptrGetProxy (const LC::Request &r)=0
 Returns find proxies for the given request. More...
 
virtual void categoriesChanged (const QStringList &newCats, const QStringList &oldCats)=0
 This signal should be emitted by plugin after the list of categories has been updated. More...
 

Detailed Description

Base class for search providers.

Plugin is handled for the supported categories by GetCategories() when needed, and GetProxy() is called for individual sub-requests.

See also
IFindProxy

Definition at line 123 of file ifinder.h.

Constructor & Destructor Documentation

◆ ~IFinder()

virtual IFinder::~IFinder ( )
inlinevirtual

Definition at line 126 of file ifinder.h.

Member Function Documentation

◆ categoriesChanged()

virtual void IFinder::categoriesChanged ( const QStringList &  newCats,
const QStringList &  oldCats 
)
pure virtual

This signal should be emitted by plugin after the list of categories has been updated.

Parameters
[out]newCatsThe list of new categories.
[out]oldCatsThe list of old categories.

◆ GetCategories()

virtual QStringList IFinder::GetCategories ( ) const
pure virtual

Returns the plugin's categories.

Returns the categories of requests that this plugin is able to handle. This list isn't cached, so it can be freely changed in runtime, though changes to the list won't be visible until user issues a new search request.

Returns
The list of up-to-date categories relevant to this plugin.

◆ GetProxy()

virtual QList<IFindProxy_ptr> IFinder::GetProxy ( const LC::Request r)
pure virtual

Returns find proxies for the given request.

Returns a shared pointer to IFindProxy objects that handle this sub-request r.

Parameters
[in]rThe request that should be handled by the returned IFindProxy objects.
Returns
QList of shared pointer to the IFindProxy handling the request.
See also
IFindProxy

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