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
QWaylandIviApplication Class Reference

\qmltype IviApplication \instantiates QWaylandIviApplication \inqmlmodule QtWayland.Compositor.IviApplication More...

#include <qwaylandiviapplication.h>

+ Inheritance diagram for QWaylandIviApplication:
+ Collaboration diagram for QWaylandIviApplication:

Signals

void iviSurfaceRequested (QWaylandSurface *surface, uint iviId, const QWaylandResource &resource)
 \qmlsignal void IviApplication::iviSurfaceRequested(WaylandSurface surface, int iviId, WaylandResource resource)
 
void iviSurfaceCreated (QWaylandIviSurface *iviSurface)
 \qmlsignal void IviApplication::iviSurfaceCreated(IviSurface *iviSurface)
 
- 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

 QWaylandIviApplication ()
 Constructs a QWaylandIviApplication object.
 
 QWaylandIviApplication (QWaylandCompositor *compositor)
 Constructs a QWaylandIviApplication object for the provided compositor.
 
void initialize () override
 Initializes the shell extension.
 
- Public Member Functions inherited from QWaylandCompositorExtensionTemplate< QWaylandIviApplication >
 QWaylandCompositorExtensionTemplate ()
 
 QWaylandCompositorExtensionTemplate (QWaylandObject *container)
 
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 QWaylandCompositorExtension
 QWaylandCompositorExtension ()
 Creates a QWaylandCompositorExtension with no container.
 
 QWaylandCompositorExtension (QWaylandObject *container)
 Creates a QWaylandCompositorExtension and adds it to the extension container.
 
 ~QWaylandCompositorExtension () override
 
QWaylandObjectextensionContainer () 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
 
QWaylandCompositorExtensionextension (const QByteArray &name)
 Returns the compositor extension which matches name if one has been registered with the QWaylandObject.
 
QWaylandCompositorExtensionextension (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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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 ()
 Returns the Wayland interface for the QWaylandIviApplication.
 
static QByteArray interfaceName ()
 
- Static Public Member Functions inherited from QWaylandCompositorExtensionTemplate< QWaylandIviApplication >
static QWaylandIviApplicationfindIn (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)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Protected Member Functions inherited from QWaylandCompositorExtensionTemplate< QWaylandIviApplication >
 QWaylandCompositorExtensionTemplate (QWaylandCompositorExtensionPrivate &dd)
 
 QWaylandCompositorExtensionTemplate (QWaylandObject *container, QWaylandCompositorExtensionPrivate &dd)
 
- 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
QObjectsender () 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< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

\qmltype IviApplication \instantiates QWaylandIviApplication \inqmlmodule QtWayland.Compositor.IviApplication

Since
5.8

Provides a shell extension for embedded-style user interfaces.

The IviApplication extension provides a way to associate an IviSurface with a regular Wayland surface. Using the IviSurface interface, the client can identify itself by giving an ivi id, and the compositor can ask the client to resize.

IviApplication corresponds to the Wayland ivi_application interface.

To provide the functionality of the shell extension in a compositor, create an instance of the IviApplication component and add it to the list of extensions supported by the compositor:

\qml import QtWayland.Compositor.IviApplication

WaylandCompositor { IviApplication { onIviSurfaceCreated: { if (iviSurface.iviId === navigationIviId) { // ... } } } } \endqml

\inmodule QtWaylandCompositor

Since
5.8

The QWaylandIviApplication class is an extension for embedded-style user interfaces.

The QWaylandIviApplication extension provides a way to associate an QWaylandIviSurface with a regular Wayland surface. Using the QWaylandIviSurface interface, the client can identify itself by giving an ivi id, and the compositor can ask the client to resize.

QWaylandIviApplication corresponds to the Wayland ivi_application interface.

Definition at line 17 of file qwaylandiviapplication.h.

Constructor & Destructor Documentation

◆ QWaylandIviApplication() [1/2]

QWaylandIviApplication::QWaylandIviApplication ( )

Constructs a QWaylandIviApplication object.

Definition at line 62 of file qwaylandiviapplication.cpp.

◆ QWaylandIviApplication() [2/2]

QWaylandIviApplication::QWaylandIviApplication ( QWaylandCompositor * compositor)

Constructs a QWaylandIviApplication object for the provided compositor.

Definition at line 70 of file qwaylandiviapplication.cpp.

Member Function Documentation

◆ initialize()

void QWaylandIviApplication::initialize ( )
overridevirtual

Initializes the shell extension.

Reimplemented from QWaylandCompositorExtension.

Definition at line 78 of file qwaylandiviapplication.cpp.

References compositor, d, QWaylandCompositorExtension::extensionContainer(), QWaylandCompositorExtension::initialize(), and qWarning.

+ Here is the call graph for this function:

◆ interface()

const struct wl_interface * QWaylandIviApplication::interface ( )
static

Returns the Wayland interface for the QWaylandIviApplication.

Definition at line 95 of file qwaylandiviapplication.cpp.

◆ interfaceName()

QByteArray QWaylandIviApplication::interfaceName ( )
static

Definition at line 103 of file qwaylandiviapplication.cpp.

◆ iviSurfaceCreated

void QWaylandIviApplication::iviSurfaceCreated ( QWaylandIviSurface * iviSurface)
signal

\qmlsignal void IviApplication::iviSurfaceCreated(IviSurface *iviSurface)

This signal is emitted when an IviSurface has been created. The supplied iviSurface is most commonly used to instantiate a ShellSurfaceItem.

This signal is emitted when an IviSurface, iviSurface, has been created.

◆ iviSurfaceRequested

void QWaylandIviApplication::iviSurfaceRequested ( QWaylandSurface * surface,
uint iviId,
const QWaylandResource & resource )
signal

\qmlsignal void IviApplication::iviSurfaceRequested(WaylandSurface surface, int iviId, WaylandResource resource)

This signal is emitted when the client has requested an ivi_surface to be associated with surface, which is identified by iviId. The handler for this signal is expected to create the ivi surface for resource and initialize it within the scope of the signal emission. If no ivi surface is created, a default one will be created instead.

This signal is emitted when the client has requested an ivi_surface to be associated with surface, which is identified by iviId. The handler for this signal is expected to create the ivi surface for resource and initialize it within the scope of the signal emission. If no ivi surface is created, a default one will be created instead.


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