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

#include <qquicksplitview_p.h>

+ Inheritance diagram for QQuickSplitViewAttached:
+ Collaboration diagram for QQuickSplitViewAttached:

Signals

void viewChanged ()
 
void minimumWidthChanged ()
 
void minimumHeightChanged ()
 
void preferredWidthChanged ()
 
void preferredHeightChanged ()
 
void maximumWidthChanged ()
 
void maximumHeightChanged ()
 
void fillWidthChanged ()
 
void fillHeightChanged ()
 
- 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

 QQuickSplitViewAttached (QObject *parent=nullptr)
 
QQuickSplitViewview () const
 \qmlattachedproperty SplitView QtQuick.Controls::SplitView::view
 
qreal minimumWidth () const
 \qmlattachedproperty real QtQuick.Controls::SplitView::minimumWidth
 
void setMinimumWidth (qreal width)
 
void resetMinimumWidth ()
 
qreal minimumHeight () const
 \qmlattachedproperty real QtQuick.Controls::SplitView::minimumHeight
 
void setMinimumHeight (qreal height)
 
void resetMinimumHeight ()
 
qreal preferredWidth () const
 \qmlattachedproperty real QtQuick.Controls::SplitView::preferredWidth
 
void setPreferredWidth (qreal width)
 
void resetPreferredWidth ()
 
qreal preferredHeight () const
 \qmlattachedproperty real QtQuick.Controls::SplitView::preferredHeight
 
void setPreferredHeight (qreal height)
 
void resetPreferredHeight ()
 
qreal maximumWidth () const
 \qmlattachedproperty real QtQuick.Controls::SplitView::maximumWidth
 
void setMaximumWidth (qreal width)
 
void resetMaximumWidth ()
 
qreal maximumHeight () const
 \qmlattachedproperty real QtQuick.Controls::SplitView::maximumHeight
 
void setMaximumHeight (qreal height)
 
void resetMaximumHeight ()
 
bool fillWidth () const
 \qmlattachedproperty bool QtQuick.Controls::SplitView::fillWidth
 
void setFillWidth (bool fill)
 
bool fillHeight () const
 \qmlattachedproperty bool QtQuick.Controls::SplitView::fillHeight
 
void setFillHeight (bool fill)
 
- 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

QQuickSplitViewview
 
qreal minimumWidth
 
qreal minimumHeight
 
qreal preferredWidth
 
qreal preferredHeight
 
qreal maximumWidth
 
qreal maximumHeight
 
bool fillHeight
 
bool fillWidth
 
- 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 92 of file qquicksplitview_p.h.

Constructor & Destructor Documentation

◆ QQuickSplitViewAttached()

QQuickSplitViewAttached::QQuickSplitViewAttached ( QObject * parent = nullptr)
explicit

Definition at line 1641 of file qquicksplitview.cpp.

Member Function Documentation

◆ fillHeight()

bool QQuickSplitViewAttached::fillHeight ( ) const

\qmlattachedproperty bool QtQuick.Controls::SplitView::fillHeight

This attached property controls whether the item takes the remaining space in the split view after all other items have been laid out.

By default, the last visible child of the split view will fill the view, but it can be changed by explicitly setting fillHeight to true on another item. If multiple items have fillHeight set to true, the top-most item will fill the view.

The height of a split item with fillHeight set to true is still restricted within its \l minimumHeight and \l maximumHeight.

See also
minimumHeight, preferredHeight, maximumHeight, fillWidth

Definition at line 2064 of file qquicksplitview.cpp.

◆ fillHeightChanged

void QQuickSplitViewAttached::fillHeightChanged ( )
signal

◆ fillWidth()

bool QQuickSplitViewAttached::fillWidth ( ) const

\qmlattachedproperty bool QtQuick.Controls::SplitView::fillWidth

This attached property controls whether the item takes the remaining space in the split view after all other items have been laid out.

By default, the last visible child of the split view will fill the view, but it can be changed by explicitly setting fillWidth to true on another item. If multiple items have fillWidth set to true, the left-most item will fill the view.

The width of a split item with fillWidth set to true is still restricted within its \l minimumWidth and \l maximumWidth.

See also
minimumWidth, preferredWidth, maximumWidth, fillHeight

Definition at line 2028 of file qquicksplitview.cpp.

◆ fillWidthChanged

void QQuickSplitViewAttached::fillWidthChanged ( )
signal

