MaliitPluginSettings

MaliitPluginSettings — plugin settings

Stability Level

Stable, unless otherwise indicated

Functions

Properties

GPtrArray * configuration-entries Read / Write / Construct Only
gchar * description-language Read / Write / Construct Only
gchar * plugin-description Read / Write / Construct Only
gchar * plugin-name Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── MaliitPluginSettings

Includes

#include <maliit/maliitpluginsettings.h>

Description

The MaliitPluginSettings is a class holding general plugin information like name, description and configuration entries.

Functions

maliit_plugin_settings_get_configuration_entries ()

GPtrArray *
maliit_plugin_settings_get_configuration_entries
                               (MaliitPluginSettings *settings);

Gets configuration entries of the plugin

Parameters

settings

The MaliitPluginSettings.

[transfer none]

Returns

Configuration entries. Returned value should not be modified nor freed.

[transfer none][element-type Maliit.SettingsEntry]


maliit_plugin_settings_get_description_language ()

const gchar *
maliit_plugin_settings_get_description_language
                               (MaliitPluginSettings *settings);

Gets language of the plugin description.

Parameters

settings

The MaliitPluginSettings.

[transfer none]

Returns

A language. Returned value should not be modified nor freed.

[transfer none]


maliit_plugin_settings_get_plugin_description ()

const gchar *
maliit_plugin_settings_get_plugin_description
                               (MaliitPluginSettings *settings);

Gets description of the plugin.

Parameters

settings

The MaliitPluginSettings.

[transfer none]

Returns

A description. Returned value should not be modified nor freed.

[transfer none]


maliit_plugin_settings_get_plugin_name ()

const gchar *
maliit_plugin_settings_get_plugin_name
                               (MaliitPluginSettings *settings);

Gets name of the plugin.

Parameters

settings

The MaliitPluginSettings.

[transfer none]

Returns

A name. Returned value should not be modified nor freed.

[transfer none]

Types and Values

struct MaliitPluginSettings

struct MaliitPluginSettings;

struct MaliitPluginSettingsClass

struct MaliitPluginSettingsClass {
    GObjectClass parent_class;
};

Members

Property Details

The “configuration-entries” property

  “configuration-entries”    GPtrArray *

List of configuration entries of the plugin.

[element-type Maliit.SettingsEntry]

Flags: Read / Write / Construct Only


The “description-language” property

  “description-language”     gchar *

Language of the plugin description.

Flags: Read / Write / Construct Only

Default value: "en"


The “plugin-description” property

  “plugin-description”       gchar *

Description of the plugin.

Flags: Read / Write / Construct Only

Default value: ""


The “plugin-name” property

  “plugin-name”              gchar *

Name of the plugin.

Flags: Read / Write / Construct Only

Default value: "unknown"

See Also

MaliitSettingsEntry, MaliitSettingsManager