src/plugins/coreplugin/designmode.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 DESIGNMODE_H
  34 #define DESIGNMODE_H
  35
  36 #include <coreplugin/imode.h>
  37
  38 namespace Core {
  39 class EditorManager;
  40 class IEditor;
  41
  42 namespace Internal {
  43 class DesignModeCoreListener;
  44 } // namespace Internal
  45
  46 /**
  47   * A global mode for Design pane - used by Bauhaus (QML Designer) and
  48   * Qt Designer. Other plugins can register themselves by registerDesignWidget()
  49   * and giving a list of mimetypes that the editor understands, as well as an instance
  50   * to the main editor widget itself.
  51   */
  52
  53 struct DesignModePrivate;
  54
  55 class CORE_EXPORT DesignMode : public Core::IMode
  56 {
  57     Q_OBJECT
  58
  59 public:
  60     explicit DesignMode(EditorManager *editorManager);
  61     virtual ~DesignMode();
  62
  63     void registerDesignWidget(QWidget *widget,
  64                               const QStringList &mimeTypes,
  65                               const Context &context);
  66     void unregisterDesignWidget(QWidget *widget);
  67
  68     QStringList registeredMimeTypes() const;
  69
  70     // IContext
  71     Context context() const;
  72     QWidget *widget();
  73
  74     // IMode
  75     QString displayName() const;
  76     QIcon icon() const;
  77     int priority() const;
  78     QString id() const;
  79     QString type() const;
  80
  81 signals:
  82     void actionsUpdated(Core::IEditor *editor);
  83
  84 private slots:
  85     void currentEditorChanged(Core::IEditor *editor);
  86     void updateActions();
  87     void updateContext(Core::IMode *newMode, Core::IMode *oldMode);
  88
  89 private:
  90     void setActiveContext(const Context &context);
  91
  92     DesignModePrivate *d;
  93     friend class Internal::DesignModeCoreListener;
  94 };
  95
  96 } // namespace Core
  97
  98 #endif // DESIGNMODE_H