HildonIMUI

HildonIMUI — Hildon Input Method user interface class

Synopsis

#define             HildonGtkInputMode
                    HildonIMUIPrivate;
#define             HILDON_IM_GCONF_DIR
#define             HILDON_IM_GCONF_LANG_DIR
#define             HILDON_IM_GCONF_PRIMARY_LANGUAGE
#define             HILDON_IM_GCONF_SECONDARY_LANGUAGE
#define             HILDON_IM_GCONF_CURRENT_LANGUAGE
#define             HILDON_IM_GCONF_USE_FINGER_KB
#define             HILDON_IM_DEFAULT_LANGUAGE
#define             OSSO_DIR
#define             IM_HOME_DIR
#define             HILDON_IM_PROP_UI
#define             HILDON_IM_PROP_UI_DESCRIPTION
#define             HILDON_IM_DEFAULT_HEIGHT
enum                HildonIMButton;
enum                HildonIMUISound;
                    HildonIMUI;
GtkWidget*          hildon_im_ui_new                    (void);
GtkWidget*          hildon_im_dynamic_widget_new        (const gchar *library_name,
                                                         const gchar *widget_name);
gboolean            hildon_im_ui_get_visibility         (HildonIMUI *self);
HildonGtkInputMode  hildon_im_ui_get_current_input_mode (HildonIMUI *self);
HildonGtkInputMode  hildon_im_ui_get_current_default_input_mode
                                                        (HildonIMUI *self);
HildonIMCommand     hildon_im_ui_get_autocase_mode      (HildonIMUI *self);
HildonIMCommitMode  hildon_im_ui_get_commit_mode        (HildonIMUI *self);
gboolean            hildon_im_ui_is_first_boot          (HildonIMUI *self);
void                hildon_im_ui_set_keyboard_state     (HildonIMUI *self,
                                                         gboolean available);
void                hildon_im_ui_set_visible            (HildonIMUI *ui,
                                                         gboolean visible);
void                hildon_im_ui_restore_previous_mode  (HildonIMUI *self);
void                hildon_im_ui_activate_plugin        (HildonIMUI *self,
                                                         gchar *name,
                                                         gboolean init);
void                hildon_im_ui_toggle_special_plugin  (HildonIMUI *self);
void                hildon_im_ui_send_utf8              (HildonIMUI *self,
                                                         const gchar *utf8);
void                hildon_im_ui_send_communication_message
                                                        (HildonIMUI *self,
                                                         gint message);
void                hildon_im_ui_send_surrounding_content
                                                        (HildonIMUI *self,
                                                         const gchar *surrounding);
void                hildon_im_ui_send_surrounding_offset
                                                        (HildonIMUI *self,
                                                         gboolean is_relative,
                                                         gint offset);
const gchar*        hildon_im_ui_get_surrounding        (HildonIMUI *ui);
gint                hildon_im_ui_get_surrounding_offset (HildonIMUI *keyboard);
void                hildon_im_ui_set_context_options    (HildonIMUI *ui,
                                                         HildonIMOptionMask options,
                                                         gboolean enable);
void                hildon_im_ui_play_sound             (HildonIMUI *ui,
                                                         HildonIMUISound sound);
const gchar*        hildon_im_ui_get_language_setting   (HildonIMUI *self,
                                                         gint index);
gboolean            hildon_im_ui_set_language_setting   (HildonIMUI *self,
                                                         gint index,
                                                         const gchar *new_language);
const gchar*        hildon_im_ui_get_active_language    (HildonIMUI *self);
gint                hildon_im_ui_get_active_language_index
                                                        (HildonIMUI *self);
gboolean            hildon_im_ui_set_active_language_index
                                                        (HildonIMUI *ui,
                                                         gint index);
const gchar*        hildon_im_ui_get_plugin_buffer      (HildonIMUI *ui);
void                hildon_im_ui_append_plugin_buffer   (HildonIMUI *ui,
                                                         const gchar *val);
void                hildon_im_ui_erase_plugin_buffer    (HildonIMUI *ui,
                                                         gint len);
void                hildon_im_ui_clear_plugin_buffer    (HildonIMUI *ui);
void                hildon_im_ui_parse_rc_file          (HildonIMUI *ui,
                                                         gchar *rc_file);
Window              hildon_im_ui_get_input_window       (HildonIMUI *ui);
HildonIMInternalModifierMask hildon_im_ui_get_mask      (HildonIMUI *self);
void                hildon_im_ui_set_mask               (HildonIMUI *self,
                                                         HildonIMInternalModifierMask mask);
gboolean            hildon_im_ui_get_shift_locked       (HildonIMUI *self);
void                hildon_im_ui_set_shift_locked       (HildonIMUI *self,
                                                         gboolean locked);
