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
58
59
60#include "RestoreFromScreenshotDlg.hh"
61
62//== CLASS DEFINITION =========================================================
63
68
69 Q_OBJECT
70 Q_INTERFACES(BaseInterface)
71 Q_INTERFACES(ToolbarInterface)
72 Q_INTERFACES(MetadataInterface)
73
74 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-DeserializeScreenshotMetadataPlugin")
75
76 signals:
77 void updateView();
78 void updatedObject(int /*_identifier*/, const UpdateType & /*_type*/);
79
80 // ToolboxInterface
81 void addToolbar(QToolBar* _toolbar);
82
83 // MetadataInterface
84 void metadataDeserialized(
85 const QVector<QPair<QString, QString> > &data);
86
87 private slots:
88
89 // initialization functions
90 void initializePlugin();
91 void pluginsInitialized();
92 void slot_restore_from_screenshot();
93 void slot_do_restore_from_screenshot();
94
95 void slotGenericMetadataDeserialized(QString key, QString value);
96 void slotObjectMetadataDeserialized(QString object_name, QString value);
97 void slotObjectMetadataDeserializedJson(
98 QString object_name, QJsonDocument value);
99
100
101 public:
102
104
106
107 QString name() {
108 return (QString("DeserializeScreenshotMetadata"));
109 }
110
111 QString description() {
112 return (QString("Deserializes meta data from viewer snapshots."));
113 }
114
115 private:
116 QToolBar *toolbar;
117 QAction *restoreAction;
118 RestoreFromScreenshotDlg *restore_from_screenshot_dlg;
119};
120
121//=============================================================================
122#endif // DESERIALIZESCREENSHOTMETADATAPLUGIN_HH defined
123//=============================================================================
124
Interface class from which all plugins have to be created.
QString description()
Return a description of what the plugin is doing.
Enables implementers to react on deserialization of meta data.
Add a toolbox to OpenFlipper.
Update type class.
Definition: UpdateType.hh:59