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

#include <qqmldelegatecomponent_p.h>

+ Inheritance diagram for QQmlDelegateChoice:
+ Collaboration diagram for QQmlDelegateChoice:

Signals

void roleValueChanged ()
 
void rowChanged ()
 
void indexChanged ()
 
void columnChanged ()
 
void delegateChanged ()
 
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

QVariant roleValue () const
 Encapsulates a delegate and when to use it.
 
void setRoleValue (const QVariant &roleValue)
 
int row () const
 \qmlproperty int Qt.labs.qmlmodels::DelegateChoice::row This property holds the value used to match the row value of model elements.
 
void setRow (int r)
 
int column () const
 \qmlproperty int Qt.labs.qmlmodels::DelegateChoice::column This property holds the value used to match the column value of model elements.
 
void setColumn (int c)
 
QQmlComponentdelegate () const
 
void setDelegate (QQmlComponent *delegate)
 \qmlproperty Component Qt.labs.qmlmodels::DelegateChoice::delegate This property holds the delegate to use if this choice matches the model item.
 
virtual bool match (int row, int column, const QVariant &value) const
 
- 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

QVariant roleValue
 
int row
 
int index
 
int column
 
QQmlComponentdelegate
 
- 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 28 of file qqmldelegatecomponent_p.h.

Member Function Documentation

◆ changed

void QQmlDelegateChoice::changed ( )
signal

Referenced by QQmlDelegateChooser::choices_append(), QQmlDelegateChooser::choices_clear(), QQmlDelegateChooser::choices_removeLast(), QQmlDelegateChooser::choices_replace(), setColumn(), setDelegate(), setRoleValue(), and setRow().

+ Here is the caller graph for this function:

◆ column()

int QQmlDelegateChoice::column ( ) const

\qmlproperty int Qt.labs.qmlmodels::DelegateChoice::column This property holds the value used to match the column value of model elements.

Definition at line 79 of file qqmldelegatecomponent.cpp.

◆ columnChanged

void QQmlDelegateChoice::columnChanged ( )
signal

Referenced by setColumn().

+ Here is the caller graph for this function:

◆ delegate()

QQmlComponent * QQmlDelegateChoice::delegate ( ) const

Definition at line 93 of file qqmldelegatecomponent.cpp.

◆ delegateChanged

void QQmlDelegateChoice::delegateChanged ( )
signal

Referenced by setDelegate().

+ Here is the caller graph for this function:

◆ indexChanged

void QQmlDelegateChoice::indexChanged ( )
signal

Referenced by setRow().

+ Here is the caller graph for this function:

◆ match()

bool QQmlDelegateChoice::match ( int row,
int column,
const QVariant & value ) const
virtual

Definition at line 117 of file qqmldelegatecomponent.cpp.

References column, QVariant::isValid(), row, QVariant::toInt(), and QVariant::toString().

+ Here is the call graph for this function:

◆ roleValue()

QT_BEGIN_NAMESPACE QVariant QQmlDelegateChoice::roleValue ( ) const

Encapsulates a delegate and when to use it.

\qmltype DelegateChoice

! \instantiates QQmlDelegateChoice \inqmlmodule Qt.labs.qmlmodels

The DelegateChoice type wraps a delegate and defines the circumstances in which it should be chosen.

DelegateChoices can be nested inside a DelegateChooser.

See also
DelegateChooser

\qmlproperty variant Qt.labs.qmlmodels::DelegateChoice::roleValue This property holds the value used to match the role data for the role provided by \l DelegateChooser::role.

Definition at line 27 of file qqmldelegatecomponent.cpp.

◆ roleValueChanged

void QQmlDelegateChoice::roleValueChanged ( )
signal

Referenced by setRoleValue().

+ Here is the caller graph for this function:

◆ row()

int QQmlDelegateChoice::row ( ) const

\qmlproperty int Qt.labs.qmlmodels::DelegateChoice::row This property holds the value used to match the row value of model elements.

With models that have only the index property (and thus only one column), this property should be intended as an index, and set to the desired index value.

Note
Setting both row and index has undefined behavior. The two are equivalent and only one should be used.
See also
index

\qmlproperty int Qt.labs.qmlmodels::DelegateChoice::index This property holds the value used to match the index value of model elements. This is effectively an alias for \l row.

See also
row

Definition at line 60 of file qqmldelegatecomponent.cpp.

◆ rowChanged

void QQmlDelegateChoice::rowChanged ( )
signal

Referenced by setRow().

+ Here is the caller graph for this function:

◆ setColumn()

void QQmlDelegateChoice::setColumn ( int c)

Definition at line 84 of file qqmldelegatecomponent.cpp.

References changed(), columnChanged(), and emit.

+ Here is the call graph for this function:

◆ setDelegate()

void QQmlDelegateChoice::setDelegate ( QQmlComponent * delegate)

\qmlproperty Component Qt.labs.qmlmodels::DelegateChoice::delegate This property holds the delegate to use if this choice matches the model item.

Definition at line 102 of file qqmldelegatecomponent.cpp.

References changed(), QObject::connect(), delegate, delegateChanged(), QQmlAbstractDelegateComponent::delegateChanged(), disconnect(), and emit.

+ Here is the call graph for this function:

◆ setRoleValue()

void QQmlDelegateChoice::setRoleValue ( const QVariant & roleValue)

Definition at line 32 of file qqmldelegatecomponent.cpp.

References changed(), emit, and roleValueChanged().

+ Here is the call graph for this function:

◆ setRow()

void QQmlDelegateChoice::setRow ( int r)

Definition at line 65 of file qqmldelegatecomponent.cpp.

References changed(), emit, indexChanged(), and rowChanged().

+ Here is the call graph for this function:

Property Documentation

◆ column

int QQmlDelegateChoice::column
readwrite

Definition at line 34 of file qqmldelegatecomponent_p.h.

Referenced by match().

◆ delegate

QQmlComponent* QQmlDelegateChoice::delegate
readwrite

Definition at line 35 of file qqmldelegatecomponent_p.h.

Referenced by QQmlDelegateChooser::delegate(), and setDelegate().

◆ index

int QQmlDelegateChoice::index
readwrite

Definition at line 33 of file qqmldelegatecomponent_p.h.

◆ roleValue

QVariant QQmlDelegateChoice::roleValue
readwrite

Definition at line 31 of file qqmldelegatecomponent_p.h.

◆ row

int QQmlDelegateChoice::row
readwrite

Definition at line 32 of file qqmldelegatecomponent_p.h.

Referenced by match().


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