GdictSpeller: GNOME Dictionary Library Reference Manual

## GdictSpeller GdictSpeller — Display matching words |

## Functions

GtkWidget * | gdict_speller_new ()
GtkWidget * | gdict_speller_new_with_context ()
void | gdict_speller_set_context ()
GdictContext * | gdict_speller_get_context ()
void | gdict_speller_set_database ()
const gchar * | gdict_speller_get_database ()
void | gdict_speller_set_strategy ()
const gchar * | gdict_speller_get_strategy ()
void | gdict_speller_clear ()
void | gdict_speller_match ()
gint | gdict_speller_count_matches ()
gchar ** | gdict_speller_get_matches ()

## Properties

GdictContext * | context | Read / Write / Construct
gchar * | database | Read / Write
gchar * | strategy | Read / Write

## Signals

void | word-activated | Run Last

## Types and Values

struct | GdictSpeller
struct | GdictSpellerClass

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GdictSpeller

## Implemented Interfaces

GdictSpeller implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Description

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

## Functions

### 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

#### Parameters

context | a GdictContext |

#### Returns

FIXME

Since:

### gdict_speller_set_context ()

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

FIXME

#### Parameters

speller | a GdictSpeller |
context | a GdictContext |

Since:

### gdict_speller_get_context ()

    GdictContext *
    gdict_speller_get_context (GdictSpeller *speller);

FIXME

#### Parameters

speller | a GdictSpeller |

#### Returns

a GdictContext.

[transfer none]

Since:

### gdict_speller_set_database ()

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

FIXME

#### Parameters

speller | a GdictSpeller |
database | FIXME |

Since:

### gdict_speller_get_database ()

    const gchar *
    gdict_speller_get_database (GdictSpeller *speller);

FIXME

#### Parameters

speller | a GdictSpeller |

#### Returns

FIXME

Since: FIXME

### gdict_speller_set_strategy ()

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

FIXME

#### Parameters

speller | a GdictSpeller |
strategy | FIXME |

Since: FIXME

### gdict_speller_get_strategy ()

    const gchar *
    gdict_speller_get_strategy (GdictSpeller *speller);

FIXME

#### Parameters

speller | a GdictSpeller |

#### Returns

FIXME

Since: FIXME

### gdict_speller_clear ()

    void
    gdict_speller_clear (GdictSpeller *speller);

FIXME

#### Parameters

speller | a GdictSpeller |

Since: FIXME

### gdict_speller_match ()

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

FIXME

#### Parameters

speller | a GdictSpeller |
word | FIXME |

Since: FIXME

### gdict_speller_count_matches ()

    gint
    gdict_speller_count_matches (GdictSpeller *speller);

### gdict_speller_get_matches ()

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

FIXME

#### Parameters

speller | a GdictSpeller |
length | FIXME |

#### Returns

FIXME.

[transfer full]

Since: FIXME

## Types and Values

### struct GdictSpeller

    struct GdictSpeller;

### struct GdictSpellerClass

    struct GdictSpellerClass {
      GtkBoxClass 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);
    };

## Property Details

### The `“context”` property

      “context”                  GdictContext *

The GdictContext object used to get the word definition.

Flags: Read / Write / Construct

### The `“database”` property

      “database”                 gchar *

The database used to query the GdictContext.

Flags: Read / Write

Default value: "*"

### The `“strategy”` property

      “strategy”                 gchar *

The strategy used to query the GdictContext.

Flags: Read / Write

Default value: "."

## Signal Details

### The `“word-activated”` signal

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

Flags: Run Last