SkkCandidate

SkkCandidate — Object representing a candidate in dictionaries.

Functions

Properties

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

Types and Values

Object Hierarchy

    GObject
    ╰── SkkCandidate

Description

Functions

skk_candidate_to_string ()

gchar *
skk_candidate_to_string (SkkCandidate *self);

Convert the candidate to string.

Parameters

self

the SkkCandidate instance

 

Returns

a string representing the candidate


skk_candidate_new ()

SkkCandidate *
skk_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 SkkCandidate


skk_candidate_get_midasi ()

const gchar *
skk_candidate_get_midasi (SkkCandidate *self);

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

Midasi word which generated this candidate.

Parameters

self

the SkkCandidate instance to query

 

Returns

the value of the "midasi" property


skk_candidate_get_okuri ()

gboolean
skk_candidate_get_okuri (SkkCandidate *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 SkkCandidate instance to query

 

Returns

the value of the "okuri" property


skk_candidate_get_text ()

const gchar *
skk_candidate_get_text (SkkCandidate *self);

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

Base string value of the candidate.

Parameters

self

the SkkCandidate instance to query

 

Returns

the value of the "text" property


skk_candidate_set_text ()

void
skk_candidate_set_text (SkkCandidate *self,
                        const gchar *value);

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

Base string value of the candidate.

Parameters

self

the SkkCandidate instance to modify

 

value

the new value of the "text" property

 

skk_candidate_get_annotation ()

const gchar *
skk_candidate_get_annotation (SkkCandidate *self);

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

Optional annotation text associated with the candidate.

Parameters

self

the SkkCandidate instance to query

 

Returns

the value of the "annotation" property


skk_candidate_set_annotation ()

void
skk_candidate_set_annotation (SkkCandidate *self,
                              const gchar *value);

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

Optional annotation text associated with the candidate.

Parameters

self

the SkkCandidate instance to modify

 

value

the new value of the "annotation" property

 

skk_candidate_get_output ()

const gchar *
skk_candidate_get_output (SkkCandidate *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 SkkCandidate instance to query

 

Returns

the value of the "output" property


skk_candidate_set_output ()

void
skk_candidate_set_output (SkkCandidate *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 SkkCandidate instance to modify

 

value

the new value of the "output" property

 

Types and Values

SKK_TYPE_CANDIDATE

#define SKK_TYPE_CANDIDATE (skk_candidate_get_type ())

The type for SkkCandidate.


struct SkkCandidate

struct SkkCandidate;

Object representing a candidate in dictionaries.


struct SkkCandidateClass

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.

Members

Property Details

The “annotation” property

  “annotation”               gchar *

Optional annotation text associated with the candidate.

Owner: SkkCandidate

Flags: Read / Write

Default value: NULL


The “midasi” property

  “midasi”                   gchar *

Midasi word which generated this candidate.

Owner: SkkCandidate

Flags: Read

Default value: NULL


The “okuri” property

  “okuri”                    gboolean

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

Owner: SkkCandidate

Flags: Read

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.

Owner: SkkCandidate

Flags: Read / Write

Default value: NULL


The “text” property

  “text”                     gchar *

Base string value of the candidate.

Owner: SkkCandidate

Flags: Read / Write

Default value: NULL