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