blob: 0a18708d0298faf1aadbfacb4bb88a0bdaa8b4fb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "mytypes.h"
namespace ScxmlEditor {
namespace PluginInterface {
class ScxmlUiFactory;
class ScxmlDocument;
/**
* @brief The ISCEditor interface for the all SCEditor plugins
*
* Every SCEditor plugin must implement this interface. SCEditor application will load all plugins which have listed
* in the environment variable QT_SCEDITOR_PLUGINS and which implements this interface. The function init() will be called
* immediately after plugin has successfully loaded. See the @ScxmlUiFactory for more information how to register editor etc for the UI.
* The function refresh() will be called when it is time to refresh data. Plugin itself can decide if this is necessary or not.
* Normally this function will be called when application get focus.
*/
class ISCEditor
{
public:
/**
* @brief init - pure virtual function to init and forward the pointer of the ScxmlUiFactory to the plugin.
* @param factory - pointer to the ScxmlUiFactory
*/
virtual void init(ScxmlUiFactory *factory) = 0;
/**
* @brief documentChanged - when document will changed this function will be called
* @param type - change reason
* @param doc - pointer to ScxmlDocument
*/
virtual void documentChanged(DocumentChangeType type, ScxmlDocument *doc) = 0;
/**
* @brief refresh - tell the plugin that it is time to update all data if necessary
*/
virtual void refresh() = 0;
/**
* @brief detach - here should be unregister all objects
*/
virtual void detach() = 0;
};
} // namespace PluginInterface
} // namespace ScxmlEditor
QT_BEGIN_NAMESPACE
Q_DECLARE_INTERFACE(ScxmlEditor::PluginInterface::ISCEditor, "StateChartEditor.ISCEditor/1.0")
QT_END_NAMESPACE
|
