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

#include <qquicksafearea_p.h>

Inheritance diagram for QQuickSafeArea:
Collaboration diagram for QQuickSafeArea:

Signals

void marginsChanged ()
void additionalMarginsChanged ()
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

 QQuickSafeArea (QQuickItem *attachee=nullptr)
 ~QQuickSafeArea ()
QMarginsF margins () const
 \qmlpropertygroup QtQuick::SafeArea::margins \qmlproperty real QtQuick::SafeArea::margins.top \qmlproperty real QtQuick::SafeArea::margins.left \qmlproperty real QtQuick::SafeArea::margins.right \qmlproperty real QtQuick::SafeArea::margins.bottom \readonly
QMarginsF additionalMargins () const
void setAdditionalMargins (const QMarginsF &additionalMargins)
 \qmlpropertygroup QtQuick::SafeArea::additionalMargins \qmlproperty real QtQuick::SafeArea::additionalMargins.top \qmlproperty real QtQuick::SafeArea::additionalMargins.left \qmlproperty real QtQuick::SafeArea::additionalMargins.right \qmlproperty real QtQuick::SafeArea::additionalMargins.bottom
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.
Public Member Functions inherited from QQuickItemChangeListener
virtual ~QQuickItemChangeListener ()
virtual void itemSiblingOrderChanged (QQuickItem *)
virtual void itemVisibilityChanged (QQuickItem *)
virtual void itemEnabledChanged (QQuickItem *)
virtual void itemOpacityChanged (QQuickItem *)
virtual void itemDestroyed (QQuickItem *)
virtual void itemChildAdded (QQuickItem *, QQuickItem *)
virtual void itemChildRemoved (QQuickItem *, QQuickItem *)
virtual void itemParentChanged (QQuickItem *, QQuickItem *)
virtual void itemRotationChanged (QQuickItem *)
virtual void itemImplicitWidthChanged (QQuickItem *)
virtual void itemImplicitHeightChanged (QQuickItem *)
virtual void itemFocusChanged (QQuickItem *, Qt::FocusReason)
virtual void itemScaleChanged (QQuickItem *)
virtual QQuickAnchorsPrivateanchorPrivate ()
virtual bool baseDeleted (const QObject *caller) const
virtual QString debugName () const

Static Public Member Functions

static QQuickSafeAreaqmlAttachedProperties (QObject *attachee)
 \qmltype SafeArea \nativetype QQuickSafeArea \inqmlmodule QtQuick
static void updateSafeAreasRecursively (QQuickItem *fromItem)
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)

Properties

QMarginsF margins
QMarginsF additionalMargins
Properties inherited from QObject
QString objectName
 the name of this object

Private Member Functions

void itemTransformChanged (QQuickItem *, QQuickItem *) override
void itemGeometryChanged (QQuickItem *, QQuickGeometryChange, const QRectF &) override
void addSourceItem (QQuickItem *item) override
void removeSourceItem (QQuickItem *item) override

Friends

class QQuickItem
class QQuickControl
Q_QUICK_EXPORT QDebug operator<< (QDebug debug, const QQuickSafeArea *safeArea)

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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 31 of file qquicksafearea_p.h.

Constructor & Destructor Documentation

◆ QQuickSafeArea()

QQuickSafeArea::QQuickSafeArea ( QQuickItem * attachee = nullptr)

Definition at line 113 of file qquicksafearea.cpp.

◆ ~QQuickSafeArea()

QQuickSafeArea::~QQuickSafeArea ( )

Definition at line 128 of file qquicksafearea.cpp.

Member Function Documentation

◆ additionalMargins()

QMarginsF QQuickSafeArea::additionalMargins ( ) const

Definition at line 197 of file qquicksafearea.cpp.

◆ additionalMarginsChanged

void QQuickSafeArea::additionalMarginsChanged ( )
signal

◆ addSourceItem()

void QQuickSafeArea::addSourceItem ( QQuickItem * item)
overrideprivatevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 402 of file qquicksafearea.cpp.

◆ itemGeometryChanged()

void QQuickSafeArea::itemGeometryChanged ( QQuickItem * item,
QQuickGeometryChange change,
const QRectF & oldGeometry )
overrideprivatevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 375 of file qquicksafearea.cpp.

◆ itemTransformChanged()

