#include <qwaylandqtshell.h>

Inheritance diagram for QWaylandQtShellSurface:

Collaboration diagram for QWaylandQtShellSurface:

Public Types
enum	CapabilityFlag { InteractiveMove = 1 , InteractiveResize = 2 }

Signals
void	surfaceChanged ()

void	windowFlagsChanged ()

void	windowStateChanged ()

void	windowGeometryChanged ()

void	minimumSizeChanged ()

void	maximumSizeChanged ()

void	positionAutomaticChanged ()

void	startMove ()

void	startResize (Qt::Edges edges)

void	windowTitleChanged ()

void	frameMarginChanged ()

void	raiseRequested ()

void	lowerRequested ()

void	activeChanged ()

void	capabilitiesChanged ()

Signals inherited from QWaylandShellSurface
void	windowTypeChanged ()

void	modalChanged ()

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
	QWaylandQtShellSurface ()
	\qmltype QtShellSurface \instantiates QWaylandQtShellSurface \inqmlmodule QtWayland.Compositor.QtShell

	QWaylandQtShellSurface (QWaylandQtShell application, QWaylandSurface surface, const QWaylandResource &resource)

void	initialize (QWaylandQtShell qtShell, QWaylandSurface surface, const QWaylandResource &resource)
	\qmlmethod void QtShellSurface::initialize(QtShell qtShell, WaylandSurface surface, WaylandResource resource)

QWaylandSurface *	surface () const
	\qmlproperty WaylandSurface QtShellSurface::surface

QRect	windowGeometry () const
	\qmlproperty rect QtShellSurface::windowGeometry

void	setWindowPosition (const QPoint &position)

QPoint	windowPosition () const
	\qmlproperty point QtShellSurface::windowPosition

Q_INVOKABLE void	requestWindowGeometry (uint windowState, const QRect &windowGeometry)
	\qmlmethod void QtShellSurface::requestWindowGeometry(int windowState, rect windowGeometry)

QSize	minimumSize () const
	\qmlproperty size QtShellSurface::minimumSize

QSize	maximumSize () const
	\qmlproperty size QtShellSurface::maximumSize

void	setFrameMargins (const QMargins &margins)

int	frameMarginLeft () const

void	setFrameMarginLeft (int left)
	\qmlproperty int QtShellSurface::frameMarginLeft

int	frameMarginRight () const

void	setFrameMarginRight (int right)
	\qmlproperty int QtShellSurface::frameMarginRight

int	frameMarginTop () const

void	setFrameMarginTop (int top)
	\qmlproperty int QtShellSurface::frameMarginTop

int	frameMarginBottom () const

void	setFrameMarginBottom (int bottom)
	\qmlproperty int QtShellSurface::frameMarginBottom

bool	positionAutomatic () const

bool	active () const

void	setActive (bool active)
	\qmlproperty bool QtShellSurface::active

QString	windowTitle () const
	\qmlproperty string QtShellSurface::windowTitle

uint	windowFlags () const
	\qmlproperty int QtShellSurface::windowFlags

Q_INVOKABLE void	sendClose ()
	\qmlmethod void QtShellSurface::sendClose()

uint	windowState () const
	\qmlproperty int QtShellSurface::windowState

void	setWindowState (uint windowState)

CapabilityFlags	capabilities () const

void	setCapabilities (CapabilityFlags capabilities)
	\qmlproperty enum QtShellSurface::capabilities

Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandQtShellSurface >
	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

bool	modal () 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.

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 wl_interface *	interface ()
	Returns the Wayland interface for the QWaylandQtShellSurface.

static QByteArray	interfaceName ()

static QWaylandSurfaceRole *	role ()
	Returns the surface role for the QWaylandQtShellSurface.

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

Static Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandQtShellSurface >
static QWaylandQtShellSurface *	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
QWaylandSurface *	surface

uint	windowFlags

uint	windowState

QString	windowTitle

QRect	windowGeometry

QPoint	windowPosition

