Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QWaylandObject Class Reference

\inmodule QtWaylandCompositor More...

#include <qwaylandcompositorextension.h>

+ Inheritance diagram for QWaylandObject:
+ Collaboration diagram for QWaylandObject:

Public Member Functions

 ~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 event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
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

 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

QList< QWaylandCompositorExtension * > extension_vector
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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.
 
- 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 inherited from QObject
QString objectName
 the name of this object
 
- 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

\inmodule QtWaylandCompositor

Since
5.8

QWaylandObject is the base class for objects that can contain Wayland extensions.

The QWaylandObject encapsulate extension container functionality. Any QWaylandObject object will automatically be an extension container and QWaylandCompositorExtension object which is a child of this will automatically add itself to its extension list, and remove itself when the extension object is destroyed.

Definition at line 20 of file qwaylandcompositorextension.h.

Constructor & Destructor Documentation

◆ ~QWaylandObject()

QWaylandObject::~QWaylandObject ( )
override

Definition at line 223 of file qwaylandcompositorextension.cpp.

◆ QWaylandObject() [1/2]

QWaylandObject::QWaylandObject ( QObject * parent = nullptr)
protected

Creates a QWaylandObject as a child of parent.

Definition at line 212 of file qwaylandcompositorextension.cpp.

◆ QWaylandObject() [2/2]

QWaylandObject::QWaylandObject ( QObjectPrivate & d,
QObject * parent = nullptr )
protected

Definition at line 217 of file qwaylandcompositorextension.cpp.

Member Function Documentation

◆ addExtension()

void QWaylandObject::addExtension ( QWaylandCompositorExtension * extension)

Registers extension with this QWaylandObject.

Definition at line 268 of file qwaylandcompositorextension.cpp.

◆ extension() [1/2]

QWaylandCompositorExtension * QWaylandObject::extension ( const QByteArray & name)

Returns the compositor extension which matches name if one has been registered with the QWaylandObject.

If no extension matching the name has been registered, this function returns null.

Definition at line 234 of file qwaylandcompositorextension.cpp.

◆ extension() [2/2]

QWaylandCompositorExtension * QWaylandObject::extension ( const wl_interface * interface)

Returns the compositor extension which matches interface if one has been registered with the QWaylandObject.

If no extension matching the interface has been registered, this function returns null.

Definition at line 248 of file qwaylandcompositorextension.cpp.

◆ extensions()

QList< QWaylandCompositorExtension * > QWaylandObject::extensions ( ) const

Returns the list of compositor extensions that have been registered with this QWaylandObject.

Definition at line 260 of file qwaylandcompositorextension.cpp.

◆ removeExtension()

void QWaylandObject::removeExtension ( QWaylandCompositorExtension * extension)

Removes extension from the list of registered extensions in this QWaylandObject, if it has previously been registered using \l{addExtension()}.

Definition at line 278 of file qwaylandcompositorextension.cpp.

Member Data Documentation

◆ extension_vector

QList<QWaylandCompositorExtension *> QWaylandObject::extension_vector
protected

Definition at line 35 of file qwaylandcompositorextension.h.

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