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 | Protected Member Functions | Properties | List of all members
QQuickDrawer Class Reference

#include <qquickdrawer_p.h>

+ Inheritance diagram for QQuickDrawer:
+ Collaboration diagram for QQuickDrawer:

Signals

void edgeChanged ()
 
void positionChanged ()
 
void dragMarginChanged ()
 
 Q_REVISION (2, 2) void interactiveChanged()
 
- Signals inherited from QQuickPopup
void opened ()
 
void closed ()
 
void aboutToShow ()
 
void aboutToHide ()
 
void xChanged ()
 
void yChanged ()
 
void zChanged ()
 
void widthChanged ()
 
void heightChanged ()
 
void implicitWidthChanged ()
 
void implicitHeightChanged ()
 
void contentWidthChanged ()
 
void contentHeightChanged ()
 
void availableWidthChanged ()
 
void availableHeightChanged ()
 
void marginsChanged ()
 
void topMarginChanged ()
 
void leftMarginChanged ()
 
void rightMarginChanged ()
 
void bottomMarginChanged ()
 
void paddingChanged ()
 
void topPaddingChanged ()
 
void leftPaddingChanged ()
 
void rightPaddingChanged ()
 
void bottomPaddingChanged ()
 
void fontChanged ()
 
void localeChanged ()
 
void parentChanged ()
 
void backgroundChanged ()
 
void contentItemChanged ()
 
void contentChildrenChanged ()
 
void clipChanged ()
 
void focusChanged ()
 
void activeFocusChanged ()
 
void modalChanged ()
 
void dimChanged ()
 
void visibleChanged ()
 
void opacityChanged ()
 
void scaleChanged ()
 
void closePolicyChanged ()
 
void enterChanged ()
 
void exitChanged ()
 
void windowChanged (QQuickWindow *window)
 
 Q_REVISION (2, 1) void spacingChanged()
 
 Q_REVISION (2, 3) void openedChanged()
 
 Q_REVISION (2, 3) void mirroredChanged()
 
 Q_REVISION (2, 3) void enabledChanged()
 
 Q_REVISION (2, 3) void paletteChanged()
 
 Q_REVISION (2, 3) void paletteCreated()
 
 Q_REVISION (2, 5) void horizontalPaddingChanged()
 
 Q_REVISION (2, 5) void verticalPaddingChanged()
 
 Q_REVISION (2, 5) void implicitContentWidthChanged()
 
 Q_REVISION (2, 5) void implicitContentHeightChanged()
 
 Q_REVISION (2, 5) void implicitBackgroundWidthChanged()
 
 Q_REVISION (2, 5) void implicitBackgroundHeightChanged()
 
 Q_REVISION (2, 5) void topInsetChanged()
 
 Q_REVISION (2, 5) void leftInsetChanged()
 
 Q_REVISION (2, 5) void rightInsetChanged()
 
 Q_REVISION (2, 5) void bottomInsetChanged()
 
- 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

 QQuickDrawer (QObject *parent=nullptr)
 
Qt::Edge edge () const
 \qmlproperty enumeration QtQuick.Controls::Drawer::edge
 
void setEdge (Qt::Edge edge)
 
qreal position () const
 \qmlproperty real QtQuick.Controls::Drawer::position
 
void setPosition (qreal position)
 
qreal dragMargin () const
 \qmlproperty real QtQuick.Controls::Drawer::dragMargin
 
void setDragMargin (qreal margin)
 
void resetDragMargin ()
 
bool isInteractive () const
 
void setInteractive (bool interactive)
 
- 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Protected Member Functions

bool childMouseEventFilter (QQuickItem *child, QEvent *event) override
 
void mouseMoveEvent (QMouseEvent *event) override
 
bool overlayEvent (QQuickItem *item, QEvent *event) override
 
void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
 
- Protected Member Functions inherited from QQuickPopup
 QQuickPopup (QQuickPopupPrivate &dd, QObject *parent)
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
bool isComponentComplete () const
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseUngrabEvent ()
 
