KWayland::Client::Keyboard

KWayland::Client::Keyboard Class Reference

#include <keyboard.h>

Inheritance diagram for KWayland::Client::Keyboard:

Public Types

enum  KeyState { Released, Pressed }
 

Signals

void entered (quint32 serial)
 
void keyChanged (quint32 key, KWayland::Client::Keyboard::KeyState state, quint32 time)
 
void keymapChanged (int fd, quint32 size)
 
void keyRepeatChanged ()
 
void left (quint32 serial)
 
void modifiersChanged (quint32 depressed, quint32 latched, quint32 locked, quint32 group)
 

Public Member Functions

 Keyboard (QObject *parent=nullptr)
 
void destroy ()
 
SurfaceenteredSurface () const
 
SurfaceenteredSurface ()
 
bool isKeyRepeatEnabled () const
 
bool isValid () const
 
qint32 keyRepeatDelay () const
 
qint32 keyRepeatRate () const
 
 operator wl_keyboard * ()
 
 operator wl_keyboard * () const
 
void release ()
 
void setup (wl_keyboard *keyboard)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (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
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
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)
 
qobject_cast (QObject *object)
 
qobject_cast (const 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)
 
QThreadthread () const 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Wrapper for the wl_keyboard interface.

This class is a convenient wrapper for the wl_keyboard interface.

To create an instance use Seat::createKeyboard.

See also
Seat

Definition at line 31 of file keyboard.h.

Member Function Documentation

void KWayland::Client::Keyboard::destroy ( )

Destroys the data held by this Keyboard.

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

This method is automatically invoked when the Seat which created this Keyboard gets destroyed.

See also
release

Definition at line 83 of file keyboard.cpp.

void KWayland::Client::Keyboard::entered ( quint32  serial)
signal

Notification that this seat's Keyboard is focused on a certain surface.

Parameters
serialThe serial for this enter
Surface * KWayland::Client::Keyboard::enteredSurface ( ) const
Returns
The Surface the Keyboard is on, may be null.

Definition at line 169 of file keyboard.cpp.

Surface * KWayland::Client::Keyboard::enteredSurface ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 164 of file keyboard.cpp.

bool KWayland::Client::Keyboard::isKeyRepeatEnabled ( ) const
Returns
Whether key repeat is enabled on this keyboard
See also
keyRepeatRate
keyRepeatDelay
keyRepeatChanged
Since
5.5

Definition at line 179 of file keyboard.cpp.

bool KWayland::Client::Keyboard::isValid ( ) const
Returns
true if managing a wl_keyboard.

Definition at line 174 of file keyboard.cpp.

void KWayland::Client::Keyboard::keyChanged ( quint32  key,
KWayland::Client::Keyboard::KeyState  state,
quint32  time 
)
signal

A key was pressed or released.

The time argument is a timestamp with millisecond granularity, with an undefined base.

Parameters
keyThe key which was pressed
stateWhether the key got Released or Pressed
timeThe timestamp
void KWayland::Client::Keyboard::keymapChanged ( int  fd,
quint32  size 
)
signal

This signal provides a file descriptor to the client which can be memory-mapped to provide a keyboard mapping description.

The signal is only emitted if the keymap format is libxkbcommon compatible.

Parameters
fdfile descriptor of the keymap
sizeThe size of the keymap
void KWayland::Client::Keyboard::keyRepeatChanged ( )
signal

Emitted whenever information on key repeat changed.

See also
isKeyRepeatEnabled
keyRepeatRate
keyRepeatDelay
Since
5.5
qint32 KWayland::Client::Keyboard::keyRepeatDelay ( ) const
Returns
the delay in millisecond for key repeat after a press.
See also
isKeyRepeatEnabled
keyRepeatRate
keyRepeatChanged
Since
5.5

Definition at line 184 of file keyboard.cpp.

qint32 KWayland::Client::Keyboard::keyRepeatRate ( ) const
Returns
the key repeat rate in characters per second.
See also
isKeyRepeatEnabled
keyRepeatDelay
keyRepeatChanged
Since
5.5

Definition at line 189 of file keyboard.cpp.

void KWayland::Client::Keyboard::left ( quint32  serial)
signal

Notification that this seat's Keyboard is no longer focused on a certain surface.

The leave notification is sent before the enter notification for the new focus.

Parameters
serialThe serial of this enter
void KWayland::Client::Keyboard::modifiersChanged ( quint32  depressed,
quint32  latched,
quint32  locked,
quint32  group 
)
signal

Notifies clients that the modifier and/or group state has changed, and it should update its local state.

void KWayland::Client::Keyboard::release ( )

Releases the wl_keyboard interface.

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

This method is automatically invoked when the Seat which created this Keyboard gets released.

Definition at line 78 of file keyboard.cpp.

void KWayland::Client::Keyboard::setup ( wl_keyboard *  keyboard)

Setup this Keyboard to manage the keyboard.

When using Seat::createKeyboard there is no need to call this method.

Definition at line 88 of file keyboard.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Nov 30 2020 22:50:55 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.