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 <QtDesigner/abstractformeditorplugin.h>
43 
44 QT_BEGIN_NAMESPACE
45 
46 /*!
47     \internal
48     \class QDesignerFormEditorPluginInterface
49     \brief The QDesignerFormEditorPluginInterface class provides an interface that is used to
50     manage plugins for Qt Designer's form editor component.
51     \inmodule QtDesigner
52 
53     \sa QDesignerFormEditorInterface
54 */
55 
56 /*!
57     \fn virtual QDesignerFormEditorPluginInterface::~QDesignerFormEditorPluginInterface()
58 
59     Destroys the plugin interface.
60 */
61 
62 /*!
63     \fn virtual bool QDesignerFormEditorPluginInterface::isInitialized() const = 0
64 
65     Returns true if the plugin interface is initialized; otherwise returns false.
66 */
67 
68 /*!
69     \fn virtual void QDesignerFormEditorPluginInterface::initialize(QDesignerFormEditorInterface *core) = 0
70 
71     Initializes the plugin interface for the specified \a core interface.
72 */
73 
74 /*!
75     \fn virtual QAction *QDesignerFormEditorPluginInterface::action() const = 0
76 
77     Returns the action associated with this interface.
78 */
79 
80 /*!
81     \fn virtual QDesignerFormEditorInterface *QDesignerFormEditorPluginInterface::core() const = 0
82 
83     Returns the core form editor interface associated with this component.
84 */
85 
86 QT_END_NAMESPACE
87