gboolean            hildon_im_ui_get_level_locked       (HildonIMUI *self);
void                hildon_im_ui_set_level_locked       (HildonIMUI *self,
                                                         gboolean locked);
gboolean            hildon_im_ui_get_shift_sticky       (HildonIMUI *self);
void                hildon_im_ui_set_shift_sticky       (HildonIMUI *self,
                                                         gboolean sticky);
gboolean            hildon_im_ui_get_level_sticky       (HildonIMUI *self);
void                hildon_im_ui_set_level_sticky       (HildonIMUI *self,
                                                         gboolean sticky);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----HildonIMUI

Implemented Interfaces

HildonIMUI implements AtkImplementorIface and GtkBuildable.

Description

Details

HildonGtkInputMode

#define HildonGtkInputMode gint

HildonIMUIPrivate

typedef struct _HildonIMUIPrivate HildonIMUIPrivate;

HILDON_IM_GCONF_DIR

#define HILDON_IM_GCONF_DIR "/apps/osso/inputmethod"

HILDON_IM_GCONF_LANG_DIR

#define HILDON_IM_GCONF_LANG_DIR                   HILDON_IM_GCONF_DIR       "/hildon-im-languages"

HILDON_IM_GCONF_PRIMARY_LANGUAGE

#define HILDON_IM_GCONF_PRIMARY_LANGUAGE           _HILDON_IM_GCONF_LANGUAGE "0"

HILDON_IM_GCONF_SECONDARY_LANGUAGE

#define HILDON_IM_GCONF_SECONDARY_LANGUAGE         _HILDON_IM_GCONF_LANGUAGE "1"

HILDON_IM_GCONF_CURRENT_LANGUAGE

#define HILDON_IM_GCONF_CURRENT_LANGUAGE           HILDON_IM_GCONF_LANG_DIR  "/current"

HILDON_IM_GCONF_USE_FINGER_KB

#define HILDON_IM_GCONF_USE_FINGER_KB              HILDON_IM_GCONF_DIR       "/use_finger_kb"

HILDON_IM_DEFAULT_LANGUAGE

#define HILDON_IM_DEFAULT_LANGUAGE IM_en_GB

OSSO_DIR

#define OSSO_DIR ".osso"

IM_HOME_DIR

#define IM_HOME_DIR "hildon-input-method"

HILDON_IM_PROP_UI

#define HILDON_IM_PROP_UI 1

HILDON_IM_PROP_UI_DESCRIPTION

#define HILDON_IM_PROP_UI_DESCRIPTION "UI"

HILDON_IM_DEFAULT_HEIGHT

#define HILDON_IM_DEFAULT_HEIGHT -1

enum HildonIMButton

typedef enum
{
  HILDON_IM_BUTTON_TAB = 0,
  HILDON_IM_BUTTON_MODE_A,
  HILDON_IM_BUTTON_MODE_B,
  HILDON_IM_BUTTON_INPUT_MENU,
  HILDON_IM_BUTTON_BACKSPACE,
  HILDON_IM_BUTTON_ENTER,
  HILDON_IM_BUTTON_SPECIAL_CHAR,
  HILDON_IM_BUTTON_CLOSE,

  HILDON_IM_NUM_BUTTONS
} HildonIMButton;

enum HildonIMUISound

typedef enum
{
  HILDON_IM_ILLEGAL_INPUT_SOUND,
  HILDON_IM_NUMBER_INPUT_SOUND,
  HILDON_IM_FINGER_TRIGGER_SOUND
} HildonIMUISound;

HildonIMUI

typedef struct _HildonIMUI HildonIMUI;

hildon_im_ui_new ()

GtkWidget*          hildon_im_ui_new                    (void);

Creates and returns a HildonIMUI

Returns :

a newly allocated HildonIMUI

hildon_im_dynamic_widget_new ()

GtkWidget*          hildon_im_dynamic_widget_new        (const gchar *library_name,
                                                         const gchar *widget_name);

`library_name` :
`widget_name` :
Returns :

hildon_im_ui_get_visibility ()

gboolean            hildon_im_ui_get_visibility         (HildonIMUI *self);

Gets the visibility of the main UI

`self` :	HildonIMUI
Returns :	a gboolean

hildon_im_ui_get_current_input_mode ()

HildonGtkInputMode  hildon_im_ui_get_current_input_mode (HildonIMUI *self);

Returns the current input mode of the ui or HILDON_IM_HIDE if self is not a valid HildonIMUI.

`self` :	HildonIMUI
Returns :	the current HildonIMMode of the UI.

hildon_im_ui_get_current_default_input_mode ()

HildonGtkInputMode  hildon_im_ui_get_current_default_input_mode
                                                        (HildonIMUI *self);

Gets the current default input mode

`self` :	HildonIMUI
Returns :	the current default HildonGtkInputMode

hildon_im_ui_get_autocase_mode ()

