Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickPathMultiline Class Reference

#include <qquickpath_p.h>

+ Inheritance diagram for QQuickPathMultiline:
+ Collaboration diagram for QQuickPathMultiline:

Signals

void pathsChanged ()
 
void startChanged ()
 
- 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

 QQuickPathMultiline (QObject *parent=nullptr)
 \qmltype PathMultiline \instantiates QQuickPathMultiline \inqmlmodule QtQuick
 
QVariant paths () const
 
void setPaths (const QVariant &paths)
 
void setPaths (const QVector< QVector< QPointF > > &paths)
 
QPointF start () const
 
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 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

QPointF start
 
QVariant paths
 
- 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 443 of file qquickpath_p.h.

Constructor & Destructor Documentation

◆ QQuickPathMultiline()

QQuickPathMultiline::QQuickPathMultiline ( QObject * parent = nullptr)

\qmltype PathMultiline \instantiates QQuickPathMultiline \inqmlmodule QtQuick

Defines a set of polylines through a list of lists of coordinates.

Since
QtQuick 2.14

This element allows to define a list of polylines at once. Each polyline in the list will be preceded by a \l{QPainterPath::moveTo}{moveTo} command, effectively making each polyline a separate one. The polylines in this list are supposed to be non-intersecting with each other. In any case, when used in conjunction with a \l ShapePath, the containing ShapePath's \l ShapePath::fillRule applies. That is, with the default OddEvenFill and non intersecting shapes, the largest shape in the list defines an area to be filled; areas where two shapes overlap are holes; areas where three shapes overlap are filled areas inside holes, etc.

The example below creates a high voltage symbol by adding each path of the symbol to the list of paths. The coordinates of the vertices are normalized, and through the containing shape's \l {QtQuick::Path::}{scale} property, the path will be rescaled together with its containing shape.

\qml PathMultiline { paths: [ [Qt.point(0.5, 0.06698), Qt.point(1, 0.93301), Qt.point(0, 0.93301), Qt.point(0.5, 0.06698)],

[Qt.point(0.5, 0.12472), Qt.point(0.95, 0.90414), Qt.point(0.05, 0.90414), Qt.point(0.5, 0.12472)],

[Qt.point(0.47131, 0.32986), Qt.point(0.36229, 0.64789), Qt.point(0.51492, 0.58590), Qt.point(0.47563, 0.76014), Qt.point(0.44950, 0.73590), Qt.point(0.46292, 0.83392), Qt.point(0.52162, 0.75190), Qt.point(0.48531, 0.76230), Qt.point(0.57529, 0.53189), Qt.point(0.41261, 0.59189), Qt.point(0.53001, 0.32786), Qt.point(0.47131, 0.32986)] ] } \endqml

See also
Path, QPainterPath::setFillRule, PathPolyline, PathQuad, PathCubic, PathArc, PathAngleArc, PathCurve, PathSvg, PathMove

\qmlproperty point QtQuick::PathMultiline::start

This read-only property contains the beginning of the polylines.

\qmlproperty list<list<point>> QtQuick::PathMultiline::paths

This property defines the vertices of the polylines.

It can be a JS array of JS arrays of points constructed with Qt.point(), a QList or QVector of QPolygonF, or QVector<QVector<QPointF>>. If you are binding this to a custom property in some C++ object, QVector<QPolygonF> or QVector<QVector<QPointF>> is the most appropriate type to use.

Definition at line 2529 of file qquickpath.cpp.

Member Function Documentation

◆ addToPath()

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

Reimplemented from QQuickCurve.

Definition at line 2597 of file qquickpath.cpp.

References i.

◆ paths()

QVariant QQuickPathMultiline::paths ( ) const

Definition at line 2533 of file qquickpath.cpp.

References QVariant::fromValue().

+ Here is the call graph for this function:

◆ pathsChanged

void QQuickPathMultiline::pathsChanged ( )
signal

Referenced by setPaths().

+ Here is the caller graph for this function:

◆ setPaths() [1/2]

void QQuickPathMultiline::setPaths ( const QVariant & paths)

Definition at line 2538 of file qquickpath.cpp.

References QList< T >::append(), qWarning, setPaths(), and QList< T >::value().

Referenced by setPaths().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setPaths() [2/2]

void QQuickPathMultiline::setPaths ( const QVector< QVector< QPointF > > & paths)

Definition at line 2577 of file qquickpath.cpp.

References QQuickPathElement::changed(), emit, paths, pathsChanged(), start, and startChanged().

+ Here is the call graph for this function:

◆ start()

QPointF QQuickPathMultiline::start ( ) const

Definition at line 2590 of file qquickpath.cpp.

◆ startChanged

void QQuickPathMultiline::startChanged ( )
signal

Referenced by setPaths().

+ Here is the caller graph for this function:

Property Documentation

◆ paths

QVariant QQuickPathMultiline::paths
readwrite

Definition at line 447 of file qquickpath_p.h.

Referenced by setPaths().

◆ start

QPointF QQuickPathMultiline::start
read

Definition at line 446 of file qquickpath_p.h.

Referenced by setPaths().


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