writRecognRadical_list

writRecognRadical_list

Synopsis



#define             WRITRECOGN_RADICAL_LIST_CONST       (obj)
                    writRecognRadical_list;
gpointer            writrecogn_radical_list_get_codeArray
                                                        (writRecognRadical_list *self);
void                writrecogn_radical_list_set_codeArray
                                                        (writRecognRadical_list *self,
                                                         gpointer val);
GObject*            writrecogn_radical_list_get_backedDataFile
                                                        (writRecognRadical_list *self);
void                writrecogn_radical_list_set_backedDataFile
                                                        (writRecognRadical_list *self,
                                                         GObject *val);
RadicalList*        writrecogn_radical_list_new         (void);
RadicalList*        writrecogn_radical_list_new_from_datafile
                                                        (CharacterDataFile *datafile);
gpointer            writrecogn_radical_list_free        (writRecognRadical_list *self,
                                                         gboolean free_code_array);
guint               writrecogn_radical_list_size        (writRecognRadical_list *self);
gboolean            writrecogn_radical_list_is_empty    (writRecognRadical_list *self);
void                writrecogn_radical_list_copy        (writRecognRadical_list *self,
                                                         RadicalList *src);
void                writrecogn_radical_list_reset       (writRecognRadical_list *self);
void                writrecogn_radical_list_append_radical
                                                        (writRecognRadical_list *self,
                                                         Radical *rad);
void                writrecogn_radical_list_append_radicalCode
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code);
void                writrecogn_radical_list_append_radicalCode_array
                                                        (writRecognRadical_list *self,
                                                         GArray *codeArray);
gboolean            writrecogn_radical_list_has_radicalCode
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code);
gint                writrecogn_radical_list_find_radical_index
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code);
Radical*            writrecogn_radical_list_find_radical_by_utf8
                                                        (writRecognRadical_list *self,
                                                         const gchar *utf8Code,
                                                         RadicalType type);
Radical*            writrecogn_radical_list_find_radical_by_code
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code,
                                                         RadicalType type);
Radical*            writrecogn_radical_list_get_radical_by_index
                                                        (writRecognRadical_list *self,
                                                         const gint index,
                                                         RadicalType type);
gboolean            writrecogn_radical_list_insert_radical_datafile
                                                        (writRecognRadical_list *self,
                                                         Radical *rad);
gboolean            writrecogn_radical_list_update_radical_datafile
                                                        (writRecognRadical_list *self,
                                                         Radical *rad,
                                                         RadicalType type);
RadicalList*        writrecogn_radical_list_find_matches
                                                        (writRecognRadical_list *self,
                                                         RadicalQuery *query);
gboolean            writrecogn_radical_list_foreach     (writRecognRadical_list *self,
                                                         ForeachCallbackFunc func,
                                                         gpointer userdata,
                                                         RadicalType type);
#define             WRITRECOGN_RADICAL_LIST_PROP_CODEARRAY(arg)
#define             WRITRECOGN_RADICAL_LIST_GET_PROP_CODEARRAY(arg)
#define             WRITRECOGN_RADICAL_LIST_PROP_BACKEDDATAFILE(arg)
#define             WRITRECOGN_RADICAL_LIST_GET_PROP_BACKEDDATAFILE(arg)

Object Hierarchy

  GObject
   +----writRecognRadical_list

Properties

  "backedDataFile"           writRecognCharacter_datafile  : Read / Write
  "codeArray"                gpointer              : Read / Write

Description

Details

WRITRECOGN_RADICAL_LIST_CONST()

#define WRITRECOGN_RADICAL_LIST_CONST(obj)	G_TYPE_CHECK_INSTANCE_CAST((obj), writrecogn_radical_list_get_type(), writRecognRadical_list const)

obj :

writRecognRadical_list

typedef struct {
	gboolean free_codeArray;
} writRecognRadical_list;

writrecogn_radical_list_get_codeArray ()

gpointer            writrecogn_radical_list_get_codeArray
                                                        (writRecognRadical_list *self);

self :

Returns :

writrecogn_radical_list_set_codeArray ()

void                writrecogn_radical_list_set_codeArray
                                                        (writRecognRadical_list *self,
                                                         gpointer val);

self :

val :

writrecogn_radical_list_get_backedDataFile ()

GObject*            writrecogn_radical_list_get_backedDataFile
                                                        (writRecognRadical_list *self);

self :

Returns :

writrecogn_radical_list_set_backedDataFile ()

void                writrecogn_radical_list_set_backedDataFile
                                                        (writRecognRadical_list *self,
                                                         GObject *val);

self :

val :

writrecogn_radical_list_new ()

RadicalList*        writrecogn_radical_list_new         (void);

Returns :

writrecogn_radical_list_new_from_datafile ()

RadicalList*        writrecogn_radical_list_new_from_datafile
                                                        (CharacterDataFile *datafile);

datafile :

Returns :

writrecogn_radical_list_free ()

gpointer            writrecogn_radical_list_free        (writRecognRadical_list *self,
                                                         gboolean free_code_array);

