KkcMetadataFile: Reference Manual

Functions

gboolean	kkc_metadata_file_parse ()
const gchar *	kkc_metadata_file_get_name ()
void	kkc_metadata_file_set_name ()
const gchar *	kkc_metadata_file_get_label ()
void	kkc_metadata_file_set_label ()
const gchar *	kkc_metadata_file_get_description ()
void	kkc_metadata_file_set_description ()
const gchar *	kkc_metadata_file_get_filename ()
void	kkc_metadata_file_set_filename ()

Properties

gchar *	description	Read / Write / Construct
gchar *	filename	Read / Write / Construct
gchar *	label	Read / Write / Construct
gchar *	name	Read / Write / Construct

Types and Values

#define	KKC_TYPE_METADATA_FILE
struct	KkcMetadataFile
struct	KkcMetadataFileClass
enum	KkcMetadataFormatError

Object Hierarchy

    GObject
    ╰── KkcMetadataFile
        ├── KkcLanguageModelMetadata
        ╰── KkcRuleMetadata

Implemented Interfaces

KkcMetadataFile implements GInitable.

Description

Functions

kkc_metadata_file_parse ()

gboolean
kkc_metadata_file_parse (KkcMetadataFile *self,
                         JsonObject *object,
                         GError **error);

Parameters

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

kkc_metadata_file_get_name ()

const gchar *
kkc_metadata_file_get_name (KkcMetadataFile *self);

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

Name of the metadata.

Parameters

self

the KkcMetadataFile instance to query

Returns

the value of the "name" property

kkc_metadata_file_set_name ()

void
kkc_metadata_file_set_name (KkcMetadataFile *self,
                            const gchar *value);

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

Name of the metadata.

Parameters

self	the KkcMetadataFile instance to modify
value	the new value of the "name" property

kkc_metadata_file_get_label ()

const gchar *
kkc_metadata_file_get_label (KkcMetadataFile *self);

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

Label string of the metadata.

Parameters

self

the KkcMetadataFile instance to query

Returns

the value of the "label" property

kkc_metadata_file_set_label ()

void
kkc_metadata_file_set_label (KkcMetadataFile *self,
                             const gchar *value);

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

Label string of the metadata.

Parameters

self	the KkcMetadataFile instance to modify
value	the new value of the "label" property

kkc_metadata_file_get_description ()

const gchar *
kkc_metadata_file_get_description (KkcMetadataFile *self);

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

Description of the metadata.

Parameters

self

the KkcMetadataFile instance to query

Returns

the value of the "description" property

kkc_metadata_file_set_description ()

void
kkc_metadata_file_set_description (KkcMetadataFile *self,
                                   const gchar *value);

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

Description of the metadata.

Parameters

self	the KkcMetadataFile instance to modify
value	the new value of the "description" property

kkc_metadata_file_get_filename ()

const gchar *
kkc_metadata_file_get_filename (KkcMetadataFile *self);

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

Location of the metadata file.

Parameters

self

the KkcMetadataFile instance to query

Returns

the value of the "filename" property

kkc_metadata_file_set_filename ()

void
kkc_metadata_file_set_filename (KkcMetadataFile *self,
                                const gchar *value);

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

Location of the metadata file.

Parameters

self	the KkcMetadataFile instance to modify
value	the new value of the "filename" property

Types and Values

KKC_TYPE_METADATA_FILE

#define KKC_TYPE_METADATA_FILE (kkc_metadata_file_get_type ())

The type for KkcMetadataFile.

struct KkcMetadataFile

struct KkcMetadataFile;

struct KkcMetadataFileClass

struct KkcMetadataFileClass {
	GObjectClass parent_class;
	gboolean (*parse) (KkcMetadataFile* self, JsonObject* object, GError** error);
};

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

Members

parse ()

virtual method called by kkc_metadata_file_parse()

enum KkcMetadataFormatError

Members

KKC_METADATA_FORMAT_ERROR_MISSING_FIELD
KKC_METADATA_FORMAT_ERROR_INVALID_FIELD

Property Details

The `“description”` property

  “description”              gchar *

Description of the metadata.

Flags: Read / Write / Construct

Default value: NULL

The `“filename”` property

  “filename”                 gchar *

Location of the metadata file.

Flags: Read / Write / Construct

Default value: NULL

The `“label”` property

  “label”                    gchar *

Label string of the metadata.

Flags: Read / Write / Construct

Default value: NULL

The `“name”` property

  “name”                     gchar *

Name of the metadata.

Flags: Read / Write / Construct

Default value: NULL