Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 
51 #ifndef FILEINTERFACE_HH
52 #define FILEINTERFACE_HH
53 
54  class QWidget;
55 #include <QString>
56 
58 
73 
74 //===========================================================================
77 //===========================================================================
78 
79  public:
80 
82  virtual ~FileInterface() {};
83 
91  virtual QWidget* saveOptionsWidget(QString _currentFilter) = 0;
92 
100  virtual QWidget* loadOptionsWidget(QString _currentFilter) = 0;
101 
104 //===========================================================================
107 //===========================================================================
108 
109 public:
110 
117  virtual DataType supportedType() = 0;
118 
119 
123  virtual QString getLoadFilters() = 0;
124 
128  virtual QString getSaveFilters() = 0;
129 
132 //===========================================================================
135 //===========================================================================
136 
137 signals:
138 
147  virtual void openedFile( int _id ) {};
148 
149 public slots:
150 
165  virtual int loadObject(QString _filename) = 0;
166 
188  virtual int loadObject(QString _filename, DataType _type){ return -1;};
189 
197  virtual bool saveObject(int _id, QString _filename) = 0;
198 
206  virtual bool saveObjects(IdList _ids, QString _filename){return false;};
209 };
210 
349 Q_DECLARE_INTERFACE(FileInterface,"OpenFlipper.FileInterface/1.0")
350 
351 #endif // FILEINTERFACE_HH
virtual bool saveObject(int _id, QString _filename)=0
Save an object from the given file.
virtual QWidget * saveOptionsWidget(QString _currentFilter)=0
Interface class for file handling.
virtual int loadObject(QString _filename, DataType _type)
Load an object from the given file.
virtual bool saveObjects(IdList _ids, QString _filename)
Save multiple objects to one file.
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:192
virtual int loadObject(QString _filename)=0
Load an object from the given file.
virtual QString getLoadFilters()=0
virtual void openedFile(int _id)
This signal has to be emitted if an object has been loaded from a file.
virtual QString getSaveFilters()=0
virtual DataType supportedType()=0
Return your supported object type( e.g. DATA_TRIANGLE_MESH )
Predefined datatypes.
Definition: DataTypes.hh:96
virtual ~FileInterface()
Destructor.
virtual QWidget * loadOptionsWidget(QString _currentFilter)=0