KkcDictionary: Reference Manual

KkcDictionary

KkcDictionary — Base interface of dictionaries.

Functions

void	kkc_dictionary_reload ()
void	kkc_dictionary_save ()

Types and Values

enum	KkcDictionaryError
	KkcDictionary
struct	KkcDictionaryIface

Object Hierarchy

    GInterface
    ╰── KkcDictionary

Prerequisites

KkcDictionary requires GObject.

Known Derived Interfaces

KkcDictionary is required by KkcSegmentDictionary and KkcSentenceDictionary.

Known Implementations

KkcDictionary is implemented by KkcEmptySegmentDictionary, KkcSystemSegmentDictionary, KkcUserDictionary, KkcUserSegmentDictionary and KkcUserSentenceDictionary.

Description

Functions

kkc_dictionary_reload ()

void
kkc_dictionary_reload (KkcDictionary *self,
                       GError **error);

Reload the dictionary.

GError will be returned in error

when reading the dictionary failed.

Parameters

self	the KkcDictionary instance
error	location to store the error occuring, or `NULL` to ignore

kkc_dictionary_save ()

void
kkc_dictionary_save (KkcDictionary *self,
                     GError **error);

Save the dictionary on disk.

GError will be returned in error

if the dictionary cannot be saved.

Parameters

self	the KkcDictionary instance
error	location to store the error occuring, or `NULL` to ignore

Types and Values

enum KkcDictionaryError

Members

KKC_DICTIONARY_ERROR_NOT_READABLE
KKC_DICTIONARY_ERROR_MALFORMED_INPUT

KkcDictionary

typedef struct _KkcDictionary KkcDictionary;

Base interface of dictionaries.

struct KkcDictionaryIface

struct KkcDictionaryIface {
	GTypeInterface parent_iface;
	void (*reload) (KkcDictionary* self, GError** error);
	void (*save) (KkcDictionary* self, GError** error);
};

Interface for creating KkcDictionary implementations.

Members

GTypeInterface `parent_iface`;	the parent interface structure
`reload` ()	virtual method called by `kkc_dictionary_reload()`
`save` ()	virtual method called by `kkc_dictionary_save()`