NimfServer 3 NIMF Library
NimfServer

## Functions

void | nimf_server_change_engine_by_id ()
void | nimf_server_change_engine ()
gchar ** | nimf_server_get_loaded_engine_ids ()
NimfServer * | nimf_server_get_default ()
NimfPreeditable * | nimf_server_get_preeditable ()

## Signals

void | engine-changed | Run Last
void | engine-loaded | Run Last
void | engine-status-changed | Run Last
void | engine-unloaded | Run Last

## Object Hierarchy

        GObject
        ╰── NimfServer

## Description

## Functions

### nimf_server_change_engine_by_id ()

    void
    nimf_server_change_engine_by_id (NimfServer *server,
                                     const gchar *engine_id);

Changes the last focused engine to the engine with the given ID.

#### Parameters

server | a NimfServer |
engine_id | engine id |

nimf_server_change_engine_by_id

### nimf_server_change_engine ()

    void
    nimf_server_change_engine (NimfServer *server,
                               const gchar *engine_id,
                               const gchar *method_id);

#### Parameters

server | a NimfServer |
engine_id | engine id |
method_id | method id |

nimf_server_change_engine

### nimf_server_get_loaded_engine_ids ()

    gchar **
    nimf_server_get_loaded_engine_ids (NimfServer *server);

The array is `NULL`-terminated.

#### Parameters

server | a NimfServer |

#### Returns

a new `NULL`-terminated engine id array.

[transfer full]

nimf_server_get_loaded_engine_ids

### nimf_server_get_default ()

    NimfServer *
    nimf_server_get_default (void);

Returns the default NimfServer instance.

If there is no default server then `NULL` is returned.

#### Returns

the default server, or `NULL` if server is not running.

[transfer none]

nimf_server_get_default

### nimf_server_get_preeditable ()

    NimfPreeditable *
    nimf_server_get_preeditable (NimfServer *server);

Returns the NimfPreeditable instance.

If there is no default preeditable then `NULL` is returned.

#### Parameters

server | a NimfServer |

#### Returns

a NimfPreeditable, or `NULL`.

[transfer none]

nimf_server_get_preeditable

## Signal Details

### The `“engine-changed”` signal

    void
    user_function (NimfServer *server,
                   char       *engine_id,
                   char       *icon_name,
                   gpointer    user_data)

The “engine-changed” signal is emitted when the engine is changed.

#### Parameters

server | a NimfServer |
engine_id | engine id |
icon_name | icon name |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

NimfServer::engine-changed

### The `“engine-loaded”` signal

    void
    user_function (NimfServer *server,
                   char       *engine_id,
                   gpointer    user_data)

The “engine-loaded” signal is emitted when the engine is loaded.

#### Parameters

server | a NimfServer |
engine_id | engine id |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

NimfServer::engine-loaded

### The `“engine-status-changed”` signal

    void
    user_function (NimfServer *server,
                   char       *engine_id,
                   char       *icon_name,
                   gpointer    user_data)

The “engine-status-changed” signal is emitted when the engine status is changed.

#### Parameters

server | a NimfServer |
engine_id | engine id |
icon_name | icon name |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

NimfServer::engine-status-changed

### The `“engine-unloaded”` signal

    void
    user_function (NimfServer *server,
                   char       *engine_id,
                   gpointer    user_data)

The “engine-unloaded” signal is emitted when the engine is unloaded.

#### Parameters

server | a NimfServer |
engine_id | engine id |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

NimfServer::engine-unloaded