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>.
Loading...
Searching...
No Matches
Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
QWaylandShellSurface Class Reference

\qmltype ShellSurface \instantiates QWaylandShellSurface \inqmlmodule QtWayland.Compositor More...

#include <qwaylandshellsurface.h>

+ Inheritance diagram for QWaylandShellSurface:
+ Collaboration diagram for QWaylandShellSurface:

Signals

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

 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.
 
virtual void initialize ()
 Initializes the QWaylandCompositorExtension.
 
bool isInitialized () const
 
virtual const struct wl_interface * extensionInterface () const =0
 A pure virtual function which should be reimplemented to return the wl_interface which corresponds to this QWaylandCompositorExtension.
 
- 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.
 

Protected Member Functions

 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)
 

Properties

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
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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)
 
- Protected Attributes inherited from QWaylandObject
QList< QWaylandCompositorExtension * > extension_vector
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

\qmltype ShellSurface \instantiates QWaylandShellSurface \inqmlmodule QtWayland.Compositor

Since
5.8

Provides a common interface for surface roles specified by shell extensions.

This interface represents a Wayland surface role given by a Wayland protocol extension that defines how the WaylandSurface should map onto the screen.

Note
Even though this type contains a very limited API, the properties and signals of the implementations are named consistently. For example, if you're only using desktop shell extensions in your compositor, it's safe to access properties such as title, maximized, etc. directly on the ShellSurface. See the various implementations for additional properties and signals.
See also
WaylandSurface, ShellSurfaceItem, WlShellSurface, IviSurface

\inmodule QtWaylandCompositor

Since
5.8

The QWaylandShellSurface class is a common interface for surface roles specified by shell extensions.

This interface represents a Wayland surface role given by a Wayland protocol extension that defines how the QWaylandSurface should map onto the screen.

See also
QWaylandSurface, QWaylandWlShellSurface, QWaylandIviSurface, QWaylandShellSurfaceTemplate

Definition at line 16 of file qwaylandshellsurface.h.

Constructor & Destructor Documentation

◆ QWaylandShellSurface() [1/3]

QWaylandShellSurface::QWaylandShellSurface ( QWaylandObject * waylandObject)

Definition at line 121 of file qwaylandshellsurface.cpp.

◆ QWaylandShellSurface() [2/3]

QT_BEGIN_NAMESPACE QWaylandShellSurface::QWaylandShellSurface ( QWaylandShellSurfacePrivate & dd)
protected

Definition at line 111 of file qwaylandshellsurface.cpp.

◆ QWaylandShellSurface() [3/3]

QWaylandShellSurface::QWaylandShellSurface ( QWaylandObject * container,
QWaylandShellSurfacePrivate & dd )
protected

Definition at line 116 of file qwaylandshellsurface.cpp.

Member Function Documentation

◆ modal()

bool QWaylandShellSurface::modal ( ) const

Definition at line 126 of file qwaylandshellsurface.cpp.

References d.

◆ modalChanged

void QWaylandShellSurface::modalChanged ( )
signal

Referenced by setModal(), and QWaylandQuickShellSurfaceItem::setShellSurface().

+ Here is the caller graph for this function:

◆ setModal()

void QWaylandShellSurface::setModal ( bool newModal)
protected

Definition at line 132 of file qwaylandshellsurface.cpp.

References d, emit, and modalChanged().

+ Here is the call graph for this function:

◆ windowType()

virtual Qt::WindowType QWaylandShellSurface::windowType ( ) const
inlinevirtual

Reimplemented in QWaylandWlShellSurface, and QWaylandXdgSurface.

Definition at line 31 of file qwaylandshellsurface.h.

References Qt::Window.

◆ windowTypeChanged

void QWaylandShellSurface::windowTypeChanged ( )
signal

Property Documentation

◆ modal

QWaylandShellSurface::modal
read

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

This property is true if the ShellSurface represents a modal dialog.

Since
6.8

This property is true if the ShellSurface represents a modal dialog.

Since
6.8

Definition at line 22 of file qwaylandshellsurface.h.

Referenced by QWaylandQuickShellSurfaceItemPrivate::lower(), and QWaylandQuickShellSurfaceItemPrivate::raise().

◆ windowType

QWaylandShellSurface::windowType
read

\qmlproperty enum QtWayland.Compositor::ShellSurface::windowType

This property holds the window type of the ShellSurface.

This property holds the window type of the QWaylandShellSurface.

Definition at line 21 of file qwaylandshellsurface.h.

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