src/plugins/coreplugin/actionmanager/command.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef COMMAND_H
  34 #define COMMAND_H
  35
  36 #include <coreplugin/core_global.h>
  37
  38 #include <QtCore/QObject>
  39
  40 QT_BEGIN_NAMESPACE
  41 class QAction;
  42 class QShortcut;
  43 class QKeySequence;
  44 QT_END_NAMESPACE
  45
  46
  47 namespace Core {
  48
  49 class Context;
  50
  51 class CORE_EXPORT Command : public QObject
  52 {
  53     Q_OBJECT
  54 public:
  55     enum CommandAttribute {
  56         CA_Hide = 1,
  57         CA_UpdateText = 2,
  58         CA_UpdateIcon = 4,
  59         CA_NonConfigurable = 8
  60     };
  61     Q_DECLARE_FLAGS(CommandAttributes, CommandAttribute)
  62
  63     virtual void setDefaultKeySequence(const QKeySequence &key) = 0;
  64     virtual QKeySequence defaultKeySequence() const = 0;
  65     virtual QKeySequence keySequence() const = 0;
  66     virtual void setDefaultText(const QString &text) = 0;
  67     virtual QString defaultText() const = 0;
  68
  69     virtual int id() const = 0;
  70
  71     virtual QAction *action() const = 0;
  72     virtual QShortcut *shortcut() const = 0;
  73     virtual Context context() const = 0;
  74
  75     virtual void setAttribute(CommandAttribute attr) = 0;
  76     virtual void removeAttribute(CommandAttribute attr) = 0;
  77     virtual bool hasAttribute(CommandAttribute attr) const = 0;
  78
  79     virtual bool isActive() const = 0;
  80
  81     virtual ~Command() {}
  82
  83     virtual void setKeySequence(const QKeySequence &key) = 0;
  84
  85     virtual QString stringWithAppendedShortcut(const QString &str) const = 0;
  86
  87     virtual bool isScriptable() const = 0;
  88     virtual bool isScriptable(const Context &) const = 0;
  89
  90 signals:
  91     void keySequenceChanged();
  92     void activeStateChanged();
  93 };
  94
  95 } // namespace Core
  96
  97 Q_DECLARE_OPERATORS_FOR_FLAGS(Core::Command::CommandAttributes)
  98
  99 #endif // COMMAND_H