KWaylandServer::XdgToplevelInterface

KWaylandServer::XdgToplevelInterface Class Reference

#include <xdgshell_interface.h>

Inheritance diagram for KWaylandServer::XdgToplevelInterface:

Public Types

enum  State {
  MaximizedHorizontal = 0x1, MaximizedVertical = 0x2, FullScreen = 0x4, Resizing = 0x8,
  Activated = 0x10, TiledLeft = 0x20, TiledTop = 0x40, TiledRight = 0x80,
  TiledBottom = 0x100, Maximized = MaximizedHorizontal | MaximizedVertical
}
 
typedef QFlags< State > States
 

Signals

void fullscreenRequested (KWaylandServer::OutputInterface *output)
 
void initializeRequested ()
 
void maximizeRequested ()
 
void maximumSizeChanged (const QSize &size)
 
void minimizeRequested ()
 
void minimumSizeChanged (const QSize &size)
 
void moveRequested (KWaylandServer::SeatInterface *seat, quint32 serial)
 
void parentXdgToplevelChanged ()
 
void resetOccurred ()
 
void resizeRequested (KWaylandServer::SeatInterface *seat, Qt::Edges edges, quint32 serial)
 
void unfullscreenRequested ()
 
void unmaximizeRequested ()
 
void windowClassChanged (const QString &windowClass)
 
void windowMenuRequested (KWaylandServer::SeatInterface *seat, const QPoint &pos, quint32 serial)
 
void windowTitleChanged (const QString &windowTitle)
 

Public Member Functions

 XdgToplevelInterface (XdgSurfaceInterface *surface,::wl_resource *resource)
 
 ~XdgToplevelInterface () override
 
bool isConfigured () const
 
QSize maximumSize () const
 
QSize minimumSize () const
 
XdgToplevelInterfaceparentXdgToplevel () const
 
void sendClose ()
 
quint32 sendConfigure (const QSize &size, const States &states)
 
XdgShellInterfaceshell () const
 
SurfaceInterfacesurface () const
 
QString windowClass () const
 
QString windowTitle () const
 
XdgSurfaceInterfacexdgSurface () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static XdgToplevelInterfaceget (::wl_resource *resource)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

The XdgToplevelInterface class represents a surface with window-like functionality such as maximize, fullscreen, resizing, minimizing, etc.

XdgToplevelInterface corresponds to the Wayland interface xdg_toplevel.

Since
5.20

Definition at line 197 of file xdgshell_interface.h.

Constructor & Destructor Documentation

KWaylandServer::XdgToplevelInterface::XdgToplevelInterface ( XdgSurfaceInterface surface,
::wl_resource *  resource 
)

Constructs an XdgToplevelInterface for the given xdg-surface surface.

Definition at line 517 of file xdgshell_interface.cpp.

KWaylandServer::XdgToplevelInterface::~XdgToplevelInterface ( )
override

Destructs the XdgToplevelInterface object.

Definition at line 523 of file xdgshell_interface.cpp.

Member Function Documentation

void KWaylandServer::XdgToplevelInterface::fullscreenRequested ( KWaylandServer::OutputInterface output)
signal

This signal is emitted when the toplevel wants to be shown in the full screen mode.

XdgToplevelInterface * KWaylandServer::XdgToplevelInterface::get ( ::wl_resource *  resource)
static

Returns the XdgToplevelInterface for the specified wayland resource object resource.

Definition at line 625 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::initializeRequested ( )
signal

This signal is emitted when the xdg-toplevel has commited the initial state and wants to be configured.

After initializing the toplevel, you must send a configure event.

bool KWaylandServer::XdgToplevelInterface::isConfigured ( ) const

Returns true if the toplevel has been configured; otherwise returns false.

Definition at line 542 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::maximizeRequested ( )
signal

This signal is emitted when the toplevel surface wants to become maximized.

QSize KWaylandServer::XdgToplevelInterface::maximumSize ( ) const

Returns the maximum window geometry size of the toplevel surface.

