GtkIMContext

struct GtkIMContextClass {
  void (* preedit_start) (
    GtkIMContext* context
  );
  void (* preedit_end) (
    GtkIMContext* context
  );
  void (* preedit_changed) (
    GtkIMContext* context
  );
  void (* commit) (
    GtkIMContext* context,
    const gchar* str
  );
  gboolean (* retrieve_surrounding) (
    GtkIMContext* context
  );
  gboolean (* delete_surrounding) (
    GtkIMContext* context,
    gint offset,
    gint n_chars
  );
  void (* set_client_window) (
    GtkIMContext* context,
    GdkWindow* window
  );
  void (* get_preedit_string) (
    GtkIMContext* context,
    gchar** str,
    PangoAttrList** attrs,
    gint* cursor_pos
  );
  gboolean (* filter_keypress) (
    GtkIMContext* context,
    GdkEventKey* event
  );
  void (* focus_in) (
    GtkIMContext* context
  );
  void (* focus_out) (
    GtkIMContext* context
  );
  void (* reset) (
    GtkIMContext* context
  );
  void (* set_cursor_location) (
    GtkIMContext* context,
    GdkRectangle* area
  );
  void (* set_use_preedit) (
    GtkIMContext* context,
    gboolean use_preedit
  );
  void (* set_surrounding) (
    GtkIMContext* context,
    const gchar* text,
    gint len,
    gint cursor_index
  );
  gboolean (* get_surrounding) (
    GtkIMContext* context,
    gchar** text,
    gint* cursor_index
  );
  void (* _gtk_reserved1) (
void
  );
  void (* _gtk_reserved2) (
void
  );
  void (* _gtk_reserved3) (
void
  );
  void (* _gtk_reserved4) (
void
  );
  void (* _gtk_reserved5) (
void
  );
  void (* _gtk_reserved6) (
void
  );
  
}

No description available.

Class members

preedit_start: void (* preedit_start) ( GtkIMContext* context )

Default handler of the GtkIMContext::preedit-start signal.

preedit_end: void (* preedit_end) ( GtkIMContext* context )

Default handler of the GtkIMContext::preedit-end signal.

preedit_changed: void (* preedit_changed) ( GtkIMContext* context )

Default handler of the GtkIMContext::preedit-changed signal.

commit: void (* commit) ( GtkIMContext* context, const gchar* str )

Default handler of the GtkIMContext::commit signal.

retrieve_surrounding: gboolean (* retrieve_surrounding) ( GtkIMContext* context )

Default handler of the GtkIMContext::retrieve-surrounding signal.

delete_surrounding: gboolean (* delete_surrounding) ( GtkIMContext* context, gint offset, gint n_chars )

Default handler of the GtkIMContext::delete-surrounding signal.

set_client_window: void (* set_client_window) ( GtkIMContext* context, GdkWindow* window )

Called via gtk_im_context_set_client_window() when the input window where the entered text will appear changes. Override this to keep track of the current input window, for instance for the purpose of positioning a status display of your input method.

get_preedit_string: void (* get_preedit_string) ( GtkIMContext* context, gchar** str, PangoAttrList** attrs, gint* cursor_pos )

Called via gtk_im_context_get_preedit_string() to retrieve the text currently being preedited for display at the cursor position. Any input method which composes complex characters or any other compositions from multiple sequential key presses should override this method to provide feedback.

filter_keypress: gboolean (* filter_keypress) ( GtkIMContext* context, GdkEventKey* event )

Called via gtk_im_context_filter_keypress() on every key press or release event. Every non-trivial input method needs to override this in order to implement the mapping from key events to text. A return value of TRUE indicates to the caller that the event was consumed by the input method. In that case, the GtkIMContext::commit signal should be emitted upon completion of a key sequence to pass the resulting text back to the input widget. Alternatively, FALSE may be returned to indicate that the event wasn’t handled by the input method. If a builtin mapping exists for the key, it is used to produce a character.

focus_in: void (* focus_in) ( GtkIMContext* context )

Called via gtk_im_context_focus_in() when the input widget has gained focus. May be overridden to keep track of the current focus.

focus_out: void (* focus_out) ( GtkIMContext* context )

Called via gtk_im_context_focus_out() when the input widget has lost focus. May be overridden to keep track of the current focus.

reset: void (* reset) ( GtkIMContext* context )

Called via gtk_im_context_reset() to signal a change such as a change in cursor position. An input method that implements preediting should override this method to clear the preedit state on reset.

set_cursor_location: void (* set_cursor_location) ( GtkIMContext* context, GdkRectangle* area )

Called via gtk_im_context_set_cursor_location() to inform the input method of the current cursor location relative to the client window. May be overridden to implement the display of popup windows at the cursor position.

set_use_preedit: void (* set_use_preedit) ( GtkIMContext* context, gboolean use_preedit )

Called via gtk_im_context_set_use_preedit() to control the use of the preedit string. Override this to display feedback by some other means if turned off.

set_surrounding: void (* set_surrounding) ( GtkIMContext* context, const gchar* text, gint len, gint cursor_index )

Called via gtk_im_context_set_surrounding() in response to signal GtkIMContext::retrieve-surrounding to update the input method’s idea of the context around the cursor. It is not necessary to override this method even with input methods which implement context-dependent behavior. The base implementation is sufficient for gtk_im_context_get_surrounding() to work.

get_surrounding: gboolean (* get_surrounding) ( GtkIMContext* context, gchar** text, gint* cursor_index )

Called via gtk_im_context_get_surrounding() to update the context around the cursor location. It is not necessary to override this method even with input methods which implement context-dependent behavior. The base implementation emits GtkIMContext::retrieve-surrounding and records the context received by the subsequent invocation of get_surrounding.

_gtk_reserved1: void (* _gtk_reserved1) ( void )

No description available.

_gtk_reserved2: void (* _gtk_reserved2) ( void )

No description available.

_gtk_reserved3: void (* _gtk_reserved3) ( void )

No description available.

_gtk_reserved4: void (* _gtk_reserved4) ( void )

No description available.

_gtk_reserved5: void (* _gtk_reserved5) ( void )

No description available.

_gtk_reserved6: void (* _gtk_reserved6) ( void )

No description available.