Ecore_IMF_Context_Module_Group (3) - Linux Manuals

Ecore_IMF_Context_Module_Group: Functions that should be used by Ecore Input Method Context modules.

NAME

Ecore Input Method Context Module Functions - Functions that should be used by Ecore Input Method Context modules.

Functions

EAPI Ecore_IMF_Context * ecore_imf_context_new (const Ecore_IMF_Context_Class *ctxc)
Creates a new Input Method Context with klass specified by ctxc.
EAPI void ecore_imf_context_data_set (Ecore_IMF_Context *ctx, void *data)
Set the Input Method Context specific data.
EAPI void * ecore_imf_context_data_get (Ecore_IMF_Context *ctx)
Get the Input Method Context specific data.
EAPI int ecore_imf_context_surrounding_get (Ecore_IMF_Context *ctx, char **text, int *cursor_pos)
Retrieve context around insertion point.
EAPI void ecore_imf_context_preedit_start_event_add (Ecore_IMF_Context *ctx)
Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue.
EAPI void ecore_imf_context_preedit_end_event_add (Ecore_IMF_Context *ctx)
Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue.
EAPI void ecore_imf_context_preedit_changed_event_add (Ecore_IMF_Context *ctx)
Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue.
EAPI void ecore_imf_context_commit_event_add (Ecore_IMF_Context *ctx, const char *str)
Adds ECORE_IMF_EVENT_COMMIT to the event queue.
EAPI void ecore_imf_context_delete_surrounding_event_add (Ecore_IMF_Context *ctx, int offset, int n_chars)
Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.

Detailed Description

Functions that should be used by Ecore Input Method Context modules.

Function Documentation

EAPI void ecore_imf_context_commit_event_add (Ecore_IMF_Context * ctx, const char * str)

Adds ECORE_IMF_EVENT_COMMIT to the event queue.

Parameters:

ctx An Ecore_IMF_Context.
str The committed string.

References ecore_event_add().

EAPI void* ecore_imf_context_data_get (Ecore_IMF_Context * ctx)

Get the Input Method Context specific data.

See ecore_imf_context_data_set for more details.

Parameters:

ctx An Ecore_IMF_Context.

Returns:

The Input Method Context specific data.

EAPI void ecore_imf_context_data_set (Ecore_IMF_Context * ctx, void * data)

Set the Input Method Context specific data.

Note that this method should be used by modules to set the Input Method Context specific data and it's not meant to be used by applications to store application specific data.

Parameters:

ctx An Ecore_IMF_Context.
data The Input Method Context specific data.

Returns:

A new Ecore_IMF_Context; on failure it returns NULL.

EAPI void ecore_imf_context_delete_surrounding_event_add (Ecore_IMF_Context * ctx, int offset, int n_chars)

Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.

Parameters:

ctx An Ecore_IMF_Context.
offset The start offset of surrounding to be deleted.
n_chars The number of characters to be deleted.

References ecore_event_add().

EAPI Ecore_IMF_Context* ecore_imf_context_new (const Ecore_IMF_Context_Class * ctxc)

Creates a new Input Method Context with klass specified by ctxc.

This method should be used by modules implementing the Input Method Context interface.

Parameters:

ctxc An Ecore_IMF_Context_Class.

Returns:

A new Ecore_IMF_Context; on failure it returns NULL.

EAPI void ecore_imf_context_preedit_changed_event_add (Ecore_IMF_Context * ctx)

Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue.

Parameters:

ctx An Ecore_IMF_Context.

References ecore_event_add().

EAPI void ecore_imf_context_preedit_end_event_add (Ecore_IMF_Context * ctx)

Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue.

Parameters:

ctx An Ecore_IMF_Context.

References ecore_event_add().

EAPI void ecore_imf_context_preedit_start_event_add (Ecore_IMF_Context * ctx)

Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue.

Parameters:

ctx An Ecore_IMF_Context.

References ecore_event_add().

EAPI int ecore_imf_context_surrounding_get (Ecore_IMF_Context * ctx, char ** text, int * cursor_pos)

Retrieve context around insertion point.

This function is implemented by calling the Ecore_IMF_Context::retrieve_surrounding_func ( set using ecore_imf_context_retrieve_surrounding_callback_set).

There is no obligation for a widget to respond to the retrieve_surrounding_func, so input methods must be prepared to function without context.

Parameters:

ctx An Ecore_IMF_Context.
text Location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns 1, then you must free the result stored in this location with free().
cursor_pos Location to store the position in characters of the insertion cursor within .

Returns:

1 if surrounding text was provided; otherwise 0.

Author

Generated automatically by Doxygen for Ecore from the source code.