Modulemd.TranslationEntry

Modulemd.TranslationEntry — Contains the translated strings for a particular module stream.

Functions

Types and Values

Description

Functions

modulemd_translation_entry_new ()

ModulemdTranslationEntry *
modulemd_translation_entry_new (const gchar *locale);

Parameters

locale

The locale for this translation. It must correspond to the format specified by libc locale names.

[transfer none][not nullable]

Since: 1.6


modulemd_translation_entry_copy ()

ModulemdTranslationEntry *
modulemd_translation_entry_copy (ModulemdTranslationEntry *self);

Returns

A deep copy of this translation entry. This must be freed with g_object_unref().

[transfer full]

Since: 1.6


modulemd_translation_entry_set_locale ()

void
modulemd_translation_entry_set_locale (ModulemdTranslationEntry *self,
                                       const gchar *locale);

This function sets the locale for this translation. It must correspond to the format specified by libc locale names.

Parameters

locale

The locale.

[transfer none][not nullable]

Since: 1.6


modulemd_translation_entry_get_locale ()

gchar *
modulemd_translation_entry_get_locale (ModulemdTranslationEntry *self);

Get the locale of this entry.

Returns

A string describing the locale of this entry, corresponding to libc locale names. This string must be freed with g_free().

[transfer full]

Since: 1.6


modulemd_translation_entry_peek_locale ()

const gchar *
modulemd_translation_entry_peek_locale
                               (ModulemdTranslationEntry *self);

Peek at the locale of this entry.

[skip]

Returns

A string describing the locale of this entry, corresponding to libc locale names. This string must not be modified or freed.

[transfer none]

Since: 1.6


modulemd_translation_entry_set_summary ()

void
modulemd_translation_entry_set_summary
                               (ModulemdTranslationEntry *self,
                                const gchar *summary);

This function sets the translation of the summary of this module.

Parameters

summary

The summary.

[transfer none][not nullable]

Since: 1.6


modulemd_translation_entry_get_summary ()

gchar *
modulemd_translation_entry_get_summary
                               (ModulemdTranslationEntry *self);

Get the summary of this entry.

Returns

A translation of the summary of the module appropriate to the locale. This string must be freed with g_free().

[transfer full]

Since: 1.6


modulemd_translation_entry_peek_summary ()

const gchar *
modulemd_translation_entry_peek_summary
                               (ModulemdTranslationEntry *self);

Peek at the summary of this entry.

[skip]

Returns

A translation of the summary of the module appropriate to the locale. This string must not be modified or freed.

[transfer none]

Since: 1.6


modulemd_translation_entry_set_description ()

void
modulemd_translation_entry_set_description
                               (ModulemdTranslationEntry *self,
                                const gchar *description);

This function sets the translation of the description of this module.

Parameters

description

The description.

[transfer none][not nullable]

Since: 1.6


modulemd_translation_entry_get_description ()

gchar *
modulemd_translation_entry_get_description
                               (ModulemdTranslationEntry *self);

Get the description of this entry.

Returns

A translation of the module description, appropriate to the locale. This string must be freed with g_free().

[transfer full]

Since: 1.6


modulemd_translation_entry_peek_description ()

const gchar *
modulemd_translation_entry_peek_description
                               (ModulemdTranslationEntry *self);

Peek at the description of this entry.

[skip]

Returns

A translation of the module description, appropriate to the locale. This string must not be modified or freed.

[transfer none]

Since: 1.6


modulemd_translation_entry_set_profile_description ()

void
modulemd_translation_entry_set_profile_description
                               (ModulemdTranslationEntry *self,
                                const gchar *profile_name,
                                const gchar *profile_description);

Parameters

profile_name

The name of the stream profile.

[transfer none][not nullable]

profile_description

A translation of the profile description appropriate to the locale. If set to NULL, this will remove the profile description from this ModulemdTranslationEntry.

[transfer none][nullable]

Since: 1.6


modulemd_translation_entry_get_profile_description ()

gchar *
modulemd_translation_entry_get_profile_description
                               (ModulemdTranslationEntry *self,
                                const gchar *profile_name);

Parameters

profile_name

The name of the stream profile.

[transfer none][not nullable]

Returns

The translated description of the requested profile. This string must be freed with g_free().

[transfer full]

Since: 1.6


modulemd_translation_entry_peek_profile_description ()

const gchar *
modulemd_translation_entry_peek_profile_description
                               (ModulemdTranslationEntry *self,
                                const gchar *profile_name);

[skip]

Parameters

profile_name

The name of the stream profile.

[transfer none][not nullable]

Returns

The translated description of the requested profile. This string must not be modified or freed.

[transfer none]

Since: 1.6


modulemd_translation_entry_get_all_profile_descriptions ()

GHashTable *
modulemd_translation_entry_get_all_profile_descriptions
                               (ModulemdTranslationEntry *self);

Returns

The complete set of profile descriptions, indexed by profile name. This must be freed with g_hash_table_unref().

[transfer container][element-type utf8 utf8]

Since: 1.6

Types and Values

MODULEMD_TYPE_TRANSLATION_ENTRY

#define             MODULEMD_TYPE_TRANSLATION_ENTRY

ModulemdTranslationEntry

typedef struct _ModulemdTranslationEntry ModulemdTranslationEntry;