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

#include <qquicklistview_p.h>

+ Inheritance diagram for QQuickViewSection:
+ Collaboration diagram for QQuickViewSection:

Public Types

enum  SectionCriteria { FullString , FirstCharacter }
 
enum  LabelPositioning { InlineLabels = 0x01 , CurrentLabelAtStart = 0x02 , NextLabelAtEnd = 0x04 }
 

Signals

void sectionsChanged ()
 
void propertyChanged ()
 
void criteriaChanged ()
 
void delegateChanged ()
 
void labelPositioningChanged ()
 
- 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

 QQuickViewSection (QQuickListView *parent=nullptr)
 
QString property () const
 
void setProperty (const QString &)
 
SectionCriteria criteria () const
 
void setCriteria (SectionCriteria)
 
QQmlComponentdelegate () const
 
void setDelegate (QQmlComponent *delegate)
 
QString sectionString (const QString &value)
 
int labelPositioning () const
 
void setLabelPositioning (int pos)
 
- 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

QString property
 
SectionCriteria criteria
 
QQmlComponentdelegate
 
int labelPositioning
 
- 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 32 of file qquicklistview_p.h.

Member Enumeration Documentation

◆ LabelPositioning

Enumerator
InlineLabels 
CurrentLabelAtStart 
NextLabelAtEnd 

Definition at line 57 of file qquicklistview_p.h.

◆ SectionCriteria

Enumerator
FullString 
FirstCharacter 

Definition at line 47 of file qquicklistview_p.h.

Constructor & Destructor Documentation

◆ QQuickViewSection()

QQuickViewSection::QQuickViewSection ( QQuickListView * parent = nullptr)

Definition at line 181 of file qquicklistview.cpp.

Member Function Documentation

◆ criteria()

SectionCriteria QQuickViewSection::criteria ( ) const
inline

Definition at line 49 of file qquicklistview_p.h.

◆ criteriaChanged

void QQuickViewSection::criteriaChanged ( )
signal

Referenced by setCriteria().

+ Here is the caller graph for this function:

◆ delegate()

QQmlComponent * QQuickViewSection::delegate ( ) const
inline

Definition at line 52 of file qquicklistview_p.h.

References m_delegate.

◆ delegateChanged

void QQuickViewSection::delegateChanged ( )
signal

Referenced by setDelegate().

+ Here is the caller graph for this function:

◆ labelPositioning()

int QQuickViewSection::labelPositioning ( ) const
inline

Definition at line 59 of file qquicklistview_p.h.

◆ labelPositioningChanged

void QQuickViewSection::labelPositioningChanged ( )
signal

Referenced by setLabelPositioning().

+ Here is the caller graph for this function:

◆ property()

QString QQuickViewSection::property ( ) const
inline

Definition at line 44 of file qquicklistview_p.h.

◆ propertyChanged

void QQuickViewSection::propertyChanged ( )
signal

Referenced by setProperty().

+ Here is the caller graph for this function:

◆ sectionsChanged

void QQuickViewSection::sectionsChanged ( )
signal

◆ sectionString()

QString QQuickViewSection::sectionString ( const QString & value)

Definition at line 218 of file qquicklistview.cpp.

References FirstCharacter, and QString::isEmpty().

Referenced by QQuickListViewPrivate::newViewItem(), QQuickListViewPrivate::sectionAt(), and QQuickListViewPrivate::updateSections().

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

◆ setCriteria()

void QQuickViewSection::setCriteria ( QQuickViewSection::SectionCriteria criteria)

Definition at line 197 of file qquicklistview.cpp.

References criteria, criteriaChanged(), emit, and QQuickListViewPrivate::updateSectionCriteria().

+ Here is the call graph for this function:

◆ setDelegate()

void QQuickViewSection::setDelegate ( QQmlComponent * delegate)

Definition at line 207 of file qquicklistview.cpp.

References delegate, delegateChanged(), emit, QQuickItemViewPrivate::forceLayoutPolish(), and QQuickListViewPrivate::releaseSectionItems().

+ Here is the call graph for this function:

◆ setLabelPositioning()

void QQuickViewSection::setLabelPositioning ( int pos)

Definition at line 226 of file qquicklistview.cpp.

References emit, QQuickItemViewPrivate::forceLayoutPolish(), and labelPositioningChanged().

+ Here is the call graph for this function:

◆ setProperty()

void QQuickViewSection::setProperty ( const QString & property)

Definition at line 187 of file qquicklistview.cpp.

References emit, property, propertyChanged(), and QQuickListViewPrivate::updateSectionCriteria().

+ Here is the call graph for this function:

Property Documentation

◆ criteria

SectionCriteria QQuickViewSection::criteria
readwrite

Definition at line 36 of file qquicklistview_p.h.

Referenced by setCriteria().

◆ delegate

◆ labelPositioning

int QQuickViewSection::labelPositioning
readwrite

◆ property


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