1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Designer of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:GPL-EXCEPT$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU
19** General Public License version 3 as published by the Free Software
20** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
21** included in the packaging of this file. Please review the following
22** information to ensure the GNU General Public License requirements will
23** be met: https://www.gnu.org/licenses/gpl-3.0.html.
24**
25** $QT_END_LICENSE$
26**
27****************************************************************************/
28
29//
30// W A R N I N G
31// -------------
32//
33// This file is not part of the Qt API. It exists for the convenience
34// of Qt Designer. This header
35// file may change from version to version without notice, or even be removed.
36//
37// We mean it.
38//
39
40#ifndef QDESIGNER_WIDGETBOX_H
41#define QDESIGNER_WIDGETBOX_H
42
43#include "shared_global_p.h"
44#include <QtDesigner/abstractwidgetbox.h>
45
46QT_BEGIN_NAMESPACE
47
48class DomUI;
49
50namespace qdesigner_internal {
51
52// A widget box with a load mode that allows for updating custom widgets.
53
54class QDESIGNER_SHARED_EXPORT QDesignerWidgetBox : public QDesignerWidgetBoxInterface
55{
56 Q_OBJECT
57public:
58 enum LoadMode { LoadMerge, LoadReplace, LoadCustomWidgetsOnly };
59
60 explicit QDesignerWidgetBox(QWidget *parent = nullptr, Qt::WindowFlags flags = nullptr);
61
62 LoadMode loadMode() const;
63 void setLoadMode(LoadMode lm);
64
65 virtual bool loadContents(const QString &contents) = 0;
66
67 // Convenience to access the widget box icon of a widget. Empty category
68 // matches all
69 virtual QIcon iconForWidget(const QString &className,
70 const QString &category = QString()) const = 0;
71
72 // Convenience to find a widget by class name. Empty category matches all
73 static bool findWidget(const QDesignerWidgetBoxInterface *wbox,
74 const QString &className,
75 const QString &category /* = QString() */,
76 Widget *widgetData);
77 // Convenience functions to create a DomWidget from widget box xml.
78 static DomUI *xmlToUi(const QString &name, const QString &xml, bool insertFakeTopLevel, QString *errorMessage);
79 static DomUI *xmlToUi(const QString &name, const QString &xml, bool insertFakeTopLevel);
80
81private:
82 LoadMode m_loadMode = LoadMerge;
83};
84} // namespace qdesigner_internal
85
86QT_END_NAMESPACE
87
88#endif // QDESIGNER_WIDGETBOX_H
89