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
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
QWaylandXdgShell Class Reference

\qmltype XdgShell \instantiates QWaylandXdgShell \inqmlmodule QtWayland.Compositor.XdgShell More...

#include <qwaylandxdgshell.h>

+ Inheritance diagram for QWaylandXdgShell:
+ Collaboration diagram for QWaylandXdgShell:

Public Slots

uint ping (QWaylandClient *client)
 \qmlmethod void XdgShell::ping(WaylandClient client)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void xdgSurfaceCreated (QWaylandXdgSurface *xdgSurface)
 \qmlsignal XdgShell::xdgSurfaceCreated(XdgSurface xdgSurface)
 
void toplevelCreated (QWaylandXdgToplevel *toplevel, QWaylandXdgSurface *xdgSurface)
 \qmlsignal XdgShell::toplevelCreated(XdgToplevel toplevel, XdgSurface xdgSurface)
 
void popupCreated (QWaylandXdgPopup *popup, QWaylandXdgSurface *xdgSurface)
 \qmlsignal XdgShell::popupCreated(XdgPopup popup, XdgSurface xdgSurface)
 
void pong (uint serial)
 \qmlsignal XdgShell::pong(int serial)
 
- Signals inherited from QWaylandShell
void focusPolicyChanged ()
 
- 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

 QWaylandXdgShell ()
 Constructs a QWaylandXdgShell object.
 
 QWaylandXdgShell (QWaylandCompositor *compositor)
 Constructs a QWaylandXdgShell object for the provided compositor.
 
void initialize () override
 Initializes the shell extension.
 
- Public Member Functions inherited from QWaylandShellTemplate< QWaylandXdgShell >
 QWaylandShellTemplate ()
 
 QWaylandShellTemplate (QWaylandObject *container)
 
const struct wl_interface * extensionInterface () const override
 A pure virtual function which should be reimplemented to return the wl_interface which corresponds to this QWaylandCompositorExtension.
 
- Public Member Functions inherited from QWaylandShell
 QWaylandShell ()
 
 QWaylandShell (QWaylandObject *waylandObject)
 
FocusPolicy focusPolicy () const
 
void setFocusPolicy (FocusPolicy focusPolicy)
 
- Public Member Functions inherited from QWaylandCompositorExtension
 QWaylandCompositorExtension ()
 Creates a QWaylandCompositorExtension with no container.
 
 QWaylandCompositorExtension (QWaylandObject *container)
 Creates a QWaylandCompositorExtension and adds it to the extension container.
 
 ~QWaylandCompositorExtension () override
 
QWaylandObject * extensionContainer () const
 
void setExtensionContainer (QWaylandObject *container)
 Sets the extension container for this QWaylandCompositorExtension to container.
 
bool isInitialized () const
 
- Public Member Functions inherited from QWaylandObject
 ~QWaylandObject () override
 
QWaylandCompositorExtension * extension (const QByteArray &name)
 Returns the compositor extension which matches name if one has been registered with the QWaylandObject.
 
QWaylandCompositorExtension * extension (const wl_interface *interface)
 Returns the compositor extension which matches interface if one has been registered with the QWaylandObject.
 
QList< QWaylandCompositorExtension * > extensions () const
 Returns the list of compositor extensions that have been registered with this QWaylandObject.
 
void addExtension (QWaylandCompositorExtension *extension)
 Registers extension with this QWaylandObject.
 
void removeExtension (QWaylandCompositorExtension *extension)
 Removes extension from the list of registered extensions in this QWaylandObject, if it has previously been registered using \l{addExtension()}.
 
- 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 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 const struct wl_interface * interface ()
 Returns the Wayland interface for the QWaylandXdgShell.
 
static QByteArray interfaceName ()
 
- Static Public Member Functions inherited from QWaylandShellTemplate< QWaylandXdgShell >
static QWaylandXdgShell * findIn (QWaylandObject *container)
 
- 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)
 

Additional Inherited Members

- Public Types inherited from QWaylandShell
enum  FocusPolicy { AutomaticFocus , ManualFocus }
 This enum type is used to specify the focus policy for shell surfaces. More...
 
- Protected Member Functions inherited from QWaylandShellTemplate< QWaylandXdgShell >
 QWaylandShellTemplate (QWaylandShellPrivate &dd)
 
 QWaylandShellTemplate (QWaylandObject *container, QWaylandShellPrivate &dd)
 
- Protected Member Functions inherited from QWaylandShell
 QWaylandShell (QWaylandShellPrivate &dd)
 
 QWaylandShell (QWaylandObject *container, QWaylandShellPrivate &dd)
 
- Protected Member Functions inherited from QWaylandCompositorExtension
 QWaylandCompositorExtension (QWaylandCompositorExtensionPrivate &dd)
 
 QWaylandCompositorExtension (QWaylandObject *container, QWaylandCompositorExtensionPrivate &dd)
 
bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
- Protected Member Functions inherited from QWaylandObject
 QWaylandObject (QObject *parent=nullptr)
 Creates a QWaylandObject as a child of parent.
 
 QWaylandObject (QObjectPrivate &d, QObject *parent=nullptr)
 
- 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 QWaylandObject
QList< QWaylandCompositorExtension * > extension_vector
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QWaylandShell
FocusPolicy focusPolicy
 \qmlproperty enumeration Shell::focusPolicy
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- 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

\qmltype XdgShell \instantiates QWaylandXdgShell \inqmlmodule QtWayland.Compositor.XdgShell

Since
5.12

Provides an extension for desktop-style user interfaces.

The XdgShell extension provides a way to associate a XdgToplevel or XdgPopup with a regular Wayland surface. Using the XdgToplevel interface, the client can request that the surface is resized, moved, and so on.

XdgShell corresponds to the Wayland interface, xdg_shell.

