MaliitPluginSettings

MaliitPluginSettings — plugin settings

Stability Level

Stable, unless otherwise indicated

Synopsis

#include <maliit/maliitpluginsettings.h>

struct              MaliitPluginSettings;
struct              MaliitPluginSettingsClass;
GPtrArray *         maliit_plugin_settings_get_configuration_entries
                                                        (MaliitPluginSettings *settings);
const gchar *       maliit_plugin_settings_get_description_language
                                                        (MaliitPluginSettings *settings);
const gchar *       maliit_plugin_settings_get_plugin_description
                                                        (MaliitPluginSettings *settings);
const gchar *       maliit_plugin_settings_get_plugin_name
                                                        (MaliitPluginSettings *settings);

Object Hierarchy

  GObject
   +----MaliitPluginSettings

Properties

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

Description

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

Details

struct MaliitPluginSettings

struct MaliitPluginSettings;

struct MaliitPluginSettingsClass

struct MaliitPluginSettingsClass {
    GObjectClass parent_class;
};

GObjectClass parent_class;

The parent class.

maliit_plugin_settings_get_configuration_entries ()

GPtrArray *         maliit_plugin_settings_get_configuration_entries
                                                        (MaliitPluginSettings *settings);

Gets configuration entries of the plugin

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.

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.

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.

settings :

The MaliitPluginSettings. [transfer none]

Returns :

A name. Returned value should not be modified nor freed. [transfer none]

Property Details

The "configuration-entries" property

  "configuration-entries"    GPtrArray*            : Read / Write / Construct Only

List of configuration entries of the plugin.


The "description-language" property

  "description-language"     gchar*                : Read / Write / Construct Only

Language of the plugin description.

Default value: "en"


The "plugin-description" property

  "plugin-description"       gchar*                : Read / Write / Construct Only

Description of the plugin.

Default value: ""


The "plugin-name" property

  "plugin-name"              gchar*                : Read / Write / Construct Only

Name of the plugin.

Default value: "unknown"

See Also

MaliitSettingsEntry, MaliitSettingsManager