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 "extrainfo.h"
43
44 QT_BEGIN_NAMESPACE
45
46 /*!
47 \class QDesignerExtraInfoExtension
48 \brief The QDesignerExtraInfoExtension class provides extra information about a widget in
49 Qt Designer.
50 \inmodule QtDesigner
51 \internal
52 */
53
54 /*!
55 Returns the path to the working directory used by this extension.*/
workingDirectory() const56 QString QDesignerExtraInfoExtension::workingDirectory() const
57 {
58 return m_workingDirectory;
59 }
60
61 /*!
62 Sets the path to the working directory used by the extension to \a workingDirectory.*/
setWorkingDirectory(const QString & workingDirectory)63 void QDesignerExtraInfoExtension::setWorkingDirectory(const QString &workingDirectory)
64 {
65 m_workingDirectory = workingDirectory;
66 }
67
68 /*!
69 \fn virtual QDesignerExtraInfoExtension::~QDesignerExtraInfoExtension()
70
71 Destroys the extension.
72 */
73
74 /*!
75 \fn virtual QDesignerFormEditorInterface *QDesignerExtraInfoExtension::core() const = 0
76
77 \omit
78 ### Description required
79 \endomit
80 */
81
82 /*!
83 \fn virtual QWidget *QDesignerExtraInfoExtension::widget() const = 0
84
85 Returns the widget described by this extension.
86 */
87
88 /*!
89 \fn virtual bool QDesignerExtraInfoExtension::saveUiExtraInfo(DomUI *ui) = 0
90
91 Saves the information about the user interface specified by \a ui, and returns true if
92 successful; otherwise returns false.
93 */
94
95 /*!
96 \fn virtual bool QDesignerExtraInfoExtension::loadUiExtraInfo(DomUI *ui) = 0
97
98 Loads extra information about the user interface specified by \a ui, and returns true if
99 successful; otherwise returns false.
100 */
101
102 /*!
103 \fn virtual bool QDesignerExtraInfoExtension::saveWidgetExtraInfo(DomWidget *widget) = 0
104
105 Saves the information about the specified \a widget, and returns true if successful;
106 otherwise returns false.
107 */
108
109 /*!
110 \fn virtual bool QDesignerExtraInfoExtension::loadWidgetExtraInfo(DomWidget *widget) = 0
111
112 Loads extra information about the specified \a widget, and returns true if successful;
113 otherwise returns false.
114 */
115
116 QT_END_NAMESPACE
117