\qmltype XdgSurface \instantiates QWaylandXdgSurface \inqmlmodule QtWayland.Compositor.XdgShell More...

#include <qwaylandxdgshell.h>

Inheritance diagram for QWaylandXdgSurface:

Collaboration diagram for QWaylandXdgSurface:

Signals
void	shellChanged ()

void	surfaceChanged ()

void	toplevelCreated ()

void	popupCreated ()

void	windowGeometryChanged ()

Signals inherited from QWaylandShellSurface
void	windowTypeChanged ()

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
	QWaylandXdgSurface ()
	Constructs a QWaylandXdgSurface.

	QWaylandXdgSurface (QWaylandXdgShell xdgShell, QWaylandSurface surface, const QWaylandResource &resource)
	Constructs a QWaylandXdgSurface for surface and initializes it with the given xdgShell, surface, and resource res.

Q_INVOKABLE void	initialize (QWaylandXdgShell xdgShell, QWaylandSurface surface, const QWaylandResource &resource)
	\qmlmethod void XdgSurface::initialize(object xdgShell, object surface, object client, int id)

Qt::WindowType	windowType () const override
	\qmlproperty enum XdgSurface::windowType

QWaylandXdgShell *	shell () const

QWaylandSurface *	surface () const

QWaylandXdgToplevel *	toplevel () const

QWaylandXdgPopup *	popup () const

QRect	windowGeometry () const

Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandXdgSurface >
	QWaylandShellSurfaceTemplate (QWaylandObject *container=nullptr)

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 QWaylandShellSurface
	QWaylandShellSurface (QWaylandObject *waylandObject)

virtual Qt::WindowType	windowType () const

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.

virtual void	initialize ()
	Initializes the QWaylandCompositorExtension.

bool	isInitialized () const

virtual const struct wl_interface *	extensionInterface () const =0
	A pure virtual function which should be reimplemented to return the `wl_interface` which corresponds to this QWaylandCompositorExtension.

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	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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 QWaylandXdgSurface.

static QByteArray	interfaceName ()

static QWaylandXdgSurface *	fromResource (::wl_resource *resource)
	Returns the QWaylandXdgSurface corresponding to the resource.

Static Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandXdgSurface >
static QWaylandXdgSurface *	findIn (QWaylandObject *container)
	If any instance of the interface has been registered with container, this is returned.

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
QWaylandXdgShell *	shell
	\qmlproperty XdgShell XdgSurface::shell

QWaylandSurface *	surface
	\qmlproperty WaylandSurface XdgSurface::surface

QWaylandXdgToplevel *	toplevel
	\qmlproperty XdgToplevel XdgSurface::toplevel

QWaylandXdgPopup *	popup
	\qmlproperty XdgPopup XdgSurface::popup

QRect	windowGeometry
	\qmlproperty rect XdgSurface::windowGeometry

Properties inherited from QWaylandShellSurface
Qt::WindowType	windowType
	\qmlproperty enum QtWayland.Compositor::ShellSurface::windowType

Properties inherited from QObject
QString	objectName
	the name of this object

Private Member Functions
void	initialize () override

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Protected Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandXdgSurface >
	QWaylandShellSurfaceTemplate (QWaylandCompositorExtensionPrivate &dd)

	QWaylandShellSurfaceTemplate (QWaylandObject *container, QWaylandCompositorExtensionPrivate &dd)