returns: the codeArray if free_codeArray = FALSE. NULL otherwise

self :

free_code_array :

Returns :

writrecogn_radical_list_size ()

guint               writrecogn_radical_list_size        (writRecognRadical_list *self);

self :

Returns :

writrecogn_radical_list_is_empty ()

gboolean            writrecogn_radical_list_is_empty    (writRecognRadical_list *self);

Tells whether the radical is NULL or has 0 element.

self :

Returns :

 FALSE if self has one or more elements; TRUE otherwise.

writrecogn_radical_list_copy ()

void                writrecogn_radical_list_copy        (writRecognRadical_list *self,
                                                         RadicalList *src);

self :

src :

writrecogn_radical_list_reset ()

void                writrecogn_radical_list_reset       (writRecognRadical_list *self);

self :

writrecogn_radical_list_append_radical ()

void                writrecogn_radical_list_append_radical
                                                        (writRecognRadical_list *self,
                                                         Radical *rad);

param self the RadicalList param rad the Radical to be added.

self :

rad :

writrecogn_radical_list_append_radicalCode ()

void                writrecogn_radical_list_append_radicalCode
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code);

param self the RadicalList param code the RadicalCode to be added.

self :

code :

writrecogn_radical_list_append_radicalCode_array ()

void                writrecogn_radical_list_append_radicalCode_array
                                                        (writRecognRadical_list *self,
                                                         GArray *codeArray);

self :

codeArray :

writrecogn_radical_list_has_radicalCode ()

gboolean            writrecogn_radical_list_has_radicalCode
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code);

returns: TRUE if code is in the list. FALSE otherwise.

self :

 this object.

code :

 the radicalCode to be found.

Returns :

writrecogn_radical_list_find_radical_index ()

gint                writrecogn_radical_list_find_radical_index
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code);

self :

code :

Returns :

writrecogn_radical_list_find_radical_by_utf8 ()

Radical*            writrecogn_radical_list_find_radical_by_utf8
                                                        (writRecognRadical_list *self,
                                                         const gchar *utf8Code,
                                                         RadicalType type);

self :

utf8Code :

type :

Returns :

writrecogn_radical_list_find_radical_by_code ()

Radical*            writrecogn_radical_list_find_radical_by_code
                                                        (writRecognRadical_list *self,
                                                         RadicalCode code,
                                                         RadicalType type);

self :

code :

type :

Returns :

writrecogn_radical_list_get_radical_by_index ()

Radical*            writrecogn_radical_list_get_radical_by_index
                                                        (writRecognRadical_list *self,
                                                         const gint index,
                                                         RadicalType type);

self :

index :

type :

Returns :

writrecogn_radical_list_insert_radical_datafile ()

gboolean            writrecogn_radical_list_insert_radical_datafile
                                                        (writRecognRadical_list *self,
                                                         Radical *rad);

self :

rad :

Returns :

writrecogn_radical_list_update_radical_datafile ()

gboolean            writrecogn_radical_list_update_radical_datafile
                                                        (writRecognRadical_list *self,
                                                         Radical *rad,
                                                         RadicalType type);

self :

rad :

type :

Returns :

writrecogn_radical_list_find_matches ()

RadicalList*        writrecogn_radical_list_find_matches
                                                        (writRecognRadical_list *self,
                                                         RadicalQuery *query);

Return a RadicalList that stores the radicalCode of matching radicals.

self :

 this RadicalList

query :

 query to the datafile

Returns :

writrecogn_radical_list_foreach ()

gboolean            writrecogn_radical_list_foreach     (writRecognRadical_list *self,
                                                         ForeachCallbackFunc func,
                                                         gpointer userdata,
                                                         RadicalType type);

Perform a function for each element of the radical list.

self :

 the radical list.

func :

 callback function to perform for each radical in self.

userdata :

 argument for passing to func.

type :

 type of the radicals.

Returns :

 TRUE if every radicals are treated; FALSE indicates the iteration is stopped midway.

WRITRECOGN_RADICAL_LIST_PROP_CODEARRAY()

#define             WRITRECOGN_RADICAL_LIST_PROP_CODEARRAY(arg)

arg :

WRITRECOGN_RADICAL_LIST_GET_PROP_CODEARRAY()

#define             WRITRECOGN_RADICAL_LIST_GET_PROP_CODEARRAY(arg)

arg :

WRITRECOGN_RADICAL_LIST_PROP_BACKEDDATAFILE()

#define             WRITRECOGN_RADICAL_LIST_PROP_BACKEDDATAFILE(arg)

arg :

WRITRECOGN_RADICAL_LIST_GET_PROP_BACKEDDATAFILE()

#define             WRITRECOGN_RADICAL_LIST_GET_PROP_BACKEDDATAFILE(arg)

arg :

Property Details

The "backedDataFile" property

  "backedDataFile"           writRecognCharacter_datafile  : Read / Write

provide datafile back end.

The "codeArray" property

  "codeArray"                gpointer              : Read / Write

GArray of radical code.