## GdictSpeller

GdictSpeller — Display matching words

## Synopsis

                        GdictSpeller;
                        GdictSpellerClass;
    GtkWidget*          gdict_speller_new                   (void);
    GtkWidget*          gdict_speller_new_with_context      (GdictContext *context);
    void                gdict_speller_set_context           (GdictSpeller *speller,
                                                             GdictContext *context);
    GdictContext*       gdict_speller_get_context           (GdictSpeller *speller);
    void                gdict_speller_set_database          (GdictSpeller *speller,
                                                             const gchar *database);
    const gchar*        gdict_speller_get_database          (GdictSpeller *speller);
    void                gdict_speller_set_strategy          (GdictSpeller *speller,
                                                             const gchar *strategy);
    const gchar*        gdict_speller_get_strategy          (GdictSpeller *speller);
    void                gdict_speller_clear                 (GdictSpeller *speller);
    void                gdict_speller_match                 (GdictSpeller *speller,
                                                             const gchar *word);
    gint                gdict_speller_count_matches         (GdictSpeller *speller);
    gchar**             gdict_speller_get_matches           (GdictSpeller *speller,
                                                             gsize length);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkVBox
                                           +----GdictSpeller

## Implemented Interfaces

GdictSpeller implements AtkImplementorIface and GtkBuildable.

## Properties

      "context"                  GdictContext*         : Read / Write / Construct
      "database"                 gchar*                : Read / Write
      "strategy"                 gchar*                : Read / Write

## Signals

      "word-activated"                                 : Run Last

## Description

GdictSpeller is a widget showing a list of words returned by a GdictContext query, using a specific database and a matching strategy.

## Details

### GdictSpeller

    typedef struct _GdictSpeller GdictSpeller;

### GdictSpellerClass

    typedef struct {
      GtkVBoxClass parent_class;

      void (*word_activated) (GdictSpeller *speller,
    		          const gchar  *word,
    			  const gchar  *database);

      /* padding for future expansion */
      void (*_gdict_speller_1) (void);
      void (*_gdict_speller_2) (void);
      void (*_gdict_speller_3) (void);
      void (*_gdict_speller_4) (void);
    } GdictSpellerClass;

### gdict_speller_new ()

    GtkWidget*          gdict_speller_new                   (void);

FIXME

Returns : | FIXME

Since

### gdict_speller_new_with_context ()

    GtkWidget*          gdict_speller_new_with_context      (GdictContext *context);

FIXME

`context` : | a GdictContext
Returns : | FIXME

Since

### gdict_speller_set_context ()

    void                gdict_speller_set_context           (GdictSpeller *speller,
                                                             GdictContext *context);

FIXME

`speller` : | a GdictSpeller
`context` : | a GdictContext

Since

### gdict_speller_get_context ()

    GdictContext*       gdict_speller_get_context           (GdictSpeller *speller);

FIXME

`speller` : | a GdictSpeller
Returns : | a GdictContext

Since

### gdict_speller_set_database ()

    void                gdict_speller_set_database          (GdictSpeller *speller,
                                                             const gchar *database);

FIXME

`speller` : | a GdictSpeller
`database` : | FIXME

Since

### gdict_speller_get_database ()

    const gchar*        gdict_speller_get_database          (GdictSpeller *speller);

FIXME

`speller` : | a GdictSpeller
Returns : | FIXME

Since FIXME

### gdict_speller_set_strategy ()

    void                gdict_speller_set_strategy          (GdictSpeller *speller,
                                                             const gchar *strategy);

FIXME

`speller` : | a GdictSpeller
`strategy` : | FIXME

Since FIXME

### gdict_speller_get_strategy ()

    const gchar*        gdict_speller_get_strategy          (GdictSpeller *speller);

FIXME

`speller` : | a GdictSpeller
Returns : | FIXME

Since FIXME

### gdict_speller_clear ()

    void                gdict_speller_clear                 (GdictSpeller *speller);

FIXME

`speller` : | a GdictSpeller

Since FIXME

### gdict_speller_match ()

    void                gdict_speller_match                 (GdictSpeller *speller,
                                                             const gchar *word);

FIXME

`speller` : | a GdictSpeller
`word` : | FIXME

Since FIXME

### gdict_speller_count_matches ()

    gint                gdict_speller_count_matches         (GdictSpeller *speller);

`speller` : |
Returns : |

### gdict_speller_get_matches ()

    gchar**             gdict_speller_get_matches           (GdictSpeller *speller,
                                                             gsize length);

FIXME

`speller` : | a GdictSpeller
`length` : | FIXME
Returns : | FIXME

Since FIXME

## Property Details

### The `"context"` property

      "context"                  GdictContext*         : Read / Write / Construct

The GdictContext object used to get the word definition.

### The `"database"` property

      "database"                 gchar*                : Read / Write

The database used to query the GdictContext.

Default value: "*"

### The `"strategy"` property

      "strategy"                 gchar*                : Read / Write

The strategy used to query the GdictContext.

Default value: "."

## Signal Details

### The `"word-activated"` signal

    void                user_function                      (GdictSpeller *gdictspeller,
                                                            gchar        *arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`gdictspeller` : | the object which received the signal.
`arg1` : |
`arg2` : |
`user_data` : | user data set when the signal handler was connected.