bool	positionAutomatic

QSize	minimumSize

QSize	maximumSize

int	frameMarginLeft

int	frameMarginRight

int	frameMarginTop

int	frameMarginBottom

bool	active

CapabilityFlags	capabilities

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

bool	modal
	\qmlproperty bool QtWayland.Compositor::ShellSurface::modal

Properties inherited from QObject
QString	objectName
	the name of this object

Private Member Functions
void	initialize () override

Friends
class	QWaylandQtShellChrome

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

Protected Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandQtShellSurface >
	QWaylandShellSurfaceTemplate (QWaylandShellSurfacePrivate &dd)

	QWaylandShellSurfaceTemplate (QWaylandObject *container, QWaylandShellSurfacePrivate &dd)

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

	QWaylandShellSurface (QWaylandObject *container, QWaylandShellSurfacePrivate &dd)

void	setModal (bool newModal)

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

Definition at line 58 of file qwaylandqtshell.h.

Member Enumeration Documentation

◆ CapabilityFlag

enum QWaylandQtShellSurface::CapabilityFlag

Enumerator
InteractiveMove
InteractiveResize

Definition at line 82 of file qwaylandqtshell.h.

Constructor & Destructor Documentation

◆ QWaylandQtShellSurface() [1/2]

QWaylandQtShellSurface::QWaylandQtShellSurface ( )

\qmltype QtShellSurface \instantiates QWaylandQtShellSurface \inqmlmodule QtWayland.Compositor.QtShell

Since: 6.3

Provides a simple way to identify and resize a surface.

This type is part of the \l{QtShell} extension and provides a way to extend the functionality of an existing WaylandSurface with window management functionality.

The QtShellSurface type holds the core functionality needed to create a compositor that supports the QtShell extension. It can be used directly, or via the QtShellChrome type, depending on what the needs of the compositor are. The QtShellChrome type has default behaviors and convenience APIs for working with QtShellSurface objects.

\qmlsignal void QtShellSurface::startMove()

The client has requested an interactive move operation in the compositor by calling \l{QWindow::startSystemMove()}.

See also: capabilities

\qmlsignal void QtShellSurface::startResize(enum edges)

The client has requested an interactive resize operation in the compositor by calling \l{QWindow::startSystemResize()}.

The edges provides information about which edge of the window should be moved during the resize. It is a mask of the following values: \list

See also: capabilities

Definition at line 250 of file qwaylandqtshell.cpp.

◆ QWaylandQtShellSurface() [2/2]

QWaylandQtShellSurface::QWaylandQtShellSurface	(	QWaylandQtShell *	application,
		QWaylandSurface *	surface,
		const QWaylandResource &	resource )

Definition at line 255 of file qwaylandqtshell.cpp.

References initialize(), and surface.

Here is the call graph for this function:

Member Function Documentation

◆ active()

bool QWaylandQtShellSurface::active ( ) const

Definition at line 557 of file qwaylandqtshell.cpp.

References d.

◆ activeChanged

void QWaylandQtShellSurface::activeChanged ( )

signal

Referenced by setActive().

Here is the caller graph for this function:

◆ capabilities()

QWaylandQtShellSurface::CapabilityFlags QWaylandQtShellSurface::capabilities ( ) const

Definition at line 590 of file qwaylandqtshell.cpp.

References d.

◆ capabilitiesChanged

void QWaylandQtShellSurface::capabilitiesChanged ( )

signal

Referenced by setCapabilities().

Here is the caller graph for this function:

◆ frameMarginBottom()

int QWaylandQtShellSurface::frameMarginBottom ( ) const

Definition at line 495 of file qwaylandqtshell.cpp.

References d.

◆ frameMarginChanged

void QWaylandQtShellSurface::frameMarginChanged ( )

signal

Referenced by setFrameMarginBottom(), setFrameMarginLeft(), setFrameMarginRight(), setFrameMargins(), and setFrameMarginTop().

Here is the caller graph for this function:

