QWaylandXdgToplevelV6 Class

The QWaylandXdgToplevelV6 class represents the toplevel window specific parts of an xdg surface. More...

Header: #include <QWaylandXdgToplevelV6>
qmake: QT += waylandcompositor
Since: Qt 5.10
Inherits: QObject

Public Types

enum State { MaximizedState, FullscreenState, ResizingState, ActivatedState }

Properties

  • 1 property inherited from QObject

Public Functions

QWaylandXdgToplevelV6(QWaylandXdgSurfaceV6 *xdgSurface, QWaylandResource &resource)
bool activated() const
QString appId() const
bool fullscreen() const
QSize maxSize() const
bool maximized() const
QSize minSize() const
QWaylandXdgToplevelV6 *parentToplevel() const
bool resizing() const
void sendClose()
uint sendConfigure(const QSize &size, const QVector<QWaylandXdgToplevelV6::State> &states)
uint sendConfigure(const QSize &size, const QVector<int> &states)
uint sendFullscreen(const QSize &size)
uint sendMaximized(const QSize &size)
uint sendResizing(const QSize &maxSize)
uint sendUnmaximized(const QSize &size = QSize(0, 0))
QSize sizeForResize(const QSizeF &size, const QPointF &delta, Qt::Edges edges) const
QVector<QWaylandXdgToplevelV6::State> states() const
QString title() const
  • 31 public functions inherited from QObject

Signals

void activatedChanged()
void appIdChanged()
void fullscreenChanged()
void maxSizeChanged()
void maximizedChanged()
void minSizeChanged()
void parentToplevelChanged()
void resizingChanged()
void setFullscreen(QWaylandOutput *output)
void setMaximized()
void setMinimized()
void showWindowMenu(QWaylandSeat *seat, const QPoint &localSurfacePosition)
void startMove(QWaylandSeat *seat)
void startResize(QWaylandSeat *seat, Qt::Edges edges)
void statesChanged()
void titleChanged()
void unsetFullscreen()
void unsetMaximized()

Static Public Members

QWaylandSurfaceRole *role()
const QMetaObject staticMetaObject
  • 9 static public members inherited from QObject

Additional Inherited Members

  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QWaylandXdgToplevelV6 class represents the toplevel window specific parts of an xdg surface.

This class is part of the QWaylandXdgShellV6 extension and provides a way to extend the functionality of an QWaylandXdgSurfaceV6 with features specific to desktop-style windows.

It corresponds to the Wayland interface zxdg_toplevel_v6.

Member Type Documentation

enum QWaylandXdgToplevelV6::State

Property Documentation

activated : const bool

This property holds whether toplevel is drawing itself as having input focus.

Access functions:

bool activated() const

Notifier signal:

void activatedChanged()

appId : const QString

This property holds the app id of the QWaylandXdgToplevelV6.

Access functions:

QString appId() const

Notifier signal:

void appIdChanged()

fullscreen : const bool

This property holds whether the client has acknowledged that it should be fullscreen.

Access functions:

bool fullscreen() const

Notifier signal:

void fullscreenChanged()

maxSize : const QSize

This property holds the maximum size of the QWaylandXdgToplevelV6.

The compositor is free to ignore this value and request a larger size.

Access functions:

QSize maxSize() const

Notifier signal:

void maxSizeChanged()

maximized : const bool

This property holds whether the client has acknowledged that it should be maximized.

Access functions:

bool maximized() const

Notifier signal:

void maximizedChanged()

minSize : const QSize

This property holds the minimum size of the QWaylandXdgToplevelV6.

The compositor is free to ignore this value and request a smaller size.

Access functions:

QSize minSize() const

Notifier signal:

void minSizeChanged()

parentToplevel : QWaylandXdgToplevelV6* const

This property holds the XdgToplevelV6 parent of this XdgToplevelV6.

Access functions:

QWaylandXdgToplevelV6 *parentToplevel() const

Notifier signal:

void parentToplevelChanged()

resizing : const bool

This property holds whether the client has acknowledged that it is being resized.

Access functions:

bool resizing() const

Notifier signal:

void resizingChanged()

states : const QList<int>

This property holds the last states the client acknowledged for this QWaylandToplevelV6.

Notifier signal:

void statesChanged()

title : const QString

This property holds the title of the QWaylandXdgToplevelV6.

Access functions:

QString title() const

Notifier signal:

void titleChanged()

Member Function Documentation

QWaylandXdgToplevelV6::QWaylandXdgToplevelV6(QWaylandXdgSurfaceV6 *xdgSurface, QWaylandResource &resource)

Constructs a QWaylandXdgToplevelV6 for the given xdgSurface and resource.

[static] QWaylandSurfaceRole *QWaylandXdgToplevelV6::role()

Returns the surface role for the QWaylandToplevelV6.

void QWaylandXdgToplevelV6::sendClose()

Sends a close event to the client. The client may choose to ignore the event.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

uint QWaylandXdgToplevelV6::sendConfigure(const QSize &size, const QVector<QWaylandXdgToplevelV6::State> &states)

Sends a configure event to the client. Parameter size contains the pixel size of the surface. A size of zero means the client is free to decide the size. Known states are enumerated in QWaylandXdgToplevelV6::State.

uint QWaylandXdgToplevelV6::sendConfigure(const QSize &size, const QVector<int> &states)

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

uint QWaylandXdgToplevelV6::sendFullscreen(const QSize &size)

Convenience for sending a configure event with the fullscreen state set, and maximized and resizing removed. The activated state is left in its current state.

size is the new size of the window.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also sendUnmaximized.

uint QWaylandXdgToplevelV6::sendMaximized(const QSize &size)

Convenience for sending a configure event with the maximized state set, and fullscreen and resizing removed. The activated state is left in its current state.

size is the new size of the window.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

uint QWaylandXdgToplevelV6::sendResizing(const QSize &maxSize)

Convenience for sending a configure event with the resizing state set, and maximized and fullscreen removed. The activated state is left in its current state.

maxSize is the new size of the window.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

uint QWaylandXdgToplevelV6::sendUnmaximized(const QSize &size = QSize(0, 0))

Convenience for sending a configure event with the maximized, fullscreen and resizing states removed, and fullscreen and resizing removed. The activated state is left in its current state.

size is the new size of the window. If size is zero, the client decides the size.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[signal] void QWaylandXdgToplevelV6::setFullscreen(QWaylandOutput *output)

See also fullscreen().

[signal] void QWaylandXdgToplevelV6::setMaximized()

See also maximized().

[signal] void QWaylandXdgToplevelV6::setMinimized()

[signal] void QWaylandXdgToplevelV6::showWindowMenu(QWaylandSeat *seat, const QPoint &localSurfacePosition)

QSize QWaylandXdgToplevelV6::sizeForResize(const QSizeF &size, const QPointF &delta, Qt::Edges edges) const

Convenience for computing the new size given the current size, a delta, and the edges active in the drag.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[signal] void QWaylandXdgToplevelV6::startMove(QWaylandSeat *seat)

[signal] void QWaylandXdgToplevelV6::startResize(QWaylandSeat *seat, Qt::Edges edges)

QVector<QWaylandXdgToplevelV6::State> QWaylandXdgToplevelV6::states() const

[signal] void QWaylandXdgToplevelV6::unsetFullscreen()

[signal] void QWaylandXdgToplevelV6::unsetMaximized()

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.