To provide the functionality of the shell extension in a compositor, create an instance of the XdgShell component and add it to the list of extensions supported by the compositor:

\qml import QtWayland.Compositor.XdgShell

WaylandCompositor { XdgShell { // ... } } \endqml

\inmodule QtWaylandCompositor

Since
5.12

The QWaylandXdgShell class is an extension for desktop-style user interfaces.

The QWaylandXdgShell extension provides a way to associate a QWaylandXdgToplevel or QWaylandXdgPopup with a regular Wayland surface. Using the QWaylandXdgToplevel interface, the client can request that the surface is resized, moved, and so on.

QWaylandXdgShell corresponds to the Wayland interface, xdg_shell.

Definition at line 35 of file qwaylandxdgshell.h.

Constructor & Destructor Documentation

◆ QWaylandXdgShell() [1/2]

QWaylandXdgShell::QWaylandXdgShell ( )
explicit

Constructs a QWaylandXdgShell object.

Definition at line 155 of file qwaylandxdgshell.cpp.

◆ QWaylandXdgShell() [2/2]

QWaylandXdgShell::QWaylandXdgShell ( QWaylandCompositor * compositor)
explicit

Constructs a QWaylandXdgShell object for the provided compositor.

Definition at line 163 of file qwaylandxdgshell.cpp.

Member Function Documentation

◆ initialize()

void QWaylandXdgShell::initialize ( )
overridevirtual

Initializes the shell extension.

Reimplemented from QWaylandCompositorExtension.

Definition at line 171 of file qwaylandxdgshell.cpp.

References compositor, connect(), d, QWaylandCompositorExtension::extensionContainer(), QWaylandCompositorExtension::initialize(), and qWarning.

+ Here is the call graph for this function:

◆ interface()

const struct wl_interface * QWaylandXdgShell::interface ( )
static

Returns the Wayland interface for the QWaylandXdgShell.

Definition at line 195 of file qwaylandxdgshell.cpp.

◆ interfaceName()

QByteArray QWaylandXdgShell::interfaceName ( )
static

Definition at line 200 of file qwaylandxdgshell.cpp.

◆ ping

uint QWaylandXdgShell::ping ( QWaylandClient * client)
slot

\qmlmethod void XdgShell::ping(WaylandClient client)

Sends a ping event to client. If the client replies to the event the \l pong signal will be emitted.

Sends a ping event to client. If the client replies to the event the \l pong signal will be emitted.

Definition at line 216 of file qwaylandxdgshell.cpp.

References QWaylandClient::client(), compositor, d, QWaylandCompositorExtension::extensionContainer(), and Q_ASSERT.

+ Here is the call graph for this function:

◆ pong

void QWaylandXdgShell::pong ( uint serial)
signal

\qmlsignal XdgShell::pong(int serial)

This signal is emitted when the client has responded to a ping event with serial, serial.

See also
ping()

This signal is emitted when the client has responded to a ping event with serial, serial.

See also
QWaylandXdgShell::ping()

◆ popupCreated

void QWaylandXdgShell::popupCreated ( QWaylandXdgPopup * popup,
QWaylandXdgSurface * xdgSurface )
signal

\qmlsignal XdgShell::popupCreated(XdgPopup popup, XdgSurface xdgSurface)

This signal is emitted when the client has created a xdg_popup. A common use case is to let the handler of this signal instantiate a ShellSurfaceItem or WaylandQuickItem for displaying popup in a QtQuick scene.

xdgSurface is the XdgSurface popup is the role object for.

This signal is emitted when the client has created a xdg_popup. A common use case is to let the handler of this signal instantiate a QWaylandShellSurfaceItem or QWaylandQuickItem for displaying popup in a QtQuick scene.

xdgSurface is the XdgSurface popup is the role object for.

Referenced by QtWayland::XdgPopupIntegration::XdgPopupIntegration(), QtWayland::XdgToplevelIntegration::XdgToplevelIntegration(), and QWaylandXdgSurfacePrivate::xdg_surface_get_popup().

+ Here is the caller graph for this function:

◆ toplevelCreated

void QWaylandXdgShell::toplevelCreated ( QWaylandXdgToplevel * toplevel,
QWaylandXdgSurface * xdgSurface )
signal

\qmlsignal XdgShell::toplevelCreated(XdgToplevel toplevel, XdgSurface xdgSurface)

This signal is emitted when the client has created a xdg_toplevel. A common use case is to let the handler of this signal instantiate a ShellSurfaceItem or WaylandQuickItem for displaying toplevel in a QtQuick scene.

xdgSurface is the XdgSurface toplevel is the role object for.

This signal is emitted when the client has created a xdg_toplevel. A common use case is to let the handler of this signal instantiate a QWaylandShellSurfaceItem or QWaylandQuickItem for displaying toplevel in a QtQuick scene.

xdgSurface is the XdgSurface toplevel is the role object for.

Referenced by QWaylandXdgSurfacePrivate::xdg_surface_get_toplevel().

+ Here is the caller graph for this function:

◆ xdgSurfaceCreated

void QWaylandXdgShell::xdgSurfaceCreated ( QWaylandXdgSurface * xdgSurface)
signal

\qmlsignal XdgShell::xdgSurfaceCreated(XdgSurface xdgSurface)

This signal is emitted when the client has created a xdg_surface. Note that xdgSurface is not mapped, i.e. according to the xdg-shell protocol it should not be displayed, until it has received a role object.

See also
toplevelCreated(), popupCreated()

This signal is emitted when the client has created a xdg_surface. Note that xdgSurface is not mapped, i.e. according to the xdg-shell protocol it should not be displayed, until it has received a role object.

See also
toplevelCreated(), popupCreated()
The documentation for this class was generated from the following files: