KkcDictionaryList: Reference Manual

Functions

void	kkc_dictionary_list_add ()
void	kkc_dictionary_list_remove ()
void	kkc_dictionary_list_clear ()
void	kkc_dictionary_list_call ()
void	kkc_dictionary_list_save ()
KkcDictionaryList *	kkc_dictionary_list_new ()
gint	kkc_dictionary_list_get_size ()
KkcDictionaryCallbackReturn	(*KkcDictionaryListDictionaryCallback) ()

Properties

gint

size

Read

Types and Values

#define	KKC_TYPE_DICTIONARY_LIST
struct	KkcDictionaryList
struct	KkcDictionaryListClass
enum	KkcDictionaryCallbackReturn

Object Hierarchy

    GEnum
    ╰── KkcDictionaryCallbackReturn
    GObject
    ╰── KkcDictionaryList

Description

Functions

kkc_dictionary_list_add ()

void
kkc_dictionary_list_add (KkcDictionaryList *self,
                         KkcDictionary *dictionary);

Register dictionary.

Parameters

self

the KkcDictionaryList instance

dictionary

.

a dictionary

.

[in]

kkc_dictionary_list_remove ()

void
kkc_dictionary_list_remove (KkcDictionaryList *self,
                            KkcDictionary *dictionary);

Unregister dictionary.

Parameters

self

the KkcDictionaryList instance

dictionary

.

a dictionary

.

[in]

kkc_dictionary_list_clear ()

void
kkc_dictionary_list_clear (KkcDictionaryList *self);

Remove all dictionaries.

Parameters

self

the KkcDictionaryList instance

kkc_dictionary_list_call ()

void
kkc_dictionary_list_call (KkcDictionaryList *self,
                          GType *type,
                          KkcDictionaryListDictionaryCallback callback,
                          gpointer callback_target);

Call function with dictionaries.

Parameters

self	the KkcDictionaryList instance
type	. type of dictionary .	[in][allow-none]
callback	. callback .	[in]
callback_target	user data to pass to `callback` .	[allow-none][closure]

kkc_dictionary_list_save ()

void
kkc_dictionary_list_save (KkcDictionaryList *self);

Save dictionaries on to disk.

Parameters

self

the KkcDictionaryList instance

kkc_dictionary_list_new ()

KkcDictionaryList *
kkc_dictionary_list_new (void);

kkc_dictionary_list_get_size ()

gint
kkc_dictionary_list_get_size (KkcDictionaryList *self);

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

The number of dictionaries registered.

Parameters

self

the KkcDictionaryList instance to query

Returns

the value of the "size" property

KkcDictionaryListDictionaryCallback ()

KkcDictionaryCallbackReturn
(*KkcDictionaryListDictionaryCallback)
                               (KkcDictionary *dictionary,
                                gpointer user_data);

Parameters

dictionary
user_data	data to pass to the delegate function.	[closure]

Types and Values

KKC_TYPE_DICTIONARY_LIST

#define KKC_TYPE_DICTIONARY_LIST (kkc_dictionary_list_get_type ())

The type for KkcDictionaryList.

struct KkcDictionaryList

struct KkcDictionaryList;

struct KkcDictionaryListClass

struct KkcDictionaryListClass {
	GObjectClass parent_class;
};

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

Members

enum KkcDictionaryCallbackReturn

Type to specify how a dictionary callback is handled.

Members

KKC_DICTIONARY_CALLBACK_RETURN_CONTINUE	Continue to the next dictionary.
KKC_DICTIONARY_CALLBACK_RETURN_REMOVE	Stop the processing.

Property Details

The `“size”` property

  “size”                     gint

The number of dictionaries registered.

Flags: Read

Default value: 0