Developer Documentation

DeserializeScreenshotMetadataPlugin.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42 //=============================================================================
43 //
44 // CLASS DeserializeScreenshotMetadataPlugin
45 //
46 //=============================================================================
47
48 #ifndef DESERIALIZESCREENSHOTMETADATAPLUGIN_HH
49 #define DESERIALIZESCREENSHOTMETADATAPLUGIN_HH
50
51 //== INCLUDES =================================================================
52
53 #include <QObject>
54
55 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
56 #include <OpenFlipper/BasePlugin/ToolbarInterface.hh>
57 #include <OpenFlipper/BasePlugin/MetadataInterface.hh>
58
59 #include <ACG/QtWidgets/QtExaminerViewer.hh>
60
61 #include "RestoreFromScreenshotDlg.hh"
62
63 //== CLASS DEFINITION =========================================================
64
65 class DeserializeScreenshotMetadataPlugin: public QObject,
66 BaseInterface,
67 ToolbarInterface,
68 MetadataInterface {
69
70 Q_OBJECT
71 Q_INTERFACES(BaseInterface)
72 Q_INTERFACES(ToolbarInterface)
73 Q_INTERFACES(MetadataInterface)
74
75 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-DeserializeScreenshotMetadataPlugin")
76
77 signals:
78 void updateView();
79 void updatedObject(int /*_identifier*/, const UpdateType & /*_type*/);
80
81 // ToolboxInterface
82 void addToolbar(QToolBar* _toolbar);
83
84 // MetadataInterface
85 void metadataDeserialized(
86 const QVector<QPair<QString, QString> > &data);
87
88 private slots:
89
90 // initialization functions
91 void initializePlugin();
92 void pluginsInitialized();
93 void slot_restore_from_screenshot();
94 void slot_do_restore_from_screenshot();
95
96 void slotGenericMetadataDeserialized(QString key, QString value);
97 void slotObjectMetadataDeserialized(QString object_name, QString value);
98 void slotObjectMetadataDeserializedJson(
99 QString object_name, QJsonDocument value);
100
101
102 public:
103
104 DeserializeScreenshotMetadataPlugin();
105
106 ~DeserializeScreenshotMetadataPlugin() { }
107
108 QString name() {
109 return (QString("DeserializeScreenshotMetadata"));
110 }
111
112 QString description() {
113 return (QString("Deserializes meta data from viewer snapshots."));
114 }
115
116 private:
117 QToolBar *toolbar;
118 QAction *restoreAction;
119 RestoreFromScreenshotDlg *restore_from_screenshot_dlg;
120 };
121
122 //=============================================================================
123 #endif // DESERIALIZESCREENSHOTMETADATAPLUGIN_HH defined
124 //=============================================================================
125
RestoreFromScreenshotDlg
Definition: RestoreFromScreenshotDlg.hh:54
DeserializeScreenshotMetadataPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: DeserializeScreenshotMetadataPlugin.hh:112
ToolbarInterface
Add a toolbox to OpenFlipper.
Definition: ToolbarInterface.hh:62
DeserializeScreenshotMetadataPlugin::name
QString name()
Return a name for the plugin.
Definition: DeserializeScreenshotMetadataPlugin.hh:108
ToolbarInterface.hh
DeserializeScreenshotMetadataPlugin
Definition: DeserializeScreenshotMetadataPlugin.hh:65
UpdateType
Update type class.
Definition: UpdateType.hh:60
MetadataInterface
Enables implementers to react on deserialization of meta data.
Definition: MetadataInterface.hh:77
MetadataInterface.hh
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
BaseInterface.hh