GdictSourcePrivate

typedef struct _GdictSourcePrivate GdictSourcePrivate;

enum GdictSourceTransport

typedef enum
{
  GDICT_SOURCE_TRANSPORT_DICTD,
  
  GDICT_SOURCE_TRANSPORT_INVALID /* only for debug */
} GdictSourceTransport;

GDICT_SOURCE_ERROR

#define GDICT_SOURCE_ERROR	(gdict_source_error_quark ())

enum GdictSourceError

typedef enum
{
  GDICT_SOURCE_ERROR_PARSE,
  GDICT_SOURCE_ERROR_INVALID_NAME,
  GDICT_SOURCE_ERROR_INVALID_TRANSPORT,
  GDICT_SOURCE_ERROR_INVALID_BAD_PARAMETER
} GdictSourceError;

gdict_source_error_quark ()

GQuark      gdict_source_error_quark        (void);

GdictSource

typedef struct {
} GdictSource;

The GdictSource structure contains onlyn private data.

gdict_source_new ()

GdictSource* gdict_source_new               (void);

Creates an empty GdictSource object. Use gdict_load_from_file() to read an existing dictionary source definition file.

gdict_source_load_from_file ()

gboolean    gdict_source_load_from_file     (GdictSource *source,
                                             const gchar *filename,
                                             GError **error);

Loads a dictionary source definition file into an empty GdictSource object.

Since 1.0

gdict_source_load_from_data ()

gboolean    gdict_source_load_from_data     (GdictSource *source,
                                             const gchar *data,
                                             gsize length,
                                             GError **error);

Loads a dictionary source definition from data inside an empty GdictSource object.

Since 1.0

gdict_source_to_data ()

gchar*      gdict_source_to_data            (GdictSource *source,
                                             gsize *length,
                                             GError **error);

Outputs a dictionary source as a string.

Since 1.0

gdict_source_set_name ()

void        gdict_source_set_name           (GdictSource *source,
                                             const gchar *name);

Sets name as the displayable name of the dictionary source.

Since 1.0

gdict_source_get_name ()

const gchar* gdict_source_get_name          (GdictSource *source);

Retrieves the name of source.

Since 1.0

gdict_source_set_description ()

void        gdict_source_set_description    (GdictSource *source,
                                             const gchar *description);

Sets the description of source. If description is NULL, unsets the currently set description.

Since 1.0

gdict_source_get_description ()

const gchar* gdict_source_get_description   (GdictSource *source);

Retrieves the description of source.

Since 1.0

gdict_source_set_database ()

void        gdict_source_set_database       (GdictSource *source,
                                             const gchar *database);

Sets the default database of source. If database is NULL, unsets the currently set database.

Since 1.0

gdict_source_get_database ()

const gchar* gdict_source_get_database      (GdictSource *source);

Retrieves the default database of source.

Since 1.0

gdict_source_set_strategy ()

void        gdict_source_set_strategy       (GdictSource *source,
                                             const gchar *strategy);

Sets the description of source. If strategy is NULL, unsets the currently set strategy.

Since 1.0

gdict_source_get_strategy ()

const gchar* gdict_source_get_strategy      (GdictSource *source);

Retrieves the default strategy of source.

Since 1.0

gdict_source_set_transport ()

void        gdict_source_set_transport      (GdictSource *source,
                                             GdictSourceTransport transport,
                                             const gchar *first_transport_property,
                                             ...);

Sets transport as the choosen transport for source. The transport argument is a method of retrieving dictionary data from a source; it is used to create the right GdictContext for this GdictSource. After transport, property name/value pairs should be listed, with a NULL pointer ending the list. Properties are the same passed to a GdictContext implementation instance using g_object_set().

Here's a simple example:

include <gdict/gdict.h>
 GdictSource *source = gdict_source_new();
 
 gdict_source_set_name (source, "My Source");
 gdict_source_set_transport (source, GDICT_SOURCE_TRANSPORT_DICTD,
                             "hostname", "dictionary-server.org",
                             "port", 2628,
                             NULL);

Since 1.0

gdict_source_set_transportv ()

void        gdict_source_set_transportv     (GdictSource *source,
                                             GdictSourceTransport transport,
                                             const gchar *first_transport_property,
                                             va_list var_args);

FIXME

Since 1.0

gdict_source_get_transport ()

GdictSourceTransport gdict_source_get_transport
                                            (GdictSource *source);

FIXME

Since 1.0

gdict_source_get_context ()

GdictContext* gdict_source_get_context      (GdictSource *source);

Gets the GdictContext bound to source.

Since 1.0

gdict_source_peek_context ()

GdictContext* gdict_source_peek_context     (GdictSource *source);

Gets the GdictContext bound to source. The returned object is a referenced copy of the context held by source; if you want a different instance, use gdict_source_get_context().

Since 1.0