KReport

KReportElement.shared.h
1/* This file is part of the KDE project
2 * Copyright (C) 2001-2007 by OpenMFG, LLC (info@openmfg.com)
3 * Copyright (C) 2007-2008 by Adam Pigg (adam@piggz.co.uk)
4 * Copyright (C) 2010-2015 Jarosław Staniek <staniek@kde.org>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef KREPORTELEMENT_H
21#define KREPORTELEMENT_H
22
23#include "kreport_export.h"
24
25#include <QColor>
26#include <QRectF>
27
28class QDebug;
29
30//! @brief The KReportElement class represents a functional visual element of a report design
31class KREPORT_EXPORT KReportElement //SDC: explicit operator== virtual_dtor
32{
33public:
34 /*!
35 @getter
36 @return element's name.
37 @setter
38 Sets the element's name to @a name.
39 */
40 QString name; //SDC:
41
42 /*!
43 @getter
44 @return element's rectangle.
45 @setter
46 Sets the element's rectangle to @a rect.
47 */
48 QRectF rect; //SDC:
49
50 /*!
51 @getter
52 @return element's Z-value.
53 The Z value decides the stacking order of sibling (neighboring) elements.
54 A sibling element of high Z value will always be drawn on top of another sibling
55 element with a lower Z value.
56 If you restore the Z value, the element's insertion order will decide its stacking order.
57 The Z-value does not affect the element's size in any way.
58 The default Z-value is 0.
59 @setter
60 Sets the element's Z-value to @a z.
61 */
62 qreal z; //SDC: default=0
63
64 /*!
65 @getter
66 @return element's foreground color.
67 The default foreground color is invalid what means 'unspecified'.
68 @setter
69 Sets the element's foreground color to @a foregroundColor.
70 */
72
73 /*!
74 @getter
75 @return element's background color.
76 The default background color is invalid what means 'unspecified'.
77 @setter
78 Sets the element's background color to @a backgroundColor.
79 */
81
82 /*!
83 @getter
84 @return element's background opacity, which is between 0.0 (transparent) and 1.0 (opaque).
85 The default opacity is 0.0.
86 @setter
87 Sets the element's background opacity to @a backgroundOpacity.
88 */
89 qreal backgroundOpacity; //SDC: default=0.0 custom_setter
90};
91
92//! Sends information about the element @a element to debug output @a dbg.
93KREPORT_EXPORT QDebug operator<<(QDebug dbg, const KReportElement& element);
94
95KREPORT_EXPORT uint qHash(const KReportElement &element, uint seed = 0) Q_DECL_NOTHROW;
96
97#endif // KREPORTELEMENT_H
The KReportElement class represents a functional visual element of a report design.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:48:09 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.