QWaylandSeat Class

The QWaylandSeat class provides access to keyboard, mouse, and touch input. 更多...

头：	#include <QWaylandSeat>
CMake:	find_package(Qt6 REQUIRED COMPONENTS WaylandCompositor) target_link_libraries(mytarget PRIVATE Qt6::WaylandCompositor)
qmake:	QT += waylandcompositor
实例化：	WaylandSeat
继承：	QWaylandObject

所有成员列表，包括继承成员

公共类型

enum	CapabilityFlag { Pointer, Keyboard, Touch, DefaultCapabilities }
flags	CapabilityFlags

特性

drag : QWaylandDrag* const
keymap : QWaylandKeymap* const

公共函数

	QWaylandSeat (QWaylandCompositor * compositor , QWaylandSeat::CapabilityFlags capabilityFlags = DefaultCapabilities)
virtual	~QWaylandSeat () override
QWaylandSeat::CapabilityFlags	capabilities () const
QWaylandCompositor *	compositor () const
QWaylandDrag *	drag () const
virtual void	initialize ()
bool	isInitialized () const
QWaylandKeyboard *	keyboard () const
QWaylandSurface *	keyboardFocus () const
QWaylandKeymap *	keymap ()
QWaylandView *	mouseFocus () const
QWaylandPointer *	pointer () const
void	sendFullKeyEvent (QKeyEvent * event )
void	sendFullTouchEvent (QWaylandSurface * surface , QTouchEvent * event )
void	sendKeyEvent (int qtKey , bool pressed )
void	sendKeyPressEvent (uint code )
void	sendKeyReleaseEvent (uint code )
void	sendMouseMoveEvent (QWaylandView * view , const QPointF & localPos , const QPointF & outputSpacePos = QPointF())
void	sendMousePressEvent (Qt::MouseButton button )
void	sendMouseReleaseEvent (Qt::MouseButton button )
void	sendMouseWheelEvent (Qt::Orientation orientation , int delta )
void	sendTouchCancelEvent (QWaylandClient * client )
void	sendTouchFrameEvent (QWaylandClient * client )
uint	sendTouchPointEvent (QWaylandSurface * surface , int id , const QPointF & point , Qt::TouchPointState state )
uint	sendTouchPointMoved (QWaylandSurface * surface , int id , const QPointF & position )
uint	sendTouchPointPressed (QWaylandSurface * surface , int id , const QPointF & position )
uint	sendTouchPointReleased (QWaylandSurface * surface , int id , const QPointF & position )
bool	setKeyboardFocus (QWaylandSurface * surface )
void	setMouseFocus (QWaylandView * view )
QWaylandTouch *	touch () const

信号

void	cursorSurfaceRequest (QWaylandSurface * surface , int hotspotX , int hotspotY )
void	keyboardFocusChanged (QWaylandSurface * newFocus , QWaylandSurface * oldFocus )
void	mouseFocusChanged (QWaylandView * newFocus , QWaylandView * oldFocus )

静态公共成员

QWaylandSeat *

fromSeatResource (struct ::wl_resource * resource )

详细描述

The QWaylandSeat provides access to different types of user input and maintains a keyboard focus and a mouse pointer. It corresponds to the wl_seat interface in the Wayland protocol.

成员类型文档编制

enum QWaylandSeat:: CapabilityFlag
flags QWaylandSeat:: CapabilityFlags

This enum type describes the capabilities of a QWaylandSeat .

常量	值	描述
`QWaylandSeat::Pointer`	`0x01`	The QWaylandSeat supports pointer input.
`QWaylandSeat::Keyboard`	`0x02`	The QWaylandSeat supports keyboard input.
`QWaylandSeat::Touch`	`0x04`	The QWaylandSeat supports touch input.
`QWaylandSeat::DefaultCapabilities`	`Pointer \| Keyboard \| Touch`	The QWaylandSeat has the default capabilities.

The CapabilityFlags type is a typedef for QFlags <CapabilityFlag>. It stores an OR combination of CapabilityFlag values.

特性文档编制

`[read-only]` drag : QWaylandDrag * const

This property holds the drag and drop operations and sends signals when they start and end. The property stores details like what image should be under the mouse cursor when the user drags it.

访问函数：

QWaylandDrag *

drag () const

`[read-only]` keymap : QWaylandKeymap * const

This property holds the keymap object.

A keymap provides a way to translate actual key scan codes into a meaningful value. For example, if you use a keymap with a Norwegian layout, the key to the right of the letter L produces an Ø.

