![]() |
![]() |
![]() |
libskk Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#define SKK_TYPE_CANDIDATE gchar * skk_candidate_to_string (SkkCandidate *self
); SkkCandidate * skk_candidate_new (const gchar *midasi
,gboolean okuri
,const gchar *text
,const gchar *annotation
,const gchar *output
); const gchar * skk_candidate_get_midasi (SkkCandidate *self
); gboolean skk_candidate_get_okuri (SkkCandidate *self
); const gchar * skk_candidate_get_text (SkkCandidate *self
); void skk_candidate_set_text (SkkCandidate *self
,const gchar *value
); const gchar * skk_candidate_get_annotation (SkkCandidate *self
); void skk_candidate_set_annotation (SkkCandidate *self
,const gchar *value
); const gchar * skk_candidate_get_output (SkkCandidate *self
); void skk_candidate_set_output (SkkCandidate *self
,const gchar *value
); struct SkkCandidate; struct SkkCandidateClass;
"annotation" gchar* : Read / Write "midasi" gchar* : Read "okuri" gboolean : Read "output" gchar* : Read / Write "text" gchar* : Read / Write
#define SKK_TYPE_CANDIDATE (skk_candidate_get_type ())
The type for SkkCandidate.
gchar * skk_candidate_to_string (SkkCandidate *self
);
Convert the candidate to string.
|
the SkkCandidate instance |
Returns : |
a string representing the candidate |
SkkCandidate * skk_candidate_new (const gchar *midasi
,gboolean okuri
,const gchar *text
,const gchar *annotation
,const gchar *output
);
Create a new Candidate.
|
midasi (index) word which generate the candidate. [in] |
|
whether the candidate is a result of okuri-ari conversion. [in] |
|
base string value of the candidate. [in] |
|
optional annotation text to the candidate. [in][allow-none] |
|
optional output text used instead of text. [in][allow-none] |
Returns : |
a new SkkCandidate |
const gchar * skk_candidate_get_midasi (SkkCandidate *self
);
Get and return the current value of the "midasi" property.
|
the SkkCandidate instance to query |
Returns : |
the value of the "midasi" property |
gboolean skk_candidate_get_okuri (SkkCandidate *self
);
Get and return the current value of the "okuri" property.
|
the SkkCandidate instance to query |
Returns : |
the value of the "okuri" property |
const gchar * skk_candidate_get_text (SkkCandidate *self
);
Get and return the current value of the "text" property.
|
the SkkCandidate instance to query |
Returns : |
the value of the "text" property |
void skk_candidate_set_text (SkkCandidate *self
,const gchar *value
);
Set the value of the "text" property to value
.
|
the SkkCandidate instance to modify |
|
the new value of the "text" property |
const gchar * skk_candidate_get_annotation (SkkCandidate *self
);
Get and return the current value of the "annotation" property.
|
the SkkCandidate instance to query |
Returns : |
the value of the "annotation" property |
void skk_candidate_set_annotation (SkkCandidate *self
,const gchar *value
);
Set the value of the "annotation" property to value
.
|
the SkkCandidate instance to modify |
|
the new value of the "annotation" property |
const gchar * skk_candidate_get_output (SkkCandidate *self
);
Get and return the current value of the "output" property.
|
the SkkCandidate instance to query |
Returns : |
the value of the "output" property |
void skk_candidate_set_output (SkkCandidate *self
,const gchar *value
);
Set the value of the "output" property to value
.
|
the SkkCandidate instance to modify |
|
the new value of the "output" property |
struct SkkCandidateClass { GObjectClass parent_class; };
The class structure for SKK_TYPE_CANDIDATE
. All the fields in this structure are private and should never be accessed directly.
"annotation"
property "annotation" gchar* : Read / Write
Optional annotation text associated with the candidate.
Default value: NULL
"midasi"
property "midasi" gchar* : Read
Midasi word which generated this candidate.
Default value: NULL
"okuri"
property "okuri" gboolean : Read
Flag to indicate whether this candidate is generated as a result of okuri-ari conversion.
Default value: FALSE
"output"
property "output" gchar* : Read / Write
Output string shown instead of text.
This is particularly useful to display a candidate of numeric conversion.
Default value: NULL