_Engine Struct Reference
[Dictionary Engine API]

Structure describing particular dictionary. More...


Data Fields

gpointer engine_data
void(* engine_set_auto_free )(Engine *engine, gboolean state)
gchar *(* engine_location )(Engine *engine)
gboolean(* engine_is_optimized )(Engine *engine)
void(* engine_optimize )(Engine *engine)
void(* engine_search_word_list )(Engine *engine, gchar *pattern, gpointer data)
void(* engine_search_word_translation )(Engine *engine, gchar *word, gpointer data)
void(* engine_close )(Engine *engine)
EngineStatus(* engine_status )(Engine *engine)
gchar *(* engine_status_message )(EngineStatus error)
gpointer(* engine_set_callback )(Engine *engine, gchar *signal, gpointer c_handler, gpointer user_data)
void(* engine_set_progress_seed )(Engine *engine, gchar *signal, gdouble seed)
gboolean(* engine_add_word )(Engine *engine, gchar *word, gchar *translation)
gboolean(* engine_remove_word )(Engine *engine, gchar *word)
gchar *(* engine_get_lang_from )(Engine *engine)
gchar *(* engine_get_lang_to )(Engine *engine)
gchar *(* engine_get_title )(Engine *engine)
gchar *(* engine_get_icon_path )(Engine *engine)


Detailed Description

Structure describing particular dictionary.
Examples:

test_dictionary_engine.c.

Definition at line 621 of file dictionary_engine.h.


Field Documentation

gpointer _Engine::engine_data

engine independent data - this should be always placed as the first field in engine structure. It must not be used by the user of engine and there should be all data needed for engine to work. Structure of data pointed by this pointer is free-form.

Definition at line 626 of file dictionary_engine.h.

Referenced by bm_engine_add_word(), bm_engine_close(), bm_engine_create(), bm_engine_location(), bm_engine_remove_word(), bm_engine_search_word_list(), bm_engine_search_word_translation(), bm_engine_set_auto_free(), bm_engine_set_callback(), bm_engine_set_progress_seed(), bm_engine_status(), xdxf_engine_close(), xdxf_engine_create(), xdxf_engine_error(), xdxf_engine_is_optimized(), xdxf_engine_location(), xdxf_engine_optimize(), xdxf_engine_search_word_list(), xdxf_engine_search_word_translation(), xdxf_engine_set_auto_free(), xdxf_engine_set_callbacks(), and xdxf_engine_set_progress_seed().

void(* _Engine::engine_set_auto_free)(Engine *engine, gboolean state)

pointer to dictionary 'dict_eng_set_auto_free' function

See also:
dict_eng_set_auto_free

Referenced by bm_engine_create(), and xdxf_engine_create().

gchar*(* _Engine::engine_location)(Engine *engine)

pointer to dictionary 'dict_eng_get_location' function

See also:
dict_eng_get_location

Referenced by bm_engine_create(), and xdxf_engine_create().

gboolean(* _Engine::engine_is_optimized)(Engine *engine)

pointer to dictionary 'dict_eng_is_optimized' function

See also:
dict_eng_is_optimized

Referenced by bm_engine_create(), and xdxf_engine_create().

void(* _Engine::engine_optimize)(Engine *engine)

pointer to dictionary 'dict_eng_optimize' function

See also:
dict_eng_optimize

Referenced by bm_engine_create(), and xdxf_engine_create().

void(* _Engine::engine_search_word_list)(Engine *engine, gchar *pattern, gpointer data)

pointer to dictionary 'dict_eng_search_word_list' function

See also:
dict_eng_search_word_list

Referenced by bm_engine_create(), and xdxf_engine_create().

void(* _Engine::engine_search_word_translation)(Engine *engine, gchar *word, gpointer data)

pointer to dictionary 'dict_eng_search_word_translation' function

See also:
dict_eng_search_word_translation

Referenced by bm_engine_create(), and xdxf_engine_create().

void(* _Engine::engine_close)(Engine *engine)

pointer to dictionary 'dict_eng_destroy' function

See also:
dict_eng_destroy

Referenced by bm_engine_create(), and xdxf_engine_create().

EngineStatus(* _Engine::engine_status)(Engine *engine)

pointer to dictionary 'dict_eng_get_last_status' function

See also:
dict_eng_get_last_status

Referenced by bm_engine_create(), and xdxf_engine_create().

gchar*(* _Engine::engine_status_message)(EngineStatus error)

pointer to dictionary 'dict_eng_status_message' function

See also:
dict_eng_get_status_message

Referenced by bm_engine_create(), and xdxf_engine_create().

gpointer(* _Engine::engine_set_callback)(Engine *engine, gchar *signal, gpointer c_handler, gpointer user_data)

pointer to dictionary 'dict_eng_set_callback' function

See also:
dict_eng_set_callback

Referenced by bm_engine_create(), and xdxf_engine_create().

void(* _Engine::engine_set_progress_seed)(Engine *engine, gchar *signal, gdouble seed)

pointer to dictionary 'dict_eng_set_progress_seed' function

See also:
dict_eng_set_progress_seed

Referenced by bm_engine_create(), and xdxf_engine_create().

gboolean(* _Engine::engine_add_word)(Engine *engine, gchar *word, gchar *translation)

pointer to dictionary 'dict_eng_add_word' function

See also:
dict_eng_add_word

Referenced by bm_engine_create(), and xdxf_engine_create().

gboolean(* _Engine::engine_remove_word)(Engine *engine, gchar *word)

pointer to dictionary 'dict_eng_remove_word' function

See also:
dict_eng_remove_word

Referenced by bm_engine_create(), and xdxf_engine_create().

gchar*(* _Engine::engine_get_lang_from)(Engine *engine)

pointer to dictionary 'dict_eng_get_lang_from' function

See also:
dict_eng_get_lang_from

Referenced by bm_engine_create().

gchar*(* _Engine::engine_get_lang_to)(Engine *engine)

pointer to dictionary 'dict_eng_get_lang_to' function

See also:
dict_eng_get_lang_to

Referenced by bm_engine_create().

gchar*(* _Engine::engine_get_title)(Engine *engine)

pointer to dictionary 'dict_eng_get_title' function

See also:
dict_eng_get_title

Referenced by bm_engine_create().

gchar*(* _Engine::engine_get_icon_path)(Engine *engine)

pointer to dictionary 'dict_eng_get_icon_path' function

See also:
dict_eng_get_icon_path

Referenced by bm_engine_create().


The documentation for this struct was generated from the following file:
Generated on Fri Jan 11 14:30:18 2008 for mDictionary Project by  doxygen 1.5.1