![]() |
![]() |
![]() |
WritRecogn Reference Manual | ![]() |
---|---|---|---|---|
enum FileOpenType; #define FILE_TYPE_OPENTYPE #define WRITRECOGN_CHARACTER_DATAFILE_CONST (obj) writRecognCharacter_datafile; GType writrecogn_character_datafile_get_type (void); gint writrecogn_character_datafile_get_openType (writRecognCharacter_datafile *self); void writrecogn_character_datafile_set_openType (writRecognCharacter_datafile *self, gint val); gchar* writrecogn_character_datafile_get_filename (writRecognCharacter_datafile *self); void writrecogn_character_datafile_set_filename (writRecognCharacter_datafile *self, gchar *val); GObject* writrecogn_character_datafile_get_cachedRadicalList (writRecognCharacter_datafile *self); void writrecogn_character_datafile_set_cachedRadicalList (writRecognCharacter_datafile *self, GObject *val); CharacterDataFile* writrecogn_character_datafile_new (void); CharacterDataFile* writrecogn_character_datafile_new_from_file (const gchar *filename, FileOpenType openType, gchar *options); void writrecogn_character_datafile_free (writRecognCharacter_datafile *self); gboolean writrecogn_character_datafile_open (writRecognCharacter_datafile *self); RadicalList* writrecogn_character_datafile_read_radicalList (writRecognCharacter_datafile *self); gboolean writrecogn_character_datafile_has_radicalCode (writRecognCharacter_datafile *self, RadicalCode code); gboolean writrecogn_character_datafile_has_radical (writRecognCharacter_datafile *self, Radical *rad, RadicalType type); Radical* writrecogn_character_datafile_read_radical (writRecognCharacter_datafile *self, RadicalCode code, RadicalType type); gboolean writrecogn_character_datafile_insert_radical (writRecognCharacter_datafile *self, Radical *rad); gboolean writrecogn_character_datafile_update_radical (writRecognCharacter_datafile *self, Radical *rad); gboolean writrecogn_character_datafile_append_radicalList (writRecognCharacter_datafile *self, RadicalList *radList); RadicalList* writrecogn_character_datafile_find_matches (writRecognCharacter_datafile *self, RadicalQuery *query); gboolean writrecogn_character_datafile_flush (writRecognCharacter_datafile *self); gboolean writrecogn_character_datafile_close (writRecognCharacter_datafile *self, gboolean needFlush); gboolean writrecogn_character_datafile_add_default_langString (writRecognCharacter_datafile *self, gchar *langStr); #define WRITRECOGN_CHARACTER_DATAFILE_PROP_OPENTYPE(arg) #define WRITRECOGN_CHARACTER_DATAFILE_GET_PROP_OPENTYPE(arg) #define WRITRECOGN_CHARACTER_DATAFILE_PROP_FILENAME(arg) #define WRITRECOGN_CHARACTER_DATAFILE_GET_PROP_FILENAME(arg) #define WRITRECOGN_CHARACTER_DATAFILE_PROP_CACHEDRADICALLIST(arg) #define WRITRECOGN_CHARACTER_DATAFILE_GET_PROP_CACHEDRADICALLIST(arg)
GObject +----writRecognCharacter_datafile +----writRecognCharacter_datafile_XML +----writRecognCharacter_datafile_Sqlite
"cachedRadicalList" writRecognRadical_list : Read / Write "filename" gchararray : Read / Write "openType" FileOpenType : Read / Write / Construct
typedef enum { FILE_OPEN_TYPE_AUTO, FILE_OPEN_TYPE_READ_ONLY, FILE_OPEN_TYPE_WRITE_ONLY, FILE_OPEN_TYPE_READ_WRITE } FileOpenType;
#define WRITRECOGN_CHARACTER_DATAFILE_CONST(obj) G_TYPE_CHECK_INSTANCE_CAST((obj), writrecogn_character_datafile_get_type(), writRecognCharacter_datafile const)
|
typedef struct { gboolean modified; gchar * message; LanguageSet * defaultLangSet; } writRecognCharacter_datafile;
GType writrecogn_character_datafile_get_type (void);
Returns : |
gint writrecogn_character_datafile_get_openType (writRecognCharacter_datafile *self);
|
|
Returns : |
void writrecogn_character_datafile_set_openType (writRecognCharacter_datafile *self, gint val);
|
|
|
gchar* writrecogn_character_datafile_get_filename (writRecognCharacter_datafile *self);
|
|
Returns : |
void writrecogn_character_datafile_set_filename (writRecognCharacter_datafile *self, gchar *val);
|
|
|
GObject* writrecogn_character_datafile_get_cachedRadicalList (writRecognCharacter_datafile *self);
|
|
Returns : |
void writrecogn_character_datafile_set_cachedRadicalList (writRecognCharacter_datafile *self, GObject *val);
|
|
|
CharacterDataFile* writrecogn_character_datafile_new (void);
Returns : |
CharacterDataFile* writrecogn_character_datafile_new_from_file (const gchar *filename, FileOpenType openType, gchar *options);
|
the file that contains the character data |
|
file opening type |
|
|
Returns : |
void writrecogn_character_datafile_free (writRecognCharacter_datafile *self);
|
gboolean writrecogn_character_datafile_open (writRecognCharacter_datafile *self);
Open the file as text file or database. Depending the inheritance class.
returns
: gboolean shows whether the file opening is successful.
|
this CharacterDataFile |
Returns : |
RadicalList* writrecogn_character_datafile_read_radicalList (writRecognCharacter_datafile *self);
Note: Open the data file first.
returns
: RadicalList contains in the data file,
NULL if the file is not yet opened or encountered error.
|
this CharacterDataFile |
Returns : |
gboolean writrecogn_character_datafile_has_radicalCode (writRecognCharacter_datafile *self, RadicalCode code);
This method finds and returns a radical with the given radicalCode from datafile. It is convenient for database-based data file. As for text-based data file, use a RadicalArray as cache.
returns
: Whether the radicalCode is in datafile.
|
this CharacterDataFile |
|
|
Returns : |
gboolean writrecogn_character_datafile_has_radical (writRecognCharacter_datafile *self, Radical *rad, RadicalType type);
This method firstly finds a radical whose radicalCode is identical, then compare the radical content.
returns
: Whether the radical exists in the datafile.
|
this CharacterDataFile |
|
|
|
type of Radical to be return, see RadicalType |
Returns : |
Radical* writrecogn_character_datafile_read_radical (writRecognCharacter_datafile *self, RadicalCode code, RadicalType type);
This method finds and returns a radical with the given radicalCode from datafile. It is convenient for database-based data file. As for text-based data file, use a RadicalArray as cache.
returns
: Founded Radical. NULL if not found.
|
this CharacterDataFile |
|
|
|
type of Radical to be return, see RadicalType |
Returns : |
gboolean writrecogn_character_datafile_insert_radical (writRecognCharacter_datafile *self, Radical *rad);
This method inserts radical
from datafile according to its radical code.
returns
: TRUE if the radical is inserted successfully,
FALSE if the radical already in database or insertion failed.
|
this CharacterDataFile |
|
radical to be insearted.
See also update_radical()
|
Returns : |
gboolean writrecogn_character_datafile_update_radical (writRecognCharacter_datafile *self, Radical *rad);
This method update radical
from datafile according to its radical code.
See also insert_radical()
returns
: TRUE if the radical is updated successfully,
FALSE if the radical is not in database or update fail.
|
this CharacterDataFile |
|
radical to be updated. |
Returns : |
gboolean writrecogn_character_datafile_append_radicalList (writRecognCharacter_datafile *self, RadicalList *radList);
This method appends radicals in radical list to the datafile.
returns
: TRUE if radical list is appended successfully,
FALSE if append fail.
|
this CharacterDataFile |
|
the radical list to be appended to. |
Returns : |
RadicalList* writrecogn_character_datafile_find_matches (writRecognCharacter_datafile *self, RadicalQuery *query);
Return a RadicalList that stores the radicalCode of matching radicals.
|
|
|
|
Returns : |
gboolean writrecogn_character_datafile_flush (writRecognCharacter_datafile *self);
Save the change in cache (if any) to datafile. Note that if the no cache exists, this function always return TRUE.
returns
: FALSE if I/O or database errors occurred, TRUE otherwise.
|
this CharacterDataFile |
Returns : |
gboolean writrecogn_character_datafile_close (writRecognCharacter_datafile *self, gboolean needFlush);
This method close database.
returns
: TRUE if the datafile close successfully,
FALSE otherwise.
|
this CharacterDataFile |
|
|
Returns : |
gboolean writrecogn_character_datafile_add_default_langString (writRecognCharacter_datafile *self, gchar *langStr);
|
|
|
|
Returns : |
#define WRITRECOGN_CHARACTER_DATAFILE_PROP_OPENTYPE(arg)
|
#define WRITRECOGN_CHARACTER_DATAFILE_GET_PROP_OPENTYPE(arg)
|
#define WRITRECOGN_CHARACTER_DATAFILE_PROP_FILENAME(arg)
|
#define WRITRECOGN_CHARACTER_DATAFILE_GET_PROP_FILENAME(arg)
|
#define WRITRECOGN_CHARACTER_DATAFILE_PROP_CACHEDRADICALLIST(arg)
|
"cachedRadicalList"
property"cachedRadicalList" writRecognRadical_list : Read / Write
cached RadicalList.
"filename"
property"filename" gchararray : Read / Write
name character data file.
Default value: NULL
"openType"
property"openType" FileOpenType : Read / Write / Construct
File open type.
Default value: FILE_OPEN_TYPE_AUTO