#include <qquickpath_p.h>

Inheritance diagram for QQuickPathRectangle:

Collaboration diagram for QQuickPathRectangle:

Signals
void	widthChanged ()

void	heightChanged ()

void	strokeAdjustmentChanged ()

void	radiusChanged ()

void	topLeftRadiusChanged ()

void	topRightRadiusChanged ()

void	bottomLeftRadiusChanged ()

void	bottomRightRadiusChanged ()

Signals inherited from QQuickCurve
void	xChanged ()

void	yChanged ()

void	relativeXChanged ()

void	relativeYChanged ()

Signals inherited from QQuickPathElement
void	changed ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickPathRectangle (QObject *parent=nullptr)

qreal	width () const
	\qmltype PathRectangle \instantiates QQuickPathRectangle \inqmlmodule QtQuick

void	setWidth (qreal width)

qreal	height () const

void	setHeight (qreal height)

qreal	strokeAdjustment () const
	\qmlproperty real QtQuick::PathRectangle::strokeAdjustment

void	setStrokeAdjustment (qreal newStrokeAdjustment)

qreal	radius () const
	\qmlproperty real QtQuick::PathRectangle::radius

void	setRadius (qreal newRadius)

qreal	topLeftRadius () const

void	setTopLeftRadius (qreal radius)

void	resetTopLeftRadius ()

qreal	topRightRadius () const

void	setTopRightRadius (qreal radius)

void	resetTopRightRadius ()

qreal	bottomLeftRadius () const

void	setBottomLeftRadius (qreal radius)

void	resetBottomLeftRadius ()

qreal	bottomRightRadius () const

void	setBottomRightRadius (qreal radius)

void	resetBottomRightRadius ()

qreal	cornerRadius (Qt::Corner corner) const
	\qmlproperty real QtQuick::PathRectangle::topLeftRadius \qmlproperty real QtQuick::PathRectangle::topRightRadius \qmlproperty real QtQuick::PathRectangle::bottomLeftRadius \qmlproperty real QtQuick::PathRectangle::bottomRightRadius

void	setCornerRadius (Qt::Corner corner, qreal newCornerRadius)

void	resetCornerRadius (Qt::Corner corner)

void	addToPath (QPainterPath &path, const QQuickPathData &) override

Public Member Functions inherited from QQuickCurve
	QQuickCurve (QObject *parent=nullptr)

qreal	x () const

void	setX (qreal x)

bool	hasX ()

qreal	y () const

void	setY (qreal y)

bool	hasY ()

qreal	relativeX () const

void	setRelativeX (qreal x)

bool	hasRelativeX ()

qreal	relativeY () const

void	setRelativeY (qreal y)

bool	hasRelativeY ()

Public Member Functions inherited from QQuickPathElement
	QQuickPathElement (QObject *parent=nullptr)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Properties
qreal	width

qreal	height

qreal	strokeAdjustment

qreal	radius

qreal	topLeftRadius

qreal	topRightRadius

qreal	bottomLeftRadius

qreal	bottomRightRadius

Properties inherited from QQuickCurve
qreal	x

qreal	y

qreal	relativeX

qreal	relativeY

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 401 of file qquickpath_p.h.

Constructor & Destructor Documentation

◆ QQuickPathRectangle()

QQuickPathRectangle::QQuickPathRectangle ( QObject * parent = nullptr )

inline

Definition at line 417 of file qquickpath_p.h.

Member Function Documentation

◆ addToPath()

void QQuickPathRectangle::addToPath	(	QPainterPath &	path,
		const QQuickPathData &	data )

overridevirtual

Reimplemented from QQuickCurve.

Definition at line 2474 of file qquickpath.cpp.

References Qt::BottomLeftCorner, Qt::BottomRightCorner, QLazilyAllocated< T, Tag >::isAllocated(), positionForCurve(), qMax(), qMin(), radius, rect, Qt::TopLeftCorner, and Qt::TopRightCorner.

Here is the call graph for this function:

◆ bottomLeftRadius()

qreal QQuickPathRectangle::bottomLeftRadius ( ) const

