![]() |
![]() |
![]() |
GTK+ Reference Manual | ![]() |
---|---|---|---|---|
#include <gtk/gtk.h> GtkIMContext; void gtk_im_context_set_client_window (GtkIMContext *context, GdkWindow *window); void gtk_im_context_get_preedit_string (GtkIMContext *context, gchar **str, PangoAttrList **attrs, gint *cursor_pos); gboolean gtk_im_context_filter_keypress (GtkIMContext *context, GdkEventKey *event); void gtk_im_context_focus_in (GtkIMContext *context); void gtk_im_context_focus_out (GtkIMContext *context); void gtk_im_context_reset (GtkIMContext *context); void gtk_im_context_set_cursor_location (GtkIMContext *context, const GdkRectangle *area); void gtk_im_context_set_use_preedit (GtkIMContext *context, gboolean use_preedit); void gtk_im_context_set_surrounding (GtkIMContext *context, const gchar *text, gint len, gint cursor_index); gboolean gtk_im_context_get_surrounding (GtkIMContext *context, gchar **text, gint *cursor_index); gboolean gtk_im_context_delete_surrounding (GtkIMContext *context, gint offset, gint n_chars); enum GtkIMContextClipboardOperation; enum HildonGtkInputMode; void gtk_im_context_hide (GtkIMContext *context); void gtk_im_context_show (GtkIMContext *context); void hildon_gtk_im_context_copy (GtkIMContext *context); void hildon_gtk_im_context_cut (GtkIMContext *context); gboolean hildon_gtk_im_context_filter_event (GtkIMContext *context, GdkEvent *event); gboolean hildon_gtk_im_context_has_selection (GtkIMContext *context); void hildon_gtk_im_context_hide (GtkIMContext *context); void hildon_gtk_im_context_paste (GtkIMContext *context); void hildon_gtk_im_context_show (GtkIMContext *context);
"hildon-input-default" HildonGtkInputMode : Read / Write / Construct "hildon-input-mode" HildonGtkInputMode : Read / Write / Construct
"clipboard-operation" : Run Last "commit" : Run Last "delete-surrounding" : Run Last "has-selection" : Run Last "preedit-changed" : Run Last "preedit-end" : Run Last "preedit-start" : Run Last "retrieve-surrounding" : Run Last
void gtk_im_context_set_client_window (GtkIMContext *context, GdkWindow *window);
Set the client window for the input context; this is the GdkWindow in which the input appears. This window is used in order to correctly position status windows, and may also be used for purposes internal to the input method.
context : |
a GtkIMContext |
window : |
the client window. This may be NULL to indicate
that the previous client window no longer exists.
|
void gtk_im_context_get_preedit_string (GtkIMContext *context, gchar **str, PangoAttrList **attrs, gint *cursor_pos);
Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point.
context : |
a GtkIMContext |
str : |
location to store the retrieved string. The
string retrieved must be freed with g_free() .
|
attrs : |
location to store the retrieved attribute list.
When you are done with this list, you must
unreference it with pango_attr_list_unref() .
|
cursor_pos : |
location to store position of cursor (in characters) within the preedit string. |
gboolean gtk_im_context_filter_keypress (GtkIMContext *context, GdkEventKey *event);
Allow an input method to internally handle key press and release
events. If this function returns TRUE
, then no further processing
should be done for this key event.
context : |
a GtkIMContext |
event : |
the key event |
Returns : | TRUE if the input method handled the key event.
|
void gtk_im_context_focus_in (GtkIMContext *context);
Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change.
context : |
a GtkIMContext |
void gtk_im_context_focus_out (GtkIMContext *context);
Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change.
context : |
a GtkIMContext |
void gtk_im_context_reset (GtkIMContext *context);
Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state.
context : |
a GtkIMContext |
void gtk_im_context_set_cursor_location (GtkIMContext *context, const GdkRectangle *area);
Notify the input method that a change in cursor position has been made. The location is relative to the client window.
context : |
a GtkIMContext |
area : |
new location |
void gtk_im_context_set_use_preedit (GtkIMContext *context, gboolean use_preedit);
Sets whether the IM context should use the preedit string
to display feedback. If use_preedit
is FALSE (default
is TRUE), then the IM context may use some other method to display
feedback, such as displaying it in a child of the root window.
context : |
a GtkIMContext |
use_preedit : |
whether the IM context should use the preedit string. |
void gtk_im_context_set_surrounding (GtkIMContext *context, const gchar *text, gint len, gint cursor_index);
Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the GtkIMContext::retrieve_surrounding signal, and will likely have no effect if called at other times.
context : |
a GtkIMContext |
text : |
text surrounding the insertion point, as UTF-8.
the preedit string should not be included within
text .
|
len : |
the length of text , or -1 if text is nul-terminated
|
cursor_index : |
the byte index of the insertion cursor within text .
|
gboolean gtk_im_context_get_surrounding (GtkIMContext *context, gchar **text, gint *cursor_index);
Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed.
This function is implemented by emitting the
GtkIMContext::retrieve_surrounding signal on the input method; in
response to this signal, a widget should provide as much context as
is available, up to an entire paragraph, by calling
gtk_im_context_set_surrounding()
. Note that there is no obligation
for a widget to respond to the ::retrieve_surrounding signal, so input
methods must be prepared to function without context.
context : |
a GtkIMContext |
text : |
location to store a UTF-8 encoded string of text
holding context around the insertion point.
If the function returns TRUE , then you must free
the result stored in this location with g_free() .
|
cursor_index : |
location to store byte index of the insertion cursor
within text .
|
Returns : | TRUE if surrounding text was provided; in this case
you must free the result stored in *text.
|
gboolean gtk_im_context_delete_surrounding (GtkIMContext *context, gint offset, gint n_chars);
Asks the widget that the input context is attached to to delete
characters around the cursor position by emitting the
GtkIMContext::delete_surrounding signal. Note that offset
and n_chars
are in characters not in bytes which differs from the usage other
places in GtkIMContext.
In order to use this function, you should first call
gtk_im_context_get_surrounding()
to get the current context, and
call this function immediately afterwards to make sure that you
know what you are deleting. You should also account for the fact
that even if the signal was handled, the input context might not
have deleted all the characters that were requested to be deleted.
This function is used by an input method that wants to make subsitutions in the existing text in response to new input. It is not useful for applications.
context : |
a GtkIMContext |
offset : |
offset from cursor position in chars; a negative value means start before the cursor. |
n_chars : |
number of characters to delete. |
Returns : | TRUE if the signal was handled.
|
typedef enum { GTK_IM_CONTEXT_CLIPBOARD_OP_COPY, GTK_IM_CONTEXT_CLIPBOARD_OP_CUT, GTK_IM_CONTEXT_CLIPBOARD_OP_PASTE } GtkIMContextClipboardOperation;
Determines the type of the requested clipboard operation.
typedef enum { HILDON_GTK_INPUT_MODE_ALPHA = 1 << 0, HILDON_GTK_INPUT_MODE_NUMERIC = 1 << 1, HILDON_GTK_INPUT_MODE_SPECIAL = 1 << 2, HILDON_GTK_INPUT_MODE_HEXA = 1 << 3, HILDON_GTK_INPUT_MODE_TELE = 1 << 4, HILDON_GTK_INPUT_MODE_FULL = (HILDON_GTK_INPUT_MODE_ALPHA | HILDON_GTK_INPUT_MODE_NUMERIC | HILDON_GTK_INPUT_MODE_SPECIAL), HILDON_GTK_INPUT_MODE_MULTILINE = 1 << 28, HILDON_GTK_INPUT_MODE_INVISIBLE = 1 << 29, HILDON_GTK_INPUT_MODE_AUTOCAP = 1 << 30, HILDON_GTK_INPUT_MODE_DICTIONARY = 1 << 31 } HildonGtkInputMode;
Determines the input mode. Setting the mode allows the input method to focus on the type of input that the application is expecting.
void gtk_im_context_hide (GtkIMContext *context);
gtk_im_context_hide
is deprecated and should not be used in newly-written code. Use hildon_gtk_im_context_hide()
instead.
Notify the input method that widget thinks the actual input method show be closed.
context : |
a GtkIMContext |
Since maemo 1.0
Stability Level: Unstable
void gtk_im_context_show (GtkIMContext *context);
gtk_im_context_show
is deprecated and should not be used in newly-written code. Use hildon_gtk_im_context_show()
instead.
Notify the input method that widget thinks the actual input method show be opened.
context : |
a GtkIMContext |
Since maemo 1.0
Stability Level: Unstable
void hildon_gtk_im_context_copy (GtkIMContext *context);
Requests from the widget attached to this input context that the selected text in it is copied to clipboard.
context : |
a GtkIMContext |
Since maemo 2.0
Stability Level: Unstable
void hildon_gtk_im_context_cut (GtkIMContext *context);
Requests from the widget attached to this input context that the selected text is cut and copied to clipboard.
context : |
a GtkIMContext |
Since maemo 2.0
Stability Level: Unstable
gboolean hildon_gtk_im_context_filter_event (GtkIMContext *context, GdkEvent *event);
Allow an input method to internally handle an event.
If this function returns TRUE
, then no further processing
should be done for this event.
Input methods must be able to accept all types of events (simply
returning FALSE
if the event was not handled), but there is no
obligation for a widget to submit any events to this function.
Widget events that are recommended to be run through this function
are GDK_BUTTON_PRESS
, GDK_BUTTON_RELEASE
, GDK_2BUTTON_PRESS
,
GDK_3BUTTON_PRESS
, GDK_KEY_PRESS
and GDK_KEY_RELEASE
.
Note that if the event passes the filter with the function returning
FALSE
, the widget still needs to process the event itself, this can
include calling gtk_im_context_focus_in()
, gtk_im_context_focus_out()
or gtk_im_context_filter_keypress()
for focus and keypress events
where applicable.
context : |
a GtkIMContext |
event : |
the event |
Returns : | TRUE if the input method handled the event.
|
Since maemo 2.0
Stability Level: Unstable
gboolean hildon_gtk_im_context_has_selection (GtkIMContext *context);
context : |
a GtkIMContext |
Returns : | TRUE if the widget attached to this input context has some text selected in it. |
Since maemo 2.0
Stability Level: Unstable
void hildon_gtk_im_context_hide (GtkIMContext *context);
Notify the input method that widget thinks the actual input method show be closed.
context : |
a GtkIMContext |
Since maemo 2.0
Stability Level: Unstable
void hildon_gtk_im_context_paste (GtkIMContext *context);
Requests from the widget attached to this input context that the text in clipboard is pasted to it.
context : |
a GtkIMContext |
Since maemo 2.0
Stability Level: Unstable
void hildon_gtk_im_context_show (GtkIMContext *context);
Notify the input method that widget thinks the actual input method show be opened.
context : |
a GtkIMContext |
Since maemo 2.0
Stability Level: Unstable
"hildon-input-default"
property"hildon-input-default" HildonGtkInputMode : Read / Write / Construct
Default input mode for this IM context. See HildonGtkInputMode.
The default setting for this property is HILDON_GTK_INPUT_MODE_FULL
,
which means that the default input mode to be used is up to the
implementation of the IM context.
Default value: HILDON_GTK_INPUT_MODE_ALPHA|HILDON_GTK_INPUT_MODE_NUMERIC|HILDON_GTK_INPUT_MODE_SPECIAL
Since maemo 5.0
"hildon-input-mode"
property"hildon-input-mode" HildonGtkInputMode : Read / Write / Construct
Allowed characters and input mode for this IM context. See HildonGtkInputMode.
Default value: HILDON_GTK_INPUT_MODE_ALPHA|HILDON_GTK_INPUT_MODE_NUMERIC|HILDON_GTK_INPUT_MODE_SPECIAL|HILDON_GTK_INPUT_MODE_AUTOCAP|HILDON_GTK_INPUT_MODE_DICTIONARY
Since maemo 2.0
Stability Level Unstable
"clipboard-operation"
signalvoid user_function (GtkIMContext *context, GtkIMContextClipboardOperation operation, gpointer user_data) : Run Last
This signal is emitted when input context wants to copy, cut or paste text. The widget needs to implement these operations.
context : |
a GtkIMContext |
operation : |
a GtkIMContextClipboardOperation |
user_data : |
user data set when the signal handler was connected. |
Since maemo 2.0
Stability Level: Unstable
"commit"
signalvoid user_function (GtkIMContext *imcontext, gchar *arg1, gpointer user_data) : Run Last
imcontext : |
the object which received the signal. |
arg1 : |
|
user_data : |
user data set when the signal handler was connected. |
"delete-surrounding"
signalgboolean user_function (GtkIMContext *imcontext, gint arg1, gint arg2, gpointer user_data) : Run Last
imcontext : |
the object which received the signal. |
arg1 : |
|
arg2 : |
|
user_data : |
user data set when the signal handler was connected. |
Returns : |
"has-selection"
signalgboolean user_function (GtkIMContext *context, gpointer user_data) : Run Last
This signal is emitted when input context needs to know if there is any text selected in the widget. Return TRUE if there is.
context : |
a GtkIMContext |
user_data : |
user data set when the signal handler was connected. |
Since maemo 2.0
Stability Level: Unstable
"preedit-changed"
signalvoid user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
imcontext : |
the object which received the signal. |
user_data : |
user data set when the signal handler was connected. |
"preedit-end"
signalvoid user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
imcontext : |
the object which received the signal. |
user_data : |
user data set when the signal handler was connected. |
"preedit-start"
signalvoid user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
imcontext : |
the object which received the signal. |
user_data : |
user data set when the signal handler was connected. |
"retrieve-surrounding"
signalgboolean user_function (GtkIMContext *imcontext, gpointer user_data) : Run Last
imcontext : |
the object which received the signal. |
user_data : |
user data set when the signal handler was connected. |
Returns : |