src/plugins/vcsbase/basevcseditorfactory.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 BASEVCSEDITORFACTORY_H
  34 #define BASEVCSEDITORFACTORY_H
  35
  36 #include "vcsbase_global.h"
  37 #include "vcsbaseeditor.h"
  38
  39 #include <coreplugin/editormanager/ieditorfactory.h>
  40
  41 #include <QtCore/QStringList>
  42
  43 namespace VCSBase {
  44
  45 struct BaseVCSEditorFactoryPrivate;
  46
  47 // Base class for editor factories creating instances of VCSBaseEditor
  48 //  subclasses.
  49 class VCSBASE_EXPORT BaseVCSEditorFactory : public Core::IEditorFactory
  50 {
  51     Q_OBJECT
  52 public:
  53     explicit BaseVCSEditorFactory(const VCSBaseEditorParameters *type);
  54     virtual ~BaseVCSEditorFactory();
  55
  56     virtual QStringList mimeTypes() const;
  57     // IEditorFactory
  58
  59     virtual QString id() const;
  60     virtual QString displayName() const;
  61
  62     virtual Core::IFile *open(const QString &fileName);
  63     virtual Core::IEditor *createEditor(QWidget *parent);
  64
  65 private:
  66     // Implement to create and initialize (call init()) a
  67     // VCSBaseEditor subclass
  68     virtual VCSBaseEditorWidget *createVCSBaseEditor(const VCSBaseEditorParameters *type,
  69                                                QWidget *parent) = 0;
  70
  71     BaseVCSEditorFactoryPrivate *m_d;
  72 };
  73
  74 // Utility template to create an editor.
  75 template <class Editor>
  76 class VCSEditorFactory : public BaseVCSEditorFactory
  77 {
  78 public:
  79     explicit VCSEditorFactory(const VCSBaseEditorParameters *type,
  80                               QObject *describeReceiver = 0,
  81                               const char *describeSlot = 0);
  82
  83 private:
  84     virtual VCSBaseEditorWidget *createVCSBaseEditor(const VCSBaseEditorParameters *type,
  85                                                QWidget *parent);
  86     QObject *m_describeReceiver;
  87     const char *m_describeSlot;
  88 };
  89
  90 template <class Editor>
  91 VCSEditorFactory<Editor>::VCSEditorFactory(const VCSBaseEditorParameters *type,
  92                                            QObject *describeReceiver,
  93                                            const char *describeSlot) :
  94     BaseVCSEditorFactory(type),
  95     m_describeReceiver(describeReceiver),
  96     m_describeSlot(describeSlot)
  97 {
  98 }
  99
 100 template <class Editor>
 101 VCSBaseEditorWidget *VCSEditorFactory<Editor>::createVCSBaseEditor(const VCSBaseEditorParameters *type,
 102                                                              QWidget *parent)
 103 {
 104     VCSBaseEditorWidget *rc = new Editor(type, parent);
 105     rc->init();
 106     if (m_describeReceiver)
 107         connect(rc, SIGNAL(describeRequested(QString,QString)), m_describeReceiver, m_describeSlot);
 108     return rc;
 109
 110 }
 111
 112 } // namespace VCSBase
 113
 114 #endif // BASEVCSEDITORFACTORY_H
 115