![]() |
![]() |
![]() |
libskk Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#define SKK_TYPE_DICT SkkCandidate ** skk_dict_split_candidates (SkkDict *self
,const gchar *midasi
,gboolean okuri
,const gchar *line
,int *result_length1
); gchar * skk_dict_join_candidates (SkkDict *self
,SkkCandidate **candidates
,int candidates_length1
); void skk_dict_reload (SkkDict *self
,GError **error
); SkkCandidate ** skk_dict_lookup (SkkDict *self
,const gchar *midasi
,gboolean okuri
,int *result_length1
); gchar ** skk_dict_complete (SkkDict *self
,const gchar *midasi
,int *result_length1
); gboolean skk_dict_select_candidate (SkkDict *self
,SkkCandidate *candidate
); gboolean skk_dict_purge_candidate (SkkDict *self
,SkkCandidate *candidate
); void skk_dict_save (SkkDict *self
,GError **error
); gboolean skk_dict_get_read_only (SkkDict *self
); struct SkkDict; struct SkkDictClass; #define SKK_TYPE_EMPTY_DICT SkkEmptyDict * skk_empty_dict_new (void
); struct SkkEmptyDict; struct SkkEmptyDictClass;
GObject +----SkkDict +----SkkCdbDict +----SkkEmptyDict +----SkkFileDict +----SkkSkkServ +----SkkUserDict
GObject +----SkkDict +----SkkEmptyDict
SkkCandidate ** skk_dict_split_candidates (SkkDict *self
,const gchar *midasi
,gboolean okuri
,const gchar *line
,int *result_length1
);
Parse a line consisting of candidates separated by "/".
|
the SkkDict instance |
|
a line consisting of candidates. [in] |
Returns : |
an array of Candidates. [array length=result_length1] |
gchar * skk_dict_join_candidates (SkkDict *self
,SkkCandidate **candidates
,int candidates_length1
);
Format an array of Candidates to be saved in a dictionary file.
|
the SkkDict instance |
|
an array of Candidate. [in][array length=candidates_length1] |
|
length of the candidates array |
Returns : |
a string |
void skk_dict_reload (SkkDict *self
,GError **error
);
Reload the dictionary.
GError will be returned in error
when reading the dictionary failed.
|
the SkkDict instance |
|
location to store the error occuring, or NULL to ignore |
SkkCandidate ** skk_dict_lookup (SkkDict *self
,const gchar *midasi
,gboolean okuri
,int *result_length1
);
Lookup candidates in the dictionary.
|
the SkkDict instance |
|
a midasi (title) string to lookup. [in] |
|
whether to search okuri-ari entries or okuri-nasi entries. [in] |
Returns : |
an array of Candidate. [array length=result_length1] |
gchar ** skk_dict_complete (SkkDict *self
,const gchar *midasi
,int *result_length1
);
Return an array of strings which matches midasi.
|
the SkkDict instance |
|
a midasi (title) string to lookup. [in] |
Returns : |
an array of strings. [array length=result_length1] |
gboolean skk_dict_select_candidate (SkkDict *self
,SkkCandidate *candidate
);
Select a candidate in the dictionary.
|
the SkkDict instance |
|
an Candidate. [in] |
Returns : |
`true` if the dictionary is modified, `false` otherwise. |
gboolean skk_dict_purge_candidate (SkkDict *self
,SkkCandidate *candidate
);
Purge a candidate in the dictionary.
|
the SkkDict instance |
|
an Candidate. [in] |
Returns : |
`true` if the dictionary is modified, `false` otherwise. |
void skk_dict_save (SkkDict *self
,GError **error
);
Save the dictionary on disk.
GError will be returned in error
if the dictionary cannot be saved.
|
the SkkDict instance |
|
location to store the error occuring, or NULL to ignore |
gboolean skk_dict_get_read_only (SkkDict *self
);
Get and return the current value of the "read-only" property.
|
the SkkDict instance to query |
Returns : |
the value of the "read-only" property |
struct SkkDictClass { GObjectClass parent_class; void (*reload) (SkkDict* self, GError** error); SkkCandidate** (*lookup) (SkkDict* self, const gchar* midasi, gboolean okuri, int* result_length1); gchar** (*complete) (SkkDict* self, const gchar* midasi, int* result_length1); gboolean (*select_candidate) (SkkDict* self, SkkCandidate* candidate); gboolean (*purge_candidate) (SkkDict* self, SkkCandidate* candidate); void (*save) (SkkDict* self, GError** error); gboolean (*get_read_only) (SkkDict* self); };
The class structure for SKK_TYPE_DICT
. All the fields in this structure are private and should never be accessed directly.
the parent class structure | |
virtual method called by skk_dict_reload()
|
|
virtual method called by skk_dict_lookup()
|
|
virtual method called by skk_dict_complete()
|
|
virtual method called by skk_dict_select_candidate()
|
|
virtual method called by skk_dict_purge_candidate()
|
|
virtual method called by skk_dict_save()
|
|
getter method for the abstract property "read-only" |
#define SKK_TYPE_EMPTY_DICT (skk_empty_dict_get_type ())
The type for SkkEmptyDict.
struct SkkEmptyDictClass { SkkDictClass parent_class; };
The class structure for SKK_TYPE_EMPTY_DICT
. All the fields in this structure are private and should never be accessed directly.
SkkDictClass |
the parent class structure |