_BookData Struct Reference
[Dictionary Engine - Bookmark format]

Internal data structure of Bookmark Engine. More...


Data Fields

DB * db_words
 Pointer to the database with words.
DB * db_trans
 Pointer to the database with translations.
BTREEINFO info_words
 Structure describing search method in words database.
BTREEINFO info_trans
 Structure describing search method in translations database.
guint freeID
 next free available id for word pointer to cache file
gchar * dict_path
 path to dictionary
EngineStatus last_error
 status of last taken action
gboolean auto_free
 auto free mechanism status: FALSE - off, TRUE - on
cb_progress cb_progress_caching
 pointer to callback function called while informing about caching progress
gpointer cb_progress_caching_data
 pointer to data passed to callback function called while informing about caching progress
gdouble cb_progress_caching_seed
 how often progress callback should be called. 0.01 mean that after each 1% of work callback shoul be called
cb_progress cb_progress_word_list
 pointer to callback function called while informing about words list searching progress
gpointer cb_progress_word_list_data
 pointer to data passed to callback function called while informing about words list searching progress
gdouble cb_progress_word_list_seed
 how often progress callback should be called. 0.01 mean that after each 1% of work callback shoul be called
cb_progress cb_progress_word_trans
 pointer to callback function called while informing about word's translation searching progress
gpointer cb_progress_word_trans_data
 pointer to data passed to callback function called while informing about word's translation searching progress
gdouble cb_progress_word_trans_seed
 how often progress callback should be called. 0.01 mean that after each 1% of work callback shoul be called
cb_word_list cb_search_word_list
 pointer to callback function called after words list is found
gpointer cb_search_word_list_data
 pointer to data passed to callback function called after words list is found
cb_word_translation cb_search_word_trans
 pointer to callback function called after word's translation is found
gpointer cb_search_word_trans_data
 pointer to data passed to callback function called after word's translation is found


Detailed Description

Internal data structure of Bookmark Engine.

Definition at line 99 of file engine_bookmark.h.


Field Documentation

DB* _BookData::db_words

Pointer to the database with words.

Definition at line 101 of file engine_bookmark.h.

Referenced by bm_add_new_entry(), bm_engine_add_word(), bm_engine_close(), bm_engine_create(), bm_engine_remove_word(), bm_engine_search_word_list(), and bm_engine_search_word_translation().

DB* _BookData::db_trans

Pointer to the database with translations.

Definition at line 104 of file engine_bookmark.h.

Referenced by bm_add_new_entry(), bm_add_only_translation(), bm_engine_close(), bm_engine_create(), bm_engine_remove_word(), bm_engine_search_word_translation(), bm_load_freeID(), and bm_save_freeID().

BTREEINFO _BookData::info_words

Structure describing search method in words database.

Definition at line 107 of file engine_bookmark.h.

Referenced by bm_engine_create().

BTREEINFO _BookData::info_trans

Structure describing search method in translations database.

Definition at line 110 of file engine_bookmark.h.

Referenced by bm_engine_create().

guint _BookData::freeID

next free available id for word pointer to cache file

Definition at line 113 of file engine_bookmark.h.

Referenced by bm_add_new_entry(), bm_engine_add_word(), bm_load_freeID(), and bm_save_freeID().

gchar* _BookData::dict_path

path to dictionary

Definition at line 117 of file engine_bookmark.h.

Referenced by bm_engine_close(), bm_engine_create(), and bm_engine_location().

EngineStatus _BookData::last_error

status of last taken action

Definition at line 119 of file engine_bookmark.h.

Referenced by bm_add_new_entry(), bm_engine_add_word(), bm_engine_status(), bm_load_freeID(), and bm_save_freeID().

gboolean _BookData::auto_free

auto free mechanism status: FALSE - off, TRUE - on

Definition at line 121 of file engine_bookmark.h.

Referenced by bm_engine_create(), bm_engine_location(), and bm_engine_set_auto_free().

cb_progress _BookData::cb_progress_caching

pointer to callback function called while informing about caching progress

Definition at line 124 of file engine_bookmark.h.

Referenced by bm_engine_create(), and bm_engine_set_callback().

gpointer _BookData::cb_progress_caching_data

pointer to data passed to callback function called while informing about caching progress

Definition at line 127 of file engine_bookmark.h.

Referenced by bm_engine_create(), and bm_engine_set_callback().

gdouble _BookData::cb_progress_caching_seed

how often progress callback should be called. 0.01 mean that after each 1% of work callback shoul be called

Definition at line 130 of file engine_bookmark.h.

Referenced by bm_engine_create(), and bm_engine_set_progress_seed().

cb_progress _BookData::cb_progress_word_list

pointer to callback function called while informing about words list searching progress

Definition at line 134 of file engine_bookmark.h.

Referenced by bm_engine_create().

gpointer _BookData::cb_progress_word_list_data

pointer to data passed to callback function called while informing about words list searching progress

Definition at line 137 of file engine_bookmark.h.

Referenced by bm_engine_create().

gdouble _BookData::cb_progress_word_list_seed

how often progress callback should be called. 0.01 mean that after each 1% of work callback shoul be called

Definition at line 140 of file engine_bookmark.h.

Referenced by bm_engine_create().

cb_progress _BookData::cb_progress_word_trans

pointer to callback function called while informing about word's translation searching progress

Definition at line 144 of file engine_bookmark.h.

Referenced by bm_engine_create().

gpointer _BookData::cb_progress_word_trans_data

pointer to data passed to callback function called while informing about word's translation searching progress

Definition at line 147 of file engine_bookmark.h.

Referenced by bm_engine_create().

gdouble _BookData::cb_progress_word_trans_seed

how often progress callback should be called. 0.01 mean that after each 1% of work callback shoul be called

Definition at line 150 of file engine_bookmark.h.

Referenced by bm_engine_create().

cb_word_list _BookData::cb_search_word_list

pointer to callback function called after words list is found

Definition at line 154 of file engine_bookmark.h.

Referenced by bm_engine_create(), bm_engine_search_word_list(), and bm_engine_set_callback().

gpointer _BookData::cb_search_word_list_data

pointer to data passed to callback function called after words list is found

Definition at line 157 of file engine_bookmark.h.

Referenced by bm_engine_create(), bm_engine_search_word_list(), and bm_engine_set_callback().

cb_word_translation _BookData::cb_search_word_trans

pointer to callback function called after word's translation is found

Definition at line 161 of file engine_bookmark.h.

Referenced by bm_engine_create(), bm_engine_search_word_translation(), and bm_engine_set_callback().

gpointer _BookData::cb_search_word_trans_data

pointer to data passed to callback function called after word's translation is found

Definition at line 164 of file engine_bookmark.h.

Referenced by bm_engine_create(), bm_engine_search_word_translation(), and bm_engine_set_callback().


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