src/plugins/designer/qtdesignerformclasscodegenerator.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 QTDESIGNERFORMCLASSCODEGENERATOR_H
  34 #define QTDESIGNERFORMCLASSCODEGENERATOR_H
  35
  36 #include <QtCore/QString>
  37 #include <QtCore/QVariant>
  38 #include <QtCore/QObject>
  39
  40 QT_BEGIN_NAMESPACE
  41 class QSettings;
  42 QT_END_NAMESPACE
  43
  44 namespace Designer {
  45 class FormClassWizardParameters;
  46 namespace Internal {
  47
  48 // How to embed the Ui::Form class.
  49 enum UiClassEmbedding
  50 {
  51     PointerAggregatedUiClass, // "Ui::Form *m_ui";
  52     AggregatedUiClass,        // "Ui::Form m_ui";
  53     InheritedUiClass          // "...private Ui::Form..."
  54 };
  55
  56 // Parameters influencing the code generation to be used in settings page.
  57 struct FormClassWizardGenerationParameters
  58 {
  59     FormClassWizardGenerationParameters();
  60     bool equals(const FormClassWizardGenerationParameters &rhs) const;
  61
  62     void fromSettings(const QSettings *);
  63     void toSettings(QSettings *) const;
  64
  65     UiClassEmbedding embedding;
  66     bool retranslationSupport; // Add handling for language change events
  67     bool includeQtModule; // Include "<QtGui/[Class]>" or just "<[Class]>"
  68     bool indentNamespace;
  69 };
  70
  71 inline bool operator==(const FormClassWizardGenerationParameters &p1, const FormClassWizardGenerationParameters &p2) { return p1.equals(p2); }
  72 inline bool operator!=(const FormClassWizardGenerationParameters &p1, const FormClassWizardGenerationParameters &p2) { return !p1.equals(p2); }
  73
  74 } // namespace Internal
  75
  76 // Publicly registered service to generate the code for a form class
  77 // (See PluginManager::Invoke) to be accessed by Qt4ProjectManager.
  78 class QtDesignerFormClassCodeGenerator : public QObject
  79 {
  80     Q_OBJECT
  81 public:
  82     explicit QtDesignerFormClassCodeGenerator(QObject *parent = 0);
  83
  84     static bool generateCpp(const FormClassWizardParameters &parameters,
  85                             QString *header, QString *source, int indentation = 4);
  86
  87     // Generate form class code according to settings.
  88     Q_INVOKABLE QVariant generateFormClassCode(const Designer::FormClassWizardParameters &parameters);
  89 };
  90 } // namespace Designer
  91
  92 #endif // QTDESIGNERFORMCLASSCODEGENERATOR_H