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 "abstractobjectinspector.h"
43
44 QT_BEGIN_NAMESPACE
45
46 /*!
47 \class QDesignerObjectInspectorInterface
48
49 \brief The QDesignerObjectInspectorInterface class allows you to
50 change the focus of Qt Designer's object inspector.
51
52 \inmodule QtDesigner
53
54 You can use the QDesignerObjectInspectorInterface to change the
55 current form window selection. For example, when implementing a
56 custom widget plugin:
57
58 \snippet doc/src/snippets/code/tools_designer_src_lib_sdk_abstractobjectinspector.cpp 0
59
60 The QDesignerObjectInspectorInterface class is not intended to be
61 instantiated directly. You can retrieve an interface to \QD's
62 object inspector using the
63 QDesignerFormEditorInterface::objectInspector() function. A
64 pointer to \QD's current QDesignerFormEditorInterface object (\c
65 formEditor in the example above) is provided by the
66 QDesignerCustomWidgetInterface::initialize() function's
67 parameter. When implementing a custom widget plugin, you must
68 subclass the QDesignerCustomWidgetInterface to expose your plugin
69 to \QD.
70
71 The interface provides the core() function that you can use to
72 retrieve a pointer to \QD's current QDesignerFormEditorInterface
73 object, and the setFormWindow() function that enables you to
74 change the current form window selection.
75
76 \sa QDesignerFormEditorInterface, QDesignerFormWindowInterface
77 */
78
79 /*!
80 Constructs an object inspector interface with the given \a parent
81 and the specified window \a flags.
82 */
QDesignerObjectInspectorInterface(QWidget * parent,Qt::WindowFlags flags)83 QDesignerObjectInspectorInterface::QDesignerObjectInspectorInterface(QWidget *parent, Qt::WindowFlags flags)
84 : QWidget(parent, flags)
85 {
86 }
87
88 /*!
89 Destroys the object inspector interface.
90 */
~QDesignerObjectInspectorInterface()91 QDesignerObjectInspectorInterface::~QDesignerObjectInspectorInterface()
92 {
93 }
94
95 /*!
96 Returns a pointer to \QD's current QDesignerFormEditorInterface
97 object.
98 */
core() const99 QDesignerFormEditorInterface *QDesignerObjectInspectorInterface::core() const
100 {
101 return 0;
102 }
103
104 /*!
105 \fn void QDesignerObjectInspectorInterface::setFormWindow(QDesignerFormWindowInterface *formWindow)
106
107 Sets the currently selected form window to \a formWindow.
108 */
109
110 QT_END_NAMESPACE
111