void QQuickSafeArea::itemTransformChanged ( QQuickItem * item,
QQuickItem * transformedItem )
overrideprivatevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 323 of file qquicksafearea.cpp.

◆ margins()

QMarginsF QQuickSafeArea::margins ( ) const

\qmlpropertygroup QtQuick::SafeArea::margins \qmlproperty real QtQuick::SafeArea::margins.top \qmlproperty real QtQuick::SafeArea::margins.left \qmlproperty real QtQuick::SafeArea::margins.right \qmlproperty real QtQuick::SafeArea::margins.bottom \readonly

This property holds the safe area margins, relative to the attached item.

See also
additionalMargins

Definition at line 157 of file qquicksafearea.cpp.

◆ marginsChanged

void QQuickSafeArea::marginsChanged ( )
signal

◆ qmlAttachedProperties()

QT_BEGIN_NAMESPACE QQuickSafeArea * QQuickSafeArea::qmlAttachedProperties ( QObject * attachee)
static

\qmltype SafeArea \nativetype QQuickSafeArea \inqmlmodule QtQuick

Since
6.9

Provides access to the safe area properties of the item or window.

The SafeArea attached type provides information about the areas of an Item or Window where content may risk being overlapped by other UI elements, such as system title bars or status bars.

This information can be used to lay out children of an item within the safe area of the item, while still allowing a background color or effect to span the entire item.

\table \row

  • Rectangle {
    id: parentItem
    gradient: Gradient.SunnyMorning
    anchors.fill: parent
    Rectangle {
    id: childItem
    gradient: Gradient.DustyGrass
    anchors {
    fill: parent
    topMargin: parent.SafeArea.margins.top
    leftMargin: parent.SafeArea.margins.left
    rightMargin: parent.SafeArea.margins.right
    bottomMargin: parent.SafeArea.margins.bottom
    }
    }
    }
  • \inlineimage safearea-ios.webp \endtable

The SafeArea margins are relative to the item they attach to. If an ancestor item has laid out its children within the safe area margins, any descendant item with its own SafeArea attached will report zero margins, unless \l{Additional margins}{additional margins} have been added.

Note
An item should not be positioned based on {its own} safe area, as that would result in a binding loop.

Definition at line 87 of file qquicksafearea.cpp.

◆ removeSourceItem()

void QQuickSafeArea::removeSourceItem ( QQuickItem * item)
overrideprivatevirtual

Reimplemented from QQuickItemChangeListener.

Definition at line 407 of file qquicksafearea.cpp.

◆ setAdditionalMargins()

void QQuickSafeArea::setAdditionalMargins ( const QMarginsF & additionalMargins)

\qmlpropertygroup QtQuick::SafeArea::additionalMargins \qmlproperty real QtQuick::SafeArea::additionalMargins.top \qmlproperty real QtQuick::SafeArea::additionalMargins.left \qmlproperty real QtQuick::SafeArea::additionalMargins.right \qmlproperty real QtQuick::SafeArea::additionalMargins.bottom

This property holds the additional safe area margins for the item.

The additional safe area margins can not be negative, and will be automatically clamped to 0.

The resulting safe area margins of the item are the sum of the inherited margins (for example from title bars or status bar) and the additional margins applied to the item.

See also
margins

Definition at line 181 of file qquicksafearea.cpp.

◆ updateSafeAreasRecursively()

void QQuickSafeArea::updateSafeAreasRecursively ( QQuickItem * fromItem)
static

Definition at line 389 of file qquicksafearea.cpp.

◆ operator<<

Q_QUICK_EXPORT QDebug operator<< ( QDebug debug,
const QQuickSafeArea * safeArea )
friend

Definition at line 413 of file qquicksafearea.cpp.

◆ QQuickControl

friend class QQuickControl
friend

Definition at line 81 of file qquicksafearea_p.h.

◆ QQuickItem

friend class QQuickItem
friend

Definition at line 80 of file qquicksafearea_p.h.

Property Documentation

◆ additionalMargins

QMarginsF QQuickSafeArea::additionalMargins
readwrite

Definition at line 36 of file qquicksafearea_p.h.

◆ margins

QMarginsF QQuickSafeArea::margins
read

Definition at line 35 of file qquicksafearea_p.h.


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