Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
\qmltype WlShellSurface \instantiates QWaylandWlShellSurface \inqmlmodule QtWayland.Compositor.WlShell More...
#include <qwaylandwlshell.h>
Public Types | |
enum | FullScreenMethod { DefaultFullScreen , ScaleFullScreen , DriverFullScreen , FillFullScreen } |
enum | ResizeEdge { NoneEdge = 0 , TopEdge = 1 , BottomEdge = 2 , LeftEdge = 4 , TopLeftEdge = 5 , BottomLeftEdge = 6 , RightEdge = 8 , TopRightEdge = 9 , BottomRightEdge = 10 } |
This enum type provides a way to specify an edge or corner of the surface. More... | |
Public Slots | |
void | ping () |
\qmlmethod void WlShellSurface::ping() | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals | |
void | surfaceChanged () |
void | shellChanged () |
void | titleChanged () |
void | classNameChanged () |
void | pong () |
void | startMove (QWaylandSeat *seat) |
void | startResize (QWaylandSeat *seat, ResizeEdge edges) |
void | setDefaultToplevel () |
void | setTransient (QWaylandSurface *parentSurface, const QPoint &relativeToParent, bool inactive) |
void | setFullScreen (FullScreenMethod method, uint framerate, QWaylandOutput *output) |
void | setPopup (QWaylandSeat *seat, QWaylandSurface *parentSurface, const QPoint &relativeToParent) |
void | setMaximized (QWaylandOutput *output) |
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 | |
Q_ENUM (FullScreenMethod) | |
Q_ENUM (ResizeEdge) | |
QWaylandWlShellSurface () | |
Constructs a QWaylandWlShellSurface. | |
QWaylandWlShellSurface (QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &resource) | |
Constructs a QWaylandWlShellSurface for surface and initializes it with the given shell and resource res. | |
~QWaylandWlShellSurface () override | |
Q_INVOKABLE void | initialize (QWaylandWlShell *shell, QWaylandSurface *surface, const QWaylandResource &resource) |
\qmlmethod void WlShellSurface::initialize(WlShell shell, WaylandSurface surface, WaylandResource resource) | |
QString | title () const |
QString | className () const |
QWaylandSurface * | surface () const |
QWaylandWlShell * | shell () const |
Qt::WindowType | windowType () const override |
\qmlproperty enum WlShellSurface::windowType | |
Q_INVOKABLE QSize | sizeForResize (const QSizeF &size, const QPointF &delta, ResizeEdge edges) |
Q_INVOKABLE void | sendConfigure (const QSize &size, ResizeEdge edges) |
\qmlmethod void WlShellSurface::sendConfigure(size s, enum edges) | |
Q_INVOKABLE void | sendPopupDone () |
\qmlmethod void WlShellSurface::sendPopupDone() | |
Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandWlShellSurface > | |
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) | |
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 struct wl_interface * | interface () |
static QByteArray | interfaceName () |
static QWaylandSurfaceRole * | role () |
static QWaylandWlShellSurface * | fromResource (wl_resource *res) |
Returns the QWaylandWlShellSurface object associated with the given resource, or null if no such object exists. | |
Static Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandWlShellSurface > | |
static QWaylandWlShellSurface * | 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 |
\qmlproperty WaylandSurface WlShellSurface::surface | |
QWaylandWlShell * | shell |
\qmlproperty WlShell WlShellSurface::shell | |
QString | title |
\qmlproperty string WlShellSurface::title | |
QString | className |
\qmlproperty string WlShellSurface::className | |
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 |
Additional Inherited Members | |
Protected Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandWlShellSurface > | |
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) | |
\qmltype WlShellSurface \instantiates QWaylandWlShellSurface \inqmlmodule QtWayland.Compositor.WlShell
Provides a wl_shell_surface
that offers desktop-style compositor-specific features to a surface.
This type is part of the \l{WlShell} extension and provides a way to extend the functionality of an existing WaylandSurface with features specific to desktop-style compositors, such as resizing and moving the surface.
It corresponds to the Wayland interface wl_shell_surface
.
\inmodule QtWaylandCompositor
The QWaylandWlShellSurface class provides desktop-style compositor-specific features to a surface.
This class is part of the QWaylandWlShell 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 wl_shell_surface
.
Definition at line 53 of file qwaylandwlshell.h.
Enumerator | |
---|---|
DefaultFullScreen | |
ScaleFullScreen | |
DriverFullScreen | |
FillFullScreen |
Definition at line 67 of file qwaylandwlshell.h.
This enum type provides a way to specify an edge or corner of the surface.
\value NoneEdge No edge. \value TopEdge The top edge. \value BottomEdge The bottom edge. \value LeftEdge The left edge. \value TopLeftEdge The top left corner. \value BottomLeftEdge The bottom left corner. \value RightEdge The right edge. \value TopRightEdge The top right corner. \value BottomRightEdge The bottom right corner.
Enumerator | |
---|---|
NoneEdge | |
TopEdge | |
BottomEdge | |
LeftEdge | |
TopLeftEdge | |
BottomLeftEdge | |
RightEdge | |
TopRightEdge | |
BottomRightEdge |
Definition at line 75 of file qwaylandwlshell.h.
QWaylandWlShellSurface::QWaylandWlShellSurface | ( | ) |
Constructs a QWaylandWlShellSurface.
Definition at line 419 of file qwaylandwlshell.cpp.
QWaylandWlShellSurface::QWaylandWlShellSurface | ( | QWaylandWlShell * | shell, |
QWaylandSurface * | surface, | ||
const QWaylandResource & | resource ) |
Constructs a QWaylandWlShellSurface for surface and initializes it with the given shell and resource res.
Definition at line 427 of file qwaylandwlshell.cpp.
References initialize(), shell, and surface.
|
override |
Definition at line 433 of file qwaylandwlshell.cpp.
References d, and QWaylandWlShellPrivate::get().
QString QWaylandWlShellSurface::className | ( | ) | const |
Definition at line 638 of file qwaylandwlshell.cpp.
References d.
|
signal |
|
static |
Returns the QWaylandWlShellSurface object associated with the given resource, or null if no such object exists.
Definition at line 670 of file qwaylandwlshell.cpp.
Referenced by QWaylandWlShellPrivate::shell_get_shell_surface().
|
overrideprivatevirtual |
Reimplemented from QWaylandCompositorExtension.
Definition at line 464 of file qwaylandwlshell.cpp.
References QWaylandCompositorExtension::initialize().
Referenced by QWaylandWlShellSurface().
void QWaylandWlShellSurface::initialize | ( | QWaylandWlShell * | shell, |
QWaylandSurface * | surface, | ||
const QWaylandResource & | resource ) |
\qmlmethod void WlShellSurface::initialize(WlShell shell, WaylandSurface surface, WaylandResource resource)
Initializes the WlShellSurface and associates it with the given shell, surface, and resource.
Initializes the QWaylandWlShellSurface and associates it with the given shell, surface, and resource.
Definition at line 449 of file qwaylandwlshell.cpp.
References d, emit, QWaylandCompositorExtension::initialize(), QWaylandResource::resource(), QWaylandCompositorExtension::setExtensionContainer(), shell, shellChanged(), surface, and surfaceChanged().
|
static |
Definition at line 469 of file qwaylandwlshell.cpp.
|
static |
Definition at line 477 of file qwaylandwlshell.cpp.
|
slot |
\qmlmethod void WlShellSurface::ping()
Sends a ping event to the client. If the client replies to the event the pong signal will be emitted.
Sends a ping event to the client. If the client replies to the event the pong signal will be emitted.
Definition at line 660 of file qwaylandwlshell.cpp.
References d.
|
signal |
QWaylandWlShellSurface::Q_ENUM | ( | FullScreenMethod | ) |
QWaylandWlShellSurface::Q_ENUM | ( | ResizeEdge | ) |
|
static |
Definition at line 644 of file qwaylandwlshell.cpp.
Referenced by QWaylandWlShellPrivate::shell_get_shell_surface().
void QWaylandWlShellSurface::sendConfigure | ( | const QSize & | size, |
ResizeEdge | edges ) |
\qmlmethod void WlShellSurface::sendConfigure(size s, enum edges)
Sends a configure event to the client, suggesting that it resize its surface to the provided size s. The edges provide a hint about how the surface was resized.
Sends a configure event to the client, suggesting that it resize its surface to the provided size. The edges provide a hint about how the surface was resized.
Definition at line 530 of file qwaylandwlshell.cpp.
void QWaylandWlShellSurface::sendPopupDone | ( | ) |
\qmlmethod void WlShellSurface::sendPopupDone()
Sends a popup_done event to the client to indicate that the user has clicked somewhere outside the client's surfaces.
Sends a popup_done event to the client to indicate that the user has clicked somewhere outside the client's surfaces.
Definition at line 551 of file qwaylandwlshell.cpp.
References d.
|
signal |
Referenced by QtWayland::WlShellIntegration::WlShellIntegration().
|
signal |
Referenced by QtWayland::WlShellIntegration::WlShellIntegration().
|
signal |
Referenced by QtWayland::WlShellIntegration::WlShellIntegration().
|
signal |
Referenced by QtWayland::WlShellIntegration::WlShellIntegration().
|
signal |
Referenced by QtWayland::WlShellIntegration::WlShellIntegration().
QWaylandWlShell * QWaylandWlShellSurface::shell | ( | ) | const |
Definition at line 592 of file qwaylandwlshell.cpp.
References d.
|
signal |
QSize QWaylandWlShellSurface::sizeForResize | ( | const QSizeF & | size, |
const QPointF & | delta, | ||
QWaylandWlShellSurface::ResizeEdge | edge ) |
Definition at line 482 of file qwaylandwlshell.cpp.
References BottomEdge, LeftEdge, qMax(), RightEdge, TopEdge, QSizeF::toSize(), QSize::width(), QPointF::x(), and QPointF::y().
|
signal |
Referenced by QtWayland::WlShellIntegration::WlShellIntegration().
|
signal |
Referenced by QtWayland::WlShellIntegration::WlShellIntegration().
QWaylandSurface * QWaylandWlShellSurface::surface | ( | ) | const |
Definition at line 575 of file qwaylandwlshell.cpp.
References d.
|
signal |
QString QWaylandWlShellSurface::title | ( | ) | const |
Definition at line 621 of file qwaylandwlshell.cpp.
References d.
|
signal |
|
overridevirtual |
\qmlproperty enum WlShellSurface::windowType
This property holds the window type of the WlShellSurface.
Reimplemented from QWaylandShellSurface.
Definition at line 604 of file qwaylandwlshell.cpp.
References d.
|
read |
\qmlproperty string WlShellSurface::className
This property holds the class name of the WlShellSurface.
This property holds the class name of the QWaylandWlShellSurface.
Definition at line 63 of file qwaylandwlshell.h.
|
read |
\qmlproperty WlShell WlShellSurface::shell
This property holds the shell associated with this WlShellSurface.
This property holds the shell associated with this QWaylandWlShellSurface.
Definition at line 61 of file qwaylandwlshell.h.
Referenced by QWaylandWlShellSurface(), and initialize().
|
read |
\qmlproperty WaylandSurface WlShellSurface::surface
This property holds the wl_surface
associated with this WlShellSurface.
This property holds the surface associated with this QWaylandWlShellSurface.
Definition at line 60 of file qwaylandwlshell.h.
Referenced by QWaylandWlShellSurface(), QtWayland::WlShellIntegration::WlShellIntegration(), and initialize().
|
read |
\qmlproperty string WlShellSurface::title
This property holds the title of the WlShellSurface.
This property holds the title of the QWaylandWlShellSurface.
Definition at line 62 of file qwaylandwlshell.h.