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 #include "abstractpromotioninterface.h"
43
44 QT_BEGIN_NAMESPACE
45
~QDesignerPromotionInterface()46 QDesignerPromotionInterface::~QDesignerPromotionInterface()
47 {
48 }
49
50 /*!
51 \class QDesignerPromotionInterface
52
53 \brief The QDesignerPromotionInterface provides functions for modifying
54 the promoted classes in Designer.
55 \inmodule QtDesigner
56 \internal
57 \since 4.3
58 */
59
60 /*!
61 \class QDesignerPromotionInterface::PromotedClass
62 A pair of database items containing the base class and the promoted class.
63
64 \typedef QDesignerPromotionInterface::PromotedClasses
65 A list of PromotedClass items.
66
67 virtual QDesignerPromotionInterface::PromotedClasses promotedClasses() const
68
69 Returns a list of promoted classes along with their base classes in alphabetical order.
70 It can be used to populate tree models for editing promoted widgets.
71
72 */
73
74 /*!
75 \fn virtual QSet<QString> QDesignerPromotionInterface::referencedPromotedClassNames() const
76
77 Returns a set of promoted classed that are referenced by the currently opened forms.
78 */
79
80 /*!
81 \fn virtual bool QDesignerPromotionInterface::addPromotedClass(const QString &baseClass, const QString &className, const QString &includeFile, QString *errorMessage)
82
83 Add a promoted class named \a with the base class \a and include file \a includeFile. Returns \c true on success or \c false along
84 with an error message in \a errorMessage on failure.
85 */
86
87 /*!
88 \fn virtual bool QDesignerPromotionInterface::removePromotedClass(const QString &className, QString *errorMessage)
89
90 Remove the promoted class named \a className unless it is referenced by a form. Returns \c true on success or \c false along
91 with an error message in \a errorMessage on failure.
92 */
93
94 /*!
95 \fn virtual bool QDesignerPromotionInterface::changePromotedClassName(const QString &oldClassName, const QString &newClassName, QString *errorMessage)
96
97 Change the class name of a promoted class from \a oldClassName to \a newClassName. Returns \c true on success or \c false along
98 with an error message in \a errorMessage on failure.
99 */
100
101 /*!
102 \fn virtual bool QDesignerPromotionInterface::setPromotedClassIncludeFile(const QString &className, const QString &includeFile, QString *errorMessage)
103
104 Change the include file of a promoted class named \a className to be \a includeFile. Returns \c true on success or \c false along
105 with an error message in \a errorMessage on failure.
106 */
107
108 /*! \fn virtual QList<QDesignerWidgetDataBaseItemInterface *> QDesignerPromotionInterface::promotionBaseClasses() const
109
110 Return a list of base classes that are suitable for promotion.
111 */
112
113 QT_END_NAMESPACE
114