KkcEmptySegmentDictionary: Reference Manual

KkcEmptySegmentDictionary

KkcEmptySegmentDictionary — Null implementation of Dictionary.

Functions

KkcEmptySegmentDictionary *	kkc_empty_segment_dictionary_new ()
gboolean	kkc_segment_dictionary_lookup_candidates ()
gchar **	kkc_segment_dictionary_complete ()
gboolean	kkc_segment_dictionary_select_candidate ()
gboolean	kkc_segment_dictionary_purge_candidate ()

Types and Values

#define	KKC_TYPE_EMPTY_SEGMENT_DICTIONARY
struct	KkcEmptySegmentDictionary
struct	KkcEmptySegmentDictionaryClass
	KkcSegmentDictionary
struct	KkcSegmentDictionaryIface

Object Hierarchy

    GInterface
    ╰── KkcSegmentDictionary
    GObject
    ╰── KkcEmptySegmentDictionary

Prerequisites

KkcSegmentDictionary requires KkcDictionary and GObject.

Implemented Interfaces

KkcEmptySegmentDictionary implements KkcDictionary and KkcSegmentDictionary.

Known Implementations

KkcSegmentDictionary is implemented by KkcEmptySegmentDictionary, KkcSystemSegmentDictionary, KkcUserDictionary and KkcUserSegmentDictionary.

Description

Functions

kkc_empty_segment_dictionary_new ()

KkcEmptySegmentDictionary *
kkc_empty_segment_dictionary_new (void);

kkc_segment_dictionary_lookup_candidates ()

gboolean
kkc_segment_dictionary_lookup_candidates
                               (KkcSegmentDictionary *self,
                                const gchar *midasi,
                                gboolean okuri,
                                KkcCandidate ***candidates,
                                int *candidates_length1);

Lookup candidates in the dictionary.

Parameters

self	the KkcSegmentDictionary instance
midasi	. a midasi (title) string to lookup .	[in]
okuri	. whether to search okuri-ari entries or okuri-nasi entries .	[in]
candidates	. output location of candidates .	[out][array length=candidates_length1]
candidates_length1	length of the `candidates` array

Returns

`true` if found, `false` otherwise

kkc_segment_dictionary_complete ()

gchar **
kkc_segment_dictionary_complete (KkcSegmentDictionary *self,
                                 const gchar *midasi,
                                 int *result_length1);

Return an array of strings which matches midasi.

Parameters

self

the KkcSegmentDictionary instance

midasi

a midasi (title) string to lookup

[in]

Returns

an array of strings

[array length=result_length1]

kkc_segment_dictionary_select_candidate ()

gboolean
kkc_segment_dictionary_select_candidate
                               (KkcSegmentDictionary *self,
                                KkcCandidate *candidate);

Select a candidate in the dictionary.

Parameters

self

the KkcSegmentDictionary instance

candidate

an Candidate

[in]

Returns

`true` if the dictionary is modified, `false` otherwise.

kkc_segment_dictionary_purge_candidate ()

gboolean
kkc_segment_dictionary_purge_candidate
                               (KkcSegmentDictionary *self,
                                KkcCandidate *candidate);

Purge a candidate in the dictionary.

Parameters

self

the KkcSegmentDictionary instance

candidate

an Candidate

[in]

Returns

`true` if the dictionary is modified, `false` otherwise.

Types and Values

KKC_TYPE_EMPTY_SEGMENT_DICTIONARY

#define KKC_TYPE_EMPTY_SEGMENT_DICTIONARY (kkc_empty_segment_dictionary_get_type ())

The type for KkcEmptySegmentDictionary.

struct KkcEmptySegmentDictionary

struct KkcEmptySegmentDictionary;

Null implementation of Dictionary.

struct KkcEmptySegmentDictionaryClass

struct KkcEmptySegmentDictionaryClass {
	GObjectClass parent_class;
};

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

Members

KkcSegmentDictionary

typedef struct _KkcSegmentDictionary KkcSegmentDictionary;

Base interface of segment dictionaries.

struct KkcSegmentDictionaryIface

struct KkcSegmentDictionaryIface {
	GTypeInterface parent_iface;
	gboolean (*lookup_candidates) (KkcSegmentDictionary* self, const gchar* midasi, gboolean okuri, KkcCandidate*** candidates, int* candidates_length1);
	gchar** (*complete) (KkcSegmentDictionary* self, const gchar* midasi, int* result_length1);
	gboolean (*select_candidate) (KkcSegmentDictionary* self, KkcCandidate* candidate);
	gboolean (*purge_candidate) (KkcSegmentDictionary* self, KkcCandidate* candidate);
};

Interface for creating KkcSegmentDictionary implementations.

Members

GTypeInterface `parent_iface`;	the parent interface structure
`lookup_candidates` ()	virtual method called by `kkc_segment_dictionary_lookup_candidates()`
`complete` ()	virtual method called by `kkc_segment_dictionary_complete()`
`select_candidate` ()	virtual method called by `kkc_segment_dictionary_select_candidate()`
`purge_candidate` ()	virtual method called by `kkc_segment_dictionary_purge_candidate()`