inline

Definition at line 439 of file qquickpath_p.h.

References Qt::BottomLeftCorner.

◆ bottomLeftRadiusChanged

void QQuickPathRectangle::bottomLeftRadiusChanged ( )

signal

Referenced by setRadius().

Here is the caller graph for this function:

◆ bottomRightRadius()

qreal QQuickPathRectangle::bottomRightRadius ( ) const

inline

Definition at line 443 of file qquickpath_p.h.

References Qt::BottomRightCorner.

◆ bottomRightRadiusChanged

void QQuickPathRectangle::bottomRightRadiusChanged ( )

signal

Referenced by setRadius().

Here is the caller graph for this function:

◆ cornerRadius()

qreal QQuickPathRectangle::cornerRadius ( Qt::Corner corner ) const

\qmlproperty real QtQuick::PathRectangle::topLeftRadius \qmlproperty real QtQuick::PathRectangle::topRightRadius \qmlproperty real QtQuick::PathRectangle::bottomLeftRadius \qmlproperty real QtQuick::PathRectangle::bottomRightRadius

If set, these properties define the individual corner radii. A zero value defines that corner to be sharp, while a positive value defines it to be rounded. When unset, the value of \l radius is used instead.

These properties are unset by default. Assign undefined to them to return them to the unset state.

See also: radius

Definition at line 2431 of file qquickpath.cpp.

References QLazilyAllocated< T, Tag >::isAllocated().

Here is the call graph for this function:

◆ height()

qreal QQuickPathRectangle::height ( ) const

Definition at line 2324 of file qquickpath.cpp.

◆ heightChanged

void QQuickPathRectangle::heightChanged ( )

signal

Referenced by setHeight().

Here is the caller graph for this function:

◆ radius()

qreal QQuickPathRectangle::radius ( ) const

\qmlproperty real QtQuick::PathRectangle::radius

This property defines the corner radius used to define a rounded rectangle.

If radius is a positive value, the rectangle path will be defined as a rounded rectangle, otherwise it will be defined as a normal rectangle.

This property may be overridden by the individual corner radius properties.

See also: topLeftRadius, topRightRadius, bottomLeftRadius, bottomRightRadius

Definition at line 2393 of file qquickpath.cpp.

References QLazilyAllocated< T, Tag >::isAllocated().

Here is the call graph for this function:

◆ radiusChanged

void QQuickPathRectangle::radiusChanged ( )

signal

Referenced by setRadius().

Here is the caller graph for this function:

◆ resetBottomLeftRadius()

void QQuickPathRectangle::resetBottomLeftRadius ( )

inline

Definition at line 441 of file qquickpath_p.h.

References Qt::BottomLeftCorner.

◆ resetBottomRightRadius()

void QQuickPathRectangle::resetBottomRightRadius ( )

inline

Definition at line 445 of file qquickpath_p.h.

References Qt::BottomRightCorner.

◆ resetCornerRadius()

void QQuickPathRectangle::resetCornerRadius ( Qt::Corner corner )

Definition at line 2447 of file qquickpath.cpp.

References QLazilyAllocated< T, Tag >::isAllocated().

Here is the call graph for this function:

◆ resetTopLeftRadius()

void QQuickPathRectangle::resetTopLeftRadius ( )

inline

Definition at line 433 of file qquickpath_p.h.

References Qt::TopLeftCorner.

◆ resetTopRightRadius()

void QQuickPathRectangle::resetTopRightRadius ( )

inline

Definition at line 437 of file qquickpath_p.h.

References Qt::TopRightCorner.

◆ setBottomLeftRadius()

void QQuickPathRectangle::setBottomLeftRadius ( qreal radius )

inline

Definition at line 440 of file qquickpath_p.h.

References Qt::BottomLeftCorner.

◆ setBottomRightRadius()

void QQuickPathRectangle::setBottomRightRadius ( qreal radius )

inline

Definition at line 444 of file qquickpath_p.h.

References Qt::BottomRightCorner.

◆ setCornerRadius()

void QQuickPathRectangle::setCornerRadius	(	Qt::Corner	corner,
		qreal	newCornerRadius )

