wlr_virtual_keyboard

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2023 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ZwpVirtualKeyboardManagerV1

type ZwpVirtualKeyboardManagerV1 struct {
	client.BaseProxy
}

ZwpVirtualKeyboardManagerV1 : virtual keyboard manager

A virtual keyboard manager allows an application to provide keyboard input events as if they came from a physical keyboard.

func NewZwpVirtualKeyboardManagerV1

func NewZwpVirtualKeyboardManagerV1(ctx *client.Context) *ZwpVirtualKeyboardManagerV1

NewZwpVirtualKeyboardManagerV1 : virtual keyboard manager

A virtual keyboard manager allows an application to provide keyboard input events as if they came from a physical keyboard.

func (*ZwpVirtualKeyboardManagerV1) CreateVirtualKeyboard

func (i *ZwpVirtualKeyboardManagerV1) CreateVirtualKeyboard(seat *client.Seat) (*ZwpVirtualKeyboardV1, error)

CreateVirtualKeyboard : Create a new virtual keyboard

Creates a new virtual keyboard associated to a seat.

If the compositor enables a keyboard to perform arbitrary actions, it should present an error when an untrusted client requests a new keyboard.

func (*ZwpVirtualKeyboardManagerV1) Destroy

func (i *ZwpVirtualKeyboardManagerV1) Destroy() error

type ZwpVirtualKeyboardManagerV1Error

type ZwpVirtualKeyboardManagerV1Error uint32
const (
	// ZwpVirtualKeyboardManagerV1ErrorUnauthorized : client not authorized to use the interface
	ZwpVirtualKeyboardManagerV1ErrorUnauthorized ZwpVirtualKeyboardManagerV1Error = 0
)

ZwpVirtualKeyboardManagerV1Error :

func (ZwpVirtualKeyboardManagerV1Error) Name

func (ZwpVirtualKeyboardManagerV1Error) String

func (ZwpVirtualKeyboardManagerV1Error) Value

type ZwpVirtualKeyboardV1

type ZwpVirtualKeyboardV1 struct {
	client.BaseProxy
}

ZwpVirtualKeyboardV1 : virtual keyboard

The virtual keyboard provides an application with requests which emulate the behaviour of a physical keyboard.

This interface can be used by clients on its own to provide raw input events, or it can accompany the input method protocol.

func NewZwpVirtualKeyboardV1

func NewZwpVirtualKeyboardV1(ctx *client.Context) *ZwpVirtualKeyboardV1

NewZwpVirtualKeyboardV1 : virtual keyboard

The virtual keyboard provides an application with requests which emulate the behaviour of a physical keyboard.

This interface can be used by clients on its own to provide raw input events, or it can accompany the input method protocol.

func (*ZwpVirtualKeyboardV1) Destroy

func (i *ZwpVirtualKeyboardV1) Destroy() error

Destroy : destroy the virtual keyboard keyboard object

func (*ZwpVirtualKeyboardV1) Key

func (i *ZwpVirtualKeyboardV1) Key(time, key, state uint32) error

Key : key event

A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base. All requests regarding a single object must share the same clock.

Keymap must be set before issuing this request.

State carries a value from the key_state enumeration.

time: timestamp with millisecond granularity
key: key that produced the event
state: physical state of the key

func (*ZwpVirtualKeyboardV1) Keymap

func (i *ZwpVirtualKeyboardV1) Keymap(format uint32, fd int, size uint32) error

Keymap : keyboard mapping

Provide a file descriptor to the compositor which can be memory-mapped to provide a keyboard mapping description.

Format carries a value from the keymap_format enumeration.

format: keymap format
fd: keymap file descriptor
size: keymap size, in bytes

func (*ZwpVirtualKeyboardV1) Modifiers

func (i *ZwpVirtualKeyboardV1) Modifiers(modsDepressed, modsLatched, modsLocked, group uint32) error

Modifiers : modifier and group state

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

The client should use wl_keyboard.modifiers event to synchronize its internal state with seat state.

Keymap must be set before issuing this request.

modsDepressed: depressed modifiers
modsLatched: latched modifiers
modsLocked: locked modifiers
group: keyboard layout

type ZwpVirtualKeyboardV1Error

type ZwpVirtualKeyboardV1Error uint32
const (
	// ZwpVirtualKeyboardV1ErrorNoKeymap : No keymap was set
	ZwpVirtualKeyboardV1ErrorNoKeymap ZwpVirtualKeyboardV1Error = 0
)

ZwpVirtualKeyboardV1Error :

func (ZwpVirtualKeyboardV1Error) Name

func (ZwpVirtualKeyboardV1Error) String

func (e ZwpVirtualKeyboardV1Error) String() string

func (ZwpVirtualKeyboardV1Error) Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL