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