Protected Member Functions inherited from QWaylandShellSurface
	QWaylandShellSurface (QWaylandCompositorExtensionPrivate &dd)

	QWaylandShellSurface (QWaylandObject *container, QWaylandCompositorExtensionPrivate &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

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\qmltype XdgSurface \instantiates QWaylandXdgSurface \inqmlmodule QtWayland.Compositor.XdgShell

Since: 5.12

XdgSurface provides desktop-style compositor-specific features to an xdg surface.

This type is part of the \l{XdgShell} extension and provides a way to extend the functionality of an existing \l{WaylandSurface} with features specific to desktop-style compositors, such as resizing and moving the surface.

It corresponds to the Wayland interface xdg_surface.

\inmodule QtWaylandCompositor

Since: 5.12

The QWaylandXdgSurface class provides desktop-style compositor-specific features to an xdg surface.

This class is part of the QWaylandXdgShell extension and provides a way to extend the functionality of an existing QWaylandSurface with features specific to desktop-style compositors, such as resizing and moving the surface.

It corresponds to the Wayland interface xdg_surface.

Definition at line 62 of file qwaylandxdgshell.h.

Constructor & Destructor Documentation

◆ QWaylandXdgSurface() [1/2]

QWaylandXdgSurface::QWaylandXdgSurface ( )

explicit

Constructs a QWaylandXdgSurface.

Definition at line 462 of file qwaylandxdgshell.cpp.

◆ QWaylandXdgSurface() [2/2]

QWaylandXdgSurface::QWaylandXdgSurface	(	QWaylandXdgShell *	xdgShell,
		QWaylandSurface *	surface,
		const QWaylandResource &	resource
	)

explicit

Constructs a QWaylandXdgSurface for surface and initializes it with the given xdgShell, surface, and resource res.

Definition at line 471 of file qwaylandxdgshell.cpp.

References initialize(), and surface.

Here is the call graph for this function:

Member Function Documentation

◆ fromResource()

QWaylandXdgSurface * QWaylandXdgSurface::fromResource ( ::wl_resource * resource )

static

Returns the QWaylandXdgSurface corresponding to the resource.

Definition at line 658 of file qwaylandxdgshell.cpp.

Referenced by QWaylandXdgSurfacePrivate::xdg_surface_get_popup().

Here is the caller graph for this function:

◆ initialize() [1/2]

void QWaylandXdgSurface::initialize ( )

overrideprivatevirtual

Reimplemented from QWaylandCompositorExtension.

Definition at line 542 of file qwaylandxdgshell.cpp.

References QWaylandCompositorExtension::initialize().

Referenced by QWaylandXdgSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize() [2/2]

void QWaylandXdgSurface::initialize	(	QWaylandXdgShell *	xdgShell,
		QWaylandSurface *	surface,
		const QWaylandResource &	resource
	)

\qmlmethod void XdgSurface::initialize(object xdgShell, object surface, object client, int id)

Initializes the XdgSurface, associating it with the given xdgShell, surface, client, and id.

Initializes the QWaylandXdgSurface, associating it with the given xdgShell, surface and resource.

Definition at line 488 of file qwaylandxdgshell.cpp.

References QWaylandSurface::bufferScaleChanged(), connect(), d, emit, QWaylandCompositorExtension::initialize(), QWaylandResource::resource(), QWaylandCompositorExtension::setExtensionContainer(), shellChanged(), surface, and surfaceChanged().

Here is the call graph for this function:

◆ interface()

const wl_interface * QWaylandXdgSurface::interface ( )

static

Returns the Wayland interface for the QWaylandXdgSurface.

Definition at line 642 of file qwaylandxdgshell.cpp.

◆ interfaceName()

QByteArray QWaylandXdgSurface::interfaceName ( )

static

Definition at line 650 of file qwaylandxdgshell.cpp.

◆ popup()

QWaylandXdgPopup * QWaylandXdgSurface::popup ( ) const

Definition at line 633 of file qwaylandxdgshell.cpp.

References d.

◆ popupCreated

void QWaylandXdgSurface::popupCreated ( )

signal

◆ shell()

QWaylandXdgShell * QWaylandXdgSurface::shell ( ) const

Definition at line 570 of file qwaylandxdgshell.cpp.

References d.

◆ shellChanged

void QWaylandXdgSurface::shellChanged ( )

signal

Referenced by initialize().

Here is the caller graph for this function:

◆ surface()

QWaylandSurface * QWaylandXdgSurface::surface ( ) const

Definition at line 587 of file qwaylandxdgshell.cpp.

References d.

◆ surfaceChanged

void QWaylandXdgSurface::surfaceChanged ( )

signal

Referenced by initialize().

Here is the caller graph for this function:

◆ toplevel()

QWaylandXdgToplevel * QWaylandXdgSurface::toplevel ( ) const

Definition at line 610 of file qwaylandxdgshell.cpp.

References d.

◆ toplevelCreated

void QWaylandXdgSurface::toplevelCreated ( )

signal

◆ windowGeometry()

QRect QWaylandXdgSurface::windowGeometry ( ) const

Definition at line 533 of file qwaylandxdgshell.cpp.

References d.

◆ windowGeometryChanged

void QWaylandXdgSurface::windowGeometryChanged ( )

signal

◆ windowType()

Qt::WindowType QWaylandXdgSurface::windowType ( ) const

overridevirtual

\qmlproperty enum XdgSurface::windowType

This property holds the window type of the XdgSurface.

Reimplemented from QWaylandShellSurface.

Definition at line 508 of file qwaylandxdgshell.cpp.

References d.

Referenced by QWaylandXdgToplevelPrivate::xdg_toplevel_set_parent().

Here is the caller graph for this function:

Property Documentation

◆ popup

QWaylandXdgSurface::popup

read

\qmlproperty XdgPopup XdgSurface::popup

This property holds the properties and methods that are specific to the popup XdgSurface.

See also: toplevel, XdgShell::popupCreated

This property holds the properties and methods that are specific to the popup QWaylandXdgSurface.

See also: QWaylandXdgSurface::toplevel, QWaylandXdgShell::popupCreated

Definition at line 59 of file qwaylandxdgshell.h.

◆ shell

QWaylandXdgSurface::shell

read

\qmlproperty XdgShell XdgSurface::shell

This property holds the shell associated with this XdgSurface.

This property holds the shell associated with this QWaylandXdgSurface.

Definition at line 59 of file qwaylandxdgshell.h.

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

◆ surface

QWaylandXdgSurface::surface

read

\qmlproperty WaylandSurface XdgSurface::surface

This property holds the surface associated with this XdgSurface.

This property holds the surface associated with this QWaylandXdgSurface.

Definition at line 59 of file qwaylandxdgshell.h.

Referenced by QWaylandXdgSurface(), QtWayland::XdgPopupIntegration::XdgPopupIntegration(), QtWayland::XdgToplevelIntegration::XdgToplevelIntegration(), initialize(), and QWaylandXdgShellPrivate::registerXdgSurface().

◆ toplevel

QWaylandXdgSurface::toplevel

read

\qmlproperty XdgToplevel XdgSurface::toplevel

This property holds the properties and methods that are specific to the toplevel XdgSurface.

See also: popup, XdgShell::toplevelCreated

This property holds the properties and methods that are specific to the toplevel QWaylandXdgSurface.

See also: QWaylandXdgSurface::popup, QWaylandXdgShell::toplevelCreated

Definition at line 59 of file qwaylandxdgshell.h.

◆ windowGeometry

QWaylandXdgSurface::windowGeometry

read

\qmlproperty rect XdgSurface::windowGeometry

This property holds the window geometry of the QWaylandXdgSurface. The window geometry describes the window's visible bounds from the user's perspective. The geometry includes title bars and borders if drawn by the client, but excludes drop shadows. It is meant to be used for aligning and tiling windows.

Definition at line 59 of file qwaylandxdgshell.h.

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

qtwayland/src/compositor/extensions/qwaylandxdgshell.h
qtwayland/src/compositor/extensions/qwaylandxdgshell.cpp

Signals

Public Member Functions

Static Public Member Functions

Properties

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QWaylandXdgSurface() [1/2]

◆ QWaylandXdgSurface() [2/2]

Member Function Documentation

◆ fromResource()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ interface()

◆ interfaceName()

◆ popup()

◆ popupCreated

◆ shell()

◆ shellChanged

◆ surface()

◆ surfaceChanged

◆ toplevel()

◆ toplevelCreated

◆ windowGeometry()

◆ windowGeometryChanged

◆ windowType()

Property Documentation

◆ popup

◆ shell

◆ surface

◆ toplevel

◆ windowGeometry