Developer Documentation

LoadSaveInterface.hh
Go to the documentation of this file.
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 #pragma once
43
44 #include <OpenFlipper/common/Types.hh>
45
59 class LoadSaveInterface {
60
61 public:
62
64 virtual ~LoadSaveInterface() {};
65
66 signals :
72 virtual void save(int _id , QString _filename ) {}
73
80 virtual void load(QString _filename, DataType _type, int& _id) {};
81
82
89 virtual void addEmptyObject( DataType _type, int& _id) {};
90
96 virtual void copyObject( int _oldId, int& _newId) {};
97
98
105 virtual void emptyObjectAdded( int _id ) {};
106
111 virtual void deleteObject( int _id ) {};
112
116 virtual void deleteAllObjects() {};
117
121 virtual void getAllFileFilters(QStringList& _filters) {};
122
123 private slots :
124
131 virtual void fileOpened( int _id ) {};
132
139 virtual void addedEmptyObject( int _id ) {};
140
154 virtual void objectDeleted( int _id ){};
155
156 };
157
224 Q_DECLARE_INTERFACE(LoadSaveInterface,"OpenFlipper.LoadSaveInterface/1.1")
225
LoadSaveInterface::save
virtual void save(int _id, QString _filename)
Save object to a file.
Definition: LoadSaveInterface.hh:72
LoadSaveInterface
Interface for all plugins which want to Load or Save files and create Objects.
Definition: LoadSaveInterface.hh:59
LoadSaveInterface::objectDeleted
virtual void objectDeleted(int _id)
An object was deleted.
Definition: LoadSaveInterface.hh:154
LoadSaveInterface::addEmptyObject
virtual void addEmptyObject(DataType _type, int &_id)
Definition: LoadSaveInterface.hh:89
LoadSaveInterface::getAllFileFilters
virtual void getAllFileFilters(QStringList &_filters)
Get all file filters that are registered.
Definition: LoadSaveInterface.hh:121
LoadSaveInterface::deleteObject
virtual void deleteObject(int _id)
Delete an object This signal can be called from any thread. .
Definition: LoadSaveInterface.hh:111
LoadSaveInterface::~LoadSaveInterface
virtual ~LoadSaveInterface()
Destructor.
Definition: LoadSaveInterface.hh:64
LoadSaveInterface::fileOpened
virtual void fileOpened(int _id)
A file has been opened.
Definition: LoadSaveInterface.hh:131
LoadSaveInterface::copyObject
virtual void copyObject(int _oldId, int &_newId)
Definition: LoadSaveInterface.hh:96
LoadSaveInterface::addedEmptyObject
virtual void addedEmptyObject(int _id)
An empty object has been added.
Definition: LoadSaveInterface.hh:139
LoadSaveInterface::deleteAllObjects
virtual void deleteAllObjects()
Delete all Objects.
Definition: LoadSaveInterface.hh:116
LoadSaveInterface::emptyObjectAdded
virtual void emptyObjectAdded(int _id)
DEPRECATED HERE (Moved to Type Interface)! Emit this signal if an empty object has been created...
Definition: LoadSaveInterface.hh:105
Types.hh
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
LoadSaveInterface::load
virtual void load(QString _filename, DataType _type, int &_id)
Load object from file with a specific DataType.
Definition: LoadSaveInterface.hh:80