Keymaps can also be used to customize key functions, such as to specify whether Control and CAPS lock should be swapped, and so on.

访问函数：

QWaylandKeymap *

keymap ()

成员函数文档编制

QWaylandSeat:: QWaylandSeat ( QWaylandCompositor * compositor , QWaylandSeat::CapabilityFlags capabilityFlags = DefaultCapabilities)

Constructs a QWaylandSeat for the given compositor and capabilityFlags .

`[override virtual]` QWaylandSeat:: ~QWaylandSeat ()

销毁 QWaylandSeat

QWaylandSeat::CapabilityFlags QWaylandSeat:: capabilities () const

Returns the capability flags for this QWaylandSeat .

QWaylandCompositor *QWaylandSeat:: compositor () const

Returns the compositor for this QWaylandSeat .

`[signal]` void QWaylandSeat:: cursorSurfaceRequest ( QWaylandSurface * surface , int hotspotX , int hotspotY )

This signal is emitted when the client has requested for a specific surface to be the mouse cursor. For example, when the user hovers over a particular surface, and you want the cursor to change into a resize arrow.

Both hotspotX and hotspotY are offsets from the top-left of a pointer surface, where a click should happen. For example, if the requested cursor surface is an arrow, the parameters indicate where the arrow's tip is, on that surface.

QWaylandDrag *QWaylandSeat:: drag () const

Returns the drag object for this QWaylandSeat .

注意： Getter function for property drag.

`[static]` QWaylandSeat QWaylandSeat:: fromSeatResource ( struct ::wl_resource resource )

返回 QWaylandSeat corresponding to the resource 。 resource is expected to have the type wl_seat.

`[虚拟]` void QWaylandSeat:: initialize ()

Initializes parts of the seat corresponding to the capabilities set in the constructor, or through setCapabilities().

注意： Normally, this function is called automatically after the seat and compositor have been created, so calling it manually is usually unnecessary.

bool QWaylandSeat:: isInitialized () const

返回 true 若 QWaylandSeat is initialized; false otherwise.

值 true indicates that it's now possible for clients to start using the seat.

QWaylandKeyboard *QWaylandSeat:: keyboard () const

Returns the keyboard for this input device.

QWaylandSurface *QWaylandSeat:: keyboardFocus () const

Returns the current focused surface for keyboard input.

另请参阅 setKeyboardFocus ().

`[signal]` void QWaylandSeat:: keyboardFocusChanged ( QWaylandSurface * newFocus , QWaylandSurface * oldFocus )

此信号被发射当 setKeyboardFocus () 被调用。

newFocus has the surface that received keyboard focus; or nullptr if no surface has focus. oldFocus has the surface that lost keyboard focus; or nullptr if no surface had focus.

QWaylandKeymap *QWaylandSeat:: keymap ()

Returns the keymap object for this QWaylandSeat .

注意： Getter function for property keymap.

QWaylandView *QWaylandSeat:: mouseFocus () const

Returns the view that currently has mouse focus.

另请参阅 setMouseFocus ().

`[signal]` void QWaylandSeat:: mouseFocusChanged ( QWaylandView * newFocus , QWaylandView * oldFocus )

This signal is emitted when the mouse focus has changed from oldFocus to newFocus .

QWaylandPointer *QWaylandSeat:: pointer () const

Returns the pointer device for this QWaylandSeat .

void QWaylandSeat:: sendFullKeyEvent ( QKeyEvent * event )

发送 event to the keyboard device.

注意： The event should correspond to an actual keyboard key in the current mapping. For example, Qt::Key_Exclam is normally not a separate key: with most keyboards the exclamation mark is produced with Shift + 1. In that case, to send an exclamation mark key press event, use QKeyEvent(QEvent::KeyPress, Qt::Key_1, Qt::ShiftModifier) .

void QWaylandSeat:: sendFullTouchEvent ( QWaylandSurface * surface , QTouchEvent * event )

发送 event 到指定 surface on the touch device.

警告： This API will automatically map QEventPoint::id () to a sequential id before sending it to the client. It should therefore not be used in combination with the other API using explicit ids, as collisions might occur.

`[invokable]` void QWaylandSeat:: sendKeyEvent ( int qtKey , bool pressed )

Sends a key press (if pressed is true ) or release (if pressed is false ) event of a key qtKey to the keyboard device.

注意： This function does not support key events that require modifiers, such as Qt::Key_Exclam 。使用 sendFullKeyEvent 代替。

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

void QWaylandSeat:: sendKeyPressEvent ( uint code )

