runnersyntax.h

Go to the documentation of this file.

/*
 *   Copyright 2009 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_RUNNERSYNTAX_H
#define PLASMA_RUNNERSYNTAX_H

#include <QtCore/QStringList>

#include <plasma/plasma.h>

namespace Plasma
{

class RunnerSyntaxPrivate;
class PLASMA_EXPORT RunnerSyntax
{
    public:
        RunnerSyntax(const QString &exampleQuery, const QString &description);

        RunnerSyntax(const RunnerSyntax &other);

        ~RunnerSyntax();

        RunnerSyntax &operator=(const RunnerSyntax &rhs);

        void addExampleQuery(const QString &exampleQuery);

        QStringList exampleQueries() const;

        QStringList exampleQueriesWithTermDescription() const;

        void setDescription(const QString &description);

        QString description() const;

        void setSearchTermDescription(const QString &description);

        QString searchTermDescription() const;

    private:
        RunnerSyntaxPrivate *const d;
};

} // namespace Plasma

#endif // multiple inclusion guard