Developer Documentation

FileInterface.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 class QWidget;
45
46 #include <QString>
47
48 #include <OpenFlipper/common/Types.hh>
49
63 class FileInterface {
64
65 //===========================================================================
68 //===========================================================================
69
70 public:
71
73 virtual ~FileInterface() {};
74
82 virtual QWidget* saveOptionsWidget(QString _currentFilter) = 0;
83
91 virtual QWidget* loadOptionsWidget(QString _currentFilter) = 0;
92
95 //===========================================================================
98 //===========================================================================
99
100 public:
101
108 virtual DataType supportedType() = 0;
109
110
114 virtual QString getLoadFilters() = 0;
115
119 virtual QString getSaveFilters() = 0;
120
123 //===========================================================================
126 //===========================================================================
127
128 signals:
129
138 virtual void openedFile( int _id ) {};
139
140 public slots:
141
156 virtual int loadObject(QString _filename) = 0;
157
179 virtual int loadObject(QString _filename, DataType _type){ return -1;};
180
188 virtual bool saveObject(int _id, QString _filename) = 0;
189
197 virtual bool saveObjects(IdList _ids, QString _filename){return false;};
200 };
201
340 Q_DECLARE_INTERFACE(FileInterface,"OpenFlipper.FileInterface/1.0")
341
FileInterface::~FileInterface
virtual ~FileInterface()
Destructor.
Definition: FileInterface.hh:73
FileInterface::saveObject
virtual bool saveObject(int _id, QString _filename)=0
Save an object from the given file.
FileInterface::loadObject
virtual int loadObject(QString _filename)=0
Load an object from the given file.
FileInterface::loadObject
virtual int loadObject(QString _filename, DataType _type)
Load an object from the given file.
Definition: FileInterface.hh:179
FileInterface::getSaveFilters
virtual QString getSaveFilters()=0
FileInterface::openedFile
virtual void openedFile(int _id)
This signal has to be emitted if an object has been loaded from a file.
Definition: FileInterface.hh:138
IdList
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:179
FileInterface::supportedType
virtual DataType supportedType()=0
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
FileInterface::saveOptionsWidget
virtual QWidget * saveOptionsWidget(QString _currentFilter)=0
FileInterface::saveObjects
virtual bool saveObjects(IdList _ids, QString _filename)
Save multiple objects to one file.
Definition: FileInterface.hh:197
Types.hh
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
FileInterface
Interface class for file handling.
Definition: FileInterface.hh:63
FileInterface::getLoadFilters
virtual QString getLoadFilters()=0
FileInterface::loadOptionsWidget
virtual QWidget * loadOptionsWidget(QString _currentFilter)=0