LeechCraft Azoth  0.6.70-6645-gcd10d7e
Modular multiprotocol IM plugin for LeechCraft
LeechCraft::Azoth::ISearchSession Class Referenceabstract

Interface for search sessions. More...

#include "ihavesearch.h"

Public Member Functions

virtual ~ISearchSession ()
 
virtual void RestartSearch (QString server)=0
 Sets the search server used and restarts the search. More...
 
virtual QAbstractItemModel * GetRepresentationModel () const =0
 Returns the model with the results. More...
 

Detailed Description

Interface for search sessions.

This interface is expected to be implemented by the objects returned from IHaveSearch::CreateSearchSession() representing search sessions.

The search server string is the via the RestartSearch() method, which also should automatically restart the search and fetch any search form, for example.

The model representing service discovery results is obtained via GetRepresentationModel() method.

See also
IHaveServiceDiscovery

Definition at line 57 of file ihavesearch.h.

Constructor & Destructor Documentation

virtual LeechCraft::Azoth::ISearchSession::~ISearchSession ( )
inlinevirtual

Definition at line 60 of file ihavesearch.h.

References GetRepresentationModel(), and RestartSearch().

+ Here is the call graph for this function:

Member Function Documentation

virtual QAbstractItemModel* LeechCraft::Azoth::ISearchSession::GetRepresentationModel ( ) const
pure virtual

Returns the model with the results.

This function should return the model containing the search results. The returned model should be the same object for each call to this function during the lifetime of this object.

Returns
Model with the results.

Referenced by ~ISearchSession().

+ Here is the caller graph for this function:

virtual void LeechCraft::Azoth::ISearchSession::RestartSearch ( QString  server)
pure virtual

Sets the search server used and restarts the search.

This function should initiate searching on the given server, if applicable, or "in general", if search server concept is not applicable to this protocol/account.

This function should initiate fetching the corresponding search form and, when it's fetched (asynchronously, of course), show it to the user, and then, after user's input, perform the search itself.

The representation model (see GetRepresentationModel()) should be filled with the search results, if any.

Parameters
[in]serverThe search server which should be used for search.

Referenced by ~ISearchSession().

+ Here is the caller graph for this function:


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