◆ frameMarginLeft()

int QWaylandQtShellSurface::frameMarginLeft ( ) const

Definition at line 421 of file qwaylandqtshell.cpp.

References d.

◆ frameMarginRight()

int QWaylandQtShellSurface::frameMarginRight ( ) const

Definition at line 444 of file qwaylandqtshell.cpp.

References d.

◆ frameMarginTop()

int QWaylandQtShellSurface::frameMarginTop ( ) const

Definition at line 467 of file qwaylandqtshell.cpp.

References d.

◆ fromResource()

QWaylandQtShellSurface * QWaylandQtShellSurface::fromResource ( ::wl_resource * resource )

static

Returns the QWaylandQtShellSurface corresponding to the resource.

Definition at line 688 of file qwaylandqtshell.cpp.

Referenced by QWaylandQtShellPrivate::zqt_shell_v1_surface_create().

Here is the caller graph for this function:

◆ initialize() [1/2]

void QWaylandQtShellSurface::initialize ( )

overrideprivatevirtual

Reimplemented from QWaylandCompositorExtension.

Definition at line 705 of file qwaylandqtshell.cpp.

References QWaylandCompositorExtension::initialize().

Referenced by QWaylandQtShellSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize() [2/2]

void QWaylandQtShellSurface::initialize	(	QWaylandQtShell *	qtShell,
		QWaylandSurface *	surface,
		const QWaylandResource &	resource )

\qmlmethod void QtShellSurface::initialize(QtShell qtShell, WaylandSurface surface, WaylandResource resource)

Initializes the QtShellSurface, associating it with the given qtShell, surface, and resource.

Definition at line 267 of file qwaylandqtshell.cpp.

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

Here is the call graph for this function:

◆ interface()

const wl_interface * QWaylandQtShellSurface::interface ( )

static

Returns the Wayland interface for the QWaylandQtShellSurface.

Definition at line 667 of file qwaylandqtshell.cpp.

◆ interfaceName()

QByteArray QWaylandQtShellSurface::interfaceName ( )

static

Definition at line 672 of file qwaylandqtshell.cpp.

◆ lowerRequested

void QWaylandQtShellSurface::lowerRequested ( )

signal

◆ maximumSize()

QSize QWaylandQtShellSurface::maximumSize ( ) const

\qmlproperty size QtShellSurface::maximumSize

The maximum size of the window if the client has specified one. Otherwise an invalid size.

Definition at line 353 of file qwaylandqtshell.cpp.

References d.

◆ maximumSizeChanged

void QWaylandQtShellSurface::maximumSizeChanged ( )

signal

◆ minimumSize()

QSize QWaylandQtShellSurface::minimumSize ( ) const

\qmlproperty size QtShellSurface::minimumSize

The minimum size of the window if the client has specified one. Otherwise an invalid size.

Definition at line 342 of file qwaylandqtshell.cpp.

References d.

◆ minimumSizeChanged

void QWaylandQtShellSurface::minimumSizeChanged ( )

signal

◆ positionAutomatic()

bool QWaylandQtShellSurface::positionAutomatic ( ) const

Definition at line 489 of file qwaylandqtshell.cpp.

References d.

◆ positionAutomaticChanged

void QWaylandQtShellSurface::positionAutomaticChanged ( )

signal

Referenced by setWindowPosition().

Here is the caller graph for this function:

◆ raiseRequested

void QWaylandQtShellSurface::raiseRequested ( )

signal

◆ requestWindowGeometry()

void QWaylandQtShellSurface::requestWindowGeometry	(	uint	windowState,
		const QRect &	windowGeometry )

\qmlmethod void QtShellSurface::requestWindowGeometry(int windowState, rect windowGeometry)

