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 * $Revision: 18129 $ *
45 * $LastChangedBy: moebius $ *
46 * $Date: 2014-02-05 10:25:53 +0100 (Mi, 05 Feb 2014) $ *
47 * *
48 \*===========================================================================*/
49 
50 //=============================================================================
51 //
52 // CLASS DeserializeScreenshotMetadataPlugin
53 //
54 //=============================================================================
55 
56 #ifndef DESERIALIZESCREENSHOTMETADATAPLUGIN_HH
57 #define DESERIALIZESCREENSHOTMETADATAPLUGIN_HH
58 
59 //== INCLUDES =================================================================
60 
61 #include <QObject>
62 
66 
67 #include <ACG/QtWidgets/QtExaminerViewer.hh>
68 
69 #include "RestoreFromScreenshotDlg.hh"
70 
71 //== CLASS DEFINITION =========================================================
72 
77 
78  Q_OBJECT
79  Q_INTERFACES(BaseInterface)
80  Q_INTERFACES(ToolbarInterface)
81  Q_INTERFACES(MetadataInterface)
82 
83 #if QT_VERSION >= 0x050000
84  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-DeserializeScreenshotMetadataPlugin")
85 #endif
86 
87  signals:
88  void updateView();
89  void updatedObject(int /*_identifier*/, const UpdateType & /*_type*/);
90 
91  // ToolboxInterface
92  void addToolbar(QToolBar* _toolbar);
93 
94  // MetadataInterface
95  void metadataDeserialized(
96  const QVector<QPair<QString, QString> > &data);
97 
98  private slots:
99 
100  // initialization functions
101  void initializePlugin();
102  void pluginsInitialized();
103  void slot_restore_from_screenshot();
104  void slot_do_restore_from_screenshot();
105 
106  void slotGenericMetadataDeserialized(QString key, QString value);
107  void slotObjectMetadataDeserialized(QString object_name, QString value);
108 #if QT_VERSION >= 0x050000
109  void slotObjectMetadataDeserializedJson(
110  QString object_name, QJsonDocument value);
111 #endif
112 
113 
114  public:
115 
117 
119 
120  QString name() {
121  return (QString("DeserializeScreenshotMetadata"));
122  }
123 
124  QString description() {
125  return (QString("Deserializes meta data from viewer snapshots."));
126  }
127 
128  private:
129  QToolBar *toolbar;
130  QAction *restoreAction;
131  RestoreFromScreenshotDlg *restore_from_screenshot_dlg;
132 };
133 
134 //=============================================================================
135 #endif // DESERIALIZESCREENSHOTMETADATAPLUGIN_HH defined
136 //=============================================================================
137 
Enables implementers to react on deserialization of meta data.
Interface class from which all plugins have to be created.
Update type class.
Definition: UpdateType.hh:70
QString description()
Return a description of what the plugin is doing.
QString name()
Return a name for the plugin.
Add a toolbox to OpenFlipper.