itemsearchjob.h

/*
    Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_ITEMSEARCHJOB_H
#define AKONADI_ITEMSEARCHJOB_H

#include <akonadi/item.h>
#include <akonadi/job.h>
#include <akonadi/collection.h>

#include <QtCore/QUrl>

namespace Akonadi {

class ItemFetchScope;
class ItemSearchJobPrivate;
class SearchQuery;

class AKONADI_EXPORT ItemSearchJob : public Job
{
    Q_OBJECT

public:
    explicit AKONADI_DEPRECATED ItemSearchJob(const QString &query, QObject *parent = 0);

    explicit ItemSearchJob(const SearchQuery &query, QObject *parent = 0);

    ~ItemSearchJob();

    void AKONADI_DEPRECATED setQuery(const QString &query);

    void setQuery(const SearchQuery &query);

    void setFetchScope(const ItemFetchScope &fetchScope);

    ItemFetchScope &fetchScope();

    Item::List items() const;

    static AKONADI_DEPRECATED QUrl akonadiItemIdUri();

    void setMimeTypes(const QStringList &mimeTypes);

    QStringList mimeTypes() const;

    void setSearchCollections(const Collection::List &collections);

    Collection::List searchCollections() const;

    void setRecursive(bool recursive);

    bool isRecursive() const;

    void setRemoteSearchEnabled(bool enabled);

    bool isRemoteSearchEnabled() const;

Q_SIGNALS:
    void itemsReceived(const Akonadi::Item::List &items);

protected:
    void doStart();
    virtual void doHandleResponse(const QByteArray &tag, const QByteArray &data);

private:
    //@cond PRIVATE
    Q_DECLARE_PRIVATE(ItemSearchJob)

    Q_PRIVATE_SLOT(d_func(), void timeout())
    //@endcond
};

}

#endif