gok-word-complete

Name

gok-word-complete -- 

Synopsis



gboolean    gok_wordcomplete_open           (gchar *directory);
void        gok_wordcomplete_close          (void);
void        gok_wordcomplete_on             (gboolean bTrueFalse);
void        gok_wordcomplete_change_number_predictions
                                            (int number);
int         gok_wordcomplete_predict        (const char letter);
gboolean    gok_wordcomplete_add_new_word   (const char *pWord);
gboolean    gok_wordcomplete_add_prediction_keys
                                            (GokKeyboard *pKeyboard);
GokOutput*  gok_wordcomplete_get_output     (GokKey *pKey);
void        gok_wordcomplete_clear_keys     (void);
void        gok_wordcomplete_end_word       (void);

Description

Details

gok_wordcomplete_open ()

gboolean    gok_wordcomplete_open           (gchar *directory);

Opens and initializes the word completor engine.

directory :

Returns :

TRUE if it was opend OK, FALSE if not.


gok_wordcomplete_close ()

void        gok_wordcomplete_close          (void);

Closes the word completor engine.


gok_wordcomplete_on ()

void        gok_wordcomplete_on             (gboolean bTrueFalse);

Turns on (or off) the word completor. This adds (or removes) the word completion keys to every keyboard that supports word completion.

bTrueFalse :


gok_wordcomplete_change_number_predictions ()

void        gok_wordcomplete_change_number_predictions
                                            (int number);

Number: Number of prediction keys.

Changes the number of word prediction keys displayed on the keyboard. This should be called after the user has selected a new number from the settings dialog.

number :


gok_wordcomplete_predict ()

int         gok_wordcomplete_predict        (const char letter);

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

letter :

Returns :

The number of words predicted.


gok_wordcomplete_add_new_word ()

gboolean    gok_wordcomplete_add_new_word   (const char *pWord);

Adds a new word to the predictor dictionary.

pWord :

Returns :

TRUE if the word was added to the dictionary, FALSE if not.


gok_wordcomplete_add_prediction_keys ()

gboolean    gok_wordcomplete_add_prediction_keys
                                            (GokKeyboard *pKeyboard);

pKeyboard: Pointer to the keyboard that gets the new prediction keys.

Adds a row of prediction keys to the given keyboard.

pKeyboard :

Returns :

TRUE if the prediction keys were added, FALSE if not.


gok_wordcomplete_get_output ()

GokOutput*  gok_wordcomplete_get_output     (GokKey *pKey);

Gets the output for a word prediction key.

pKey: Pointer to the word completion key that will be output.

pKey :

Returns :

A pointer to the output.


gok_wordcomplete_clear_keys ()

void        gok_wordcomplete_clear_keys     (void);

Clears the word completion keys on the current keyboard. (The keys are still displayed, they just have no label or output.)


gok_wordcomplete_end_word ()

void        gok_wordcomplete_end_word       (void);

Resets the part word buffer.