src/bookmarks/bdb/include/engine_bookmark.h File Reference

Header for bookmark dictionary engine. More...

Go to the source code of this file.

Data Structures

struct  _BookData
 Internal data structure of Bookmark Engine. More...

Defines

#define PRINT_STATE(state)   ( (state) ? "TRUE" : "FALSE" )
 Translate boolean value into string.
Timers
#define TIMER_START   TRUE
 Flags telling that we want to start timer.
#define TIMER_STOP   FALSE
 Flags telling that we want to stop timer.

Typedefs

typedef _BookData BookData

Functions

static gchar * string_to_path (gchar **string)
 Convert string to proper path name.
static gboolean is_Bookmark_db_file (gchar *file)
 Tells if file is in Bookmarks format (file should exist).
static gboolean bm_add_new_entry (gchar *word, gchar *translation, BookData *data)
 Add new translation for word.
static void bm_load_freeID (BookData *data)
 Get minimal free value available for word's id.
static void bm_save_freeID (BookData *data)
 Get minimal free value available for word's id.
static gboolean bm_add_only_translation (BookData *data, gchar *translation, guint id)
 Add only new translation with id.
static gint bm_compare_key_trans (const DBT *a, const DBT *b)
 Compare method for searching in translation file.
static gint bm_compare_key_words (const DBT *a, const DBT *b)
 Compare method for searching in words file.
EngineModule engine_global_functions ()
 implementation of engine_global_functions(void) function.
Module functions
gboolean bm_engine_check (gchar *location)
 dict_eng_module_check() function implementation.
gchar * bm_engine_description ()
 dict_eng_module_get_description() function implementation.
gchar * bm_engine_format ()
 dict_eng_module_get_format() function implementation.
gchar * bm_engine_version ()
 dict_eng_module_get_version() function implementation.
Enginebm_engine_create (gchar *location, EngineOptimizationFlag flags, cb_progress progress_handler, gpointer progress_data, gdouble seed)
 dict_eng_module_create() function implementation.
Particular dictionary function
gboolean bm_engine_add_word (Engine *engine, gchar *word, gchar *translation)
 dict_eng_add_word() function implementation.
gboolean bm_engine_remove_word (Engine *engine, gchar *word)
 dict_eng_remove_word() function implementation.
gchar * bm_engine_get_lang_from (Engine *engine)
 dict_eng_get_lang_from() function implementation.
gchar * bm_engine_get_lang_to (Engine *engine)
 dict_eng_get_lang_to() function implementation.
gchar * bm_engine_get_title (Engine *engine)
 dict_eng_get_title() function implementation.
gchar * bm_engine_get_icon_path (Engine *engine)
 dict_eng_get_icon_path() function implementation.
void bm_engine_close (Engine *engine)
 dict_eng_destroy() function implementation.
gchar * bm_engine_location (Engine *engine)
 dict_eng_get_location() function implementation.
void bm_engine_optimize (Engine *engine)
 dict_eng_optimize() function implementation.
gboolean bm_engine_is_optimized (Engine *engine)
 dict_eng_is_optimized() function implementation.
void bm_engine_set_auto_free (Engine *engine, gboolean state)
 dict_eng_set_auto_free() function implementation.
gpointer bm_engine_set_callback (Engine *engine, gchar *event, gpointer c_handler, gpointer user_data)
 dict_eng_set_callback() function implementation.
void bm_engine_set_progress_seed (Engine *engine, gchar *signal, gdouble seed)
 dict_eng_set_progress_seed() function implementation.
void bm_engine_search_word_list (Engine *engine, gchar *pattern, gpointer data)
 dict_eng_search_word_list() function implementation.
void bm_engine_search_word_translation (Engine *engine, gchar *word, gpointer data)
 dict_eng_search_word_translation() function implementation.
EngineStatus bm_engine_status (Engine *engine)
 dict_eng_get_last_status() function implementation.
gchar * bm_engine_status_message (EngineStatus error)
 dict_eng_status_message() function implementation.

Variables

static const gchar * DIC_ENG_VERSION = "0.2"
 Start/stop timers.Version of bookmark engine.
static const gchar * DIC_ENG_FORMAT = "Users' Bookmarks"
 Short description of format supported by the current engine.
static const gchar * DIC_ENG_DESCRIPTION
 Short description of engine.


Detailed Description

Header for bookmark dictionary engine.

Definition in file engine_bookmark.h.


Generated on Fri Jan 11 14:30:17 2008 for mDictionary Project by  doxygen 1.5.1