Definition at line 567 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::maximumSizeChanged ( const QSize size)
signal

This signal is emitted when the toplevel's maximum size has been changed.

void KWaylandServer::XdgToplevelInterface::minimizeRequested ( )
signal

This signal is emitted when the toplevel wants to be iconified.

QSize KWaylandServer::XdgToplevelInterface::minimumSize ( ) const

Returns the minimum window geometry size of the toplevel surface.

Definition at line 562 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::minimumSizeChanged ( const QSize size)
signal

This signal is emitted when the toplevel's minimum size has been changed.

void KWaylandServer::XdgToplevelInterface::moveRequested ( KWaylandServer::SeatInterface seat,
quint32  serial 
)
signal

This signal is emitted when the toplevel wants to be interactively moved.

The seat and the serial indicate the user action in response to which this request has been issued.

XdgToplevelInterface * KWaylandServer::XdgToplevelInterface::parentXdgToplevel ( ) const

Returns the parent XdgToplevelInterface above which this toplevel is stacked.

Definition at line 547 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::parentXdgToplevelChanged ( )
signal

This signal is emitted when the parent toplevel has changed.

void KWaylandServer::XdgToplevelInterface::resetOccurred ( )
signal

This signal is emitted when the toplevel has been unmapped and its state has been reset.

void KWaylandServer::XdgToplevelInterface::resizeRequested ( KWaylandServer::SeatInterface seat,
Qt::Edges  edges,
quint32  serial 
)
signal

This signal is emitted when the toplevel wants to be interactively resized along the specified window edges edges.

The seat and the serial indicate the user action in response to which this request has been issued.

void KWaylandServer::XdgToplevelInterface::sendClose ( )

Sends a close event to the client.

The client may choose to ignore this request.

Definition at line 620 of file xdgshell_interface.cpp.

quint32 KWaylandServer::XdgToplevelInterface::sendConfigure ( const QSize size,
const States states 
)

Sends a configure event to the client.

size specifies the new window geometry size. A size of zero means the client should decide its own window dimensions.

Definition at line 572 of file xdgshell_interface.cpp.

XdgShellInterface * KWaylandServer::XdgToplevelInterface::shell ( ) const

Returns the XdgShellInterface for this XdgToplevelInterface.

This is equivalent to xdgSurface()->shell().

Definition at line 527 of file xdgshell_interface.cpp.

SurfaceInterface * KWaylandServer::XdgToplevelInterface::surface ( ) const

Returns the SurfaceInterface associated with the XdgToplevelInterface.

Definition at line 537 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::unfullscreenRequested ( )
signal

This signal is emitted when the toplevel surface wants to leave the full screen mode.

void KWaylandServer::XdgToplevelInterface::unmaximizeRequested ( )
signal

This signal is emitted when the toplevel surface wants to become unmaximized.

QString KWaylandServer::XdgToplevelInterface::windowClass ( ) const

Returns the window class of the toplevel surface.

Definition at line 557 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::windowClassChanged ( const QString windowClass)
signal

This signal is emitted when the toplevel's application id has been changed.

void KWaylandServer::XdgToplevelInterface::windowMenuRequested ( KWaylandServer::SeatInterface seat,
const QPoint pos,
quint32  serial 
)
signal

This signal is emitted when the toplevel has requested the window menu to be shown at pos.

The seat and the serial indicate the user action that triggerred the request.

QString KWaylandServer::XdgToplevelInterface::windowTitle ( ) const

Returns the window title of the toplevel surface.

Definition at line 552 of file xdgshell_interface.cpp.

void KWaylandServer::XdgToplevelInterface::windowTitleChanged ( const QString windowTitle)
signal

This signal is emitted when the toplevel's title has been changed.

XdgSurfaceInterface * KWaylandServer::XdgToplevelInterface::xdgSurface ( ) const

Returns the XdgSurfaceInterface associated with the XdgToplevelInterface.

Definition at line 532 of file xdgshell_interface.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Sep 18 2020 23:06:16 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.