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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/*
Copyright (C) 2002 Nikolas Zimmermann <wildfox@kde.org>
This file is part of the KDE project
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KSVGIconEngine_H
#define KSVGIconEngine_H
#include <tqdom.h>
#include <tdelibs_export.h>
/**
* \file ksvgiconengine.h
*/
class KSVGIconPainter;
class TDECORE_EXPORT KSVGIconEngine
{
public:
KSVGIconEngine();
~KSVGIconEngine();
/**
* @short Reads SVG(Z) document @p path, parses and renders its contents.
*
* @param path is the path of the SVG document.
* @param width is the width of the render result. Omit it or pass 0 to use document's default.
* @param height is the height of the render result. Omit it or pass 0 to use document's default.
*
* @return True if rendering is successful, otherwise false.
*/
bool load(const TQString &path, int width = 0, int height = 0);
/**
* @deprecated
* @short Reads SVG(Z) document @p path, parses and renders its contents.
*
* This function uses the old parameter order which does not allow width and height to be omitted
* and is kept for compatibility. Prefer the variant below instead.
*
* @see load(const TQString&, int, int);
*/
bool load(int width, int height, const TQString &path) KDE_DEPRECATED;
/**
* @short Renders the SVG data stored as DOM in @p data.
*
* @param data is the TQDocDocument representation of the SVG document to render.
* @see load(const TQString&, int, int);
*/
bool parse(const TQDomDocument &data, int width = 0, int height = 0);
/**
* @short Renders the SVG data stored as string in @p data.
*
* This function is a wrapper provided for convenience.
*
* @param data is a TQString containing the SVG document to render.
* @see parse(const TQDomDocument&, int, int);
*/
bool parse(const TQString &data, int width = 0, int height = 0);
/**
* @short Returns a pointer to the engine's KSVGIconPainter object.
*
* Typically you won't need access to the painter and you won't be able to do so
* from outside tdelibs (since the KSVGIconPainter header is not installed).
*/
KSVGIconPainter *painter();
/**
* @short Returns a pointer to the rendered TQImage.
*/
TQImage *image();
/**
* @short Returns the rendered image's width.
*/
double width();
/**
* @short Returns the rendered image's height.
*/
double height();
private:
struct Private;
Private *d;
};
#endif
|
