KWayland::Client::TextInputManager Class Reference

#include <textinput.h>

Inheritance diagram for KWayland::Client::TextInputManager:

Signals
void	removed ()

Public Member Functions
TextInput *	createTextInput (Seat *seat, QObject *parent=nullptr)
void	destroy ()
EventQueue *	eventQueue ()
bool	isValid () const
	operator wl_text_input_manager * ()
	operator wl_text_input_manager * () const
	operator zwp_text_input_manager_v2 * ()
	operator zwp_text_input_manager_v2 * () const
void	release ()
void	setEventQueue (EventQueue *queue)
void	setup (wl_text_input_manager *textinputmanagerunstablev0)
void	setup (zwp_text_input_manager_v2 *textinputmanagerunstablev2)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
	TextInputManager (Private *p, QObject *parent=nullptr)
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 const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
QScopedPointer< Private >	d

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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

Manager class for the TextInputManager interfaces.

The TextInputManager supports multiple interfaces:

• wl_text_input_manager
• zwp_text_input_manager_v2

Due to that it is different to other manager classes. It can only be created through the corresponding factory method in Registry. A manual setup is not directly possible.

The only task of a TextInputManager is to create TextInput for a given Seat.

Since

5.23

Definition at line 415 of file textinput.h.

Member Function Documentation

createTextInput()

TextInput * KWayland::Client::TextInputManager::createTextInput	(	Seat *	seat,
		QObject *	parent = nullptr
	)

Creates a TextInput for the seat.

Parameters

seat	The Seat to create the TextInput for
parent	The parent to use for the TextInput

Definition at line 207 of file textinput.cpp.

destroy()

void KWayland::Client::TextInputManager::destroy

(

)

Destroys the data held by this TextInputManager.

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 interface once there is a new connection available.

This method is automatically invoked when the Registry which created this TextInput gets destroyed.

See also

release

Definition at line 167 of file textinput.cpp.

eventQueue()

EventQueue * KWayland::Client::TextInputManager::eventQueue

(

)

Returns

The event queue to use for creating objects with this TextInputManager.

Definition at line 177 of file textinput.cpp.

isValid()

bool KWayland::Client::TextInputManager::isValid

(

)

const

Returns

true if managing a resource.

Definition at line 202 of file textinput.cpp.

operator wl_text_input_manager *() [1/2]

KWayland::Client::TextInputManager::operator wl_text_input_manager *

(

)

Returns

null if not for a wl_text_input_manager

Definition at line 182 of file textinput.cpp.

operator wl_text_input_manager *() [2/2]

KWayland::Client::TextInputManager::operator wl_text_input_manager *

(

)

const

Returns

null if not for a wl_text_input_manager

operator zwp_text_input_manager_v2 *() [1/2]

KWayland::Client::TextInputManager::operator zwp_text_input_manager_v2 *

(

)

Returns

null if not for a zwp_text_input_manager_v2

Definition at line 192 of file textinput.cpp.

operator zwp_text_input_manager_v2 *() [2/2]

KWayland::Client::TextInputManager::operator zwp_text_input_manager_v2 *

(

)

const

Returns

null if not for a zwp_text_input_manager_v2

release()

void KWayland::Client::TextInputManager::release

(

)

Releases the interface.

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

Definition at line 162 of file textinput.cpp.

removed

void KWayland::Client::TextInputManager::removed ( )

signal

The corresponding global for this interface on the Registry got removed.

This signal gets only emitted if the TextInputManager got created by Registry::createTextInputManager

setEventQueue()

void KWayland::Client::TextInputManager::setEventQueue

(

EventQueue *

queue

)

Sets the queue to use for creating objects with this TextInputManager.

Definition at line 172 of file textinput.cpp.

setup() [1/2]

void KWayland::Client::TextInputManager::setup

(

wl_text_input_manager *

textinputmanagerunstablev0

)

Setup this TextInputManager to manage the textinputmanagerunstablev0.

When using Registry::createTextInputManager there is no need to call this method.

Definition at line 152 of file textinput.cpp.

setup() [2/2]

void KWayland::Client::TextInputManager::setup

(

zwp_text_input_manager_v2 *

textinputmanagerunstablev2

)

Setup this TextInputManager to manage the textinputmanagerunstablev0.

When using Registry::createTextInputManager there is no need to call this method.

Definition at line 157 of file textinput.cpp.

---

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

• textinput.h
• textinput.cpp