KkcCandidate

KkcCandidate — Object representing a candidate in dictionaries.

Functions

Properties

gchar * annotation Read / Write
gchar * midasi Read / Write / Construct
gboolean okuri Read / Write / Construct
gchar * output Read / Write
gchar * text Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── KkcCandidate

Description

Functions

kkc_candidate_to_string ()

gchar *
kkc_candidate_to_string (KkcCandidate *self);

Convert the candidate to string.

Parameters

self

the KkcCandidate instance

 

Returns

a string representing the candidate


kkc_candidate_new ()

KkcCandidate *
kkc_candidate_new (const gchar *midasi,
                   gboolean okuri,
                   const gchar *text,
                   const gchar *annotation,
                   const gchar *output);

Create a new Candidate.

Parameters

midasi

 .

midasi (index) word which generate the candidate

.

[in]

okuri

 .

whether the candidate is a result of okuri-ari conversion

.

[in]

text

 .

base string value of the candidate

.

[in]

annotation

 .

optional annotation text to the candidate

.

[in][allow-none]

output

 .

optional output text used instead of text

.

[in][allow-none]

Returns

a new KkcCandidate


kkc_candidate_get_midasi ()

const gchar *
kkc_candidate_get_midasi (KkcCandidate *self);

Get and return the current value of the "midasi" property.

Midasi word which generated this candidate.

Parameters

self

the KkcCandidate instance to query

 

Returns

the value of the "midasi" property


kkc_candidate_set_midasi ()

void
kkc_candidate_set_midasi (KkcCandidate *self,
                          const gchar *value);

Set the value of the "midasi" property to value .

Midasi word which generated this candidate.

Parameters

self

the KkcCandidate instance to modify

 

value

the new value of the "midasi" property

 

kkc_candidate_get_okuri ()

gboolean
kkc_candidate_get_okuri (KkcCandidate *self);

Get and return the current value of the "okuri" property.

Flag to indicate whether this candidate is generated as a result of okuri-ari conversion.

Parameters

self

the KkcCandidate instance to query

 

Returns

the value of the "okuri" property


kkc_candidate_set_okuri ()

void
kkc_candidate_set_okuri (KkcCandidate *self,
                         gboolean value);

Set the value of the "okuri" property to value .

Flag to indicate whether this candidate is generated as a result of okuri-ari conversion.

Parameters

self

the KkcCandidate instance to modify

 

value

the new value of the "okuri" property

 

kkc_candidate_get_text ()

const gchar *
kkc_candidate_get_text (KkcCandidate *self);

Get and return the current value of the "text" property.

Base string value of the candidate.

Parameters

self

the KkcCandidate instance to query

 

Returns

the value of the "text" property


kkc_candidate_set_text ()

void
kkc_candidate_set_text (KkcCandidate *self,
                        const gchar *value);

Set the value of the "text" property to value .

Base string value of the candidate.

Parameters

self

the KkcCandidate instance to modify

 

value

the new value of the "text" property

 

kkc_candidate_get_annotation ()

const gchar *
kkc_candidate_get_annotation (KkcCandidate *self);

Get and return the current value of the "annotation" property.

Optional annotation text associated with the candidate.

Parameters

self

the KkcCandidate instance to query

 

Returns

the value of the "annotation" property


kkc_candidate_set_annotation ()

void
kkc_candidate_set_annotation (KkcCandidate *self,
                              const gchar *value);

Set the value of the "annotation" property to value .

Optional annotation text associated with the candidate.

Parameters

self

the KkcCandidate instance to modify

 

value

the new value of the "annotation" property

 

kkc_candidate_get_output ()

const gchar *
kkc_candidate_get_output (KkcCandidate *self);

Get and return the current value of the "output" property.

Output string shown instead of text.

This is particularly useful to display a candidate of numeric conversion.

Parameters

self

the KkcCandidate instance to query

 

Returns

the value of the "output" property


kkc_candidate_set_output ()

void
kkc_candidate_set_output (KkcCandidate *self,
                          const gchar *value);

Set the value of the "output" property to value .

Output string shown instead of text.

This is particularly useful to display a candidate of numeric conversion.

Parameters

self

the KkcCandidate instance to modify

 

value

the new value of the "output" property

 

Types and Values

KKC_TYPE_CANDIDATE

#define KKC_TYPE_CANDIDATE (kkc_candidate_get_type ())

The type for KkcCandidate.


struct KkcCandidate

struct KkcCandidate;

Object representing a candidate in dictionaries.


struct KkcCandidateClass

struct KkcCandidateClass {
	GObjectClass parent_class;
};

The class structure for KKC_TYPE_CANDIDATE. All the fields in this structure are private and should never be accessed directly.

Members

Property Details

The “annotation” property

  “annotation”               gchar *

Optional annotation text associated with the candidate.

Flags: Read / Write

Default value: NULL


The “midasi” property

  “midasi”                   gchar *

Midasi word which generated this candidate.

Flags: Read / Write / Construct

Default value: NULL


The “okuri” property

  “okuri”                    gboolean

Flag to indicate whether this candidate is generated as a result of okuri-ari conversion.

Flags: Read / Write / Construct

Default value: FALSE


The “output” property

  “output”                   gchar *

Output string shown instead of text.

This is particularly useful to display a candidate of numeric conversion.

Flags: Read / Write

Default value: NULL


The “text” property

  “text”                     gchar *

Base string value of the candidate.

Flags: Read / Write

Default value: NULL