![]() |
![]() |
![]() |
Maliit Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#include <maliit/maliitsettingsentry.h> struct MaliitSettingsEntry; struct MaliitSettingsEntryClass; GHashTable * maliit_settings_entry_get_attributes (MaliitSettingsEntry *entry
); const gchar * maliit_settings_entry_get_description (MaliitSettingsEntry *entry
); MaliitSettingsEntryType maliit_settings_entry_get_entry_type (MaliitSettingsEntry *entry
); const gchar * maliit_settings_entry_get_key (MaliitSettingsEntry *entry
); GVariant * maliit_settings_entry_get_value (MaliitSettingsEntry *entry
); gboolean maliit_settings_entry_is_value_valid (MaliitSettingsEntry *entry
,GVariant *value
); void maliit_settings_entry_set_value (MaliitSettingsEntry *entry
,GVariant *value
); gboolean maliit_settings_entry_is_current_value_valid (MaliitSettingsEntry *entry
);
"attributes" GHashTable* : Read / Write / Construct Only "description" gchar* : Read / Write / Construct Only "extension" MaliitAttributeExtension* : Write / Construct Only "extension-key" gchar* : Read / Write / Construct Only "type" MaliitSettingsEntryType : Read / Write / Construct Only "valid" gboolean : Read / Write / Construct Only "value" GVariant* : Read / Write / Construct Only
The MaliitSettingsEntry is a class holding single plugin
setting. It can be one of several available types
(MaliitSettingsEntryType). It can also have some attributes like
value domain (MALIIT_SETTING_VALUE_DOMAIN()
), default value
(MALIIT_SETTING_DEFAULT_VALUE) and value ranges
(MALIIT_SETTING_VALUE_RANGE_MIN()
and
MALIIT_SETTING_VALUE_RANGE_MAX()
).
GHashTable * maliit_settings_entry_get_attributes
(MaliitSettingsEntry *entry
);
Gets attributes of the entry. The keys of the attributes are
MALIIT_SETTING_VALUE_DOMAIN()
,
MALIIT_SETTING_VALUE_DOMAIN_DESCRIPTIONS()
,
MALIIT_SETTING_VALUE_RANGE_MIN()
, MALIIT_SETTING_VALUE_RANGE_MAX()
and MALIIT_SETTING_DEFAULT_VALUE()
. Note that these keys don't have
to exist in attributes.
|
The MaliitSettingsEntry. [transfer none] |
Returns : |
Attributes. Returned value should not be modified nor freed. [transfer none][element-type utf8 GLib.Variant] |
const gchar * maliit_settings_entry_get_description
(MaliitSettingsEntry *entry
);
Gets description of the entry.
|
The MaliitSettingsEntry. [transfer none] |
Returns : |
A description. Returned value should not be modified nor freed. [transfer none] |
MaliitSettingsEntryType maliit_settings_entry_get_entry_type
(MaliitSettingsEntry *entry
);
Gets type of the entry.
|
The MaliitSettingsEntry. [transfer none] |
Returns : |
A type. |
const gchar * maliit_settings_entry_get_key (MaliitSettingsEntry *entry
);
Gets key of the entry.
|
The MaliitSettingsEntry. [transfer none] |
Returns : |
A key. Returned value should not be modified nor freed. [transfer none] |
GVariant * maliit_settings_entry_get_value (MaliitSettingsEntry *entry
);
Gets value of the entry. Check its validity with
maliit_settings_entry_is_current_value_valid()
before using it.
|
The MaliitSettingsEntry. [transfer none] |
Returns : |
A value. [transfer none] |
gboolean maliit_settings_entry_is_value_valid (MaliitSettingsEntry *entry
,GVariant *value
);
Checks whether the value is valid one for the entry.
|
The MaliitSettingsEntry. [transfer none] |
|
The GVariant. [transfer none] |
Returns : |
TRUE if valid, otherwise FALSE . |
void maliit_settings_entry_set_value (MaliitSettingsEntry *entry
,GVariant *value
);
Sets a new value of the entry. Before setting new value, validate
it with maliit_settings_entry_is_value_valid()
.
|
The MaliitSettingsEntry. [transfer none] |
|
The GVariant. [transfer none] |
gboolean maliit_settings_entry_is_current_value_valid
(MaliitSettingsEntry *entry
);
Gets whether current value of the entry is valid.
|
The MaliitSettingsEntry. [transfer none] |
Returns : |
TRUE if valid, otherwise FALSE
|
"attributes"
property "attributes" GHashTable* : Read / Write / Construct Only
Attributes of the entry.
"description"
property "description" gchar* : Read / Write / Construct Only
Description of the entry.
Default value: ""
"extension"
property"extension" MaliitAttributeExtension* : Write / Construct Only
MaliitAttributeExtension used by this entry.
"extension-key"
property "extension-key" gchar* : Read / Write / Construct Only
Key of the entry.
Default value: ""
"type"
property"type" MaliitSettingsEntryType : Read / Write / Construct Only
Type of the entry
Default value: MALIIT_STRING_TYPE
"valid"
property "valid" gboolean : Read / Write / Construct Only
Whether entry's value is valid.
Default value: FALSE
"value-changed"
signalvoid user_function (MaliitSettingsEntry *entry,
gpointer user_data) : Run First
Emitted when value of the entry was changed in the plugin.
|
The MaliitSettingsEntry emitting the signal. |
|
user data set when the signal handler was connected. |