Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QQuickLayoutItemProxyAttachedData Class Reference

Provides attached properties for items that are managed by one or more LayoutItemProxy. More...

#include <qquicklayoutitemproxy_p.h>

+ Inheritance diagram for QQuickLayoutItemProxyAttachedData:
+ Collaboration diagram for QQuickLayoutItemProxyAttachedData:

Signals

void controlTaken ()
 
void controlReleased ()
 
void controllingProxyChanged ()
 
void proxiesChanged ()
 
- 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

 QQuickLayoutItemProxyAttachedData (QObject *parent)
 
 ~QQuickLayoutItemProxyAttachedData () override
 
void registerProxy (QQuickLayoutItemProxy *proxy)
 QQuickLayoutItemProxyAttachedData::registerProxy registers a proxy that manages the item this data is attached to.
 
void releaseProxy (QQuickLayoutItemProxy *proxy)
 QQuickLayoutItemProxyAttachedData::releaseProxy removes a proxy from a list of known proxies that manage the item this data is attached to.
 
bool takeControl (QQuickLayoutItemProxy *proxy)
 QQuickLayoutItemProxyAttachedData::takeControl is called by LayoutItemProxies when they try to take control over the item this data is attached to.
 
void releaseControl (QQuickLayoutItemProxy *proxy)
 QQuickLayoutItemProxyAttachedData::releaseControl is called by LayoutItemProxies when they try no longer control the item.
 
QQuickLayoutItemProxygetControllingProxy () const
 QQuickLayoutItemProxyAttachedData::getControllingProxy.
 
const QList< QQuickLayoutItemProxy * > & getProxies () const
 QQuickLayoutItemProxyAttachedData::getProxies.
 
bool proxyHasControl () const
 QQuickLayoutItemProxyAttachedData::proxyHasControl.
 
