KWayland::Client::ServerSideDecoration
#include <server_decoration.h>

Public Types | |
enum | Mode { Mode::None, Mode::Client, Mode::Server } |
Signals | |
void | modeChanged () |
Public Member Functions | |
Mode | defaultMode () const |
void | destroy () |
bool | isValid () const |
Mode | mode () const |
operator org_kde_kwin_server_decoration * () | |
operator org_kde_kwin_server_decoration * () const | |
void | release () |
void | requestMode (Mode mode) |
void | setup (org_kde_kwin_server_decoration *serversidedecoration) |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, 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 QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () 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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (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) |
QThread * | thread () const const |
Additional Inherited Members | |
![]() | |
objectName | |
![]() | |
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 *context, Functor functor, 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) |
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
typedef | QObjectList |
![]() | |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
Describing how a Surface should be decorated.
Use ServerSideDecorationManager::create to create a ServerSideDecoration.
- See also
- ServerSideDecorationManager
- Since
- 5.6
Definition at line 133 of file server_decoration.h.
Member Enumeration Documentation
◆ Mode
|
strong |
Decoration mode used for the Surface.
Enumerator | |
---|---|
None | Undecorated: neither client, nor server provide decoration. Example: popups. |
Client | The decoration is part of the surface. |
Server | The surface gets embedded into a decoration frame provided by the Server. |
Definition at line 174 of file server_decoration.h.
Member Function Documentation
◆ defaultMode()
ServerSideDecoration::Mode KWayland::Client::ServerSideDecoration::defaultMode | ( | ) | const |
- Returns
- The default decoration mode the server uses
- See also
- mode
Definition at line 273 of file server_decoration.cpp.
◆ destroy()
void KWayland::Client::ServerSideDecoration::destroy | ( | ) |
Destroys the data held by this ServerSideDecoration.
This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, it's not possible to call release anymore as that calls into the Wayland connection and the call would fail. This method cleans up the data, so that the instance can be deleted or set up to a new org_kde_kwin_server_decoration interface once there is a new connection available.
This method is automatically invoked when the Registry which created this ServerDecoration gets destroyed.
- See also
- release
Definition at line 228 of file server_decoration.cpp.
◆ isValid()
bool KWayland::Client::ServerSideDecoration::isValid | ( | ) | const |
- Returns
true
if managing a org_kde_kwin_server_decoration.
Definition at line 243 of file server_decoration.cpp.
◆ mode()
ServerSideDecoration::Mode KWayland::Client::ServerSideDecoration::mode | ( | ) | const |
- Returns
- The current decoration mode for the Surface.
The mode represents the mode pushed from the Server.
- See also
- requestMode
- modeChanged
Definition at line 268 of file server_decoration.cpp.
◆ modeChanged
|
signal |
Emitted whenever the Server changes the decoration mode for the Surface.
- See also
- requestMode
- mode
◆ release()
void KWayland::Client::ServerSideDecoration::release | ( | ) |
Releases the org_kde_kwin_server_decoration interface.
After the interface has been released the ServerSideDecoration instance is no longer valid and can be setup with another org_kde_kwin_server_decoration interface.
Definition at line 223 of file server_decoration.cpp.
◆ requestMode()
void KWayland::Client::ServerSideDecoration::requestMode | ( | Mode | mode | ) |
Request the decoration mode
for the Surface.
The server will acknowledge the change which will trigger the modeChanged signal.
- See also
- mode
- modeChanged
Definition at line 248 of file server_decoration.cpp.
◆ setup()
void KWayland::Client::ServerSideDecoration::setup | ( | org_kde_kwin_server_decoration * | serversidedecoration | ) |
Setup this ServerSideDecoration to manage the serversidedecoration
.
When using ServerSideDecorationManager::createServerSideDecoration there is no need to call this method.
Definition at line 218 of file server_decoration.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Jan 31 2023 03:53:29 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.