1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the Qt Designer of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef ABSTRACTWIDGETBOX_H
43 #define ABSTRACTWIDGETBOX_H
44 
45 #include <QtDesigner/sdk_global.h>
46 
47 #include <QtCore/QMetaType>
48 #include <QtGui/QWidget>
49 #include <QtGui/QIcon>
50 
51 QT_BEGIN_HEADER
52 
53 QT_BEGIN_NAMESPACE
54 
55 class DomUI;
56 class QDesignerDnDItemInterface;
57 
58 class QDESIGNER_SDK_EXPORT QDesignerWidgetBoxInterface : public QWidget
59 {
60     Q_OBJECT
61 public:
62     class Widget {
63     public:
64         enum Type { Default, Custom };
65         Widget(const QString &aname = QString(), const QString &xml = QString(),
66                 const QString &icon_name = QString(), Type atype = Default)
m_name(aname)67             : m_name(aname), m_xml(xml), m_icon_name(icon_name), m_type(atype) {}
name()68         QString name() const { return m_name; }
setName(const QString & aname)69         void setName(const QString &aname) { m_name = aname; }
domXml()70         QString domXml() const { return m_xml; }
setDomXml(const QString & xml)71         void setDomXml(const QString &xml) { m_xml = xml; }
iconName()72         QString iconName() const { return m_icon_name; }
setIconName(const QString & icon_name)73         void setIconName(const QString &icon_name) { m_icon_name = icon_name; }
type()74         Type type() const { return m_type; }
setType(Type atype)75         void setType(Type atype) { m_type = atype; }
76 
isNull()77         bool isNull() const { return m_name.isEmpty(); }
78 
79     private:
80         QString m_name;
81         QString m_xml;
82         QString m_icon_name;
83         Type m_type;
84     };
85     typedef QList<Widget> WidgetList;
86 
87     class Category {
88     public:
89         enum Type { Default, Scratchpad };
90 
91         Category(const QString &aname = QString(), Type atype = Default)
m_name(aname)92             : m_name(aname), m_type(atype) {}
93 
name()94         QString name() const { return m_name; }
setName(const QString & aname)95         void setName(const QString &aname) { m_name = aname; }
widgetCount()96         int widgetCount() const { return m_widget_list.size(); }
widget(int idx)97         Widget widget(int idx) const { return m_widget_list.at(idx); }
removeWidget(int idx)98         void removeWidget(int idx) { m_widget_list.removeAt(idx); }
addWidget(const Widget & awidget)99         void addWidget(const Widget &awidget) { m_widget_list.append(awidget); }
type()100         Type type() const { return m_type; }
setType(Type atype)101         void setType(Type atype) { m_type = atype; }
102 
isNull()103         bool isNull() const { return m_name.isEmpty(); }
104 
105     private:
106         QString m_name;
107         Type m_type;
108         QList<Widget> m_widget_list;
109     };
110     typedef QList<Category> CategoryList;
111 
112     QDesignerWidgetBoxInterface(QWidget *parent = 0, Qt::WindowFlags flags = 0);
113     virtual ~QDesignerWidgetBoxInterface();
114 
115     virtual int categoryCount() const = 0;
116     virtual Category category(int cat_idx) const = 0;
117     virtual void addCategory(const Category &cat) = 0;
118     virtual void removeCategory(int cat_idx) = 0;
119 
120     virtual int widgetCount(int cat_idx) const = 0;
121     virtual Widget widget(int cat_idx, int wgt_idx) const = 0;
122     virtual void addWidget(int cat_idx, const Widget &wgt) = 0;
123     virtual void removeWidget(int cat_idx, int wgt_idx) = 0;
124 
125     int findOrInsertCategory(const QString &categoryName);
126 
127     virtual void dropWidgets(const QList<QDesignerDnDItemInterface*> &item_list,
128                                 const QPoint &global_mouse_pos) = 0;
129 
130     virtual void setFileName(const QString &file_name) = 0;
131     virtual QString fileName() const = 0;
132     virtual bool load() = 0;
133     virtual bool save() = 0;
134 };
135 
136 QT_END_NAMESPACE
137 
138 Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDesignerWidgetBoxInterface::Widget))
139 
140 QT_END_HEADER
141 
142 #endif // ABSTRACTWIDGETBOX_H
143