virtual void contentItemChange (QQuickItem *newItem, QQuickItem *oldItem)
 
virtual void contentSizeChange (const QSizeF &newSize, const QSizeF &oldSize)
 
virtual void fontChange (const QFont &newFont, const QFont &oldFont)
 
virtual void localeChange (const QLocale &newLocale, const QLocale &oldLocale)
 
virtual void itemChange (QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &data)
 
virtual void marginsChange (const QMarginsF &newMargins, const QMarginsF &oldMargins)
 
virtual void paddingChange (const QMarginsF &newPadding, const QMarginsF &oldPadding)
 
virtual void spacingChange (qreal newSpacing, qreal oldSpacing)
 
virtual void insetChange (const QMarginsF &newInset, const QMarginsF &oldInset)
 
virtual QFont defaultFont () const
 
QString accessibleName () const
 
void maybeSetAccessibleName (const QString &name)
 
QVariant accessibleProperty (const char *propertyName)
 
bool setAccessibleProperty (const char *propertyName, const QVariant &value)
 
- 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)
 

Properties

Qt::Edge edge
 
qreal position
 
qreal dragMargin
 
bool interactive
 
- Properties inherited from QQuickPopup
qreal x
 
qreal y
 
qreal z
 
qreal width
 
qreal height
 
qreal implicitWidth
 
qreal implicitHeight
 
qreal contentWidth
 
qreal contentHeight
 
qreal availableWidth
 
qreal availableHeight
 
qreal margins
 
qreal topMargin
 
qreal leftMargin
 
qreal rightMargin
 
qreal bottomMargin
 
qreal padding
 
qreal topPadding
 
qreal leftPadding
 
qreal rightPadding
 
qreal bottomPadding
 
QLocale locale
 
QFont font
 
QQuickItem * parent
 
QQuickItem * background
 
QQuickItem * contentItem
 
bool clip
 
bool focus
 
bool activeFocus
 
bool modal
 
bool dim
 
bool visible
 
qreal opacity
 
qreal scale
 
ClosePolicy closePolicy
 
TransformOrigin transformOrigin
 
QQuickTransition * enter
 
QQuickTransition * exit
 
qreal spacing
 
bool opened
 
bool mirrored
 
bool enabled
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QQuickPopup
void open ()
 \qmlmethod void QtQuick.Controls::Popup::open()
 
void close ()
 \qmlmethod void QtQuick.Controls::Popup::close()
 
- 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 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 24 of file qquickdrawer_p.h.

Constructor & Destructor Documentation

◆ QQuickDrawer()

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

Definition at line 627 of file qquickdrawer.cpp.

References d, Qt::LeftEdge, and QGuiApplication::styleHints().

+ Here is the call graph for this function:

Member Function Documentation

◆ childMouseEventFilter()

bool QQuickDrawer::childMouseEventFilter ( QQuickItem * child,
QEvent * event )
overrideprotectedvirtual

Reimplemented from QQuickPopup.

Definition at line 784 of file qquickdrawer.cpp.

References child, d, QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseMove, QEvent::TouchBegin, QEvent::TouchEnd, and QEvent::TouchUpdate.

◆ dragMargin()

qreal QQuickDrawer::dragMargin ( ) const

\qmlproperty real QtQuick.Controls::Drawer::dragMargin

This property holds the distance from the screen edge within which drag actions will open the drawer. Setting the value to 0 or less prevents opening the drawer by dragging.

The default value is Qt.styleHints.startDragDistance.

See also
interactive

Definition at line 735 of file qquickdrawer.cpp.

References d.

◆ dragMarginChanged

void QQuickDrawer::dragMarginChanged ( )
signal

Referenced by setDragMargin().

+ Here is the caller graph for this function:

◆ edge()

Qt::Edge QQuickDrawer::edge ( ) const

\qmlproperty enumeration QtQuick.Controls::Drawer::edge

This property holds the edge of the window at which the drawer will open from. The acceptable values are:

\value Qt.TopEdge The top edge of the window. \value Qt.LeftEdge The left edge of the window (default). \value Qt.RightEdge The right edge of the window. \value Qt.BottomEdge The bottom edge of the window.

