summaryrefslogtreecommitdiffstats
path: root/ksvg/dom/SVGRectElement.h
blob: 2a77420d2c46d12e424662957d55b9644b80f042 (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
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*
    Copyright (C) 2001-2003 KSVG Team
    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.


    This file includes excerpts from the Scalable Vector Graphics
    (SVG) 1.0 Specification (Proposed Recommendation)
    http://www.w3.org/TR/SVG

    Copyright � 2001 World Wide Web Consortium, (Massachusetts
    Institute of Technology, Institut National de Recherche en
    Informatique et en Automatique, Keio University).
    All Rights Reserved.

    $Id$
 */

#ifndef SVGRectElement_H
#define SVGRectElement_H

#include "SVGElement.h"
#include "SVGTests.h"
#include "SVGLangSpace.h"
#include "SVGExternalResourcesRequired.h"
#include "SVGStylable.h"
#include "SVGTransformable.h"

namespace KSVG
{

class SVGAnimatedLength;
class SVGRectElementImpl;

/**
 * The <code> rect </code> element defines a rectangle which is
 * axis-aligned with the current <a href =
 * "http://www.w3.org/TR/SVG/intro.html#TermUserCoordinateSystem">
 * user coordinate</a> system.
 * Rounded rectangles can be achieved by setting appropriate values
 * for attributes <code> x </code> and <code> y</code>.
 *
 * For more info look here : <a href =
 * "http://www.w3.org/TR/SVG/shapes.html#RectElement"> 9.2 The
 * 'rect' element</a>.
 */
class SVGRectElement : public SVGElement,
					   public SVGTests,
					   public SVGLangSpace,
					   public SVGExternalResourcesRequired,
					   public SVGStylable,
					   public SVGTransformable
{
public:
	SVGRectElement();
	SVGRectElement(const SVGRectElement &);
	SVGRectElement &operator=(const SVGRectElement &other);
	SVGRectElement(SVGRectElementImpl *);
	~SVGRectElement();

	/**
	 * The x-axis coordinate of the side of the rectangle which has
	 * the smaller x-axis coordinate value in the current user
	 * coordinate system.
	 * If the attribute is not specified, the effect is as if a value
	 * of "0" were specified.
	 *
	 * This attribute is animatable.
	 *
	 * @return The x-axis coordinate of the rectangle.
	 */
	SVGAnimatedLength x();

	/**
	 * The y-axis coordinate of the side of the rectangle which has
	 * the smaller y-axis coordinate value in the current user
	 * coordinate system. If the attribute is not specified, the
	 * effect is as if a value of "0" were specified.
	 *
	 * This attribute is animatable.
	 *
	 * @return The y-axis coordinate of the rectangle.
	 */
	SVGAnimatedLength y();

	/**
	 * The width of the rectangle. A negative value is an error (see
	 * <a href =
	 * "http://www.w3.org/TR/SVG/implnote.html#ErrorProcessing">
	 * Error processing</a>).
	 * A value of zero disables rendering of the element.
	 *
	 * This attribute is animatable.
	 *
	 * @return The width of the rectangle.
	 */
	SVGAnimatedLength width();

	/**
	 * The heigth of the rectangle. A negative value is an error (see
	 * <a href =
	 * "http://www.w3.org/TR/SVG/implnote.html#ErrorProcessing">
	 * Error processing</a>). A value of zero disables rendering of
	 * the element.
	 *
	 * This attribute is animatable.
	 *
	 * @return The height of the rectangle
	 */
	SVGAnimatedLength height();

	/**
	 * For rounded rectangles, the x-axis radius of the ellipse used
	 * to round off the corners of the rectangle. A negative value is
	 * an error (see <a 	 href =
	 * "http://www.w3.org/TR/SVG/implnote.html#ErrorProcessing"> Error
	 * processing</a>).
	 *
	 * See <a href="http://www.w3.org/TR/SVG/shapes.html#RectElement">
	 * 9.2 The 'rect' element </a> for info about what happens if the
	 * attribute is not specified.
	 *
	 * This attribute is animatable
	 *
	 * @return The x-axis radius of the ellipse used to round off the
	 * corners of the rectangle.
	 */
	SVGAnimatedLength rx();

	/**
	 * For rounded rectangles, the y-axis radius of the ellipse used
	 * to round off the corners of the rectangle. A negative value is
	 * an error (see <a href =
	 * "http://www.w3.org/TR/SVG/implnote.html#ErrorProcessing">Error
	 * processing</a>).
	 *
	 * See <a href="http://www.w3.org/TR/SVG/shapes.html#RectElement">
	 * 9.2 The 'rect' element </a> for info about what happens if the
	 * attribute is not specified.
	 *
	 * This attribute is animatable
	 *
	 * @return The y-axis radius of the ellipse used to round off the
	 * corners of the rectangle.
	 */
	SVGAnimatedLength ry();

	// Internal! - NOT PART OF THE SVG SPECIFICATION
	SVGRectElementImpl *handle() const { return impl; }

private:
	SVGRectElementImpl *impl;
};

}

#endif

// vim:ts=4:noet