ifinder.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/
 
#ifndef INTERFACES_IFINDER_H
#define INTERFACES_IFINDER_H
#include <memory>
#include <QStringList>
#include <QHash>
#include <QVariant>
 
class QAbstractItemModel;
 
namespace LC
{
    struct Request
    {
        enum Type
        {
            RTFixed,        
            RTWildcard,     
            RTRegexp,       
            RTTag           
        };

        bool CaseSensitive_;

        Type Type_;

        QString Plugin_;

        QString Category_;

        QString String_;
        QHash<QString, QVariant> Params_;
    };
}

class Q_DECL_EXPORT IFindProxy
{
public:
    virtual ~IFindProxy () {}

    virtual QAbstractItemModel* GetModel () = 0;

    virtual QByteArray GetUniqueSearchID () const = 0;

    virtual QStringList GetCategories () const = 0;
};
 
typedef std::shared_ptr<IFindProxy> IFindProxy_ptr;

class Q_DECL_EXPORT IFinder
{
public:
    virtual ~IFinder () {}

    virtual QStringList GetCategories () const = 0;

    virtual QList<IFindProxy_ptr> GetProxy (const LC::Request& r) = 0;

    virtual void categoriesChanged (const QStringList& newCats,
            const QStringList& oldCats) = 0;
};
 
Q_DECLARE_INTERFACE (IFinder, "org.Deviant.LeechCraft.IFinder/1.0")
Q_DECLARE_INTERFACE (IFindProxy, "org.Deviant.LeechCraft.IFinder/1.0")
 
#endif