summaryrefslogtreecommitdiffstats
path: root/kalzium/src/exporter.h
blob: c780a3940abba0272f8052b7c633a5b21aa469b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#ifndef EXPORTER_H
#define EXPORTER_H

/***************************************************************************

                           The header for the exporter class of Kalzium
                             -------------------
    begin                : June 2005
    copyright            : (C) 2005 by Martin Pfeiffer
    email                : hubipete@gmx.net
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

class QPixmap;
class QString;

/**
 * Small class that provides some exporting functions for graphics.
 *
 * @author Martin Pfeiffer
 */
class Exporter
{
public:
	Exporter();
	~Exporter();

	/**
	 * Export the image @p pixmap to the file @p fileName.
	 * If specified, @p x, @p y, @p width and @p height gives the region of
	 * @p pixmap we should export. Otherwise, the entire @p pixmap will be
	 * exported.
	 * @return whether the image was saved successfully
	 */
	bool saveAsImage( const QPixmap* pixmap, const QString& fileName, int x = 0, int y = 0, int width = 0, int height = 0 );

	/**
	 * Which image type can we export to?
	 * @return a string representing a filter string for file dialogs with
	 * the image type we can export to
	 */
	QString supportedImageFormats();
};

#endif