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
QQmlSorterBase Class Referenceabstract

#include <qqmlsorterbase_p.h>

Inheritance diagram for QQmlSorterBase:
Collaboration diagram for QQmlSorterBase:

Public Slots

void invalidate (bool updateCache=true)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void enabledChanged ()
void sortOrderChanged ()
void priorityChanged ()
void columnChanged ()
void invalidateModel ()
void invalidateCache (QQmlSorterBase *filter)
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

 QQmlSorterBase (QQmlSorterBasePrivate *privObj, QObject *parent=nullptr)
 \qmltype Sorter \inherits QtObject \inqmlmodule QtQml.Models
virtual ~QQmlSorterBase ()=default
bool enabled () const
 \qmlproperty bool Sorter::enabled
void setEnabled (const bool enabled)
Qt::SortOrder sortOrder () const
 \qmlproperty Qt::SortOrder Sorter::sortOrder
void setSortOrder (const Qt::SortOrder sortOrder)
int priority () const
 \qmlproperty int Sorter::priority
void setPriority (const int priority)
int column () const
 \qmlproperty int Sorter::column
void setColumn (const int column)
virtual QPartialOrdering compare (const QModelIndex &, const QModelIndex &, const QQmlSortFilterProxyModel *) const =0
virtual void update (const QQmlSortFilterProxyModel *)
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

bool enabled
Qt::SortOrder sortOrder
int priority
int column
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

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 29 of file qqmlsorterbase_p.h.

Constructor & Destructor Documentation

◆ QQmlSorterBase()

QT_BEGIN_NAMESPACE QQmlSorterBase::QQmlSorterBase ( QQmlSorterBasePrivate * privObj,
QObject * parent = nullptr )
explicit

\qmltype Sorter \inherits QtObject \inqmlmodule QtQml.Models

Since
6.10 \preliminary

Abstract base type providing functionality common to sorters.

Sorter provides a set of common properties for all the sorters that they inherit from.

Definition at line 21 of file qqmlsorterbase.cpp.

◆ ~QQmlSorterBase()

virtual QQmlSorterBase::~QQmlSorterBase ( )
virtualdefault

Member Function Documentation

◆ column()

int QQmlSorterBase::column ( ) const

\qmlproperty int Sorter::column

This property holds the column that this sorter is applied to.

The default value is 0.

Definition at line 107 of file qqmlsorterbase.cpp.

◆ columnChanged

void QQmlSorterBase::columnChanged ( )
signal

◆ compare()

virtual QPartialOrdering QQmlSorterBase::compare ( const QModelIndex & ,
const QModelIndex & ,
const QQmlSortFilterProxyModel *  ) const
pure virtual

◆ enabled()

bool QQmlSorterBase::enabled ( ) const

\qmlproperty bool Sorter::enabled

This property enables the \l SortFilterProxyModel to consider this sorter while sorting the model data.

The default value is true.

Definition at line 34 of file qqmlsorterbase.cpp.

◆ enabledChanged

void QQmlSorterBase::enabledChanged ( )
signal

◆ invalidate

void QQmlSorterBase::invalidate ( bool updateCache = true)
slot

Definition at line 126 of file qqmlsorterbase.cpp.

◆ invalidateCache

void QQmlSorterBase::invalidateCache ( QQmlSorterBase * filter)
signal

◆ invalidateModel

void QQmlSorterBase::invalidateModel ( )
signal

◆ priority()

int QQmlSorterBase::priority ( ) const

\qmlproperty int Sorter::priority

This property holds the priority that is given to this sorter compared to other sorters. The lesser value results in a higher priority and the higher value results in a lower priority.

The default value is -1.

Definition at line 84 of file qqmlsorterbase.cpp.

◆ priorityChanged

void QQmlSorterBase::priorityChanged ( )
signal

◆ setColumn()

void QQmlSorterBase::setColumn ( const int column)

Definition at line 113 of file qqmlsorterbase.cpp.

◆ setEnabled()

void QQmlSorterBase::setEnabled ( const bool enabled)

Definition at line 41 of file qqmlsorterbase.cpp.

◆ setPriority()

void QQmlSorterBase::setPriority ( const int priority)

Definition at line 90 of file qqmlsorterbase.cpp.

◆ setSortOrder()

void QQmlSorterBase::setSortOrder ( const Qt::SortOrder sortOrder)

Definition at line 65 of file qqmlsorterbase.cpp.

◆ sortOrder()

Qt::SortOrder QQmlSorterBase::sortOrder ( ) const

\qmlproperty Qt::SortOrder Sorter::sortOrder

This property holds the order used by \l SortFilterProxyModel when sorting the model data.

The default value is Qt::AscendingOrder.

Definition at line 59 of file qqmlsorterbase.cpp.

◆ sortOrderChanged

void QQmlSorterBase::sortOrderChanged ( )
signal

◆ update()

virtual void QQmlSorterBase::update ( const QQmlSortFilterProxyModel * )
inlinevirtual

Definition at line 57 of file qqmlsorterbase_p.h.

Property Documentation

◆ column

int QQmlSorterBase::column
readwrite

◆ enabled

bool QQmlSorterBase::enabled
readwrite

Definition at line 32 of file qqmlsorterbase_p.h.

◆ priority

int QQmlSorterBase::priority
readwrite

Definition at line 34 of file qqmlsorterbase_p.h.

◆ sortOrder

Qt::SortOrder QQmlSorterBase::sortOrder
readwrite

Definition at line 33 of file qqmlsorterbase_p.h.


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