---
name: "wayland_server_zwp_input_method_v1_t"
section: "3"
platform: "linux"
package: "waylandpp-dev"
version: "1.0.0-6+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/wayland_server_zwp_input_method_v1_t"
---

# wayland\_server\_zwp\_input\_method\_v1\_t(3)

input method

## NAME

wayland::server::zwp\_input\_method\_v1\_t - input method

## SYNOPSIS

`#include <wayland-server-protocol-unstable.hpp>`

Inherits wayland::server::resource\_t.

### Public Member Functions

void **activate** (bool post=true)\
 activate event  void **deactivate** (**zwp\_input\_method\_context\_v1\_t** const &context, bool post=true)\
 deactivate event  bool **proxy\_has\_object** () const\
 Check whether this wrapper actually wraps an object.  void **post\_no\_memory** () const\
 uint32\_t **get\_id** () const\
 client\_t **get\_client** () const\
 unsigned int **get\_version** () const\
 std::string **get\_class** ()\

### Static Public Attributes

static constexpr std::uint32\_t **activate\_since\_version** = 1\
 Minimum protocol version required for the **activate** function.  static constexpr std::uint32\_t **deactivate\_since\_version** = 1\
 Minimum protocol version required for the **deactivate** function.

## Detailed Description

input method

An input method object is responsible for composing text in response to input from hardware or virtual keyboards. There is one input method object per seat. On activate there is a new input method context object created which allows the input method to communicate with the text input.

Definition at line **1046** of file **wayland-server-protocol-unstable.hpp**.

## Member Function Documentation

### void zwp\_input\_method\_v1\_t::activate (bool post = `true`)

activate event A text input was activated. Creates an input method context object which allows communication with the text input.

Definition at line **4603** of file **wayland-server-protocol-unstable.cpp**.

### void zwp\_input\_method\_v1\_t::deactivate (zwp\_input\_method\_context\_v1\_t const & context, bool post = `true`)

deactivate event

**Parameters**

*context*

The text input corresponding to the context argument was deactivated. The input method context should be destroyed after deactivation is handled.

Definition at line **4608** of file **wayland-server-protocol-unstable.cpp**.

### std::string wayland::server::resource\_t::get\_class ()` [inherited]`

Retrieve the interface name (class) of a resource object.

**Returns**

Interface name of the resource object.

### client\_t wayland::server::resource\_t::get\_client () const` [inherited]`

Get the associated client

**Returns**

the client that owns the resource.

### uint32\_t wayland::server::resource\_t::get\_id () const` [inherited]`

Get the internal ID of the resource

**Returns**

the internal ID of the resource

### unsigned int wayland::server::resource\_t::get\_version () const` [inherited]`

Get interface version

**Returns**

Interface version this resource has been constructed with.

### void wayland::server::resource\_t::post\_no\_memory () const` [inherited]`

Post 'not enough memory' error to the client

If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance.

### bool wayland::server::resource\_t::proxy\_has\_object () const` [inherited]`

Check whether this wrapper actually wraps an object.

**Returns**

true if there is an underlying object, false if this wrapper is empty

## Member Data Documentation

### constexpr std::uint32\_t wayland::server::zwp\_input\_method\_v1\_t::activate\_since\_version = 1` [static]`, ` [constexpr]`

Minimum protocol version required for the **activate** function.

Definition at line **1081** of file **wayland-server-protocol-unstable.hpp**.

### constexpr std::uint32\_t wayland::server::zwp\_input\_method\_v1\_t::deactivate\_since\_version = 1` [static]`, ` [constexpr]`

Minimum protocol version required for the **deactivate** function.

Definition at line **1095** of file **wayland-server-protocol-unstable.hpp**.

## Author

Generated automatically by Doxygen for Wayland++ from the source code.