\qmltype IviSurface \instantiates QWaylandIviSurface \inqmlmodule QtWayland.Compositor.IviApplication More...

#include <qwaylandivisurface.h>

Inheritance diagram for QWaylandIviSurface:

Collaboration diagram for QWaylandIviSurface:

Signals
void	surfaceChanged ()

void	iviIdChanged ()

Signals inherited from QWaylandShellSurface
void	windowTypeChanged ()

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
	QWaylandIviSurface ()
	Constructs a QWaylandIviSurface.

	QWaylandIviSurface (QWaylandIviApplication application, QWaylandSurface surface, uint iviId, const QWaylandResource &resource)
	Constructs a QWaylandIviSurface for surface and initializes it with the given application, surface, iviId, and resource.

Q_INVOKABLE void	initialize (QWaylandIviApplication iviApplication, QWaylandSurface surface, uint iviId, const QWaylandResource &resource)
	\qmlmethod void IviSurface::initialize(IviApplication iviApplication, WaylandSurface surface, int iviId, WaylandResource resource)

QWaylandSurface *	surface () const

uint	iviId () const

Q_INVOKABLE void	sendConfigure (const QSize &size)
	\qmlmethod int IviSurface::sendConfigure(size size)

Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandIviSurface >
	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)

virtual Qt::WindowType	windowType () 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	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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 ()
	Returns the Wayland interface for the QWaylandIviSurface.

static QByteArray	interfaceName ()

static QWaylandSurfaceRole *	role ()
	Returns the surface role for the QWaylandIviSurface.

static QWaylandIviSurface *	fromResource (::wl_resource *resource)
	Returns the QWaylandIviSurface corresponding to the resource.

Static Public Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandIviSurface >
static QWaylandIviSurface *	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 IviSurface::surface

uint	iviId
	\qmlproperty int IviSurface::iviId \readonly

Properties inherited from QWaylandShellSurface
Qt::WindowType	windowType
	\qmlproperty enum QtWayland.Compositor::ShellSurface::windowType

Properties inherited from QObject
QString	objectName
	the name of this object

Private Member Functions
void	initialize () override

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Protected Member Functions inherited from QWaylandShellSurfaceTemplate< QWaylandIviSurface >
	QWaylandShellSurfaceTemplate (QWaylandCompositorExtensionPrivate &dd)

	QWaylandShellSurfaceTemplate (QWaylandObject *container, QWaylandCompositorExtensionPrivate &dd)

Protected Member Functions inherited from QWaylandShellSurface
	QWaylandShellSurface (QWaylandCompositorExtensionPrivate &dd)

	QWaylandShellSurface (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
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)

Detailed Description

\qmltype IviSurface \instantiates QWaylandIviSurface \inqmlmodule QtWayland.Compositor.IviApplication

Since: 5.8

Provides a simple way to identify and resize a surface.

This type is part of the \l{IviApplication} extension and provides a way to extend the functionality of an existing WaylandSurface with a way to resize and identify it.

It corresponds to the Wayland ivi_surface interface.

\inmodule QtWaylandCompositor

Since: 5.8

The QWaylandIviSurface class provides a simple way to identify and resize a surface.

This class is part of the QWaylandIviApplication extension and provides a way to extend the functionality of an existing QWaylandSurface with a way to resize and identify it.

It corresponds to the Wayland ivi_surface interface.

Definition at line 22 of file qwaylandivisurface.h.

Constructor & Destructor Documentation

◆ QWaylandIviSurface() [1/2]

QWaylandIviSurface::QWaylandIviSurface ( )

Constructs a QWaylandIviSurface.

Definition at line 48 of file qwaylandivisurface.cpp.

◆ QWaylandIviSurface() [2/2]

QWaylandIviSurface::QWaylandIviSurface	(	QWaylandIviApplication *	application,
		QWaylandSurface *	surface,
		uint	iviId,
		const QWaylandResource &	resource
	)

Constructs a QWaylandIviSurface for surface and initializes it with the given application, surface, iviId, and resource.

Definition at line 57 of file qwaylandivisurface.cpp.

References initialize(), iviId, and surface.

Here is the call graph for this function:

Member Function Documentation

◆ fromResource()

QWaylandIviSurface * QWaylandIviSurface::fromResource ( ::wl_resource * resource )

static

Returns the QWaylandIviSurface corresponding to the resource.