HildonIMCommand     hildon_im_ui_get_autocase_mode      (HildonIMUI *self);

Returns the autocase mode of the ui or HILDON_IM_LOW if self is not a valid HildonIMUI

`self` :	HildonIMUI
Returns :	a HildonIMCommand

hildon_im_ui_get_commit_mode ()

HildonIMCommitMode  hildon_im_ui_get_commit_mode        (HildonIMUI *self);

Gets the current commit mode of the input method

`self` :	HildonIMUI
Returns :	a HildonIMCommitMode

hildon_im_ui_is_first_boot ()

gboolean            hildon_im_ui_is_first_boot          (HildonIMUI *self);

Determines whether this is a first boot

`self` :	HildonIMUI
Returns :

hildon_im_ui_set_keyboard_state ()

void                hildon_im_ui_set_keyboard_state     (HildonIMUI *self,
                                                         gboolean available);

Inform the UI of the external keyboard state

`self` :	HildonIMUI
`available` :	is a keyboard available?

hildon_im_ui_set_visible ()

void                hildon_im_ui_set_visible            (HildonIMUI *ui,
                                                         gboolean visible);

Set the visibility of the IM UI

`ui` :	HildonIMUI
`visible` :

hildon_im_ui_restore_previous_mode ()

void                hildon_im_ui_restore_previous_mode  (HildonIMUI *self);

Restores the input method to the previous input method selected

self : HildonIMUI

hildon_im_ui_activate_plugin ()

void                hildon_im_ui_activate_plugin        (HildonIMUI *self,
                                                         gchar *name,
                                                         gboolean init);

Activates the specified input method plugin

`self` :	HildonIMUI
`name` :	the plugin's name
`init` :	requires initialization?

hildon_im_ui_toggle_special_plugin ()

void                hildon_im_ui_toggle_special_plugin  (HildonIMUI *self);

Toggle between the special and active plugin

self : HildonIMUI

hildon_im_ui_send_utf8 ()

void                hildon_im_ui_send_utf8              (HildonIMUI *self,
                                                         const gchar *utf8);

Sends a utf-8 string to the client widget.

`self` :	HildonIMUI
`utf8` :	a utf-8 string

hildon_im_ui_send_communication_message ()

void                hildon_im_ui_send_communication_message
                                                        (HildonIMUI *self,
                                                         gint message);

Sends a HildonIMComMessage of type message with a XEvent to the IM context

`self` :	HildonIMUI
`message` :	the message

hildon_im_ui_send_surrounding_content ()

void                hildon_im_ui_send_surrounding_content
                                                        (HildonIMUI *self,
                                                         const gchar *surrounding);

Sends the surrounding context around the insertion point to the IM context.

`self` :	HildonIMUI
`surrounding` :	the surrounding string

hildon_im_ui_send_surrounding_offset ()

void                hildon_im_ui_send_surrounding_offset
                                                        (HildonIMUI *self,
                                                         gboolean is_relative,
                                                         gint offset);

Sends the character offset of the cursor location in the surrounding content.

`self` :	HildonIMUI
`is_relative` :	whether it is a relative offset
`offset` :	the offset

hildon_im_ui_get_surrounding ()

const gchar*        hildon_im_ui_get_surrounding        (HildonIMUI *ui);

Returns: the surrounding text

`ui` :	a HildonIMUI
Returns :	the context around the cursor

hildon_im_ui_get_surrounding_offset ()

gint                hildon_im_ui_get_surrounding_offset (HildonIMUI *keyboard);

`keyboard` :
Returns :

hildon_im_ui_set_context_options ()

void                hildon_im_ui_set_context_options    (HildonIMUI *ui,
                                                         HildonIMOptionMask options,
                                                         gboolean enable);

`ui` :	HildonIMUI
`options` :	HildonIMOptionMask
`enable` :	the option is enabled?

hildon_im_ui_play_sound ()

void                hildon_im_ui_play_sound             (HildonIMUI *ui,
                                                         HildonIMUISound sound);

Play a sound

`ui` :	HildonIMUI
`sound` :	the HildonIMUISound

hildon_im_ui_get_language_setting ()

const gchar*        hildon_im_ui_get_language_setting   (HildonIMUI *self,
                                                         gint index);

Gets the language setting for the specified language index

`self` :	HildonIMUI
`index` :	language index
Returns :

hildon_im_ui_set_language_setting ()

gboolean            hildon_im_ui_set_language_setting   (HildonIMUI *self,
                                                         gint index,
                                                         const gchar *new_language);

Sets the language setting to the specified language index

`self` :	HildonIMUI
`index` :	language index
`new_language` :
Returns :	TRUE if successful FALSE otherwise

hildon_im_ui_get_active_language ()

const gchar*        hildon_im_ui_get_active_language    (HildonIMUI *self);