Sends a key press event with the key code to the keyboard device.

void QWaylandSeat:: sendKeyReleaseEvent ( uint code )

Sends a key release event with the key code to the keyboard device.

void QWaylandSeat:: sendMouseMoveEvent ( QWaylandView * view , const QPointF & localPos , const QPointF & outputSpacePos = QPointF())

Sets the mouse focus to view and sends a mouse move event to the pointer device with the local position localPos and output space position outputSpacePos .

void QWaylandSeat:: sendMousePressEvent ( Qt::MouseButton button )

Sends a mouse press event for button 到 QWaylandSeat 's pointer device.

void QWaylandSeat:: sendMouseReleaseEvent ( Qt::MouseButton button )

Sends a mouse release event for button 到 QWaylandSeat 's pointer device.

void QWaylandSeat:: sendMouseWheelEvent ( Qt::Orientation orientation , int delta )

Sends a mouse wheel event to the QWaylandSeat 's pointer device with the given orientation and delta .

`[invokable]` void QWaylandSeat:: sendTouchCancelEvent ( QWaylandClient * client )

Sends a cancel event to the touch device of a client .

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

`[invokable]` void QWaylandSeat:: sendTouchFrameEvent ( QWaylandClient * client )

Sends a frame event to the touch device of a client to indicate the end of a series of touch up, down, and motion events.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

uint QWaylandSeat:: sendTouchPointEvent ( QWaylandSurface * surface , int id , const QPointF & point , Qt::TouchPointState state )

Sends a touch point event to the surface on a touch device with the given id , point and state .

警告： This API should not be used in combination with forwarding of touch events using QWaylandQuickItem::touchEventsEnabled or sendFullTouchEvent , as it might lead to conflicting touch ids.

Returns the serial for the touch up or touch down event.

`[invokable]` uint QWaylandSeat:: sendTouchPointMoved ( QWaylandSurface * surface , int id , const QPointF & position )

Sends a touch moved event for the touch point id on surface with position position .

注意： You need to send a touch frame event when you are done sending touch events.

警告： This API should not be used in combination with forwarding of touch events using QWaylandQuickItem::touchEventsEnabled or sendFullTouchEvent , as it might lead to conflicting touch ids.

Returns the serial for the touch motion event.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

`[invokable]` uint QWaylandSeat:: sendTouchPointPressed ( QWaylandSurface * surface , int id , const QPointF & position )

Sends a touch pressed event for the touch point id on surface with position position .

注意： You need to send a touch frame event when you are done sending touch events.

警告： This API should not be used in combination with forwarding of touch events using QWaylandQuickItem::touchEventsEnabled or sendFullTouchEvent , as it might lead to conflicting touch ids.

Returns the serial for the touch down event.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

`[invokable]` uint QWaylandSeat:: sendTouchPointReleased ( QWaylandSurface * surface , int id , const QPointF & position )

Sends a touch released event for the touch point id on surface with position position .

注意： You need to send a touch frame event when you are done sending touch events.

警告： This API should not be used in combination with forwarding of touch events using QWaylandQuickItem::touchEventsEnabled or sendFullTouchEvent , as it might lead to conflicting touch ids.

Returns the serial for the touch up event.

注意： 此函数可以被援引，通过元对象系统和从 QML。见 Q_INVOKABLE .

bool QWaylandSeat:: setKeyboardFocus ( QWaylandSurface * surface )

Sets the current keyboard focus to surface . Returns a boolean indicating if the operation was successful.

另请参阅 keyboardFocus ().

void QWaylandSeat:: setMouseFocus ( QWaylandView * view )

Sets the current mouse focus to view .

另请参阅 mouseFocus ().

QWaylandTouch *QWaylandSeat:: touch () const

Returns the touch device for this QWaylandSeat .

QWaylandSeat Class

公共类型

特性

公共函数

信号

静态公共成员

详细描述

成员类型文档编制

enum QWaylandSeat:: CapabilityFlag flags QWaylandSeat:: CapabilityFlags

特性文档编制

[read-only] drag : QWaylandDrag * const

[read-only] keymap : QWaylandKeymap * const

成员函数文档编制

QWaylandSeat:: QWaylandSeat ( QWaylandCompositor * compositor , QWaylandSeat::CapabilityFlags capabilityFlags = DefaultCapabilities)

[override virtual] QWaylandSeat:: ~QWaylandSeat ()

QWaylandSeat::CapabilityFlags QWaylandSeat:: capabilities () const

QWaylandCompositor *QWaylandSeat:: compositor () const