Definition at line 2439 of file qquickpath.cpp.

References QLazilyAllocated< T, Tag >::value().

Here is the call graph for this function:

◆ setHeight()

void QQuickPathRectangle::setHeight ( qreal height )

Definition at line 2329 of file qquickpath.cpp.

References QQuickPathElement::changed(), emit, height, and heightChanged().

Here is the call graph for this function:

◆ setRadius()

void QQuickPathRectangle::setRadius ( qreal newRadius )

Definition at line 2398 of file qquickpath.cpp.

References Qt::BottomLeftCorner, bottomLeftRadiusChanged(), Qt::BottomRightCorner, bottomRightRadiusChanged(), QQuickPathElement::changed(), emit, radiusChanged(), Qt::TopLeftCorner, topLeftRadiusChanged(), Qt::TopRightCorner, topRightRadiusChanged(), and QLazilyAllocated< T, Tag >::value().

Here is the call graph for this function:

◆ setStrokeAdjustment()

void QQuickPathRectangle::setStrokeAdjustment ( qreal newStrokeAdjustment )

Definition at line 2371 of file qquickpath.cpp.

References QQuickPathElement::changed(), emit, and strokeAdjustmentChanged().

Here is the call graph for this function:

◆ setTopLeftRadius()

void QQuickPathRectangle::setTopLeftRadius ( qreal radius )

inline

Definition at line 432 of file qquickpath_p.h.

References Qt::TopLeftCorner.

◆ setTopRightRadius()

void QQuickPathRectangle::setTopRightRadius ( qreal radius )

inline

Definition at line 436 of file qquickpath_p.h.

References Qt::TopRightCorner.

◆ setWidth()

void QQuickPathRectangle::setWidth ( qreal width )

Definition at line 2314 of file qquickpath.cpp.

References QQuickPathElement::changed(), emit, width, and widthChanged().

Here is the call graph for this function:

◆ strokeAdjustment()

qreal QQuickPathRectangle::strokeAdjustment ( ) const

\qmlproperty real QtQuick::PathRectangle::strokeAdjustment

This property defines the stroke width adjustment to the rectangle coordinates.

When used in a \l ShapePath with stroking enabled, the actual stroked rectangle will by default extend beyond the defined rectangle by half the stroke width on all sides. This is the expected behavior since the path defines the midpoint line of the stroking, and corresponds to QPainter and SVG rendering.

If one instead wants the defined rectangle to be the outer edge of the stroked rectangle, like a \l Rectangle item with a border, one can set strokeAdjustment to the stroke width. This will effectively shift all edges inwards by half the stroke width. Like in the following example:

\qml ShapePath { id: myRec fillColor: "white" strokeColor: "black" strokeWidth: 16 joinStyle: ShapePath.MiterJoin

PathRectangle { x: 10; y: 10; width: 200; height: 100; strokeAdjustment: myRec.strokeWidth } } \endqml

Definition at line 2366 of file qquickpath.cpp.

◆ strokeAdjustmentChanged

void QQuickPathRectangle::strokeAdjustmentChanged ( )

signal

Referenced by setStrokeAdjustment().

Here is the caller graph for this function:

◆ topLeftRadius()

qreal QQuickPathRectangle::topLeftRadius ( ) const

inline

Definition at line 431 of file qquickpath_p.h.

References Qt::TopLeftCorner.

◆ topLeftRadiusChanged

void QQuickPathRectangle::topLeftRadiusChanged ( )

signal

Referenced by setRadius().

Here is the caller graph for this function:

◆ topRightRadius()

qreal QQuickPathRectangle::topRightRadius ( ) const

inline

Definition at line 435 of file qquickpath_p.h.

References Qt::TopRightCorner.

◆ topRightRadiusChanged

void QQuickPathRectangle::topRightRadiusChanged ( )

signal

Referenced by setRadius().

Here is the caller graph for this function:

◆ width()

qreal QQuickPathRectangle::width ( ) const

\qmltype PathRectangle \instantiates QQuickPathRectangle \inqmlmodule QtQuick

