summaryrefslogtreecommitdiff
path: root/src/plugins/designer/cpp/formclasswizardparameters.h
blob: 0ddcf39d55b3a8fdc47d85bf346e69d384e3749c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** No Commercial Usage
**
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/

#ifndef FORMCLASSWIZARDPARAMETERS_H
#define FORMCLASSWIZARDPARAMETERS_H

#include "../designer_export.h"
#include <QtCore/QString>
#include <QtCore/QSharedDataPointer>

QT_BEGIN_NAMESPACE
class QSettings;
QT_END_NAMESPACE

namespace Designer {

class FormClassWizardGenerationParametersPrivate;
class FormClassWizardParametersPrivate;

// Parameters influencing the code generation.
class DESIGNER_EXPORT FormClassWizardGenerationParameters {
public:
    // How to embed the Ui::Form class.
    enum UiClassEmbedding {
        PointerAggregatedUiClass, // "Ui::Form *m_ui";
        AggregatedUiClass,        // "Ui::Form m_ui";
        InheritedUiClass          // "...private Ui::Form..."
    };

    FormClassWizardGenerationParameters();
    ~FormClassWizardGenerationParameters();
    FormClassWizardGenerationParameters(const FormClassWizardGenerationParameters&);
    FormClassWizardGenerationParameters &operator=(const FormClassWizardGenerationParameters &);

    void fromSettings(const QSettings *);
    void toSettings(QSettings *) const;

    UiClassEmbedding embedding() const;
    void setEmbedding(UiClassEmbedding e);

    bool retranslationSupport() const; // Add handling for language change events
    void setRetranslationSupport(bool v);

    bool includeQtModule() const;      // Include "<QtGui/[Class]>" or just "<[Class]>"
    void setIncludeQtModule(bool v);

    bool indentNamespace() const;
    void setIndentNamespace(bool v);

    bool equals(const FormClassWizardGenerationParameters &rhs) const;

private:
    QSharedDataPointer<FormClassWizardGenerationParametersPrivate> m_d;
};

inline bool operator==(const FormClassWizardGenerationParameters &p1, const FormClassWizardGenerationParameters &p2) { return p1.equals(p2); }
inline bool operator!=(const FormClassWizardGenerationParameters &p1, const FormClassWizardGenerationParameters &p2) { return !p1.equals(p2); }

// Parameters required to generate the code part of a form class with
// helpers for XML-processing ui templates.
class DESIGNER_EXPORT FormClassWizardParameters {
public:
    FormClassWizardParameters();
    ~FormClassWizardParameters();
    FormClassWizardParameters(const FormClassWizardParameters &);
    FormClassWizardParameters &operator=(const FormClassWizardParameters &);

    bool generateCpp(const FormClassWizardGenerationParameters &fgp,
                     QString *header, QString *source, int indentation = 4) const;

    // Helper to parse UI XML forms to determine:
    // 1) The ui class name from "<class>Designer::Internal::FormClassWizardPage</class>"
    // 2) the base class from: widget class="QWizardPage"...
    static bool getUIXmlData(const QString &uiXml, QString *formBaseClass, QString *uiClassName);
    // Helper to change the class name in a UI XML form
    static QString changeUiClassName(const QString &uiXml, const QString &newUiClassName);

    QString uiTemplate() const;
    void setUiTemplate(const QString &);

    QString className() const;
    void setClassName(const QString &);

    QString path() const;
    void setPath(const QString &);

    QString sourceFile() const;
    void setSourceFile(const QString &);

    QString headerFile() const;
    void setHeaderFile(const QString &);

    QString uiFile() const;
    void setUiFile(const QString &);

private:
    QSharedDataPointer<FormClassWizardParametersPrivate> m_d;
};

} // namespace Designer

#endif // FORMCLASSWIZARDPARAMETERS_H