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
QQuickPathRectangle Class Reference

#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 ()
 Q_REVISION (6, 10) void bevelChanged()
 Q_REVISION (6, 10) void topLeftBevelChanged()
 Q_REVISION (6, 10) void topRightBevelChanged()
 Q_REVISION (6, 10) void bottomLeftBevelChanged()
 Q_REVISION (6, 10) void bottomRightBevelChanged()
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 \nativetype 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
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
void setCornerRadius (Qt::Corner corner, qreal newCornerRadius)
void resetCornerRadius (Qt::Corner corner)
bool hasBevel () const
void setBevel (bool bevel)
bool hasTopLeftBevel () const
void setTopLeftBevel (bool bevel)
void resetTopLeftBevel ()
bool hasTopRightBevel () const
void setTopRightBevel (bool bevel)
void resetTopRightBevel ()
bool hasBottomLeftBevel () const
void setBottomLeftBevel (bool bevel)
void resetBottomLeftBevel ()
bool hasBottomRightBevel () const
void setBottomRightBevel (bool bevel)
void resetBottomRightBevel ()
bool cornerBevel (Qt::Corner corner) const
void setCornerBevel (Qt::Corner corner, bool newCornerBevel)
void resetCornerBevel (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< QStringbindableObjectName ()
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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
bool bevel
bool topLeftBevel
bool topRightBevel
bool bottomLeftBevel
bool bottomRightBevel
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
QObjectsender () 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< QObjectDatad_ptr

Detailed Description

Definition at line 409 of file qquickpath_p.h.

Constructor & Destructor Documentation

◆ QQuickPathRectangle()

QQuickPathRectangle::QQuickPathRectangle ( QObject * parent = nullptr)
inline

Definition at line 430 of file qquickpath_p.h.

Member Function Documentation

◆ addToPath()

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

Reimplemented from QQuickCurve.

Definition at line 2675 of file qquickpath.cpp.

◆ bottomLeftRadius()

qreal QQuickPathRectangle::bottomLeftRadius ( ) const
inline

Definition at line 452 of file qquickpath_p.h.

◆ bottomLeftRadiusChanged

void QQuickPathRectangle::bottomLeftRadiusChanged ( )
signal

◆ bottomRightRadius()

qreal QQuickPathRectangle::bottomRightRadius ( ) const
inline

Definition at line 456 of file qquickpath_p.h.

◆ bottomRightRadiusChanged

void QQuickPathRectangle::bottomRightRadiusChanged ( )
signal

◆ cornerBevel()

bool QQuickPathRectangle::cornerBevel ( Qt::Corner corner) const

{bevel-properties} {QtQuick::PathRectangle} {qml/pathrectangle/pathrectangle.qml} {shape}

Definition at line 2628 of file qquickpath.cpp.

◆ cornerRadius()

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

{radius-properties} {PathRectangle} {qml/pathrectangle/pathrectangle.qml} {shape}

Definition at line 2545 of file qquickpath.cpp.

◆ hasBevel()

bool QQuickPathRectangle::hasBevel ( ) const

{bevel-property} {QtQuick::PathRectangle}{qml/pathrectangle/pathrectangle-bevel.qml} {shape}

Since
6.10

Definition at line 2598 of file qquickpath.cpp.

◆ hasBottomLeftBevel()

bool QQuickPathRectangle::hasBottomLeftBevel ( ) const
inline

Definition at line 475 of file qquickpath_p.h.

◆ hasBottomRightBevel()

bool QQuickPathRectangle::hasBottomRightBevel ( ) const
inline

Definition at line 479 of file qquickpath_p.h.

◆ hasTopLeftBevel()

bool QQuickPathRectangle::hasTopLeftBevel ( ) const
inline

Definition at line 467 of file qquickpath_p.h.

◆ hasTopRightBevel()

bool QQuickPathRectangle::hasTopRightBevel ( ) const
inline

Definition at line 471 of file qquickpath_p.h.

◆ height()

qreal QQuickPathRectangle::height ( ) const

Definition at line 2457 of file qquickpath.cpp.

◆ heightChanged

void QQuickPathRectangle::heightChanged ( )
signal

◆ Q_REVISION [1/5]

QQuickPathRectangle::Q_REVISION ( 6 ,
10  )
signal

◆ Q_REVISION [2/5]

QQuickPathRectangle::Q_REVISION ( 6 ,
10  )
signal

◆ Q_REVISION [3/5]

QQuickPathRectangle::Q_REVISION ( 6 ,
10  )
signal

◆ Q_REVISION [4/5]

QQuickPathRectangle::Q_REVISION ( 6 ,
10  )
signal

◆ Q_REVISION [5/5]

QQuickPathRectangle::Q_REVISION ( 6 ,
10  )
signal

◆ radius()

qreal QQuickPathRectangle::radius ( ) const

{radius-property} {QtQuick::PathRectangle}

The default value is 0.

Definition at line 2519 of file qquickpath.cpp.

◆ radiusChanged

void QQuickPathRectangle::radiusChanged ( )
signal

◆ resetBottomLeftBevel()

void QQuickPathRectangle::resetBottomLeftBevel ( )
inline

Definition at line 477 of file qquickpath_p.h.

◆ resetBottomLeftRadius()

void QQuickPathRectangle::resetBottomLeftRadius ( )
inline

Definition at line 454 of file qquickpath_p.h.

◆ resetBottomRightBevel()

void QQuickPathRectangle::resetBottomRightBevel ( )
inline

Definition at line 481 of file qquickpath_p.h.

◆ resetBottomRightRadius()

void QQuickPathRectangle::resetBottomRightRadius ( )
inline

Definition at line 458 of file qquickpath_p.h.

◆ resetCornerBevel()

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

Definition at line 2648 of file qquickpath.cpp.

◆ resetCornerRadius()

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

Definition at line 2564 of file qquickpath.cpp.

◆ resetTopLeftBevel()

void QQuickPathRectangle::resetTopLeftBevel ( )
inline

Definition at line 469 of file qquickpath_p.h.

◆ resetTopLeftRadius()

void QQuickPathRectangle::resetTopLeftRadius ( )
inline

Definition at line 446 of file qquickpath_p.h.

◆ resetTopRightBevel()

void QQuickPathRectangle::resetTopRightBevel ( )
inline

Definition at line 473 of file qquickpath_p.h.

◆ resetTopRightRadius()

void QQuickPathRectangle::resetTopRightRadius ( )
inline

Definition at line 450 of file qquickpath_p.h.

◆ setBevel()

void QQuickPathRectangle::setBevel ( bool bevel)

Definition at line 2603 of file qquickpath.cpp.

◆ setBottomLeftBevel()

void QQuickPathRectangle::setBottomLeftBevel ( bool bevel)
inline

Definition at line 476 of file qquickpath_p.h.

◆ setBottomLeftRadius()

void QQuickPathRectangle::setBottomLeftRadius ( qreal radius)
inline

Definition at line 453 of file qquickpath_p.h.

◆ setBottomRightBevel()

void QQuickPathRectangle::setBottomRightBevel ( bool bevel)
inline

Definition at line 480 of file qquickpath_p.h.

◆ setBottomRightRadius()

void QQuickPathRectangle::setBottomRightRadius ( qreal radius)
inline

Definition at line 457 of file qquickpath_p.h.

◆ setCornerBevel()

void QQuickPathRectangle::setCornerBevel ( Qt::Corner corner,
bool newCornerBevel )

Definition at line 2636 of file qquickpath.cpp.

◆ setCornerRadius()

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

Definition at line 2553 of file qquickpath.cpp.

◆ setHeight()

void QQuickPathRectangle::setHeight ( qreal height)

Definition at line 2462 of file qquickpath.cpp.

◆ setRadius()

void QQuickPathRectangle::setRadius ( qreal newRadius)

Definition at line 2524 of file qquickpath.cpp.

◆ setStrokeAdjustment()

void QQuickPathRectangle::setStrokeAdjustment ( qreal newStrokeAdjustment)

Definition at line 2504 of file qquickpath.cpp.

◆ setTopLeftBevel()

void QQuickPathRectangle::setTopLeftBevel ( bool bevel)
inline

Definition at line 468 of file qquickpath_p.h.

◆ setTopLeftRadius()

void QQuickPathRectangle::setTopLeftRadius ( qreal radius)
inline

Definition at line 445 of file qquickpath_p.h.

◆ setTopRightBevel()

void QQuickPathRectangle::setTopRightBevel ( bool bevel)
inline

Definition at line 472 of file qquickpath_p.h.

◆ setTopRightRadius()

void QQuickPathRectangle::setTopRightRadius ( qreal radius)
inline

Definition at line 449 of file qquickpath_p.h.

◆ setWidth()

void QQuickPathRectangle::setWidth ( qreal width)

Definition at line 2447 of file qquickpath.cpp.

◆ 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 2499 of file qquickpath.cpp.

◆ strokeAdjustmentChanged

void QQuickPathRectangle::strokeAdjustmentChanged ( )
signal

◆ topLeftRadius()

qreal QQuickPathRectangle::topLeftRadius ( ) const
inline

Definition at line 444 of file qquickpath_p.h.

◆ topLeftRadiusChanged

void QQuickPathRectangle::topLeftRadiusChanged ( )
signal

◆ topRightRadius()

qreal QQuickPathRectangle::topRightRadius ( ) const
inline

Definition at line 448 of file qquickpath_p.h.

◆ topRightRadiusChanged

void QQuickPathRectangle::topRightRadiusChanged ( )
signal

◆ width()

qreal QQuickPathRectangle::width ( ) const

\qmltype PathRectangle \nativetype 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 or beveled corners. The API corresponds to that of the \l Rectangle item.

Shape {
id: rectangleShape
width: 200
height: 150
anchors.centerIn: parent
preferredRendererType: Shape.CurveRenderer
ShapePath {
fillColor: "#3ad23c"
PathRectangle {
width: rectangleShape.width
height: rectangleShape.height
topLeftRadius: 30
bottomRightRadius: 30
bevel: true
}
}
}
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 2442 of file qquickpath.cpp.

◆ widthChanged

void QQuickPathRectangle::widthChanged ( )
signal

Property Documentation

◆ bevel

bool QQuickPathRectangle::bevel
readwrite

Definition at line 421 of file qquickpath_p.h.

◆ bottomLeftBevel

bool QQuickPathRectangle::bottomLeftBevel
readwrite

Definition at line 424 of file qquickpath_p.h.

◆ bottomLeftRadius

qreal QQuickPathRectangle::bottomLeftRadius
readwrite

Definition at line 419 of file qquickpath_p.h.

◆ bottomRightBevel

bool QQuickPathRectangle::bottomRightBevel
readwrite

Definition at line 425 of file qquickpath_p.h.

◆ bottomRightRadius

qreal QQuickPathRectangle::bottomRightRadius
readwrite

Definition at line 420 of file qquickpath_p.h.

◆ height

qreal QQuickPathRectangle::height
readwrite

Definition at line 414 of file qquickpath_p.h.

◆ radius

qreal QQuickPathRectangle::radius
readwrite

Definition at line 416 of file qquickpath_p.h.

◆ strokeAdjustment

qreal QQuickPathRectangle::strokeAdjustment
readwrite

Definition at line 415 of file qquickpath_p.h.

◆ topLeftBevel

bool QQuickPathRectangle::topLeftBevel
readwrite

Definition at line 422 of file qquickpath_p.h.

◆ topLeftRadius

qreal QQuickPathRectangle::topLeftRadius
readwrite

Definition at line 417 of file qquickpath_p.h.

◆ topRightBevel

bool QQuickPathRectangle::topRightBevel
readwrite

Definition at line 423 of file qquickpath_p.h.

◆ topRightRadius

qreal QQuickPathRectangle::topRightRadius
readwrite

Definition at line 418 of file qquickpath_p.h.

◆ width

qreal QQuickPathRectangle::width
readwrite

Definition at line 413 of file qquickpath_p.h.


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