← Back to branch summary

~ubuntu-branches/ubuntu/raring/kbibtex/raring

« back to all changes in this revision

Viewing changes to src/libkbibtexio/fileexporter.h

  • Committer: Package Import Robot
  • Author(s): Michael Hanke
  • Date: 2011-07-18 09:29:48 UTC
  • mfrom: (1.1.6) (2.1.5 sid)
  • Revision ID: package-import@ubuntu.com-20110718092948-ksxjmg7kdfamolmg
Tags: 0.3-1
http://bugs.debian.org/634255
* First upstream release for KDE4 (Closes: #634255). A number of search
  engines are still missing, in comparison to the 0.2 series.
* Bumped Standards-Version to 3.9.2, no changes necessary.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/libkbibtexio/fileexporter.h
 
1
/***************************************************************************
 
2
*   Copyright (C) 2004-2009 by Thomas Fischer                             *
 
3
*   fischer@unix-ag.uni-kl.de                                             *
 
4
*                                                                         *
 
5
*   This program is free software; you can redistribute it and/or modify  *
 
6
*   it under the terms of the GNU General Public License as published by  *
 
7
*   the Free Software Foundation; either version 2 of the License, or     *
 
8
*   (at your option) any later version.                                   *
 
9
*                                                                         *
 
10
*   This program is distributed in the hope that it will be useful,       *
 
11
*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 
12
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 
13
*   GNU General Public License for more details.                          *
 
14
*                                                                         *
 
15
*   You should have received a copy of the GNU General Public License     *
 
16
*   along with this program; if not, write to the                         *
 
17
*   Free Software Foundation, Inc.,                                       *
 
18
*   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 
19
***************************************************************************/
 
20
#ifndef KBIBTEX_IO_FILEEXPORTER_H
 
21
#define KBIBTEX_IO_FILEEXPORTER_H
 
22
 
 
23
#include <QObject>
 
24
 
 
25
#include <file.h>
 
26
 
 
27
class QIODevice;
 
28
 
 
29
class File;
 
30
class Element;
 
31
 
 
32
/**
 
33
 * @author Thomas Fischer <fischer@unix-ag.uni-kl.de>
 
34
 */
 
35
class KBIBTEXIO_EXPORT FileExporter : public QObject
 
36
{
 
37
    Q_OBJECT
 
38
 
 
39
public:
 
40
    FileExporter();
 
41
    ~FileExporter();
 
42
 
 
43
    virtual bool save(QIODevice *iodevice, const File* bibtexfile, QStringList *errorLog = NULL) = 0;
 
44
    virtual bool save(QIODevice *iodevice, const Element* element, QStringList *errorLog = NULL) = 0;
 
45
 
 
46
    /**
 
47
      * When exporting data, show a dialog where the user may select options on the
 
48
      * export process such as selecting encoding. Re-implementing this function is
 
49
      * optional and should only be done if user interaction is necessary at export
 
50
      * actions.
 
51
      * Whatever settings are made in the export dialog have to be stored in the
 
52
      * File object via its property map.
 
53
      * A calling application should call this function before calling save() or similar
 
54
      * functions. However, an application may opt to not call this function, e.g. in case
 
55
      * of a Save operation opposed to a SaveAs option which would call this function.
 
56
      * The implementing class must be aware of this behaviour.
 
57
      * The implementer may choose to show or not show a dialog, depending on e.g. if
 
58
      * additional information is necessary or not.
 
59
      */
 
60
    /**
 
61
     * @see File::setProperty()
 
62
     * @see File::property()
 
63
     */
 
64
    virtual void showExportDialog(QWidget *parent, File *bibtexfile) const {
 
65
        Q_UNUSED(parent);
 
66
        Q_UNUSED(bibtexfile);
 
67
    }
 
68
 
 
69
signals:
 
70
    void progress(int current, int total);
 
71
 
 
72
public slots:
 
73
    virtual void cancel() {
 
74
        // nothing
 
75
    };
 
76
};
 
77
 
 
78
#endif // KBIBTEX_IO_FILEEXPORTER_H