1// Copyright (C) 2020 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef ABSTRACTFORMBUILDER_H
5#define ABSTRACTFORMBUILDER_H
6
7#if 0
8# pragma qt_sync_skip_header_check
9#endif
10
11#include "uilib_global.h"
12
13#include <QtCore/qlist.h>
14#include <QtCore/qhash.h>
15#include <QtCore/qdir.h>
16#include <QtCore/qscopedpointer.h>
17
18#include <QtWidgets/qsizepolicy.h>
19#include <QtGui/qpalette.h>
20
21QT_BEGIN_NAMESPACE
22#if 0
23// pragma for syncqt, don't remove.
24
25#pragma qt_class(QAbstractFormBuilder)
26#endif
27
28class QAction;
29class QButtonGroup;
30class QActionGroup;
31class QComboBox;
32class QIODevice;
33class QIcon;
34class QLayout;
35class QLayoutItem;
36class QListWidget;
37class QObject;
38class QSpacerItem;
39class QTreeWidget;
40class QTableWidget;
41class QVariant;
42class QWidget;
43class QAbstractButton;
44class QAbstractItemView;
45
46#ifdef QFORMINTERNAL_NAMESPACE
47namespace QFormInternal
48{
49#endif
50
51class DomAction;
52class DomActionGroup;
53class DomButtonGroup;
54class DomButtonGroups;
55class DomActionRef;
56class DomBrush;
57class DomColorGroup;
58class DomConnections;
59class DomCustomWidgets;
60class DomLayout;
61class DomLayoutItem;
62class DomProperty;
63class DomResources;
64class DomSpacer;
65class DomString;
66class DomTabStops;
67class DomUI;
68class DomWidget;
69class DomResourcePixmap;
70
71class QResourceBuilder;
72class QTextBuilder;
73class QFormBuilderExtra;
74
75class QDESIGNER_UILIB_EXPORT QAbstractFormBuilder
76{
77public:
78 Q_DISABLE_COPY_MOVE(QAbstractFormBuilder)
79
80 QAbstractFormBuilder();
81 virtual ~QAbstractFormBuilder();
82
83 QDir workingDirectory() const;
84 void setWorkingDirectory(const QDir &directory);
85
86 virtual QWidget *load(QIODevice *dev, QWidget *parentWidget = nullptr);
87 virtual void save(QIODevice *dev, QWidget *widget);
88
89 QString errorString() const;
90
91protected:
92//
93// load
94//
95 virtual void loadExtraInfo(DomWidget *ui_widget, QWidget *widget, QWidget *parentWidget);
96
97 virtual QWidget *create(DomUI *ui, QWidget *parentWidget);
98 virtual QWidget *create(DomWidget *ui_widget, QWidget *parentWidget);
99 virtual QLayout *create(DomLayout *ui_layout, QLayout *layout, QWidget *parentWidget);
100 virtual QLayoutItem *create(DomLayoutItem *ui_layoutItem, QLayout *layout, QWidget *parentWidget);
101
102 virtual QAction *create(DomAction *ui_action, QObject *parent);
103 virtual QActionGroup *create(DomActionGroup *ui_action_group, QObject *parent);
104 virtual void addMenuAction(QAction *action);
105
106 virtual void applyProperties(QObject *o, const QList<DomProperty*> &properties);
107 bool applyPropertyInternally(QObject *o, const QString &propertyName, const QVariant &value);
108
109 virtual void applyTabStops(QWidget *widget, DomTabStops *tabStops);
110
111 virtual QWidget *createWidget(const QString &widgetName, QWidget *parentWidget, const QString &name);
112 virtual QLayout *createLayout(const QString &layoutName, QObject *parent, const QString &name);
113 virtual QAction *createAction(QObject *parent, const QString &name);
114 virtual QActionGroup *createActionGroup(QObject *parent, const QString &name);
115
116 virtual void createCustomWidgets(DomCustomWidgets *) {}
117 virtual void createConnections(DomConnections *, QWidget *) {}
118 virtual void createResources(DomResources*) {}
119
120 virtual bool addItem(DomLayoutItem *ui_item, QLayoutItem *item, QLayout *layout);
121 virtual bool addItem(DomWidget *ui_widget, QWidget *widget, QWidget *parentWidget);
122
123//
124// save
125//
126 virtual void saveExtraInfo(QWidget *widget, DomWidget *ui_widget, DomWidget *ui_parentWidget);
127
128 virtual void saveDom(DomUI *ui, QWidget *widget);
129
130 virtual DomActionRef *createActionRefDom(QAction *action);
131
132 virtual DomWidget *createDom(QWidget *widget, DomWidget *ui_parentWidget, bool recursive = true);
133 virtual DomLayout *createDom(QLayout *layout, DomLayout *ui_layout, DomWidget *ui_parentWidget);
134 virtual DomLayoutItem *createDom(QLayoutItem *item, DomLayout *ui_parentLayout, DomWidget *ui_parentWidget);
135 virtual DomSpacer *createDom(QSpacerItem *spacer, DomLayout *ui_parentLayout, DomWidget *ui_parentWidget);
136
137 virtual DomAction *createDom(QAction *action);
138 virtual DomActionGroup *createDom(QActionGroup *actionGroup);
139 DomButtonGroup *createDom(QButtonGroup *buttonGroup);
140
141 virtual DomConnections *saveConnections();
142 virtual DomCustomWidgets *saveCustomWidgets();
143 virtual DomTabStops *saveTabStops();
144 virtual DomResources *saveResources();
145 DomButtonGroups *saveButtonGroups(const QWidget *mainContainer);
146 virtual QList<DomProperty*> computeProperties(QObject *obj);
147 virtual bool checkProperty(QObject *obj, const QString &prop) const;
148 virtual DomProperty *createProperty(QObject *object, const QString &propertyName, const QVariant &value);
149
150 virtual void layoutInfo(DomLayout *layout, QObject *parent, int *margin, int *spacing);
151
152 void loadListWidgetExtraInfo(DomWidget *ui_widget, QListWidget *listWidget, QWidget *parentWidget);
153 void loadTreeWidgetExtraInfo(DomWidget *ui_widget, QTreeWidget *treeWidget, QWidget *parentWidget);
154 void loadTableWidgetExtraInfo(DomWidget *ui_widget, QTableWidget *tableWidget, QWidget *parentWidget);
155 void loadComboBoxExtraInfo(DomWidget *ui_widget, QComboBox *comboBox, QWidget *parentWidget);
156 void loadButtonExtraInfo(const DomWidget *ui_widget, QAbstractButton *button, QWidget *parentWidget);
157 void loadItemViewExtraInfo(DomWidget *ui_widget, QAbstractItemView *itemView, QWidget *parentWidget);
158
159 void saveListWidgetExtraInfo(QListWidget *widget, DomWidget *ui_widget, DomWidget *ui_parentWidget);
160 void saveTreeWidgetExtraInfo(QTreeWidget *treeWidget, DomWidget *ui_widget, DomWidget *ui_parentWidget);
161 void saveTableWidgetExtraInfo(QTableWidget *tablWidget, DomWidget *ui_widget, DomWidget *ui_parentWidget);
162 void saveComboBoxExtraInfo(QComboBox *widget, DomWidget *ui_widget, DomWidget *ui_parentWidget);
163 void saveButtonExtraInfo(const QAbstractButton *widget, DomWidget *ui_widget, DomWidget *ui_parentWidget);
164 void saveItemViewExtraInfo(const QAbstractItemView *itemView, DomWidget *ui_widget, DomWidget *ui_parentWidget);
165
166 void setResourceBuilder(QResourceBuilder *builder);
167 QResourceBuilder *resourceBuilder() const;
168 DomProperty *saveResource(const QVariant &v) const;
169
170 void setTextBuilder(QTextBuilder *builder);
171 QTextBuilder *textBuilder() const;
172 DomProperty *saveText(const QString &attributeName, const QVariant &v) const;
173//
174// utils
175//
176
177 QVariant toVariant(const QMetaObject *meta, DomProperty *property);
178 static QString toString(const DomString *str);
179
180 using DomPropertyHash = QHash<QString, DomProperty*>;
181 static DomPropertyHash propertyMap(const QList<DomProperty*> &properties);
182
183 void setupColorGroup(QPalette &palette, QPalette::ColorGroup colorGroup, DomColorGroup *group);
184 DomColorGroup *saveColorGroup(const QPalette &palette);
185 QBrush setupBrush(DomBrush *brush);
186 DomBrush *saveBrush(const QBrush &brush);
187
188 void reset();
189 void initialize(const DomUI *ui);
190
191//
192// utils
193//
194
195 static QMetaEnum toolBarAreaMetaEnum();
196
197//
198// Icon/pixmap stuff
199//
200 // A Pair of icon path/qrc path.
201 using IconPaths = QPair<QString, QString>;
202
203 void setIconProperty(DomProperty &, const IconPaths &) const;
204 void setPixmapProperty(DomProperty &, const IconPaths &) const;
205
206 static const DomResourcePixmap *domPixmap(const DomProperty* p);
207
208private:
209//
210// utils
211//
212 static Qt::ToolBarArea toolbarAreaFromDOMAttributes(const DomPropertyHash &attributeMap);
213
214 friend QDESIGNER_UILIB_EXPORT DomProperty *variantToDomProperty(QAbstractFormBuilder *abstractFormBuilder, const QMetaObject *meta, const QString &propertyName, const QVariant &value);
215 friend QDESIGNER_UILIB_EXPORT QVariant domPropertyToVariant(QAbstractFormBuilder *abstractFormBuilder,const QMetaObject *meta, const DomProperty *property);
216
217protected:
218 QScopedPointer<QFormBuilderExtra> d;
219};
220
221#ifdef QFORMINTERNAL_NAMESPACE
222}
223#endif
224
225QT_END_NAMESPACE
226
227#endif // ABSTRACTFORMBUILDER_H
228

source code of qttools/src/designer/src/lib/uilib/abstractformbuilder.h