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