◆ maximumHeight()

qreal QQuickSplitViewAttached::maximumHeight ( ) const

\qmlattachedproperty real QtQuick.Controls::SplitView::maximumHeight

This attached property controls the maximum height of the split item. The \l preferredHeight is bound within the \l minimumHeight and \l maximumHeight. A split item cannot be dragged to be larger than its maximumHeight.

The default value is Infinity. To reset this property to its default value, set it to undefined.

See also
minimumHeight, preferredHeight, fillHeight, maximumWidth

Definition at line 1978 of file qquicksplitview.cpp.

◆ maximumHeightChanged

void QQuickSplitViewAttached::maximumHeightChanged ( )
signal

◆ maximumWidth()

qreal QQuickSplitViewAttached::maximumWidth ( ) const

\qmlattachedproperty real QtQuick.Controls::SplitView::maximumWidth

This attached property controls the maximum width of the split item. The \l preferredWidth is bound within the \l minimumWidth and \l maximumWidth. A split item cannot be dragged to be larger than its maximumWidth.

The default value is Infinity. To reset this property to its default value, set it to undefined.

See also
minimumWidth, preferredWidth, fillWidth, maximumHeight

Definition at line 1931 of file qquicksplitview.cpp.

◆ maximumWidthChanged

void QQuickSplitViewAttached::maximumWidthChanged ( )
signal

◆ minimumHeight()

qreal QQuickSplitViewAttached::minimumHeight ( ) const

\qmlattachedproperty real QtQuick.Controls::SplitView::minimumHeight

This attached property controls the minimum height of the split item. The \l preferredHeight is bound within the \l minimumHeight and \l maximumHeight. A split item cannot be dragged to be smaller than its minimumHeight.

The default value is 0. To reset this property to its default value, set it to undefined.

See also
maximumHeight, preferredHeight, fillHeight, minimumWidth

Definition at line 1746 of file qquicksplitview.cpp.

◆ minimumHeightChanged

void QQuickSplitViewAttached::minimumHeightChanged ( )
signal

◆ minimumWidth()

qreal QQuickSplitViewAttached::minimumWidth ( ) const

\qmlattachedproperty real QtQuick.Controls::SplitView::minimumWidth

This attached property controls the minimum width of the split item. The \l preferredWidth is bound within the \l minimumWidth and \l maximumWidth. A split item cannot be dragged to be smaller than its minimumWidth.

The default value is 0. To reset this property to its default value, set it to undefined.

See also
maximumWidth, preferredWidth, fillWidth, minimumHeight

Definition at line 1699 of file qquicksplitview.cpp.

◆ minimumWidthChanged

void QQuickSplitViewAttached::minimumWidthChanged ( )
signal

◆ preferredHeight()

qreal QQuickSplitViewAttached::preferredHeight ( ) const

\qmlattachedproperty real QtQuick.Controls::SplitView::preferredHeight

This attached property controls the preferred height of the split item. The preferred height will be used as the size of the item, and will be bound within the \l minimumHeight and \l maximumHeight. If the preferred height is not set, the item's \l{Item::}{implicitHeight} will be used.

When a split item is resized, the preferredHeight will be set in order to keep track of the new size.

By default, this property is not set, and therefore \l{Item::}{implicitHeight} will be used instead. To reset this property to its default value, set it to undefined.

Note
Do not set the \l{Item::}{height} property of a split item, as it will be overwritten upon each layout of the SplitView.
See also
minimumHeight, maximumHeight, fillHeight, preferredWidth

Definition at line 1869 of file qquicksplitview.cpp.

◆ preferredHeightChanged

void QQuickSplitViewAttached::preferredHeightChanged ( )
signal

◆ preferredWidth()

qreal QQuickSplitViewAttached::preferredWidth ( ) const

\qmlattachedproperty real QtQuick.Controls::SplitView::preferredWidth

This attached property controls the preferred width of the split item. The preferred width will be used as the size of the item, and will be bound within the \l minimumWidth and \l maximumWidth. If the preferred width is not set, the item's \l {Item::}{implicitWidth} will be used.

When a split item is resized, the preferredWidth will be set in order to keep track of the new size.

By default, this property is not set, and therefore \l {Item::}{implicitWidth} will be used instead. To reset this property to its default value, set it to undefined.

