commandinterface.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2005 Christoph Cullmann (cullmann@kde.org)
   Copyright (C) 2005-2006 Dominik Haumann (dhdev@gmx.de)
   Copyright (C) 2008 Erlend Hamberg (ehamberg@gmail.com)

   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 KDELIBS_KTEXTEDITOR_COMMANDINTERFACE_H
#define KDELIBS_KTEXTEDITOR_COMMANDINTERFACE_H

#include <ktexteditor/ktexteditor_export.h>
#include <ktexteditor/range.h>
#include <QtCore/QObject>

class QStringList;
class KCompletion;

namespace KTextEditor
{

class Editor;
class View;

class KTEXTEDITOR_EXPORT Command
{
  public:
    virtual ~Command () {}

  public:
    virtual const QStringList &cmds () = 0;

    virtual bool exec (KTextEditor::View *view, const QString &cmd, QString &msg) = 0;

    virtual bool help (KTextEditor::View *view, const QString &cmd, QString &msg) = 0;
};

class KTEXTEDITOR_EXPORT CommandExtension
{
  public:
    virtual ~CommandExtension() {}
 //### this is yet to be tried
    virtual void flagCompletions( QStringList&list ) = 0;

    virtual KCompletion *completionObject( KTextEditor::View *view,
                                           const QString & cmdname ) = 0;

    virtual bool wantsToProcessText( const QString &cmdname ) = 0;
 // ### yet to be tested. The obvious candidate is isearch.
    virtual void processText( KTextEditor::View *view, const QString &text ) = 0;
};

class KTEXTEDITOR_EXPORT CommandInterface
{
  public:
    virtual ~CommandInterface () {}

  public:
    virtual bool registerCommand (Command *cmd) = 0;

    virtual bool unregisterCommand (Command *cmd) = 0;

    virtual Command *queryCommand (const QString &cmd) const = 0;

    virtual QList<Command*> commands() const = 0;

    virtual QStringList commandList() const = 0;
};

class KTEXTEDITOR_EXPORT RangeCommand
{
  public:
    virtual ~RangeCommand() {}

    virtual bool exec (KTextEditor::View *view, const QString &cmd, QString &msg,
        const KTextEditor::Range &range) = 0;

    virtual bool supportsRange (const QString &cmd) = 0;
};

}

Q_DECLARE_INTERFACE(KTextEditor::CommandInterface, "org.kde.KTextEditor.CommandInterface")

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;