.TH "wayland::server::zwp_input_method_v1_t" 3 "Wed May 1 2024 17:27:19" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::server::zwp_input_method_v1_t \- input method  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <wayland\-server\-protocol\-unstable\&.hpp>\fP
.PP
Inherits wayland::server::resource_t\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBactivate\fP (bool post=true)"
.br
.RI "activate event "
.ti -1c
.RI "void \fBdeactivate\fP (\fBzwp_input_method_context_v1_t\fP const &context, bool post=true)"
.br
.RI "deactivate event "
.ti -1c
.RI "bool \fBproxy_has_object\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "void \fBpost_no_memory\fP () const"
.br
.ti -1c
.RI "uint32_t \fBget_id\fP () const"
.br
.ti -1c
.RI "client_t \fBget_client\fP () const"
.br
.ti -1c
.RI "unsigned int \fBget_version\fP () const"
.br
.ti -1c
.RI "std::string \fBget_class\fP ()"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::uint32_t \fBactivate_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBactivate\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBdeactivate_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBdeactivate\fP function\&. "
.in -1c
.SH "Detailed Description"
.PP 
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\&. 
.PP
Definition at line \fB1046\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "void zwp_input_method_v1_t::activate (bool post = \fCtrue\fP)"

.PP
activate event A text input was activated\&. Creates an input method context object which allows communication with the text input\&. 
.PP
Definition at line \fB4603\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_input_method_v1_t::deactivate (\fBzwp_input_method_context_v1_t\fP const & context, bool post = \fCtrue\fP)"

.PP
deactivate event 
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP 
.RE
.PP
The text input corresponding to the context argument was deactivated\&. The input method context should be destroyed after deactivation is handled\&. 
.PP
Definition at line \fB4608\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::string wayland::server::resource_t::get_class ()\fC [inherited]\fP"
Retrieve the interface name (class) of a resource object\&.
.PP
\fBReturns\fP
.RS 4
Interface name of the resource object\&. 
.RE
.PP

.SS "client_t wayland::server::resource_t::get_client () const\fC [inherited]\fP"
Get the associated client
.PP
\fBReturns\fP
.RS 4
the client that owns the resource\&. 
.RE
.PP

.SS "uint32_t wayland::server::resource_t::get_id () const\fC [inherited]\fP"
Get the internal ID of the resource
.PP
\fBReturns\fP
.RS 4
the internal ID of the resource 
.RE
.PP

.SS "unsigned int wayland::server::resource_t::get_version () const\fC [inherited]\fP"
Get interface version
.PP
\fBReturns\fP
.RS 4
Interface version this resource has been constructed with\&. 
.RE
.PP

.SS "void wayland::server::resource_t::post_no_memory () const\fC [inherited]\fP"
Post 'not enough memory' error to the client
.PP
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\&. 
.SS "bool wayland::server::resource_t::proxy_has_object () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "constexpr std::uint32_t wayland::server::zwp_input_method_v1_t::activate_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBactivate\fP function\&. 
.PP
Definition at line \fB1081\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_input_method_v1_t::deactivate_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBdeactivate\fP function\&. 
.PP
Definition at line \fB1095\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Wayland++ from the source code\&.