- 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.
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children.
 
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
template<typename T >
findChild (const QString &aName=QString(), 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 (const QString &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 >
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

QML_ANONYMOUSbool proxyHasControl
 
QQuickLayoutItemProxycontrollingProxy
 
QList< QQuickLayoutItemProxy * > proxies
 
- 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

Provides attached properties for items that are managed by one or more LayoutItemProxy.

It stores all proxies that target the item, and will emit signals when the proxies or the controlling proxy changes. Proxies can listen to the signal and pick up control if they wish to.

Definition at line 114 of file qquicklayoutitemproxy_p.h.

Constructor & Destructor Documentation

◆ QQuickLayoutItemProxyAttachedData()

QQuickLayoutItemProxyAttachedData::QQuickLayoutItemProxyAttachedData ( QObject parent)

Definition at line 406 of file qquicklayoutitemproxy.cpp.

◆ ~QQuickLayoutItemProxyAttachedData()

QQuickLayoutItemProxyAttachedData::~QQuickLayoutItemProxyAttachedData ( )
override

Definition at line 412 of file qquicklayoutitemproxy.cpp.

References proxies, and proxy.

Member Function Documentation

◆ controllingProxyChanged

void QQuickLayoutItemProxyAttachedData::controllingProxyChanged ( )
signal

Referenced by releaseControl(), and takeControl().

+ Here is the caller graph for this function:

◆ controlReleased

void QQuickLayoutItemProxyAttachedData::controlReleased ( )
signal

Referenced by releaseControl().

+ Here is the caller graph for this function:

◆ controlTaken

void QQuickLayoutItemProxyAttachedData::controlTaken ( )
signal

Referenced by takeControl().

+ Here is the caller graph for this function:

◆ getControllingProxy()

QQuickLayoutItemProxy * QQuickLayoutItemProxyAttachedData::getControllingProxy ( ) const

QQuickLayoutItemProxyAttachedData::getControllingProxy.

Returns
the proxy that currently controls the item this data is attached to. Returns null if no proxy controls the item.

Definition at line 507 of file qquicklayoutitemproxy.cpp.

References controllingProxy.

Referenced by QQuickLayoutItemProxy::~QQuickLayoutItemProxy(), QQuickLayoutItemProxy::effectiveTarget(), and QQuickLayoutItemProxy::maybeTakeControl().

+ Here is the caller graph for this function:

◆ getProxies()

const QList< QQuickLayoutItemProxy * > & QQuickLayoutItemProxyAttachedData::getProxies ( ) const

QQuickLayoutItemProxyAttachedData::getProxies.

Returns
a list of all proxies that target the item this data is attached to.

Definition at line 516 of file qquicklayoutitemproxy.cpp.

References proxies.

◆ proxiesChanged

void QQuickLayoutItemProxyAttachedData::proxiesChanged ( )
signal

Referenced by registerProxy(), and releaseProxy().

+ Here is the caller graph for this function:

◆ proxyHasControl()

bool QQuickLayoutItemProxyAttachedData::proxyHasControl ( ) const

QQuickLayoutItemProxyAttachedData::proxyHasControl.

Returns
true if a proxy is controlling the item, false otherwise.

Definition at line 525 of file qquicklayoutitemproxy.cpp.

References controllingProxy.

◆ registerProxy()

void QQuickLayoutItemProxyAttachedData::registerProxy ( QQuickLayoutItemProxy proxy)

QQuickLayoutItemProxyAttachedData::registerProxy registers a proxy that manages the item this data is attached to.

This is required to easily notify proxies when the target is destroyed or when it is free to take over control.

Definition at line 427 of file qquicklayoutitemproxy.cpp.

References emit, proxies, proxiesChanged(), and proxy.

Referenced by QQuickLayoutItemProxy::setTarget().

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

◆ releaseControl()

void QQuickLayoutItemProxyAttachedData::releaseControl ( QQuickLayoutItemProxy proxy)

QQuickLayoutItemProxyAttachedData::releaseControl is called by LayoutItemProxies when they try no longer control the item.

Parameters
proxyThe proxy that gives up control.

Definition at line 483 of file qquicklayoutitemproxy.cpp.

References controllingProxy, controllingProxyChanged(), controlReleased(), emit, QObject::parent(), proxies, proxy, and qCDebug.

Referenced by QQuickLayoutItemProxy::~QQuickLayoutItemProxy(), QQuickLayoutItemProxy::maybeTakeControl(), and releaseProxy().

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

◆ releaseProxy()

void QQuickLayoutItemProxyAttachedData::releaseProxy ( QQuickLayoutItemProxy proxy)

QQuickLayoutItemProxyAttachedData::releaseProxy removes a proxy from a list of known proxies that manage the item this data is attached to.

Definition at line 440 of file qquicklayoutitemproxy.cpp.

References controllingProxy, QObject::deleteLater(), emit, proxies, proxiesChanged(), proxy, and releaseControl().

Referenced by QQuickLayoutItemProxy::~QQuickLayoutItemProxy().

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

◆ takeControl()

bool QQuickLayoutItemProxyAttachedData::takeControl ( QQuickLayoutItemProxy proxy)

QQuickLayoutItemProxyAttachedData::takeControl is called by LayoutItemProxies when they try to take control over the item this data is attached to.

Returns
true if no other proxy controls the item and if control is granted to the proxy, false otherwise.
Parameters
proxyThe proxy that tries to take control.

Definition at line 462 of file qquicklayoutitemproxy.cpp.

References controllingProxy, controllingProxyChanged(), controlTaken(), emit, QObject::parent(), proxies, proxy, and qCDebug.

Referenced by QQuickLayoutItemProxy::maybeTakeControl().

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

Property Documentation

◆ controllingProxy

QQuickLayoutItemProxy * QQuickLayoutItemProxyAttachedData::controllingProxy
read

◆ proxies

QList< QQuickLayoutItemProxy * > QQuickLayoutItemProxyAttachedData::proxies
read

◆ proxyHasControl

QML_ANONYMOUSbool QQuickLayoutItemProxyAttachedData::proxyHasControl
read

Definition at line 118 of file qquicklayoutitemproxy_p.h.

Referenced by QQuickLayoutItemProxy::setTarget().


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