Defines a rectangle with optionally rounded corners.

Since: QtQuick 6.8

PathRectangle provides an easy way to specify a rectangle, optionally with rounded corners. The API corresponds to that of the \l Rectangle item.

See also: Path, PathLine, PathQuad, PathCubic, PathArc, PathAngleArc, PathCurve, PathSvg

\qmlproperty real QtQuick::PathRectangle::x \qmlproperty real QtQuick::PathRectangle::y

Defines the top left corner of the rectangle.

Unless that corner is rounded, this will also be the start and end point of the path.

See also: relativeX, relativeY

\qmlproperty real QtQuick::PathRectangle::relativeX \qmlproperty real QtQuick::PathRectangle::relativeY

Defines the top left corner of the rectangle relative to the path's start point.

If both a relative and absolute end position are specified for a single axis, the relative position will be used.

Relative and absolute positions can be mixed, for example it is valid to set a relative x and an absolute y.

See also: x, y

\qmlproperty real QtQuick::PathRectangle::width \qmlproperty real QtQuick::PathRectangle::height

Defines the width and height of the rectangle.

See also: x, y

Definition at line 2309 of file qquickpath.cpp.

◆ widthChanged

void QQuickPathRectangle::widthChanged ( )

signal

Referenced by setWidth().

Here is the caller graph for this function:

Property Documentation

◆ bottomLeftRadius

qreal QQuickPathRectangle::bottomLeftRadius

readwrite

Definition at line 411 of file qquickpath_p.h.

◆ bottomRightRadius

qreal QQuickPathRectangle::bottomRightRadius

readwrite

Definition at line 412 of file qquickpath_p.h.

◆ height

qreal QQuickPathRectangle::height

readwrite

Definition at line 406 of file qquickpath_p.h.

Referenced by setHeight().

◆ radius

qreal QQuickPathRectangle::radius

readwrite

Definition at line 408 of file qquickpath_p.h.

Referenced by addToPath().

◆ strokeAdjustment

qreal QQuickPathRectangle::strokeAdjustment

readwrite

Definition at line 407 of file qquickpath_p.h.

◆ topLeftRadius

qreal QQuickPathRectangle::topLeftRadius

readwrite

Definition at line 409 of file qquickpath_p.h.

◆ topRightRadius

qreal QQuickPathRectangle::topRightRadius

readwrite

Definition at line 410 of file qquickpath_p.h.

◆ width

qreal QQuickPathRectangle::width

readwrite

Definition at line 405 of file qquickpath_p.h.

Referenced by setWidth().

The documentation for this class was generated from the following files:

qtdeclarative/src/quick/util/qquickpath_p.h (22272aefeb4755cbcf78e91e450c44caab5fbfa6)
qtdeclarative/src/quick/util/qquickpath.cpp (79ad1c222b9d9422fa72d393c6d8018a7584675d)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickPathRectangle()

Member Function Documentation

◆ addToPath()

◆ bottomLeftRadius()

◆ bottomLeftRadiusChanged

◆ bottomRightRadius()

◆ bottomRightRadiusChanged

◆ cornerRadius()

◆ height()

◆ heightChanged

◆ radius()

◆ radiusChanged

◆ resetBottomLeftRadius()

◆ resetBottomRightRadius()

◆ resetCornerRadius()

◆ resetTopLeftRadius()

◆ resetTopRightRadius()

◆ setBottomLeftRadius()

◆ setBottomRightRadius()

◆ setCornerRadius()

◆ setHeight()

◆ setRadius()

◆ setStrokeAdjustment()

◆ setTopLeftRadius()

◆ setTopRightRadius()

◆ setWidth()

◆ strokeAdjustment()

◆ strokeAdjustmentChanged

◆ topLeftRadius()

◆ topLeftRadiusChanged

◆ topRightRadius()

◆ topRightRadiusChanged

◆ width()

◆ widthChanged

Property Documentation

◆ bottomLeftRadius

◆ bottomRightRadius

◆ height

◆ radius

◆ strokeAdjustment

◆ topLeftRadius

◆ topRightRadius

◆ width