NimfPreeditable 3 NIMF Library
NimfPreeditable

## Functions

void | nimf_preeditable_show ()
void | nimf_preeditable_hide ()
gboolean | nimf_preeditable_is_visible ()
void | nimf_preeditable_set_text ()
void | nimf_preeditable_set_cursor_location ()

## Types and Values

#define | NIMF_TYPE_PREEDITABLE
struct | NimfPreeditableInterface
| NimfPreeditable

## Object Hierarchy

        GInterface
        ╰── NimfPreeditable

## Prerequisites

NimfPreeditable requires GObject.

## Description

## Functions

### nimf_preeditable_show ()

    void
    nimf_preeditable_show (NimfPreeditable *preeditable);

Shows preeditable

#### Parameters

preeditable | a NimfPreeditable |

nimf_preeditable_show

### nimf_preeditable_hide ()

    void
    nimf_preeditable_hide (NimfPreeditable *preeditable);

Hides the preeditable

#### Parameters

preeditable | a NimfPreeditable |

nimf_preeditable_hide

### nimf_preeditable_is_visible ()

    gboolean
    nimf_preeditable_is_visible (NimfPreeditable *preeditable);

#### Parameters

preeditable | a NimfPreeditable |

#### Returns

`TRUE` if the preeditable is visible

nimf_preeditable_is_visible

### nimf_preeditable_set_text ()

    void
    nimf_preeditable_set_text (NimfPreeditable *preeditable,
                               const gchar *text,
                               gint cursor_pos);

Sets text to preeditable .

#### Parameters

preeditable | a NimfPreeditable |
text | text |
cursor_pos | cursor position |

nimf_preeditable_set_text

### nimf_preeditable_set_cursor_location ()

    void
    nimf_preeditable_set_cursor_location (NimfPreeditable *preeditable,
                                          const NimfRectangle *area);

Notifies the preeditable that a change in cursor position has been made. The location is the position of a window position in root window coordinates.

#### Parameters

preeditable | a NimfPreeditable |
area | a NimfRectangle |

nimf_preeditable_set_cursor_location

## Types and Values

### NIMF_TYPE_PREEDITABLE

    #define NIMF_TYPE_PREEDITABLE nimf_preeditable_get_type ()

NIMF_TYPE_PREEDITABLE

### struct NimfPreeditableInterface

    struct NimfPreeditableInterface {
      GTypeInterface parent;

      void     (* show)                (NimfPreeditable     *preeditable);
      void     (* hide)                (NimfPreeditable     *preeditable);
      gboolean (* is_visible)          (NimfPreeditable     *preeditable);
      void     (* set_text)            (NimfPreeditable     *preeditable,
                                        const gchar         *text,
                                        gint                 cursor_pos);
      void     (* set_cursor_location) (NimfPreeditable     *preeditable,
                                        const NimfRectangle *area);
    };

Provides an interface for preedit gadget.

#### Members

GTypeInterface parent; | The parent interface. |
show () | Shows the preeditable. |
hide () | Hides the preeditable. |
is_visible () | Checks if the preeditable is visible. |
set_text () | Sets the text in the preeditable to the given value, replacing the current contents. |
set_cursor_location () | Sets the cursor position. |

NimfPreeditableInterface

### NimfPreeditable

    typedef struct _NimfPreeditable NimfPreeditable;

NimfPreeditable