| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 4 | ** All rights reserved.
|
|---|
| 5 | ** Contact: Nokia Corporation ([email protected])
|
|---|
| 6 | **
|
|---|
| 7 | ** This file is part of the Qt Designer of the Qt Toolkit.
|
|---|
| 8 | **
|
|---|
| 9 | ** $QT_BEGIN_LICENSE:LGPL$
|
|---|
| 10 | ** Commercial Usage
|
|---|
| 11 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
|---|
| 12 | ** accordance with the Qt Commercial License Agreement provided with the
|
|---|
| 13 | ** Software or, alternatively, in accordance with the terms contained in
|
|---|
| 14 | ** a written agreement between you and Nokia.
|
|---|
| 15 | **
|
|---|
| 16 | ** GNU Lesser General Public License Usage
|
|---|
| 17 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
|---|
| 18 | ** General Public License version 2.1 as published by the Free Software
|
|---|
| 19 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
|---|
| 20 | ** packaging of this file. Please review the following information to
|
|---|
| 21 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
|---|
| 22 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|---|
| 23 | **
|
|---|
| 24 | ** In addition, as a special exception, Nokia gives you certain additional
|
|---|
| 25 | ** rights. These rights are described in the Nokia Qt LGPL Exception
|
|---|
| 26 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|---|
| 27 | **
|
|---|
| 28 | ** GNU General Public License Usage
|
|---|
| 29 | ** Alternatively, this file may be used under the terms of the GNU
|
|---|
| 30 | ** General Public License version 3.0 as published by the Free Software
|
|---|
| 31 | ** Foundation and appearing in the file LICENSE.GPL included in the
|
|---|
| 32 | ** packaging of this file. Please review the following information to
|
|---|
| 33 | ** ensure the GNU General Public License version 3.0 requirements will be
|
|---|
| 34 | ** met: http://www.gnu.org/copyleft/gpl.html.
|
|---|
| 35 | **
|
|---|
| 36 | ** If you have questions regarding the use of this file, please contact
|
|---|
| 37 | ** Nokia at [email protected].
|
|---|
| 38 | ** $QT_END_LICENSE$
|
|---|
| 39 | **
|
|---|
| 40 | ****************************************************************************/
|
|---|
| 41 |
|
|---|
| 42 | #include "abstractpromotioninterface.h"
|
|---|
| 43 |
|
|---|
| 44 | QT_BEGIN_NAMESPACE
|
|---|
| 45 |
|
|---|
| 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
|
|---|
