Documentation for <wlr/types/wlr_input_method_v2.h>

Back to index

Table of contents

struct wlr_input_method_keyboard_grab_v2 

struct wlr_input_method_keyboard_grab_v2 {
	struct wl_resource *resource;
	struct wlr_input_method_v2 *input_method;
	struct wlr_keyboard *keyboard;
	
	struct wl_listener keyboard_keymap;
	struct wl_listener keyboard_repeat_info;
	struct wl_listener keyboard_destroy;
	
	struct {
		struct wl_signal destroy; // struct wlr_input_method_keyboard_grab_v2
	} events;
};

wlr_input_method_keyboard_grab_v2_destroy() 

void wlr_input_method_keyboard_grab_v2_destroy(​struct wlr_input_method_keyboard_grab_v2 *keyboard_grab);

wlr_input_method_keyboard_grab_v2_send_key() 

void wlr_input_method_keyboard_grab_v2_send_key(​struct wlr_input_method_keyboard_grab_v2 *keyboard_grab, uint32_t time, uint32_t key, uint32_t state);

wlr_input_method_keyboard_grab_v2_send_modifiers() 

void wlr_input_method_keyboard_grab_v2_send_modifiers(​struct wlr_input_method_keyboard_grab_v2 *keyboard_grab, struct wlr_keyboard_modifiers *modifiers);

wlr_input_method_keyboard_grab_v2_set_keyboard() 

void wlr_input_method_keyboard_grab_v2_set_keyboard(​struct wlr_input_method_keyboard_grab_v2 *keyboard_grab, struct wlr_keyboard *keyboard);

struct wlr_input_method_manager_v2 

struct wlr_input_method_manager_v2 {
	struct wl_global *global;
	struct wl_list input_methods; // struct wlr_input_method_v2.link
	
	struct wl_listener display_destroy;
	
	struct {
		struct wl_signal input_method; // struct wlr_input_method_v2
		struct wl_signal destroy; // struct wlr_input_method_manager_v2
	} events;
};

wlr_input_method_manager_v2_create() 

struct wlr_input_method_manager_v2 *wlr_input_method_manager_v2_create(​struct wl_display *display);

struct wlr_input_method_v2 

struct wlr_input_method_v2 {
	struct wl_resource *resource;
	
	struct wlr_seat *seat;
	struct wlr_seat_client *seat_client;
	
	struct wlr_input_method_v2_state pending;
	struct wlr_input_method_v2_state current;
	bool active; // pending compositor-side state
	bool client_active; // state known to the client
	uint32_t current_serial; // received in last commit call
	
	struct wl_list popup_surfaces;
	struct wlr_input_method_keyboard_grab_v2 *keyboard_grab;
	
	struct wl_list link;
	
	struct wl_listener seat_client_destroy;
	
	struct {
		struct wl_signal commit; // struct wlr_input_method_v2
		struct wl_signal new_popup_surface; // struct wlr_input_popup_surface_v2
		struct wl_signal grab_keyboard; // struct wlr_input_method_keyboard_grab_v2
		struct wl_signal destroy; // struct wlr_input_method_v2
	} events;
};

struct wlr_input_method_v2_delete_surrounding_text 

struct wlr_input_method_v2_delete_surrounding_text {
	uint32_t before_length;
	uint32_t after_length;
};

struct wlr_input_method_v2_preedit_string 

struct wlr_input_method_v2_preedit_string {
	char *text;
	int32_t cursor_begin;
	int32_t cursor_end;
};

wlr_input_method_v2_send_activate() 

void wlr_input_method_v2_send_activate(​struct wlr_input_method_v2 *input_method);

wlr_input_method_v2_send_content_type() 

void wlr_input_method_v2_send_content_type(​struct wlr_input_method_v2 *input_method, uint32_t hint, uint32_t purpose);

wlr_input_method_v2_send_deactivate() 

void wlr_input_method_v2_send_deactivate(​struct wlr_input_method_v2 *input_method);

wlr_input_method_v2_send_done() 

void wlr_input_method_v2_send_done(​struct wlr_input_method_v2 *input_method);

wlr_input_method_v2_send_surrounding_text() 

void wlr_input_method_v2_send_surrounding_text(​struct wlr_input_method_v2 *input_method, const char *text, uint32_t cursor, uint32_t anchor);

wlr_input_method_v2_send_text_change_cause() 

void wlr_input_method_v2_send_text_change_cause(​struct wlr_input_method_v2 *input_method, uint32_t cause);

wlr_input_method_v2_send_unavailable() 

void wlr_input_method_v2_send_unavailable(​struct wlr_input_method_v2 *input_method);

struct wlr_input_method_v2_state 

struct wlr_input_method_v2_state {
	struct wlr_input_method_v2_preedit_string preedit;
	char *commit_text;
	struct wlr_input_method_v2_delete_surrounding_text delete;
};

struct wlr_input_popup_surface_v2 

struct wlr_input_popup_surface_v2 {
	struct wl_resource *resource;
	struct wlr_input_method_v2 *input_method;
	struct wl_list link;
	
	struct wlr_surface *surface;
	
	struct {
		struct wl_signal destroy;
	} events;
	
	void *data;
};

wlr_input_popup_surface_v2_send_text_input_rectangle() 

void wlr_input_popup_surface_v2_send_text_input_rectangle(​struct wlr_input_popup_surface_v2 *popup_surface, struct wlr_box *sbox);

wlr_input_popup_surface_v2_try_from_wlr_surface() 

struct wlr_input_popup_surface_v2 *wlr_input_popup_surface_v2_try_from_wlr_surface(​struct wlr_surface *surface);

Get a struct wlr_input_popup_surface_v2 from a struct wlr_surface.

Returns NULL if the surface has a different role or if the input popup surface has been destroyed.