Note
Do not set the \l{Item::}{width} property of a split item, as it will be overwritten upon each layout of the SplitView.
See also
minimumWidth, maximumWidth, fillWidth, preferredHeight

Definition at line 1800 of file qquicksplitview.cpp.

◆ preferredWidthChanged

void QQuickSplitViewAttached::preferredWidthChanged ( )
signal

◆ resetMaximumHeight()

void QQuickSplitViewAttached::resetMaximumHeight ( )

Definition at line 1996 of file qquicksplitview.cpp.

◆ resetMaximumWidth()

void QQuickSplitViewAttached::resetMaximumWidth ( )

Definition at line 1949 of file qquicksplitview.cpp.

◆ resetMinimumHeight()

void QQuickSplitViewAttached::resetMinimumHeight ( )

Definition at line 1764 of file qquicksplitview.cpp.

◆ resetMinimumWidth()

void QQuickSplitViewAttached::resetMinimumWidth ( )

Definition at line 1717 of file qquicksplitview.cpp.

◆ resetPreferredHeight()

void QQuickSplitViewAttached::resetPreferredHeight ( )

Definition at line 1900 of file qquicksplitview.cpp.

◆ resetPreferredWidth()

void QQuickSplitViewAttached::resetPreferredWidth ( )

Definition at line 1831 of file qquicksplitview.cpp.

◆ setFillHeight()

void QQuickSplitViewAttached::setFillHeight ( bool fill)

Definition at line 2070 of file qquicksplitview.cpp.

◆ setFillWidth()

void QQuickSplitViewAttached::setFillWidth ( bool fill)

Definition at line 2034 of file qquicksplitview.cpp.

◆ setMaximumHeight()

void QQuickSplitViewAttached::setMaximumHeight ( qreal height)

Definition at line 1984 of file qquicksplitview.cpp.

◆ setMaximumWidth()

void QQuickSplitViewAttached::setMaximumWidth ( qreal width)

Definition at line 1937 of file qquicksplitview.cpp.

◆ setMinimumHeight()

void QQuickSplitViewAttached::setMinimumHeight ( qreal height)

Definition at line 1752 of file qquicksplitview.cpp.

◆ setMinimumWidth()

void QQuickSplitViewAttached::setMinimumWidth ( qreal width)

Definition at line 1705 of file qquicksplitview.cpp.

◆ setPreferredHeight()

void QQuickSplitViewAttached::setPreferredHeight ( qreal height)

Definition at line 1875 of file qquicksplitview.cpp.

◆ setPreferredWidth()

void QQuickSplitViewAttached::setPreferredWidth ( qreal width)

Definition at line 1806 of file qquicksplitview.cpp.

◆ view()

QQuickSplitView * QQuickSplitViewAttached::view ( ) const

\qmlattachedproperty SplitView QtQuick.Controls::SplitView::view

This attached property holds the split view of the item it is attached to, or null if the item is not in a split view.

Definition at line 1680 of file qquicksplitview.cpp.

◆ viewChanged

void QQuickSplitViewAttached::viewChanged ( )
signal

Property Documentation

◆ fillHeight

bool QQuickSplitViewAttached::fillHeight
readwrite

Definition at line 108 of file qquicksplitview_p.h.

◆ fillWidth

bool QQuickSplitViewAttached::fillWidth
readwrite

Definition at line 109 of file qquicksplitview_p.h.

◆ maximumHeight

qreal QQuickSplitViewAttached::maximumHeight
readwrite

Definition at line 106 of file qquicksplitview_p.h.

◆ maximumWidth

qreal QQuickSplitViewAttached::maximumWidth
readwrite

Definition at line 104 of file qquicksplitview_p.h.

◆ minimumHeight

qreal QQuickSplitViewAttached::minimumHeight
readwrite

Definition at line 98 of file qquicksplitview_p.h.

◆ minimumWidth

qreal QQuickSplitViewAttached::minimumWidth
readwrite

Definition at line 96 of file qquicksplitview_p.h.

◆ preferredHeight

qreal QQuickSplitViewAttached::preferredHeight
readwrite

Definition at line 102 of file qquicksplitview_p.h.

◆ preferredWidth

qreal QQuickSplitViewAttached::preferredWidth
readwrite

Definition at line 100 of file qquicksplitview_p.h.

◆ view

QQuickSplitView * QQuickSplitViewAttached::view
read

Definition at line 95 of file qquicksplitview_p.h.


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