KWayland::Client::XdgOutput Class Reference

#include <xdgoutput.h>

Inheritance diagram for KWayland::Client::XdgOutput:

Signals
void	changed ()

Public Member Functions
void	destroy ()
bool	isValid () const
QPoint	logicalPosition () const
QSize	logicalSize () const
	operator zxdg_output_v1 * ()
	operator zxdg_output_v1 * () const
void	release ()
void	setup (zxdg_output_v1 *xdgoutput)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Wrapper for the zxdg_output_v1 interface.

This class provides a convenient wrapper for the zxdg_output_v1 interface.

The XdgOutputManager can be used as a drop-in replacement for any zxdg_output_v1 pointer as it provides matching cast operators.

This protocol provides a potentially more correct size and position of the screen than Output with respect to scaling.

See also

Registry

Definition at line 158 of file xdgoutput.h.

Member Function Documentation

void KWayland::Client::XdgOutput::changed ( )

signal

Emitted when the logical position or size changes.

void KWayland::Client::XdgOutput::destroy

(

)

Destroys the data held by this XdgOutput.

This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, it's not possible to call release anymore as that calls into the Wayland connection and the call would fail. This method cleans up the data, so that the instance can be deleted or set up to a new zxdg_output_v1 interface once there is a new connection available.

It is suggested to connect this method to ConnectionThread::connectionDied:

connect(connection, &ConnectionThread::connectionDied, xdgoutput, &XdgOutput::destroy);

See also

release

Definition at line 209 of file xdgoutput.cpp.

bool KWayland::Client::XdgOutput::isValid

(

)

const

Returns

true if managing a zxdg_output_v1.

Definition at line 232 of file xdgoutput.cpp.

QPoint KWayland::Client::XdgOutput::logicalPosition

(

)

const

The top left position of the output in compositor co-ordinates.

Definition at line 219 of file xdgoutput.cpp.

QSize KWayland::Client::XdgOutput::logicalSize

(

)

const

The size of the output in compositor co-ordinates (i.e pixel size / output scale)

Definition at line 214 of file xdgoutput.cpp.

void KWayland::Client::XdgOutput::release

(

)

Releases the zxdg_output_v1 interface.

After the interface has been released the XdgOutput instance is no longer valid and can be setup with another zxdg_output_v1 interface.

Definition at line 204 of file xdgoutput.cpp.

void KWayland::Client::XdgOutput::setup

(

zxdg_output_v1 *

xdgoutput

)

Setup this XdgOutput to manage the xdgoutput.

When using XdgOutputManager::createXdgOutput there is no need to call this method.

Definition at line 199 of file xdgoutput.cpp.

---

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

• xdgoutput.h
• xdgoutput.cpp