runnermanager.h

Go to the documentation of this file.

/*
 *   Copyright (C) 2006 Aaron Seigo <aseigo@kde.org>
 *   Copyright (C) 2007 Ryan P. Bitanga <ryan.bitanga@gmail.com>
 *   Copyright (C) 2008 Jordi Polo <mumismo@gmail.com>
 *
 *   This program 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, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef PLASMA_RUNNERMANAGER_H
#define PLASMA_RUNNERMANAGER_H

#include <QtCore/QList>
#include <QtCore/QObject>

#include <kplugininfo.h>

#include <plasma/plasma_export.h>
#include "abstractrunner.h"

class QAction;
class KConfigGroup;

namespace Plasma
{
    class QueryMatch;
    class AbstractRunner;
    class RunnerContext;
    class RunnerManagerPrivate;

class PLASMA_EXPORT RunnerManager : public QObject
{
    Q_OBJECT

    public:
        explicit RunnerManager(QObject *parent=0);
        explicit RunnerManager(KConfigGroup &config, QObject *parent=0);
        ~RunnerManager();

        AbstractRunner *runner(const QString &name) const;

        AbstractRunner *singleModeRunner() const;

        void setSingleModeRunnerId(const QString &id);

        QString singleModeRunnerId() const;

        bool singleMode() const;

        void setSingleMode(bool singleMode);

        QString runnerName(const QString &id) const;

        QList<AbstractRunner *> runners() const;

        QStringList singleModeAdvertisedRunnerIds() const;

        RunnerContext *searchContext() const;

        QList<QueryMatch> matches() const;

        void run(const QueryMatch &match);

        void run(const QString &id);

        QList<QAction*> actionsForMatch(const QueryMatch &match);

        QString query() const;

        void reloadConfiguration();

        void setAllowedRunners(const QStringList &runners);

        void loadRunner(const KService::Ptr service);

        void loadRunner(const QString &path);

        QStringList allowedRunners() const;

        QMimeData * mimeDataForMatch(const QueryMatch &match) const;

        QMimeData * mimeDataForMatch(const QString &id) const;

        static KPluginInfo::List listRunnerInfo(const QString &parentApp = QString());

    public Q_SLOTS:
        void setupMatchSession();

        void matchSessionComplete();

        void launchQuery(const QString &term, const QString &runnerId);

        void launchQuery(const QString &term);

        bool execQuery(const QString &term, const QString &runnerName);

        bool execQuery(const QString &term);

        void reset();

    Q_SIGNALS:
        void matchesChanged(const QList<Plasma::QueryMatch> &matches);

        void queryFinished();

    private:
        Q_PRIVATE_SLOT(d, void scheduleMatchesChanged())
        Q_PRIVATE_SLOT(d, void matchesChanged())
        Q_PRIVATE_SLOT(d, void jobDone(ThreadWeaver::Job*))
        Q_PRIVATE_SLOT(d, void unblockJobs())
        Q_PRIVATE_SLOT(d, void runnerMatchingSuspended(bool))

        RunnerManagerPrivate * const d;

        friend class RunnerManagerPrivate;
};

}

#endif