Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qquickshape_p.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QQUICKSHAPE_P_H
6#define QQUICKSHAPE_P_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17//
18
19#include <QtQuickShapes/private/qquickshapesglobal_p.h>
20#include <QtQuick/qquickitem.h>
21
22#include <private/qtquickglobal_p.h>
23#include <private/qquickpath_p_p.h>
24#include <private/qquickrectangle_p.h>
25
26QT_BEGIN_NAMESPACE
27
28class QQuickShapePathPrivate;
29class QQuickShapePrivate;
30
31void Q_QUICKSHAPES_EXPORT QQuickShapes_initializeModule();
32
33class Q_QUICKSHAPES_EXPORT QQuickShapesModule
34{
35public:
36 static void defineModule();
37};
38
39class Q_QUICKSHAPES_EXPORT QQuickShapeGradient : public QQuickGradient
40{
41 Q_OBJECT
42 Q_PROPERTY(SpreadMode spread READ spread WRITE setSpread NOTIFY spreadChanged)
43 Q_CLASSINFO("DefaultProperty", "stops")
44
45 QML_NAMED_ELEMENT(ShapeGradient)
46 QML_ADDED_IN_VERSION(1, 0)
47 QML_UNCREATABLE("ShapeGradient is an abstract base class.");
48
49public:
50 enum SpreadMode {
51 PadSpread,
52 ReflectSpread,
53 RepeatSpread
54 };
55 Q_ENUM(SpreadMode)
56
57 QQuickShapeGradient(QObject *parent = nullptr);
58
59 SpreadMode spread() const;
60 void setSpread(SpreadMode mode);
61
62Q_SIGNALS:
63 void spreadChanged();
64
65private:
66 SpreadMode m_spread;
67};
68
69class Q_QUICKSHAPES_EXPORT QQuickShapeLinearGradient : public QQuickShapeGradient
70{
71 Q_OBJECT
72 Q_PROPERTY(qreal x1 READ x1 WRITE setX1 NOTIFY x1Changed)
73 Q_PROPERTY(qreal y1 READ y1 WRITE setY1 NOTIFY y1Changed)
74 Q_PROPERTY(qreal x2 READ x2 WRITE setX2 NOTIFY x2Changed)
75 Q_PROPERTY(qreal y2 READ y2 WRITE setY2 NOTIFY y2Changed)
76 Q_CLASSINFO("DefaultProperty", "stops")
77 QML_NAMED_ELEMENT(LinearGradient)
78 QML_ADDED_IN_VERSION(1, 0)
79
80public:
81 QQuickShapeLinearGradient(QObject *parent = nullptr);
82
83 qreal x1() const;
84 void setX1(qreal v);
85 qreal y1() const;
86 void setY1(qreal v);
87 qreal x2() const;
88 void setX2(qreal v);
89 qreal y2() const;
90 void setY2(qreal v);
91
92Q_SIGNALS:
93 void x1Changed();
94 void y1Changed();
95 void x2Changed();
96 void y2Changed();
97
98private:
99 QPointF m_start;
100 QPointF m_end;
101};
102
103class Q_QUICKSHAPES_EXPORT QQuickShapeRadialGradient : public QQuickShapeGradient
104{
105 Q_OBJECT
106 Q_PROPERTY(qreal centerX READ centerX WRITE setCenterX NOTIFY centerXChanged)
107 Q_PROPERTY(qreal centerY READ centerY WRITE setCenterY NOTIFY centerYChanged)
108 Q_PROPERTY(qreal centerRadius READ centerRadius WRITE setCenterRadius NOTIFY centerRadiusChanged)
109 Q_PROPERTY(qreal focalX READ focalX WRITE setFocalX NOTIFY focalXChanged)
110 Q_PROPERTY(qreal focalY READ focalY WRITE setFocalY NOTIFY focalYChanged)
111 Q_PROPERTY(qreal focalRadius READ focalRadius WRITE setFocalRadius NOTIFY focalRadiusChanged)
112 Q_CLASSINFO("DefaultProperty", "stops")
113 QML_NAMED_ELEMENT(RadialGradient)
114 QML_ADDED_IN_VERSION(1, 0)
115
116public:
117 QQuickShapeRadialGradient(QObject *parent = nullptr);
118
119 qreal centerX() const;
120 void setCenterX(qreal v);
121
122 qreal centerY() const;
123 void setCenterY(qreal v);
124
125 qreal centerRadius() const;
126 void setCenterRadius(qreal v);
127
128 qreal focalX() const;
129 void setFocalX(qreal v);
130
131 qreal focalY() const;
132 void setFocalY(qreal v);
133
134 qreal focalRadius() const;
135 void setFocalRadius(qreal v);
136
137Q_SIGNALS:
138 void centerXChanged();
139 void centerYChanged();
140 void focalXChanged();
141 void focalYChanged();
142 void centerRadiusChanged();
143 void focalRadiusChanged();
144
145private:
146 QPointF m_centerPoint;
147 QPointF m_focalPoint;
148 qreal m_centerRadius = 0;
149 qreal m_focalRadius = 0;
150};
151
152class Q_QUICKSHAPES_EXPORT QQuickShapeConicalGradient : public QQuickShapeGradient
153{
154 Q_OBJECT
155 Q_PROPERTY(qreal centerX READ centerX WRITE setCenterX NOTIFY centerXChanged)
156 Q_PROPERTY(qreal centerY READ centerY WRITE setCenterY NOTIFY centerYChanged)
157 Q_PROPERTY(qreal angle READ angle WRITE setAngle NOTIFY angleChanged)
158 Q_CLASSINFO("DefaultProperty", "stops")
159 QML_NAMED_ELEMENT(ConicalGradient)
160 QML_ADDED_IN_VERSION(1, 0)
161
162public:
163 QQuickShapeConicalGradient(QObject *parent = nullptr);
164
165 qreal centerX() const;
166 void setCenterX(qreal v);
167
168 qreal centerY() const;
169 void setCenterY(qreal v);
170
171 qreal angle() const;
172 void setAngle(qreal v);
173
174Q_SIGNALS:
175 void centerXChanged();
176 void centerYChanged();
177 void angleChanged();
178
179private:
180 QPointF m_centerPoint;
181 qreal m_angle = 0;
182};
183
184class Q_QUICKSHAPES_EXPORT QQuickShapeTrim : public QObject
185{
186 Q_OBJECT
187
188 Q_PROPERTY(qreal start READ start WRITE setStart NOTIFY startChanged FINAL)
189 Q_PROPERTY(qreal end READ end WRITE setEnd NOTIFY endChanged FINAL)
190 Q_PROPERTY(qreal offset READ offset WRITE setOffset NOTIFY offsetChanged FINAL)
191 QML_ANONYMOUS
192 QML_ADDED_IN_VERSION(6, 10)
193public:
194 QQuickShapeTrim(QObject *parent = nullptr);
195
196 qreal start() const;
197 void setStart(qreal t);
198
199 qreal end() const;
200 void setEnd(qreal t);
201
202 qreal offset() const;
203 void setOffset(qreal t);
204
205Q_SIGNALS:
206 void startChanged();
207 void endChanged();
208 void offsetChanged();
209
210private:
211 qreal m_start = 0;
212 qreal m_end = 1;
213 qreal m_offset = 0;
214};
215
216class Q_QUICKSHAPES_EXPORT QQuickShapePath : public QQuickPath
217{
218 Q_OBJECT
219
220 Q_PROPERTY(QColor strokeColor READ strokeColor WRITE setStrokeColor NOTIFY strokeColorChanged)
221 Q_PROPERTY(qreal strokeWidth READ strokeWidth WRITE setStrokeWidth NOTIFY strokeWidthChanged)
222 Q_PROPERTY(QColor fillColor READ fillColor WRITE setFillColor NOTIFY fillColorChanged)
223 Q_PROPERTY(FillRule fillRule READ fillRule WRITE setFillRule NOTIFY fillRuleChanged)
224 Q_PROPERTY(JoinStyle joinStyle READ joinStyle WRITE setJoinStyle NOTIFY joinStyleChanged)
225 Q_PROPERTY(int miterLimit READ miterLimit WRITE setMiterLimit NOTIFY miterLimitChanged)
226 Q_PROPERTY(CapStyle capStyle READ capStyle WRITE setCapStyle NOTIFY capStyleChanged)
227 Q_PROPERTY(StrokeStyle strokeStyle READ strokeStyle WRITE setStrokeStyle NOTIFY strokeStyleChanged)
228 Q_PROPERTY(qreal dashOffset READ dashOffset WRITE setDashOffset NOTIFY dashOffsetChanged)
229 Q_PROPERTY(QList<qreal> dashPattern READ dashPattern WRITE setDashPattern NOTIFY dashPatternChanged)
230 Q_PROPERTY(QQuickShapeGradient *fillGradient READ fillGradient WRITE setFillGradient NOTIFY fillGradientChanged RESET resetFillGradient)
231 Q_PROPERTY(QSizeF scale READ scale WRITE setScale NOTIFY scaleChanged OVERRIDE REVISION(1, 14))
232 Q_PROPERTY(PathHints pathHints READ pathHints WRITE setPathHints NOTIFY pathHintsChanged REVISION(6, 7) FINAL)
233 Q_PROPERTY(QMatrix4x4 fillTransform READ fillTransform WRITE setFillTransform NOTIFY fillTransformChanged REVISION(6, 8) FINAL)
234 Q_PROPERTY(QQuickItem *fillItem READ fillItem WRITE setFillItem NOTIFY fillItemChanged REVISION(6, 8) FINAL)
235 Q_PROPERTY(QQuickShapeTrim *trim READ trim CONSTANT REVISION(6, 10) FINAL)
236 Q_PROPERTY(bool cosmeticStroke READ cosmeticStroke WRITE setCosmeticStroke NOTIFY cosmeticStrokeChanged REVISION(6, 11) FINAL)
237 Q_PROPERTY(QQuickShapeGradient *strokeGradient READ strokeGradient WRITE setStrokeGradient NOTIFY strokeGradientChanged RESET resetStrokeGradient REVISION(6, 12))
238 Q_PROPERTY(bool visible READ isVisible WRITE setVisible NOTIFY visibleChanged REVISION(6, 13) FINAL)
239 QML_NAMED_ELEMENT(ShapePath)
240 QML_ADDED_IN_VERSION(1, 0)
241
242public:
243 enum FillRule {
244 OddEvenFill = Qt::OddEvenFill,
245 WindingFill = Qt::WindingFill
246 };
247 Q_ENUM(FillRule)
248
249 enum JoinStyle {
250 MiterJoin = Qt::MiterJoin,
251 BevelJoin = Qt::BevelJoin,
252 RoundJoin = Qt::RoundJoin
253 };
254 Q_ENUM(JoinStyle)
255
256 enum CapStyle {
257 FlatCap = Qt::FlatCap,
258 SquareCap = Qt::SquareCap,
259 RoundCap = Qt::RoundCap
260 };
261 Q_ENUM(CapStyle)
262
263 enum StrokeStyle {
264 SolidLine = Qt::SolidLine,
265 DashLine = Qt::DashLine
266 };
267 Q_ENUM(StrokeStyle)
268
269 enum PathHint {
270 PathLinear = 0x1,
271 PathQuadratic = 0x2,
272 PathConvex = 0x4,
273 PathFillOnRight = 0x8,
274 PathSolid = 0x10,
275 PathNonIntersecting = 0x20,
276 PathNonOverlappingControlPointTriangles = 0x40
277 };
278 Q_DECLARE_FLAGS(PathHints, PathHint)
279 Q_FLAG(PathHints)
280
281 QQuickShapePath(QObject *parent = nullptr);
282 ~QQuickShapePath();
283
284 QColor strokeColor() const;
285 void setStrokeColor(const QColor &color);
286
287 qreal strokeWidth() const;
288 void setStrokeWidth(qreal w);
289
290 void setStrokeGradient(QQuickShapeGradient *gradient);
291 QQuickShapeGradient *strokeGradient() const;
292 void resetStrokeGradient();
293
294 QColor fillColor() const;
295 void setFillColor(const QColor &color);
296
297 FillRule fillRule() const;
298 void setFillRule(FillRule fillRule);
299
300 JoinStyle joinStyle() const;
301 void setJoinStyle(JoinStyle style);
302
303 int miterLimit() const;
304 void setMiterLimit(int limit);
305
306 CapStyle capStyle() const;
307 void setCapStyle(CapStyle style);
308
309 StrokeStyle strokeStyle() const;
310 void setStrokeStyle(StrokeStyle style);
311
312 qreal dashOffset() const;
313 void setDashOffset(qreal offset);
314
315 QList<qreal> dashPattern() const;
316 void setDashPattern(const QList<qreal> &array);
317
318 QQuickShapeGradient *fillGradient() const;
319 void setFillGradient(QQuickShapeGradient *gradient);
320 void resetFillGradient();
321
322 PathHints pathHints() const;
323 void setPathHints(PathHints newPathHints);
324
325 QMatrix4x4 fillTransform() const;
326 void setFillTransform(const QMatrix4x4 &matrix);
327
328 QQuickItem *fillItem() const;
329 void setFillItem(QQuickItem *newFillItem);
330
331 QQuickShapeTrim *trim();
332 bool hasTrim() const;
333
334 bool cosmeticStroke() const;
335 void setCosmeticStroke(bool c);
336
337 bool isVisible() const;
338 void setVisible(bool visible);
339
340Q_SIGNALS:
341 void shapePathChanged();
342 void strokeColorChanged();
343 void strokeWidthChanged();
344 void fillColorChanged();
345 void fillRuleChanged();
346 void joinStyleChanged();
347 void miterLimitChanged();
348 void capStyleChanged();
349 void strokeStyleChanged();
350 void dashOffsetChanged();
351 void dashPatternChanged();
352 Q_REVISION(6, 11) void fillGradientChanged();
353
354 Q_REVISION(6, 7) void pathHintsChanged();
355 Q_REVISION(6, 8) void fillTransformChanged();
356 Q_REVISION(6, 8) void fillItemChanged();
357 Q_REVISION(6, 11) void cosmeticStrokeChanged();
358 Q_REVISION(6, 12) void strokeGradientChanged();
359 Q_REVISION(6, 13) void visibleChanged();
360
361private:
362 Q_DISABLE_COPY(QQuickShapePath)
363 Q_DECLARE_PRIVATE(QQuickShapePath)
364 Q_PRIVATE_SLOT(d_func(), void _q_fillGradientChanged())
365 Q_PRIVATE_SLOT(d_func(), void _q_strokeGradientChanged())
366 Q_PRIVATE_SLOT(d_func(), void _q_fillItemDestroyed())
367};
368
369Q_DECLARE_OPERATORS_FOR_FLAGS(QQuickShapePath::PathHints)
370
371class Q_QUICKSHAPES_EXPORT QQuickShape : public QQuickItem
372{
373 Q_OBJECT
374 Q_PROPERTY(RendererType rendererType READ rendererType NOTIFY rendererChanged)
375 Q_PROPERTY(bool asynchronous READ asynchronous WRITE setAsynchronous NOTIFY asynchronousChanged)
376 Q_PROPERTY(bool vendorExtensionsEnabled READ vendorExtensionsEnabled WRITE setVendorExtensionsEnabled NOTIFY vendorExtensionsEnabledChanged)
377 Q_PROPERTY(RendererType preferredRendererType READ preferredRendererType
378 WRITE setPreferredRendererType NOTIFY preferredRendererTypeChanged REVISION(6, 6) FINAL)
379 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
380 Q_PROPERTY(ContainsMode containsMode READ containsMode WRITE setContainsMode NOTIFY containsModeChanged REVISION(1, 11))
381 Q_PROPERTY(QRectF boundingRect READ boundingRect NOTIFY boundingRectChanged REVISION(6, 6) FINAL)
382 Q_PROPERTY(FillMode fillMode READ fillMode WRITE setFillMode NOTIFY fillModeChanged REVISION(6, 7) FINAL)
383 Q_PROPERTY(HAlignment horizontalAlignment READ horizontalAlignment WRITE setHorizontalAlignment NOTIFY horizontalAlignmentChanged REVISION(6, 7) FINAL)
384 Q_PROPERTY(VAlignment verticalAlignment READ verticalAlignment WRITE setVerticalAlignment NOTIFY verticalAlignmentChanged REVISION(6, 7) FINAL)
385
386 Q_PROPERTY(QQmlListProperty<QObject> data READ data OVERRIDE)
387 Q_CLASSINFO("DefaultProperty", "data")
388 QML_NAMED_ELEMENT(Shape)
389 QML_ADDED_IN_VERSION(1, 0)
390
391public:
392 enum RendererType {
393 UnknownRenderer,
394 GeometryRenderer,
395 NvprRenderer,
396 SoftwareRenderer,
397 CurveRenderer
398 };
399 Q_ENUM(RendererType)
400
401 enum Status {
402 Null,
403 Ready,
404 Processing
405 };
406 Q_ENUM(Status)
407
408 enum ContainsMode {
409 BoundingRectContains,
410 FillContains
411 };
412 Q_ENUM(ContainsMode)
413
414 enum FillMode {
415 NoResize,
416 PreserveAspectFit,
417 PreserveAspectCrop,
418 Stretch
419 };
420 Q_ENUM(FillMode)
421
422 enum HAlignment { AlignLeft = Qt::AlignLeft,
423 AlignRight = Qt::AlignRight,
424 AlignHCenter = Qt::AlignHCenter };
425 Q_ENUM(HAlignment)
426 enum VAlignment { AlignTop = Qt::AlignTop,
427 AlignBottom = Qt::AlignBottom,
428 AlignVCenter = Qt::AlignVCenter };
429 Q_ENUM(VAlignment)
430
431 QQuickShape(QQuickItem *parent = nullptr);
432 ~QQuickShape();
433
434 RendererType rendererType() const;
435
436 bool asynchronous() const;
437 void setAsynchronous(bool async);
438
439 Q_REVISION(6, 6) RendererType preferredRendererType() const;
440 Q_REVISION(6, 6) void setPreferredRendererType(RendererType preferredType);
441
442 Q_REVISION(6, 6) QRectF boundingRect() const override;
443
444 bool vendorExtensionsEnabled() const;
445 void setVendorExtensionsEnabled(bool enable);
446
447 Status status() const;
448
449 ContainsMode containsMode() const;
450 void setContainsMode(ContainsMode containsMode);
451
452 bool contains(const QPointF &point) const override;
453
454 QQmlListProperty<QObject> data();
455
456 Q_REVISION(6, 7) FillMode fillMode() const;
457 Q_REVISION(6, 7) void setFillMode(FillMode newFillMode);
458
459 Q_REVISION(6, 7) HAlignment horizontalAlignment() const;
460 Q_REVISION(6, 7) void setHorizontalAlignment(HAlignment newHorizontalAlignment);
461
462 Q_REVISION(6, 7) VAlignment verticalAlignment() const;
463 Q_REVISION(6, 7) void setVerticalAlignment(VAlignment newVerticalAlignment);
464
465protected:
466 QQuickShape(QQuickShapePrivate &dd, QQuickItem *parent);
467
468 QSGNode *updatePaintNode(QSGNode *node, UpdatePaintNodeData *) override;
469 void updatePolish() override;
470 void itemChange(ItemChange change, const ItemChangeData &data) override;
471 void componentComplete() override;
472 void classBegin() override;
473
474Q_SIGNALS:
475 void rendererChanged();
476 void asynchronousChanged();
477 void vendorExtensionsEnabledChanged();
478 void statusChanged();
479 Q_REVISION(6, 6) void preferredRendererTypeChanged();
480 Q_REVISION(6, 6) void boundingRectChanged();
481 Q_REVISION(1, 11) void containsModeChanged();
482
483 Q_REVISION(6, 7) void fillModeChanged();
484 Q_REVISION(6, 7) void horizontalAlignmentChanged();
485 Q_REVISION(6, 7) void verticalAlignmentChanged();
486
487private:
488 Q_DISABLE_COPY(QQuickShape)
489 Q_DECLARE_PRIVATE(QQuickShape)
490 Q_PRIVATE_SLOT(d_func(), void _q_shapePathChanged())
491};
492
493QT_END_NAMESPACE
494
495#endif // QQUICKSHAPE_P_H
Q_STATIC_LOGGING_CATEGORY
QT_BEGIN_NAMESPACE Q_STATIC_LOGGING_CATEGORY(lcSynthesizedIterableAccess, "qt.iterable.synthesized", QtWarningMsg)
initResources
static void initResources()
Definition qquickshape.cpp:17
vpe_clear
static void vpe_clear(QQmlListProperty< QObject > *property)
Definition qquickshape.cpp:1390
vpe_append
static void vpe_append(QQmlListProperty< QObject > *property, QObject *obj)
Definition qquickshape.cpp:1372
Q_GHS_KEEP_REFERENCE
Q_GHS_KEEP_REFERENCE(QQuickShapes_initializeModule)