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

#include <qqmlcompositefilterbase_p.h>

Inheritance diagram for QQmlCompositeFilterBase:
Collaboration diagram for QQmlCompositeFilterBase:

Public Member Functions

 QQmlCompositeFilterBase (QObject *parent)
 \qmltype CompositeFilter
void update (const QQmlSortFilterProxyModel *model) override
bool isActive () const override
int column () const override
 \qmlproperty int Filter::column
void setColumn (int column) override
bool supportColumnFiltering () const override
Public Member Functions inherited from QQmlFilterCompositor
 QQmlFilterCompositor (QObject *parent)
QList< QQmlFilterBase * > filters ()
QQmlListProperty< QQmlFilterBasefiltersListProperty ()
bool filterAcceptsRowInternal (int, const QModelIndex &, const QQmlSortFilterProxyModel *) const override
bool filterAcceptsColumnInternal (int, const QModelIndex &, const QQmlSortFilterProxyModel *) const override
void updateFilters ()
Public Member Functions inherited from QQmlFilterBase
bool enabled () const
 \qmlproperty bool Filter::enabled
void setEnabled (bool bEnable)
bool isInverted () const
 \qmlproperty bool Filter::inverted
void setInverted (bool bInvert)
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 isQmlExposed () const noexcept
 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.

Protected Member Functions

 QQmlCompositeFilterBase (QQmlFilterCompositorPrivate *priv, QObject *parent)
void refreshCache () override
Protected Member Functions inherited from QQmlFilterCompositor
 QQmlFilterCompositor (QQmlFilterBasePrivate *priv, QObject *parent)
Protected Member Functions inherited from QQmlFilterBase
 QQmlFilterBase (QQmlFilterBasePrivate *privObj, QObject *parent)
 \qmltype Filter \inherits QtObject \inqmlmodule QtQml.Models
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)

Properties

QQmlListProperty< QQmlFilterBasefilters
Properties inherited from QQmlFilterBase
bool enabled
bool inverted
int column
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Slots inherited from QQmlFilterBase
void invalidate (bool updateCache=false)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QQmlFilterBase
void invalidateModel ()
void invalidateCache (QQmlFilterBase *filter)
void enabledChanged ()
void invertedChanged ()
void columnChanged ()
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.
Static Public Member Functions inherited from QQmlFilterCompositor
static void append (QQmlListProperty< QQmlFilterBase > *filterComp, QQmlFilterBase *filter)
static qsizetype count (QQmlListProperty< QQmlFilterBase > *filterComp)
static QQmlFilterBaseat (QQmlListProperty< QQmlFilterBase > *filterComp, qsizetype index)
static void clear (QQmlListProperty< QQmlFilterBase > *filterComp)
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 &)
 Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool disconnect (QMetaObject::Connection &)
static bool disconnect (QMetaObject::Connection &&conn)
 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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 28 of file qqmlcompositefilterbase_p.h.

Constructor & Destructor Documentation

◆ QQmlCompositeFilterBase() [1/2]

QT_BEGIN_NAMESPACE QQmlCompositeFilterBase::QQmlCompositeFilterBase ( QObject * parent)
explicit

\qmltype CompositeFilter

\inherits FilterBase \inqmlmodule QtQml.Models

Since
6.12 \preliminary

Abstract base type providing functionality common to composite filters.

CompositeFilter provides a set of common properties that all composite filter types inherit, such as \l AllOfFilter and \l AnyOfFilter.

Definition at line 23 of file qqmlcompositefilterbase.cpp.

◆ QQmlCompositeFilterBase() [2/2]

QQmlCompositeFilterBase::QQmlCompositeFilterBase ( QQmlFilterCompositorPrivate * priv,
QObject * parent )
protected

Definition at line 28 of file qqmlcompositefilterbase.cpp.

Member Function Documentation

◆ column()

int QQmlCompositeFilterBase::column ( ) const
inlineoverridevirtual

\qmlproperty int Filter::column

This property specifies which column in the model the filter should be applied on. If the value is -1, the filter will be applied to all the columns in the model.

The default value is -1.

Reimplemented from QQmlFilterBase.

Definition at line 42 of file qqmlcompositefilterbase_p.h.

◆ isActive()

bool QQmlCompositeFilterBase::isActive ( ) const
overridevirtual

Reimplemented from QQmlFilterBase.

Definition at line 62 of file qqmlcompositefilterbase.cpp.

◆ refreshCache()

void QQmlCompositeFilterBase::refreshCache ( )
overrideprotectedvirtual

Reimplemented from QQmlFilterCompositor.

Definition at line 68 of file qqmlcompositefilterbase.cpp.

◆ setColumn()

void QQmlCompositeFilterBase::setColumn ( int column)
inlineoverridevirtual

Reimplemented from QQmlFilterBase.

Definition at line 46 of file qqmlcompositefilterbase_p.h.

◆ supportColumnFiltering()

bool QQmlCompositeFilterBase::supportColumnFiltering ( ) const
overridevirtual

Reimplemented from QQmlFilterBase.

Definition at line 77 of file qqmlcompositefilterbase.cpp.

◆ update()

void QQmlCompositeFilterBase::update ( const QQmlSortFilterProxyModel * model)
overridevirtual

Reimplemented from QQmlFilterBase.

Definition at line 34 of file qqmlcompositefilterbase.cpp.

Property Documentation

◆ filters

QQmlListProperty<QQmlFilterBase> QQmlCompositeFilterBase::filters
read

Definition at line 32 of file qqmlcompositefilterbase_p.h.


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