## gok-word-complete

gok-word-complete

## Synopsis

    gboolean            gok_wordcomplete_open               (GokWordComplete *complete,
                                                             gchar *directory);
    void                gok_wordcomplete_close              (GokWordComplete *complete);
    gchar**             gok_wordcomplete_predict            (GokWordComplete *complete,
                                                             gint num_predictions);
    gboolean            gok_wordcomplete_add_new_word       (GokWordComplete *complete,
                                                             const char *word);

## Description

## Details

### gok_wordcomplete_open ()

    gboolean            gok_wordcomplete_open               (GokWordComplete *complete,
                                                             gchar *directory);

Opens and initializes the word completor engine.

`complete` : |
`directory` : |
Returns : | TRUE if it was opend OK, FALSE if not.

### gok_wordcomplete_close ()

    void                gok_wordcomplete_close              (GokWordComplete *complete);

Closes the word completor engine.

`complete` : |

### gok_wordcomplete_predict ()

    gchar**             gok_wordcomplete_predict            (GokWordComplete *complete,
                                                             gint num_predictions);

Makes a prediction. If the currently displayed keyboard is showing prediction keys then they are filled in with the predictions.

`complete` : |
`num_predictions` : |
Returns : | An array of strings representing the predicted completions.

### gok_wordcomplete_add_new_word ()

    gboolean            gok_wordcomplete_add_new_word       (GokWordComplete *complete,
                                                             const char *word);

Adds a new word to the predictor dictionary.

`complete` : |
`word` : |
Returns : | TRUE if the word was added to the dictionary, FALSE if not.