[signal] void QWaylandSeat:: cursorSurfaceRequest ( QWaylandSurface * surface , int hotspotX , int hotspotY )

QWaylandDrag *QWaylandSeat:: drag () const

[static] QWaylandSeat *QWaylandSeat:: fromSeatResource ( struct ::wl_resource * resource )

[虚拟] void QWaylandSeat:: initialize ()

bool QWaylandSeat:: isInitialized () const

QWaylandKeyboard *QWaylandSeat:: keyboard () const

QWaylandSurface *QWaylandSeat:: keyboardFocus () const

[signal] void QWaylandSeat:: keyboardFocusChanged ( QWaylandSurface * newFocus , QWaylandSurface * oldFocus )

QWaylandKeymap *QWaylandSeat:: keymap ()

QWaylandView *QWaylandSeat:: mouseFocus () const

[signal] void QWaylandSeat:: mouseFocusChanged ( QWaylandView * newFocus , QWaylandView * oldFocus )

QWaylandPointer *QWaylandSeat:: pointer () const

void QWaylandSeat:: sendFullKeyEvent ( QKeyEvent * event )

void QWaylandSeat:: sendFullTouchEvent ( QWaylandSurface * surface , QTouchEvent * event )

[invokable] void QWaylandSeat:: sendKeyEvent ( int qtKey , bool pressed )

void QWaylandSeat:: sendKeyPressEvent ( uint code )

void QWaylandSeat:: sendKeyReleaseEvent ( uint code )

void QWaylandSeat:: sendMouseMoveEvent ( QWaylandView * view , const QPointF & localPos , const QPointF & outputSpacePos = QPointF())

void QWaylandSeat:: sendMousePressEvent ( Qt::MouseButton button )

void QWaylandSeat:: sendMouseReleaseEvent ( Qt::MouseButton button )

void QWaylandSeat:: sendMouseWheelEvent ( Qt::Orientation orientation , int delta )

[invokable] void QWaylandSeat:: sendTouchCancelEvent ( QWaylandClient * client )

[invokable] void QWaylandSeat:: sendTouchFrameEvent ( QWaylandClient * client )

uint QWaylandSeat:: sendTouchPointEvent ( QWaylandSurface * surface , int id , const QPointF & point , Qt::TouchPointState state )

[invokable] uint QWaylandSeat:: sendTouchPointMoved ( QWaylandSurface * surface , int id , const QPointF & position )

[invokable] uint QWaylandSeat:: sendTouchPointPressed ( QWaylandSurface * surface , int id , const QPointF & position )

[invokable] uint QWaylandSeat:: sendTouchPointReleased ( QWaylandSurface * surface , int id , const QPointF & position )

bool QWaylandSeat:: setKeyboardFocus ( QWaylandSurface * surface )

void QWaylandSeat:: setMouseFocus ( QWaylandView * view )

QWaylandTouch *QWaylandSeat:: touch () const

内容

enum QWaylandSeat:: CapabilityFlag
flags QWaylandSeat:: CapabilityFlags

`[read-only]` drag : QWaylandDrag * const

`[read-only]` keymap : QWaylandKeymap * const

`[override virtual]` QWaylandSeat:: ~QWaylandSeat ()

`[signal]` void QWaylandSeat:: cursorSurfaceRequest ( QWaylandSurface * surface , int hotspotX , int hotspotY )

`[static]` QWaylandSeat QWaylandSeat:: fromSeatResource ( struct ::wl_resource resource )

`[虚拟]` void QWaylandSeat:: initialize ()

`[signal]` void QWaylandSeat:: keyboardFocusChanged ( QWaylandSurface * newFocus , QWaylandSurface * oldFocus )

`[signal]` void QWaylandSeat:: mouseFocusChanged ( QWaylandView * newFocus , QWaylandView * oldFocus )

`[invokable]` void QWaylandSeat:: sendKeyEvent ( int qtKey , bool pressed )

`[invokable]` void QWaylandSeat:: sendTouchCancelEvent ( QWaylandClient * client )

`[invokable]` void QWaylandSeat:: sendTouchFrameEvent ( QWaylandClient * client )

`[invokable]` uint QWaylandSeat:: sendTouchPointMoved ( QWaylandSurface * surface , int id , const QPointF & position )

`[invokable]` uint QWaylandSeat:: sendTouchPointPressed ( QWaylandSurface * surface , int id , const QPointF & position )

`[invokable]` uint QWaylandSeat:: sendTouchPointReleased ( QWaylandSurface * surface , int id , const QPointF & position )