ifinder.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 **********************************************************************/
 
#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