Gets the active language.

`self` :	HildonIMUI
Returns :

hildon_im_ui_get_active_language_index ()

gint                hildon_im_ui_get_active_language_index
                                                        (HildonIMUI *self);

Gets the index of the active language.

`self` :	HildonIMUI
Returns :

hildon_im_ui_set_active_language_index ()

gboolean            hildon_im_ui_set_active_language_index
                                                        (HildonIMUI *ui,
                                                         gint index);

Sets the index of the active language.

`ui` :	HildonIMUI
`index` :	the index to set
Returns :	TRUE if successful, FALSE otherwise

hildon_im_ui_get_plugin_buffer ()

const gchar*        hildon_im_ui_get_plugin_buffer      (HildonIMUI *ui);

Retrieve the contents of the shared plugin buffer

`ui` :	HildonIMUI
Returns :

hildon_im_ui_append_plugin_buffer ()

void                hildon_im_ui_append_plugin_buffer   (HildonIMUI *ui,
                                                         const gchar *val);

Append a value to the end of the shared plugin buffer

`ui` :	HildonIMUI
`val` :	The value to append

hildon_im_ui_erase_plugin_buffer ()

void                hildon_im_ui_erase_plugin_buffer    (HildonIMUI *ui,
                                                         gint len);

Erases a number of characters from the end of the shared plugin buffer

`ui` :	HildonIMUI
`len` :	number of characters to erase

hildon_im_ui_clear_plugin_buffer ()

void                hildon_im_ui_clear_plugin_buffer    (HildonIMUI *ui);

Clears the shared plugin buffer

ui : HildonIMUI

hildon_im_ui_parse_rc_file ()

void                hildon_im_ui_parse_rc_file          (HildonIMUI *ui,
                                                         gchar *rc_file);

Parses the given rc_file only if it has not been parsed before.

`ui` :	HildonIMUI
`rc_file` :	the gtkrc file to parse

hildon_im_ui_get_input_window ()

Window              hildon_im_ui_get_input_window       (HildonIMUI *ui);

`ui` :	HildonIMUI
Returns :	The client application's X window

hildon_im_ui_get_mask ()

HildonIMInternalModifierMask hildon_im_ui_get_mask      (HildonIMUI *self);

`self` :	HildonIMUI
Returns :	The mask representing shift and level states as in client context

hildon_im_ui_set_mask ()

void                hildon_im_ui_set_mask               (HildonIMUI *self,
                                                         HildonIMInternalModifierMask mask);

Sets the new states of shift and level to be sent to the client context

`self` :	HildonIMUI
`mask` :	a HildonIMInternalModifierMask representing the new mask

hildon_im_ui_get_shift_locked ()

gboolean            hildon_im_ui_get_shift_locked       (HildonIMUI *self);

`self` :	HildonIMUI
Returns :	TRUE if shift is currently locked, FALSE otherwise.

hildon_im_ui_set_shift_locked ()

void                hildon_im_ui_set_shift_locked       (HildonIMUI *self,
                                                         gboolean locked);

Activate/deactivates shift lock.

`self` :	HildonIMUI
`locked` :	boolean value to set/remove shift lock state.

hildon_im_ui_get_level_locked ()

gboolean            hildon_im_ui_get_level_locked       (HildonIMUI *self);

`self` :	HildonIMUI
Returns :	TRUE if level is currently locked, FALSE otherwise.

hildon_im_ui_set_level_locked ()

void                hildon_im_ui_set_level_locked       (HildonIMUI *self,
                                                         gboolean locked);

Activate/deactivates level lock.

`self` :	HildonIMUI
`locked` :	boolean value to set/remove level lock state.

hildon_im_ui_get_shift_sticky ()

gboolean            hildon_im_ui_get_shift_sticky       (HildonIMUI *self);

`self` :	HildonIMUI
Returns :	TRUE if shift is currently sticky, FALSE otherwise.

hildon_im_ui_set_shift_sticky ()

void                hildon_im_ui_set_shift_sticky       (HildonIMUI *self,
                                                         gboolean sticky);

Activate/deactivates shift sticky.

`self` :	HildonIMUI
`sticky` :	boolean value to set/remove shift sticky mask.

hildon_im_ui_get_level_sticky ()

gboolean            hildon_im_ui_get_level_sticky       (HildonIMUI *self);

`self` :	HildonIMUI
Returns :	TRUE if level is currently sticky, FALSE otherwise.

hildon_im_ui_set_level_sticky ()

void                hildon_im_ui_set_level_sticky       (HildonIMUI *self,
                                                         gboolean sticky);

Activate/deactivates level sticky.

`self` :	HildonIMUI
`sticky` :	boolean value to set/remove level sticky mask.

			Hildon Input Method - Reference Manual
Top \| Description \| Object Hierarchy \| Implemented Interfaces