Definition at line 651 of file qquickdrawer.cpp.

References d.

◆ edgeChanged

void QQuickDrawer::edgeChanged ( )
signal

Referenced by setEdge().

+ Here is the caller graph for this function:

◆ geometryChange()

void QQuickDrawer::geometryChange ( const QRectF & newGeometry,
const QRectF & oldGeometry )
overrideprotectedvirtual

Reimplemented from QQuickPopup.

Definition at line 836 of file qquickdrawer.cpp.

References d, and QQuickPopup::geometryChange().

+ Here is the call graph for this function:

◆ isInteractive()

bool QQuickDrawer::isInteractive ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlproperty bool QtQuick.Controls::Drawer::interactive

This property holds whether the drawer is interactive. A non-interactive drawer does not react to swipes.

The default value is true.

See also
dragMargin

Definition at line 767 of file qquickdrawer.cpp.

References d.

◆ mouseMoveEvent()

void QQuickDrawer::mouseMoveEvent ( QMouseEvent * event)
overrideprotectedvirtual

Reimplemented from QQuickPopup.

Definition at line 806 of file qquickdrawer.cpp.

References d.

◆ overlayEvent()

bool QQuickDrawer::overlayEvent ( QQuickItem * item,
QEvent * event )
overrideprotectedvirtual

Reimplemented from QQuickPopup.

Definition at line 812 of file qquickdrawer.cpp.

References d, item, QEvent::MouseMove, QQuickPopup::overlayEvent(), and QEvent::TouchUpdate.

+ Here is the call graph for this function:

◆ position()

qreal QQuickDrawer::position ( ) const

\qmlproperty real QtQuick.Controls::Drawer::position

This property holds the position of the drawer relative to its final destination. That is, the position will be 0.0 when the drawer is fully closed, and 1.0 when fully open.

Definition at line 703 of file qquickdrawer.cpp.

References d.

◆ positionChanged

void QQuickDrawer::positionChanged ( )
signal

Referenced by setPosition().

+ Here is the caller graph for this function:

◆ Q_REVISION

QQuickDrawer::Q_REVISION ( 2 ,
2  )
signal

◆ resetDragMargin()

void QQuickDrawer::resetDragMargin ( )

Definition at line 751 of file qquickdrawer.cpp.

References setDragMargin(), and QGuiApplication::styleHints().

+ Here is the call graph for this function:

◆ setDragMargin()

void QQuickDrawer::setDragMargin ( qreal margin)

Definition at line 741 of file qquickdrawer.cpp.

References d, dragMarginChanged(), emit, and qFuzzyCompare().

Referenced by resetDragMargin().

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

◆ setEdge()

void QQuickDrawer::setEdge ( Qt::Edge edge)

Definition at line 682 of file qquickdrawer.cpp.

References d, edge, edgeChanged(), emit, and QQuickPopup::isComponentComplete().

+ Here is the call graph for this function:

◆ setInteractive()

void QQuickDrawer::setInteractive ( bool interactive)

Definition at line 773 of file qquickdrawer.cpp.

References d, emit, and interactive.

◆ setPosition()

void QQuickDrawer::setPosition ( qreal position)

Definition at line 709 of file qquickdrawer.cpp.

References d, emit, QQuickPopup::isComponentComplete(), position, positionChanged(), and qFuzzyCompare().

+ Here is the call graph for this function:

Property Documentation

◆ dragMargin

qreal QQuickDrawer::dragMargin
readwrite

Definition at line 29 of file qquickdrawer_p.h.

◆ edge

Qt::Edge QQuickDrawer::edge
readwrite

Definition at line 27 of file qquickdrawer_p.h.

Referenced by setEdge().

◆ interactive

bool QQuickDrawer::interactive
readwrite

Definition at line 31 of file qquickdrawer_p.h.

Referenced by setInteractive().

◆ position

qreal QQuickDrawer::position
readwrite

Definition at line 28 of file qquickdrawer_p.h.

Referenced by setPosition().

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