#include <qquickpositioners_p.h>

Inheritance diagram for QQuickPositionerAttached:

Collaboration diagram for QQuickPositionerAttached:

Signals
void	indexChanged ()

void	isFirstItemChanged ()

void	isLastItemChanged ()

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
	QQuickPositionerAttached (QObject *parent)
	\qmltype Positioner \instantiates QQuickPositionerAttached \inqmlmodule QtQuick

int	index () const

void	setIndex (int index)
	\qmlattachedproperty int QtQuick::Positioner::index

bool	isFirstItem () const

void	setIsFirstItem (bool isFirstItem)
	\qmlattachedproperty bool QtQuick::Positioner::isFirstItem \qmlattachedproperty bool QtQuick::Positioner::isLastItem

bool	isLastItem () const

void	setIsLastItem (bool isLastItem)

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
int	index

bool	isFirstItem

bool	isLastItem

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 36 of file qquickpositioners_p.h.

Constructor & Destructor Documentation

◆ QQuickPositionerAttached()

QQuickPositionerAttached::QQuickPositionerAttached ( QObject * parent )

\qmltype Positioner \instantiates QQuickPositionerAttached \inqmlmodule QtQuick

Provides attached properties that contain details on where an item exists in a positioner.

An object of type Positioner is attached to the top-level child item within a Column, Row, Flow or Grid. It provides properties that allow a child item to determine where it exists within the layout of its parent Column, Row, Flow or Grid.

For example, below is a \l Grid with 16 child rectangles, as created through a \l Repeater. Each \l Rectangle displays its index in the Grid using \l {Positioner::index}{Positioner.index}, and the first item is colored differently by taking \l {Positioner::isFirstItem}{Positioner.isFirstItem} into account:

Grid {
    Repeater {
        model: 16
 
        Rectangle {
            id: rect
            width: 30; height: 30
            border.width: 1
            color: Positioner.isFirstItem ? "yellow" : "lightsteelblue"
 
            Text { text: rect.Positioner.index }
        }
    }
}

Definition at line 742 of file qquickpositioners.cpp.

References QObject::parent(), QQuickItem::parent, qobject_cast< QQuickItem * >(), and QQuickBasePositioner::updateAttachedProperties().

Here is the call graph for this function:

Member Function Documentation

◆ index()

int QQuickPositionerAttached::index ( ) const

inline

Definition at line 47 of file qquickpositioners_p.h.

◆ indexChanged

void QQuickPositionerAttached::indexChanged ( )

signal

Referenced by setIndex().

Here is the caller graph for this function:

◆ isFirstItem()

bool QQuickPositionerAttached::isFirstItem ( ) const

inline

Definition at line 50 of file qquickpositioners_p.h.

◆ isFirstItemChanged

void QQuickPositionerAttached::isFirstItemChanged ( )

signal

Referenced by setIsFirstItem().

Here is the caller graph for this function:

◆ isLastItem()

bool QQuickPositionerAttached::isLastItem ( ) const

inline

Definition at line 53 of file qquickpositioners_p.h.

◆ isLastItemChanged

void QQuickPositionerAttached::isLastItemChanged ( )

signal

Referenced by setIsLastItem().

Here is the caller graph for this function:

◆ setIndex()

void QQuickPositionerAttached::setIndex ( int index )

\qmlattachedproperty int QtQuick::Positioner::index

This property allows the item to determine its index within the positioner.

Definition at line 759 of file qquickpositioners.cpp.

References emit, index, and indexChanged().

Referenced by QQuickBasePositioner::updateAttachedProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIsFirstItem()

void QQuickPositionerAttached::setIsFirstItem ( bool isFirstItem )

\qmlattachedproperty bool QtQuick::Positioner::isFirstItem \qmlattachedproperty bool QtQuick::Positioner::isLastItem

These properties allow the item to determine if it is the first or last item in the positioner, respectively.

Definition at line 774 of file qquickpositioners.cpp.

References emit, isFirstItem, and isFirstItemChanged().

Here is the call graph for this function:

◆ setIsLastItem()

void QQuickPositionerAttached::setIsLastItem ( bool isLastItem )

Definition at line 782 of file qquickpositioners.cpp.

References emit, isLastItem, and isLastItemChanged().

Here is the call graph for this function:

Property Documentation

◆ index

int QQuickPositionerAttached::index

read

Definition at line 43 of file qquickpositioners_p.h.

Referenced by setIndex().

◆ isFirstItem

bool QQuickPositionerAttached::isFirstItem

read

Definition at line 44 of file qquickpositioners_p.h.

Referenced by setIsFirstItem().

◆ isLastItem

bool QQuickPositionerAttached::isLastItem

read

Definition at line 45 of file qquickpositioners_p.h.

Referenced by setIsLastItem().

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

qtdeclarative/src/quick/items/qquickpositioners_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/items/qquickpositioners.cpp (5a85b92dd3f5bc0b7f0a753986d23a944fe2ab24)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickPositionerAttached()

Member Function Documentation

◆ index()

◆ indexChanged

◆ isFirstItem()

◆ isFirstItemChanged

◆ isLastItem()

◆ isLastItemChanged

◆ setIndex()

◆ setIsFirstItem()

◆ setIsLastItem()

Property Documentation

◆ index

◆ isFirstItem

◆ isLastItem