Definition at line 150 of file qwaylandivisurface.cpp.

Referenced by QWaylandIviApplicationPrivate::ivi_application_surface_create().

Here is the caller graph for this function:

◆ initialize() [1/2]

void QWaylandIviSurface::initialize ( )

overrideprivatevirtual

Reimplemented from QWaylandCompositorExtension.

Definition at line 186 of file qwaylandivisurface.cpp.

References QWaylandCompositorExtension::initialize().

Referenced by QWaylandIviSurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize() [2/2]

void QWaylandIviSurface::initialize	(	QWaylandIviApplication *	iviApplication,
		QWaylandSurface *	surface,
		uint	iviId,
		const QWaylandResource &	resource
	)

\qmlmethod void IviSurface::initialize(IviApplication iviApplication, WaylandSurface surface, int iviId, WaylandResource resource)

Initializes the IviSurface, associating it with the given iviApplication, surface, iviId, and resource.

Initializes the QWaylandIviSurface, associating it with the given iviApplication, surface, iviId, and resource.

Definition at line 74 of file qwaylandivisurface.cpp.

References d, emit, QWaylandCompositorExtension::initialize(), iviId, iviIdChanged(), QWaylandResource::resource(), QWaylandCompositorExtension::setExtensionContainer(), surface, and surfaceChanged().

Here is the call graph for this function:

◆ interface()

const struct wl_interface * QWaylandIviSurface::interface ( )

static

Returns the Wayland interface for the QWaylandIviSurface.

Definition at line 129 of file qwaylandivisurface.cpp.

◆ interfaceName()

QByteArray QWaylandIviSurface::interfaceName ( )

static

Definition at line 134 of file qwaylandivisurface.cpp.

◆ iviId()

uint QWaylandIviSurface::iviId ( ) const

Definition at line 120 of file qwaylandivisurface.cpp.

References d.

◆ iviIdChanged

void QWaylandIviSurface::iviIdChanged ( )

signal

Referenced by initialize().

Here is the caller graph for this function:

◆ role()

QWaylandSurfaceRole * QWaylandIviSurface::role ( )

static

Returns the surface role for the QWaylandIviSurface.

Definition at line 142 of file qwaylandivisurface.cpp.

Referenced by QWaylandIviApplicationPrivate::ivi_application_surface_create().

Here is the caller graph for this function:

◆ sendConfigure()

void QWaylandIviSurface::sendConfigure ( const QSize & size )

\qmlmethod int IviSurface::sendConfigure(size size)

Sends a configure event to the client, telling it to resize the surface to the given size.

Definition at line 166 of file qwaylandivisurface.cpp.

References d, and qWarning.

◆ surface()

QWaylandSurface * QWaylandIviSurface::surface ( ) const

Definition at line 102 of file qwaylandivisurface.cpp.

References d.

◆ surfaceChanged

void QWaylandIviSurface::surfaceChanged ( )

signal

Referenced by initialize().

Here is the caller graph for this function:

Property Documentation

◆ iviId

QWaylandIviSurface::iviId

read

\qmlproperty int IviSurface::iviId \readonly

This property holds the ivi id id of this IviSurface.

This property holds the ivi id of this QWaylandIviSurface.

Definition at line 62 of file qwaylandivisurface.h.

Referenced by QWaylandIviSurface(), initialize(), and QWaylandIviApplicationPrivate::unregisterIviSurface().

◆ surface

QWaylandIviSurface::surface

read

\qmlproperty WaylandSurface IviSurface::surface

This property holds the surface associated with this IviSurface.

This property holds the surface associated with this QWaylandIviSurface.

Definition at line 62 of file qwaylandivisurface.h.

Referenced by QtWayland::IviSurfaceIntegration::IviSurfaceIntegration(), QWaylandIviSurface(), and initialize().

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

qtwayland/src/compositor/extensions/qwaylandivisurface.h
qtwayland/src/compositor/extensions/qwaylandivisurface.cpp

Signals

Public Member Functions

Static Public Member Functions

Properties

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QWaylandIviSurface() [1/2]

◆ QWaylandIviSurface() [2/2]

Member Function Documentation

◆ fromResource()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ interface()

◆ interfaceName()

◆ iviId()

◆ iviIdChanged

◆ role()

◆ sendConfigure()

◆ surface()

◆ surfaceChanged

Property Documentation

◆ iviId

◆ surface