← Back to branch summary

~librecad-dev/librecad/librecad

« back to all changes in this revision

Viewing changes to librecad/src/lib/filters/rs_filterinterface.h

  • Committer: Scott Howard
  • Date: 2014-02-21 19:07:55 UTC
  • Revision ID: showard@debian.org-20140221190755-csjax9wb146hgdq4
first commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
librecad/src/lib/filters/rs_filterinterface.h
 
1
/****************************************************************************
 
2
**
 
3
** This file is part of the LibreCAD project, a 2D CAD program
 
4
**
 
5
** Copyright (C) 2010 R. van Twisk (librecad@rvt.dds.nl)
 
6
** Copyright (C) 2001-2003 RibbonSoft. All rights reserved.
 
7
**
 
8
**
 
9
** This file may be distributed and/or modified under the terms of the
 
10
** GNU General Public License version 2 as published by the Free Software 
 
11
** Foundation and appearing in the file gpl-2.0.txt included in the
 
12
** packaging of this file.
 
13
**
 
14
** This program is distributed in the hope that it will be useful,
 
15
** but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
** GNU General Public License for more details.
 
18
** 
 
19
** You should have received a copy of the GNU General Public License
 
20
** along with this program; if not, write to the Free Software
 
21
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
22
**
 
23
** This copyright notice MUST APPEAR in all copies of the script!  
 
24
**
 
25
**********************************************************************/
 
26
 
 
27
 
 
28
#ifndef RS_FILTERINTERFACE_H
 
29
#define RS_FILTERINTERFACE_H
 
30
 
 
31
#include "rs_graphic.h"
 
32
 
 
33
/**
 
34
 * This is the interface that must be implemented for all 
 
35
 * format filter classes. The RS_FileIO class 
 
36
 * uses the methods defined in here to interact with the format
 
37
 * filter classes.
 
38
 *
 
39
 * @author Andrew Mustun
 
40
 */
 
41
class RS_FilterInterface {
 
42
public:
 
43
    /**
 
44
     * Constructor.
 
45
     */
 
46
    RS_FilterInterface() {
 
47
    }
 
48
 
 
49
    /**
 
50
     * Destructor.
 
51
     */
 
52
    virtual ~RS_FilterInterface() {}
 
53
 
 
54
    /**
 
55
     * Checks if this filter can import the given file type.
 
56
     *
 
57
     * @retval true if the filter can import the file type 
 
58
     * @retval false otherwise.
 
59
     */
 
60
    virtual bool canImport(const QString &fileName, RS2::FormatType t) const = 0;
 
61
 
 
62
    /**
 
63
     * Checks if this filter can export the given file type.
 
64
     *
 
65
     * @return true if the filter can export the file type, 
 
66
     *         false otherwise.
 
67
     */
 
68
    virtual bool canExport(const QString &fileName, RS2::FormatType t) const = 0;
 
69
 
 
70
    /**
 
71
     * The implementation of this method in a inherited format
 
72
     * class should read a file from disk and put the entities
 
73
     * into the current entity container.
 
74
     */
 
75
    virtual bool fileImport(RS_Graphic& g, const QString& file, RS2::FormatType type) = 0;
 
76
 
 
77
    /**
 
78
     * The implementation of this method in a inherited format
 
79
     * class should write the entities in the current entity container
 
80
     * to a file on the disk.
 
81
     */
 
82
    virtual bool fileExport(RS_Graphic& g, const QString& file, RS2::FormatType type) = 0;
 
83
 
 
84
    static RS_FilterInterface * createFilter(){return NULL;}
 
85
};
 
86
 
 
87
#endif