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