/* Generated by wayland-scanner 1.23.0 */ #ifndef TEXT_INPUT_UNSTABLE_V1_SERVER_PROTOCOL_H #define TEXT_INPUT_UNSTABLE_V1_SERVER_PROTOCOL_H #include <stdint.h> #include <stddef.h> #include "wayland-server.h" #ifdef __cplusplus extern "C" { #endif struct wl_client; struct wl_resource; /** * @page page_text_input_unstable_v1 The text_input_unstable_v1 protocol * @section page_ifaces_text_input_unstable_v1 Interfaces * - @subpage page_iface_zwp_text_input_v1 - text input * - @subpage page_iface_zwp_text_input_manager_v1 - text input manager * @section page_copyright_text_input_unstable_v1 Copyright * <pre> * * Copyright © 2012, 2013 Intel Corporation * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice (including the next * paragraph) shall be included in all copies or substantial portions of the * Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. * </pre> */ struct wl_seat; struct wl_surface; struct zwp_text_input_manager_v1; struct zwp_text_input_v1; #ifndef ZWP_TEXT_INPUT_V1_INTERFACE #define ZWP_TEXT_INPUT_V1_INTERFACE /** * @page page_iface_zwp_text_input_v1 zwp_text_input_v1 * @section page_iface_zwp_text_input_v1_desc Description * * An object used for text input. Adds support for text input and input * methods to applications. A text_input object is created from a * wl_text_input_manager and corresponds typically to a text entry in an * application. * * Requests are used to activate/deactivate the text_input object and set * state information like surrounding and selected text or the content type. * The information about entered text is sent to the text_input object via * the pre-edit and commit events. Using this interface removes the need * for applications to directly process hardware key events and compose text * out of them. * * Text is generally UTF-8 encoded, indices and lengths are in bytes. * * Serials are used to synchronize the state between the text input and * an input method. New serials are sent by the text input in the * commit_state request and are used by the input method to indicate * the known text input state in events like preedit_string, commit_string, * and keysym. The text input can then ignore events from the input method * which are based on an outdated state (for example after a reset). * * Warning! The protocol described in this file is experimental and * backward incompatible changes may be made. Backward compatible changes * may be added together with the corresponding interface version bump. * Backward incompatible changes are done by bumping the version number in * the protocol and interface names and resetting the interface version. * Once the protocol is to be declared stable, the 'z' prefix and the * version number in the protocol and interface names are removed and the * interface version number is reset. * @section page_iface_zwp_text_input_v1_api API * See @ref iface_zwp_text_input_v1. */ /** * @defgroup iface_zwp_text_input_v1 The zwp_text_input_v1 interface * * An object used for text input. Adds support for text input and input * methods to applications. A text_input object is created from a * wl_text_input_manager and corresponds typically to a text entry in an * application. * * Requests are used to activate/deactivate the text_input object and set * state information like surrounding and selected text or the content type. * The information about entered text is sent to the text_input object via * the pre-edit and commit events. Using this interface removes the need * for applications to directly process hardware key events and compose text * out of them. * * Text is generally UTF-8 encoded, indices and lengths are in bytes. * * Serials are used to synchronize the state between the text input and * an input method. New serials are sent by the text input in the * commit_state request and are used by the input method to indicate * the known text input state in events like preedit_string, commit_string, * and keysym. The text input can then ignore events from the input method * which are based on an outdated state (for example after a reset). * * Warning! The protocol described in this file is experimental and * backward incompatible changes may be made. Backward compatible changes * may be added together with the corresponding interface version bump. * Backward incompatible changes are done by bumping the version number in * the protocol and interface names and resetting the interface version. * Once the protocol is to be declared stable, the 'z' prefix and the * version number in the protocol and interface names are removed and the * interface version number is reset. */ extern const struct wl_interface zwp_text_input_v1_interface; #endif #ifndef ZWP_TEXT_INPUT_MANAGER_V1_INTERFACE #define ZWP_TEXT_INPUT_MANAGER_V1_INTERFACE /** * @page page_iface_zwp_text_input_manager_v1 zwp_text_input_manager_v1 * @section page_iface_zwp_text_input_manager_v1_desc Description * * A factory for text_input objects. This object is a global singleton. * @section page_iface_zwp_text_input_manager_v1_api API * See @ref iface_zwp_text_input_manager_v1. */ /** * @defgroup iface_zwp_text_input_manager_v1 The zwp_text_input_manager_v1 interface * * A factory for text_input objects. This object is a global singleton. */ extern const struct wl_interface zwp_text_input_manager_v1_interface; #endif #ifndef ZWP_TEXT_INPUT_V1_CONTENT_HINT_ENUM #define ZWP_TEXT_INPUT_V1_CONTENT_HINT_ENUM /** * @ingroup iface_zwp_text_input_v1 * content hint * * Content hint is a bitmask to allow to modify the behavior of the text * input. */ enum zwp_text_input_v1_content_hint { … }; /** * @ingroup iface_zwp_text_input_v1 * Validate a zwp_text_input_v1 content_hint value. * * @return true on success, false on error. * @ref zwp_text_input_v1_content_hint */ static inline bool zwp_text_input_v1_content_hint_is_valid(uint32_t value, uint32_t version) { … } #endif /* ZWP_TEXT_INPUT_V1_CONTENT_HINT_ENUM */ #ifndef ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_ENUM #define ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_ENUM /** * @ingroup iface_zwp_text_input_v1 * content purpose * * The content purpose allows to specify the primary purpose of a text * input. * * This allows an input method to show special purpose input panels with * extra characters or to disallow some characters. */ enum zwp_text_input_v1_content_purpose { … }; /** * @ingroup iface_zwp_text_input_v1 * Validate a zwp_text_input_v1 content_purpose value. * * @return true on success, false on error. * @ref zwp_text_input_v1_content_purpose */ static inline bool zwp_text_input_v1_content_purpose_is_valid(uint32_t value, uint32_t version) { … } #endif /* ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_ENUM */ #ifndef ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_ENUM #define ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_ENUM enum zwp_text_input_v1_preedit_style { … }; /** * @ingroup iface_zwp_text_input_v1 * Validate a zwp_text_input_v1 preedit_style value. * * @return true on success, false on error. * @ref zwp_text_input_v1_preedit_style */ static inline bool zwp_text_input_v1_preedit_style_is_valid(uint32_t value, uint32_t version) { … } #endif /* ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_ENUM */ #ifndef ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_ENUM #define ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_ENUM enum zwp_text_input_v1_text_direction { … }; /** * @ingroup iface_zwp_text_input_v1 * Validate a zwp_text_input_v1 text_direction value. * * @return true on success, false on error. * @ref zwp_text_input_v1_text_direction */ static inline bool zwp_text_input_v1_text_direction_is_valid(uint32_t value, uint32_t version) { … } #endif /* ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_ENUM */ /** * @ingroup iface_zwp_text_input_v1 * @struct zwp_text_input_v1_interface */ struct zwp_text_input_v1_interface { … }; #define ZWP_TEXT_INPUT_V1_ENTER … #define ZWP_TEXT_INPUT_V1_LEAVE … #define ZWP_TEXT_INPUT_V1_MODIFIERS_MAP … #define ZWP_TEXT_INPUT_V1_INPUT_PANEL_STATE … #define ZWP_TEXT_INPUT_V1_PREEDIT_STRING … #define ZWP_TEXT_INPUT_V1_PREEDIT_STYLING … #define ZWP_TEXT_INPUT_V1_PREEDIT_CURSOR … #define ZWP_TEXT_INPUT_V1_COMMIT_STRING … #define ZWP_TEXT_INPUT_V1_CURSOR_POSITION … #define ZWP_TEXT_INPUT_V1_DELETE_SURROUNDING_TEXT … #define ZWP_TEXT_INPUT_V1_KEYSYM … #define ZWP_TEXT_INPUT_V1_LANGUAGE … #define ZWP_TEXT_INPUT_V1_TEXT_DIRECTION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_ENTER_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_LEAVE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_MODIFIERS_MAP_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_INPUT_PANEL_STATE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_PREEDIT_STRING_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_PREEDIT_STYLING_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_PREEDIT_CURSOR_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_COMMIT_STRING_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_CURSOR_POSITION_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_DELETE_SURROUNDING_TEXT_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_KEYSYM_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_LANGUAGE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_ACTIVATE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_DEACTIVATE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_SHOW_INPUT_PANEL_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_HIDE_INPUT_PANEL_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_RESET_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_SET_SURROUNDING_TEXT_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_SET_CONTENT_TYPE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_SET_CURSOR_RECTANGLE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_SET_PREFERRED_LANGUAGE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_COMMIT_STATE_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 */ #define ZWP_TEXT_INPUT_V1_INVOKE_ACTION_SINCE_VERSION … /** * @ingroup iface_zwp_text_input_v1 * Sends an enter event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_enter(struct wl_resource *resource_, struct wl_resource *surface) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an leave event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_leave(struct wl_resource *resource_) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an modifiers_map event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_modifiers_map(struct wl_resource *resource_, struct wl_array *map) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an input_panel_state event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_input_panel_state(struct wl_resource *resource_, uint32_t state) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an preedit_string event to the client owning the resource. * @param resource_ The client's resource * @param serial serial of the latest known text input state */ static inline void zwp_text_input_v1_send_preedit_string(struct wl_resource *resource_, uint32_t serial, const char *text, const char *commit) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an preedit_styling event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_preedit_styling(struct wl_resource *resource_, uint32_t index, uint32_t length, uint32_t style) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an preedit_cursor event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_preedit_cursor(struct wl_resource *resource_, int32_t index) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an commit_string event to the client owning the resource. * @param resource_ The client's resource * @param serial serial of the latest known text input state */ static inline void zwp_text_input_v1_send_commit_string(struct wl_resource *resource_, uint32_t serial, const char *text) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an cursor_position event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_cursor_position(struct wl_resource *resource_, int32_t index, int32_t anchor) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an delete_surrounding_text event to the client owning the resource. * @param resource_ The client's resource */ static inline void zwp_text_input_v1_send_delete_surrounding_text(struct wl_resource *resource_, int32_t index, uint32_t length) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an keysym event to the client owning the resource. * @param resource_ The client's resource * @param serial serial of the latest known text input state */ static inline void zwp_text_input_v1_send_keysym(struct wl_resource *resource_, uint32_t serial, uint32_t time, uint32_t sym, uint32_t state, uint32_t modifiers) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an language event to the client owning the resource. * @param resource_ The client's resource * @param serial serial of the latest known text input state */ static inline void zwp_text_input_v1_send_language(struct wl_resource *resource_, uint32_t serial, const char *language) { … } /** * @ingroup iface_zwp_text_input_v1 * Sends an text_direction event to the client owning the resource. * @param resource_ The client's resource * @param serial serial of the latest known text input state */ static inline void zwp_text_input_v1_send_text_direction(struct wl_resource *resource_, uint32_t serial, uint32_t direction) { … } /** * @ingroup iface_zwp_text_input_manager_v1 * @struct zwp_text_input_manager_v1_interface */ struct zwp_text_input_manager_v1_interface { … }; /** * @ingroup iface_zwp_text_input_manager_v1 */ #define ZWP_TEXT_INPUT_MANAGER_V1_CREATE_TEXT_INPUT_SINCE_VERSION … #ifdef __cplusplus } #endif #endif
Codebase Browser
chromium