/**
* @brief Enumeration for input method function error
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
typedef enum
{
/**
* @brief Enumeration of the option window type
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @see ime_option_window_created_cb
*/
/**
* @brief Enumeration of layout variation
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @see ime_context_get_layout_variation
*/
*
* @remarks Currently, a font style is available to use.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @see ime_preedit_attribute, ime_update_preedit_string
*/
/**
* @brief Value for #IME_ATTR_FONTSTYLE. Draw a line under the text.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
#define IME_ATTR_FONTSTYLE_UNDERLINE 1
/**
* @brief Value for #IME_ATTR_FONTSTYLE. Draw text in highlighted color.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
#define IME_ATTR_FONTSTYLE_HIGHLIGHT 2
/**
* @brief Value for #IME_ATTR_FONTSTYLE. Draw text in reversal color.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
#define IME_ATTR_FONTSTYLE_REVERSAL 4
*
* @remarks A preedit string may have one or more different attributes. This structure describes each attribute of the string.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @see ime_update_preedit_string, ime_attribute_type
*/
* @details This is one of parameters of ime_show_cb() callback function. IME application
* should configure its input panel with this structure information.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @see ime_context_get_layout, ime_context_get_layout_variation, ime_context_get_cursor_position,
* ime_context_get_autocapital_type, ime_context_get_return_key_type, ime_context_get_return_key_state,
* @details This is one of parameters of ime_process_key_event_cb() callback function. IME application
* may distinguish the key event by using this if necessary.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @see ime_process_key_event_cb, ime_device_info_get_name, ime_device_info_get_class, ime_device_info_get_subclass
*/
* @remarks This callback function is mandatory and must be registered using ime_run(). The
* ime_get_main_window() can be used to get the created input panel window.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks This callback function is mandatory and must be registered using ime_run(). The
* ime_get_main_window() can be used to get the created input panel window.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* IME application should configure its input panel with #ime_context_h structure information.
* The ime_get_main_window() can be used to get the created input panel window.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks This callback function is mandatory and must be registered using ime_run(). The
* ime_get_main_window() can be used to get the created input panel window.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called when an associated text input UI control has focus.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called when an associated text input UI control loses focus.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks The ime_request_surrounding_text() must be called to invoke this callback function, asynchronously.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called to reset the input context of an associated text input UI control.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called when the position of the cursor in an associated text input UI control changes.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks The allocated @a lang_code will be released internally.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* through #ime_context_h. This callback function will be only called when the client
* application changes the edit field's language attribute after the input panel is shown.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details This API is used by the applications to deliver the specific data to the input panel.
* The data format MUST be negotiated by both application and input panel.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks The allocated @a data will be released internally.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* through #ime_context_h. This callback function will be only called when the client
* application changes the edit field's layout attribute after the input panel is shown.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* application changes the edit field's @c Return key type attribute after the input panel
* is shown.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* application changes the edit field's @c Return key disable attribute after the input panel
* is shown.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called when an associated text input UI control requests the position and size from the input panel.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called when the system display language is changed.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called when the device is rotated.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called when Accessibility in Settings application is on or off.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks if Input panel requests to open the option window, @a type will be #IME_OPTION_WINDOW_TYPE_KEYBOARD.
* And if Settings application requests to open it, @a type will be #IME_OPTION_WINDOW_TYPE_SETTING_APPLICATION.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Called to destroy the option window.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks These four callback functions are mandatory for IME application.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @see ime_run
*/
* ime_terminate_cb(), ime_show_cb(), and ime_hide_cb() callback functions
* are mandatory for IME application.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_focus_in_cb() callback function is called when an associated text input
* UI control has focus.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_focus_out_cb() callback function is called when an associated text input
* UI control loses focus.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_surrounding_text_updated_cb() callback function is called when an
* associated text input UI control responds to a request with the surrounding text.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_input_context_reset_cb() callback function is called to reset the input
* context of an associated text input UI control.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_cursor_position_updated_cb() callback function is called when the position
* of the cursor in an associated text input UI control changes.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_language_requested_cb() callback function is called when an associated
* text input UI control requests the language from the input panel.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_language_set_cb() callback function is called to set the preferred
* language to the input panel.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_imdata_set_cb() callback function is called to set the application
* specific data to deliver to the input panel.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_imdata_requested_cb() callback function is called when an associated
* text input UI control requests the application specific data from the input panel.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_layout_set_cb() callback function is called when an associated text input
* UI control requests the input panel to set its layout.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_return_key_type_set_cb() callback function is called when an associated
* text input UI control requests the input panel to set the @c Return key label.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_return_key_state_set_cb() callback function is called when an associated
* text input UI control requests the input panel to enable or disable the @c Return key state.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_geometry_requested_cb() callback function is called when an associated
* text input UI control requests the position and size from the input panel.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_process_key_event_cb() callback function is called when the key event
* is received from the external keyboard devices or ime_send_key_event() function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_display_language_changed_cb() callback function is called when the system
* display language is changed.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_rotation_degree_changed_cb() callback function is called when the device
* is rotated.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks The ime_accessibility_state_changed_cb() callback function is called when
* Accessibility in Settings application is on or off.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks The ime_option_window_created_cb() callback function is called to create the option window.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks The ime_option_window_destroyed_cb() callback function is called to destroy the option window.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* If @a forward_key is @c true, this key event goes to the edit filed directly. And if @a forward_key
* is @c false, the ime_process_key_event_cb() callback function receives the key event before the edit field.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Sends the text to the associated text input UI control.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Requests to show preedit string.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Requests to hide preedit string.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Updates a new preedit string.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Requests the surrounding text from the position of the cursor, asynchronously.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Requests to delete surrounding text.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks The specific error code can be obtained using the get_last_result() method if this function returns NULL.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief This API updates the input panel window's size information.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* function calls ime_option_window_created_cb() callback function with
* #IME_OPTION_WINDOW_TYPE_KEYBOARD parameter.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details The input panel can call this function to close the option window which
* is created from either the input panel or Settings application.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the layout information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the layout variation information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the cursor position information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the autocapital type information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the @c Return key label type information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the @c Return key state information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the prediction mode information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks If @a password_mode is @c true, the input panel is advised not to support the predictive text.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @remarks @a input_hint is a bit-wise value which recommends the input panel provide
* an auto completion and so on if it is capable of supporting such features.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the bidirectional information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
* @details Each edit field has various attributes for input panel. This function can be
* called to get the preferred language information in ime_show_cb() callback function.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
*
* @remarks @a dev_name must be released using free().
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Gets the device class of the key event.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*
/**
* @brief Gets the device subclass of the key event.
*
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*
* @privlevel public
*