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 | // sdk |
30 | #include "abstractmetadatabase.h" |
31 | |
32 | QT_BEGIN_NAMESPACE |
33 | |
34 | /*! |
35 | \class QDesignerMetaDataBaseInterface |
36 | \brief The QDesignerMetaDataBaseInterface class provides an interface to Qt Designer's |
37 | object meta database. |
38 | \inmodule QtDesigner |
39 | \internal |
40 | */ |
41 | |
42 | /*! |
43 | Constructs an interface to the meta database with the given \a parent. |
44 | */ |
45 | QDesignerMetaDataBaseInterface::QDesignerMetaDataBaseInterface(QObject *parent) |
46 | : QObject(parent) |
47 | { |
48 | } |
49 | |
50 | /*! |
51 | Destroys the interface to the meta database. |
52 | */ |
53 | QDesignerMetaDataBaseInterface::~QDesignerMetaDataBaseInterface() = default; |
54 | |
55 | /*! |
56 | \fn QDesignerMetaDataBaseItemInterface *QDesignerMetaDataBaseInterface::item(QObject *object) const |
57 | |
58 | Returns the item in the meta database associated with the given \a object. |
59 | */ |
60 | |
61 | /*! |
62 | \fn void QDesignerMetaDataBaseInterface::add(QObject *object) |
63 | |
64 | Adds the specified \a object to the meta database. |
65 | */ |
66 | |
67 | /*! |
68 | \fn void QDesignerMetaDataBaseInterface::remove(QObject *object) |
69 | |
70 | Removes the specified \a object from the meta database. |
71 | */ |
72 | |
73 | /*! |
74 | \fn QList<QObject*> QDesignerMetaDataBaseInterface::objects() const |
75 | |
76 | Returns the list of objects that have corresponding items in the meta database. |
77 | */ |
78 | |
79 | /*! |
80 | \fn QDesignerFormEditorInterface *QDesignerMetaDataBaseInterface::core() const |
81 | |
82 | Returns the core interface that is associated with the meta database. |
83 | */ |
84 | |
85 | |
86 | // Doc: Interface only |
87 | |
88 | /*! |
89 | \class QDesignerMetaDataBaseItemInterface |
90 | \brief The QDesignerMetaDataBaseItemInterface class provides an interface to individual |
91 | items in Qt Designer's meta database. |
92 | \inmodule QtDesigner |
93 | \internal |
94 | |
95 | This class allows individual items in \QD's meta-data database to be accessed and modified. |
96 | Use the QDesignerMetaDataBaseInterface class to change the properties of the database itself. |
97 | */ |
98 | |
99 | /*! |
100 | \fn QDesignerMetaDataBaseItemInterface::~QDesignerMetaDataBaseItemInterface() |
101 | |
102 | Destroys the item interface to the meta-data database. |
103 | */ |
104 | |
105 | /*! |
106 | \fn QString QDesignerMetaDataBaseItemInterface::name() const |
107 | |
108 | Returns the name of the item in the database. |
109 | |
110 | \sa setName() |
111 | */ |
112 | |
113 | /*! |
114 | \fn void QDesignerMetaDataBaseItemInterface::setName(const QString &name) |
115 | |
116 | Sets the name of the item to the given \a name. |
117 | |
118 | \sa name() |
119 | */ |
120 | |
121 | /*! |
122 | \fn QList<QWidget*> QDesignerMetaDataBaseItemInterface::tabOrder() const |
123 | |
124 | Returns a list of widgets in the order defined by the form's tab order. |
125 | |
126 | \sa setTabOrder() |
127 | */ |
128 | |
129 | |
130 | /*! |
131 | \fn void QDesignerMetaDataBaseItemInterface::setTabOrder(const QList<QWidget*> &tabOrder) |
132 | |
133 | Sets the tab order in the form using the list of widgets defined by \a tabOrder. |
134 | |
135 | \sa tabOrder() |
136 | */ |
137 | |
138 | |
139 | /*! |
140 | \fn bool QDesignerMetaDataBaseItemInterface::enabled() const |
141 | |
142 | Returns whether the item is enabled. |
143 | |
144 | \sa setEnabled() |
145 | */ |
146 | |
147 | /*! |
148 | \fn void QDesignerMetaDataBaseItemInterface::setEnabled(bool enabled) |
149 | |
150 | If \a enabled is true, the item is enabled; otherwise it is disabled. |
151 | |
152 | \sa enabled() |
153 | */ |
154 | |
155 | QT_END_NAMESPACE |
156 | |