MaliitSettingsManager

MaliitSettingsManager — settings manager

Stability Level

Stable, unless otherwise indicated

Functions

Signals

void connected Run First
void disconnected Run First
void plugin-settings-received Run First

Types and Values

Object Hierarchy

    GObject
    ╰── MaliitSettingsManager

Includes

#include <maliit/maliitsettingsmanager.h>

Description

The MaliitSettingsManager handles requesting and receiving plugin settings from maliit-server and notifying when those settings has changed.

Functions

maliit_settings_manager_new ()

MaliitSettingsManager *
maliit_settings_manager_new (void);

Creates new settings manager.

Returns

The newly created MaliitSettingsManager.

[transfer full]


maliit_settings_manager_get_preferred_description_locale ()

const gchar *
maliit_settings_manager_get_preferred_description_locale
                               (void);

Gets the preferred locale for human-readable description.

Returns

The string being a current preferred locale. Returned string should not be freed nor modified.

[transfer none]


maliit_settings_manager_load_plugin_settings ()

void
maliit_settings_manager_load_plugin_settings
                               (MaliitSettingsManager *manager);

Request the list of settings from maliit-server. The settings will be returned async via the MaliitServerManager::plugin-settings-received signal

Parameters

manager

The MaliitSettingsManager.

[transfer none]

maliit_settings_manager_set_preferred_description_locale ()

void
maliit_settings_manager_set_preferred_description_locale
                               (const gchar *locale_name);

Sets the preferred locale for human-readable descriptions. The setting is valid for all instances of MaliitSettingsManager in the process. Note that the server may not always be able to return info in the requested locale.

Parameters

locale_name

The new preferred locale.

[transfer none]

Types and Values

struct MaliitSettingsManager

struct MaliitSettingsManager;

struct MaliitSettingsManagerClass

struct MaliitSettingsManagerClass {
    GObjectClass parent_class;
};

Members

Signal Details

The “connected” signal

void
user_function (MaliitSettingsManager *manager,
               gpointer               user_data)

Emitted when connection to maliit-server is established.

Parameters

manager

The MaliitSettingsManager emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “disconnected” signal

void
user_function (MaliitSettingsManager *manager,
               gpointer               user_data)

Emitted when connection to maliit-server is broken.

Parameters

manager

The MaliitSettingsManager emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First


The “plugin-settings-received” signal

void
user_function (MaliitSettingsManager *manager,
               gpointer               settings,
               gpointer               user_data)

Emitted after call to maliit_settings_manager_load_plugin_settings() and when the plugin list changes on the server.

Parameters

manager

The MaliitSettingsManager emitting the signal.

 

settings

Gotten settings.

[type GLib.List][element-type Maliit.PluginSettings]

user_data

user data set when the signal handler was connected.

 

Flags: Run First

See Also

MaliitSettingsEntry, MaliitPluginSettings