querymatch.h

Go to the documentation of this file.

/*
 *   Copyright 2006-2007 Aaron Seigo <aseigo@kde.org>
 *
 *   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_QUERYMATCH_H
#define PLASMA_QUERYMATCH_H

#include <QtCore/QList>
#include <QtCore/QSharedDataPointer>

#include <plasma/plasma_export.h>

class QAction;
class QIcon;
class QString;
class QVariant;
class QWidget;

namespace Plasma
{

class RunnerContext;
class AbstractRunner;
class QueryMatchPrivate;

class PLASMA_EXPORT QueryMatch
{
    public:
        enum Type {
            NoMatch = 0,         
            CompletionMatch = 10, 
            PossibleMatch = 30,   
            InformationalMatch = 50, 
            HelperMatch = 70, 
            ExactMatch = 100 
        };

        explicit QueryMatch(AbstractRunner *runner);

        QueryMatch(const QueryMatch &other);

        ~QueryMatch();
        QueryMatch &operator=(const QueryMatch &other);
        bool operator==(const QueryMatch &other) const;
        bool operator!=(const QueryMatch &other) const;
        bool operator<(const QueryMatch &other) const;


        AbstractRunner *runner() const;

        bool isValid() const;

        void setType(Type type);

        Type type() const;

        void setRelevance(qreal relevance);

        qreal relevance() const;

        void run(const RunnerContext &context) const;

        void setData(const QVariant &data);

        QVariant data() const;

        void setId(const QString &id);

        QString id() const;

        void setText(const QString &text);

        QString text() const;

        void setSubtext(const QString &text);

        QString subtext() const;

        void setIcon(const QIcon &icon);

        QIcon icon() const;

        void setEnabled(bool enable);

        bool isEnabled() const;

        QAction* selectedAction() const;

        void setSelectedAction(QAction *action);

        bool hasConfigurationInterface() const;

        void createConfigurationInterface(QWidget *parent);

    private:
        QSharedDataPointer<QueryMatchPrivate> d;
};

}

#endif