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
Signals | Public Member Functions | Static Public Member Functions | Properties | Friends | List of all members
QQuickLayoutMirroringAttached Class Reference

#include <qquickitem_p.h>

+ Inheritance diagram for QQuickLayoutMirroringAttached:
+ Collaboration diagram for QQuickLayoutMirroringAttached:

Signals

void enabledChanged ()
 
void childrenInheritChanged ()
 
- 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

 QQuickLayoutMirroringAttached (QObject *parent=nullptr)
 \qmltype LayoutMirroring \instantiates QQuickLayoutMirroringAttached \inqmlmodule QtQuick
 
bool enabled () const
 
void setEnabled (bool)
 
void resetEnabled ()
 
bool childrenInherit () const
 
void setChildrenInherit (bool)
 
- 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< QString > bindableObjectName ()
 
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).
 
QThread * thread () 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 >
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 >
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 QObjectList & children () 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< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () 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.
 

Static Public Member Functions

static QQuickLayoutMirroringAttached * qmlAttachedProperties (QObject *)
 
- 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

bool enabled
 
bool childrenInherit
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QQuickItemPrivate
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Protected Member Functions inherited from QObject
QObject * sender () 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< QObjectData > d_ptr
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 826 of file qquickitem_p.h.

Constructor & Destructor Documentation

◆ QQuickLayoutMirroringAttached()

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

\qmltype LayoutMirroring \instantiates QQuickLayoutMirroringAttached \inqmlmodule QtQuick

Property used to mirror layout behavior.

The LayoutMirroring attached property is used to horizontally mirror \l {anchor-layout}{Item anchors}, \l{Item Positioners}{positioner} types (such as \l Row and \l Grid) and views (such as \l GridView and horizontal \l ListView). Mirroring is a visual change: left anchors become right anchors, and positioner types like \l Grid and \l Row reverse the horizontal layout of child items.

Mirroring is enabled for an item by setting the \l enabled property to true. By default, this only affects the item itself; setting the \l childrenInherit property to true propagates the mirroring behavior to all child items as well. If the LayoutMirroring attached property has not been defined for an item, mirroring is not enabled.

Note
Since Qt 5.8, LayoutMirroring can be attached to a \l Window. In practice, it is the same as attaching LayoutMirroring to the window's contentItem.

The following example shows mirroring in action. The \l Row below is specified as being anchored to the left of its parent. However, since mirroring has been enabled, the anchor is horizontally reversed and it is now anchored to the right. Also, since items in a \l Row are positioned from left to right by default, they are now positioned from right to left instead, as demonstrated by the numbering and opacity of the items:

import QtQuick
Rectangle {
LayoutMirroring.enabled: true
LayoutMirroring.childrenInherit: true
width: 300; height: 50
color: "yellow"
border.width: 1
Row {
anchors { left: parent.left; margins: 5 }
y: 5; spacing: 5
Repeater {
model: 5
Rectangle {
color: "red"
opacity: (5 - index) / 5
width: 40; height: 40
Text {
text: index + 1
anchors.centerIn: parent
}
}
}
}
}

Layout mirroring is useful when it is necessary to support both left-to-right and right-to-left layout versions of an application to target different language areas. The \l childrenInherit property allows layout mirroring to be applied without manually setting layout configurations for every item in an application. Keep in mind, however, that mirroring does not affect any positioning that is defined by the \l Item \l {Item::}{x} coordinate value, so even with mirroring enabled, it will often be necessary to apply some layout fixes to support the desired layout direction. Also, it may be necessary to disable the mirroring of individual child items (by setting \l {enabled}{LayoutMirroring.enabled} to false for such items) if mirroring is not the desired behavior, or if the child item already implements mirroring in some custom way.

To set the layout direction based on the \l {Default Layout Direction}{default layout direction} of the application, use the following code:

LayoutMirroring.enabled: Qt.application.layoutDirection === Qt.RightToLeft
Qt
Definition qcompare.h:63

See \l {Right-to-left User Interfaces} for further details on using LayoutMirroring and other related features to implement right-to-left support for an application.

\qmlproperty bool QtQuick::LayoutMirroring::enabled

This property holds whether the item's layout is mirrored horizontally. Setting this to true horizontally reverses \l {anchor-layout}{anchor} settings such that left anchors become right, and right anchors become left. For \l{Item Positioners}{positioner} types (such as \l Row and \l Grid) and view types (such as \l {GridView}{GridView} and \l {ListView}{ListView}) this also mirrors the horizontal layout direction of the item.

The default value is false.

\qmlproperty bool QtQuick::LayoutMirroring::childrenInherit

This property holds whether the \l {enabled}{LayoutMirroring.enabled} value for this item is inherited by its children.

The default value is false.

Definition at line 1484 of file qquickitem.cpp.

References QQuickItemPrivate::extra, QQuickItemPrivate::get(), item, QObject::parent(), qmlWarning(), tr, and window().

Referenced by qmlAttachedProperties().

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

Member Function Documentation

◆ childrenInherit()

bool QQuickLayoutMirroringAttached::childrenInherit ( ) const

Definition at line 1528 of file qquickitem.cpp.

References QQuickItemPrivate::inheritMirrorFromItem.

◆ childrenInheritChanged

void QQuickLayoutMirroringAttached::childrenInheritChanged ( )
signal

Referenced by setChildrenInherit().

+ Here is the caller graph for this function:

◆ enabled()

bool QQuickLayoutMirroringAttached::enabled ( ) const

Definition at line 1502 of file qquickitem.cpp.

References QQuickItemPrivate::effectiveLayoutMirror.

◆ enabledChanged

void QQuickLayoutMirroringAttached::enabledChanged ( )
signal

◆ qmlAttachedProperties()

QQuickLayoutMirroringAttached * QQuickLayoutMirroringAttached::qmlAttachedProperties ( QObject * object)
static

Definition at line 1497 of file qquickitem.cpp.

References QQuickLayoutMirroringAttached().

+ Here is the call graph for this function:

◆ resetEnabled()

void QQuickLayoutMirroringAttached::resetEnabled ( )

Definition at line 1520 of file qquickitem.cpp.

References QQuickItemPrivate::isMirrorImplicit, and QQuickItemPrivate::resolveLayoutMirror().

+ Here is the call graph for this function:

◆ setChildrenInherit()

void QQuickLayoutMirroringAttached::setChildrenInherit ( bool childrenInherit)

Definition at line 1533 of file qquickitem.cpp.

References childrenInherit, childrenInheritChanged(), QQuickItemPrivate::inheritMirrorFromItem, and QQuickItemPrivate::resolveLayoutMirror().

+ Here is the call graph for this function:

◆ setEnabled()

void QQuickLayoutMirroringAttached::setEnabled ( bool enabled)

Definition at line 1507 of file qquickitem.cpp.

References QQuickItemPrivate::effectiveLayoutMirror, QQuickItemPrivate::inheritMirrorFromItem, QQuickItemPrivate::isMirrorImplicit, QQuickItemPrivate::resolveLayoutMirror(), and QQuickItemPrivate::setLayoutMirror().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QQuickItemPrivate

friend class QQuickItemPrivate
friend

Definition at line 852 of file qquickitem_p.h.

Property Documentation

◆ childrenInherit

bool QQuickLayoutMirroringAttached::childrenInherit
readwrite

Definition at line 830 of file qquickitem_p.h.

Referenced by setChildrenInherit().

◆ enabled

bool QQuickLayoutMirroringAttached::enabled
readwrite

Definition at line 829 of file qquickitem_p.h.

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