Requests a new windowState and windowGeometry for the QtShellSurface. The state and geometry is updated when the client has acknowledged the request (at which point it is safe to assume that the surface's buffer has been resized if necessary).

Definition at line 366 of file qwaylandqtshell.cpp.

References d, QRect::isValid(), windowGeometry, and windowState.

Referenced by QWaylandQtShellChromePrivate::updateDecorationInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ role()

QWaylandSurfaceRole * QWaylandQtShellSurface::role ( )

static

Returns the surface role for the QWaylandQtShellSurface.

Definition at line 680 of file qwaylandqtshell.cpp.

Referenced by QWaylandQtShellPrivate::zqt_shell_v1_surface_create().

Here is the caller graph for this function:

◆ sendClose()

void QWaylandQtShellSurface::sendClose ( )

\qmlmethod void QtShellSurface::sendClose()

Requests that the client application closes itself.

Definition at line 517 of file qwaylandqtshell.cpp.

References d.

◆ setActive()

void QWaylandQtShellSurface::setActive ( bool active )

\qmlproperty bool QtShellSurface::active

This property holds whether the surface is currently considered active.

Note: There are no restrictions in QtShellSurface that prevents multiple surfaces from being active simultaneously. Such logic must either be implemented by the compositor itself, or by using the QtShellChrome type, which will automatically manage the activation state of surfaces.

Definition at line 543 of file qwaylandqtshell.cpp.

References active, activeChanged(), compositor, d, emit, QWaylandSeat::setKeyboardFocus(), and surface.

Here is the call graph for this function:

◆ setCapabilities()

void QWaylandQtShellSurface::setCapabilities ( CapabilityFlags capabilities )

\qmlproperty enum QtShellSurface::capabilities

This property holds the capabilities of the compositor. By default, no special capabilities are enabled.

\list

QtShellSurface.InteractiveMove The client can trigger a server-side interactive move operation using \l{QWindow::startSystemMove()}. The compositor will be notified of this through the \l{startMove()} signal.
QtShellSurface.InteractiveResize The client can trigger a server-side interactive resize operation using \l{QWindow::startSystemResize()}. The compositor will be notified of this through the \l{startResize()} signal. \endlist

Definition at line 578 of file qwaylandqtshell.cpp.

References capabilities, capabilitiesChanged(), d, and emit.

Here is the call graph for this function:

◆ setFrameMarginBottom()

void QWaylandQtShellSurface::setFrameMarginBottom ( int bottom )

\qmlproperty int QtShellSurface::frameMarginBottom

This holds the window frame margin below the surface.

Definition at line 478 of file qwaylandqtshell.cpp.

References d, emit, and frameMarginChanged().

Here is the call graph for this function:

◆ setFrameMarginLeft()

void QWaylandQtShellSurface::setFrameMarginLeft ( int left )

\qmlproperty int QtShellSurface::frameMarginLeft

This holds the window frame margin to the left of the surface.

Definition at line 409 of file qwaylandqtshell.cpp.

References d, emit, and frameMarginChanged().

Here is the call graph for this function:

◆ setFrameMarginRight()

void QWaylandQtShellSurface::setFrameMarginRight ( int right )

\qmlproperty int QtShellSurface::frameMarginRight

This holds the window frame margin to the right of the surface.

Definition at line 432 of file qwaylandqtshell.cpp.

References d, emit, and frameMarginChanged().

Here is the call graph for this function:

◆ setFrameMargins()

void QWaylandQtShellSurface::setFrameMargins ( const QMargins & margins )

Definition at line 392 of file qwaylandqtshell.cpp.

References d, emit, and frameMarginChanged().

Here is the call graph for this function:

◆ setFrameMarginTop()

void QWaylandQtShellSurface::setFrameMarginTop ( int top )

\qmlproperty int QtShellSurface::frameMarginTop

This holds the window frame margin above the surface.

Definition at line 456 of file qwaylandqtshell.cpp.

References d, emit, and frameMarginChanged().

Here is the call graph for this function:

◆ setWindowPosition()

void QWaylandQtShellSurface::setWindowPosition ( const QPoint & position )

Definition at line 312 of file qwaylandqtshell.cpp.

References d, emit, position(), positionAutomaticChanged(), and windowGeometryChanged().

Here is the call graph for this function:

◆ setWindowState()

void QWaylandQtShellSurface::setWindowState ( uint windowState )

◆ startMove

void QWaylandQtShellSurface::startMove ( )

signal

◆ startResize

void QWaylandQtShellSurface::startResize ( Qt::Edges edges )

signal

◆ surface()

QWaylandSurface * QWaylandQtShellSurface::surface ( ) const

\qmlproperty WaylandSurface QtShellSurface::surface

This property holds the surface associated with this QtShellSurface.

Definition at line 289 of file qwaylandqtshell.cpp.

References d.

◆ surfaceChanged

void QWaylandQtShellSurface::surfaceChanged ( )

signal

Referenced by initialize().

Here is the caller graph for this function:

◆ windowFlags()

uint QWaylandQtShellSurface::windowFlags ( ) const

\qmlproperty int QtShellSurface::windowFlags

This property holds the window flags of the QtShellSurface.

Definition at line 506 of file qwaylandqtshell.cpp.

References d.

◆ windowFlagsChanged

void QWaylandQtShellSurface::windowFlagsChanged ( )

signal

◆ windowGeometry()

QRect QWaylandQtShellSurface::windowGeometry ( ) const

\qmlproperty rect QtShellSurface::windowGeometry

This property holds the window geometry of the shell surface.

Definition at line 331 of file qwaylandqtshell.cpp.

References d.

◆ windowGeometryChanged

void QWaylandQtShellSurface::windowGeometryChanged ( )

signal

Referenced by setWindowPosition().

Here is the caller graph for this function:

◆ windowPosition()

QPoint QWaylandQtShellSurface::windowPosition ( ) const

\qmlproperty point QtShellSurface::windowPosition

This property holds the position of the shell surface relative to its output.

Definition at line 306 of file qwaylandqtshell.cpp.

References d.

◆ windowState()

uint QWaylandQtShellSurface::windowState ( ) const

\qmlproperty int QtShellSurface::windowState

This property holds the window state of the QtShellSurface.

Note: When \l{requestWindowGeometry()} is called to update state of the surface, the windowState property will not be updated until the client has acknowledged the state change.

Definition at line 604 of file qwaylandqtshell.cpp.

References d.

◆ windowStateChanged

void QWaylandQtShellSurface::windowStateChanged ( )

signal

◆ windowTitle()

QString QWaylandQtShellSurface::windowTitle ( ) const

\qmlproperty string QtShellSurface::windowTitle

This property holds the window title of the QtShellSurface.

Definition at line 528 of file qwaylandqtshell.cpp.

References d.

◆ windowTitleChanged

void QWaylandQtShellSurface::windowTitleChanged ( )

signal

Friends And Related Symbol Documentation

◆ QWaylandQtShellChrome

friend class QWaylandQtShellChrome

friend

Definition at line 167 of file qwaylandqtshell.h.

Property Documentation

◆ active

bool QWaylandQtShellSurface::active

readwrite

Definition at line 76 of file qwaylandqtshell.h.

Referenced by setActive().

◆ capabilities

CapabilityFlags QWaylandQtShellSurface::capabilities

readwrite

Definition at line 77 of file qwaylandqtshell.h.

Referenced by setCapabilities().

◆ frameMarginBottom

int QWaylandQtShellSurface::frameMarginBottom

readwrite

Definition at line 75 of file qwaylandqtshell.h.

◆ frameMarginLeft

int QWaylandQtShellSurface::frameMarginLeft

readwrite

Definition at line 72 of file qwaylandqtshell.h.

◆ frameMarginRight

int QWaylandQtShellSurface::frameMarginRight

readwrite

Definition at line 73 of file qwaylandqtshell.h.

◆ frameMarginTop

int QWaylandQtShellSurface::frameMarginTop

readwrite

Definition at line 74 of file qwaylandqtshell.h.

◆ maximumSize

QSize QWaylandQtShellSurface::maximumSize

read

Definition at line 71 of file qwaylandqtshell.h.

Referenced by QWaylandQtShellChromePrivate::updateDecorationInteraction().

◆ minimumSize

QSize QWaylandQtShellSurface::minimumSize

read

Definition at line 70 of file qwaylandqtshell.h.

Referenced by QWaylandQtShellChromePrivate::updateDecorationInteraction().

◆ positionAutomatic

bool QWaylandQtShellSurface::positionAutomatic

read

Definition at line 69 of file qwaylandqtshell.h.

◆ surface

QWaylandSurface * QWaylandQtShellSurface::surface

read

Definition at line 63 of file qwaylandqtshell.h.

Referenced by QtWayland::QtShellIntegration::QtShellIntegration(), QWaylandQtShellSurface(), initialize(), and setActive().

◆ windowFlags

uint QWaylandQtShellSurface::windowFlags

read

Definition at line 64 of file qwaylandqtshell.h.

◆ windowGeometry

QRect QWaylandQtShellSurface::windowGeometry

read

Definition at line 67 of file qwaylandqtshell.h.

Referenced by requestWindowGeometry(), and QWaylandQtShellChromePrivate::updateDecorationInteraction().

◆ windowPosition

QPoint QWaylandQtShellSurface::windowPosition

readwrite

Definition at line 68 of file qwaylandqtshell.h.

◆ windowState

uint QWaylandQtShellSurface::windowState

read

Definition at line 65 of file qwaylandqtshell.h.

Referenced by requestWindowGeometry(), and QWaylandQtShellChromePrivate::updateDecorationInteraction().

◆ windowTitle

QString QWaylandQtShellSurface::windowTitle

read

Definition at line 66 of file qwaylandqtshell.h.

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

qtwayland/src/imports/compositor-extensions/qtshell/qwaylandqtshell.h (811f060c37a58580e0697d0beb34a6f91efeeb41)
qtwayland/src/imports/compositor-extensions/qtshell/qwaylandqtshell.cpp (ab97eaea8b476cd6168527183a13c3c6dfbc5746)

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CapabilityFlag

Constructor & Destructor Documentation

◆ QWaylandQtShellSurface() [1/2]

◆ QWaylandQtShellSurface() [2/2]

Member Function Documentation

◆ active()

◆ activeChanged

◆ capabilities()

◆ capabilitiesChanged

◆ frameMarginBottom()

◆ frameMarginChanged

◆ frameMarginLeft()

◆ frameMarginRight()

◆ frameMarginTop()

◆ fromResource()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ interface()

◆ interfaceName()

◆ lowerRequested

◆ maximumSize()

◆ maximumSizeChanged

◆ minimumSize()

◆ minimumSizeChanged

◆ positionAutomatic()

◆ positionAutomaticChanged

◆ raiseRequested

◆ requestWindowGeometry()

◆ role()

◆ sendClose()

◆ setActive()

◆ setCapabilities()

◆ setFrameMarginBottom()

◆ setFrameMarginLeft()

◆ setFrameMarginRight()

◆ setFrameMargins()

◆ setFrameMarginTop()

◆ setWindowPosition()

◆ setWindowState()

◆ startMove

◆ startResize

◆ surface()

◆ surfaceChanged

◆ windowFlags()

◆ windowFlagsChanged

◆ windowGeometry()

◆ windowGeometryChanged

◆ windowPosition()

◆ windowState()

◆ windowStateChanged

◆ windowTitle()

◆ windowTitleChanged

Friends And Related Symbol Documentation

◆ QWaylandQtShellChrome

Property Documentation

◆ active

◆ capabilities

◆ frameMarginBottom

◆ frameMarginLeft

◆ frameMarginRight

◆ frameMarginTop

◆ maximumSize

◆ minimumSize

◆ positionAutomatic

◆ surface

◆ windowFlags

◆ windowGeometry

◆ windowPosition

◆ windowState

◆ windowTitle