![]() |
![]() |
![]() |
Camel Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Known Derived Interfaces |
struct CamelSettings;GParamSpec ** camel_settings_class_list_settings (,
CamelSettingsClass *settings_class); CamelSettings * camel_settings_clone (
guint *n_settingsCamelSettings *settings
);gboolean camel_settings_equal (CamelSettings *settings_a
,CamelSettings *settings_b
);void camel_settings_load_from_url (CamelSettings *settings
,CamelURL *url
);void camel_settings_save_to_url (CamelSettings *settings
,CamelURL *url
);
struct CamelSettings;
Contains only private data that should be read and manipulated using the functions below.
Since 3.2
GParamSpec ** camel_settings_class_list_settings (,
CamelSettingsClass *settings_class);
guint *n_settings
Returns an array of class
which are
considered to be settings. By default all properties are considered
to be settings, but subclasses may wish to exclude certain properties.
Free the returned array with g_free()
|
a |
|
return location for the length of the returned array |
Returns : |
an array of |
Since 3.2
CamelSettings * camel_settings_clone (CamelSettings *settings
);
Creates an copy of settings
, such that passing settings
and the
copied instance to camel_settings_equal()
would return TRUE
By default, this creates a new settings instance with the same settings
, and copies all settings
to the new instance.
|
a CamelSettings |
Returns : |
a newly-created copy of settings
|
Since 3.2
gboolean camel_settings_equal (CamelSettings *settings_a
,CamelSettings *settings_b
);
Returns TRUE
settings_a
and settings_b
are equal.
By default, equality requires both instances to have the same settings_a
is equal to the corresponding value in settings_b
.
|
a CamelSettings |
|
another CamelSettings |
Returns : |
TRUE settings_a and settings_b are equal |
Since 3.2
void camel_settings_load_from_url (CamelSettings *settings
,CamelURL *url
);
Populates settings
with parameters from url
. The url
parameter value
is converted according to the settings
.
This function is highly Evolution-centric and is only temporary. Expect this function to be removed as early as version 3.4.
|
a CamelSettings |
|
a CamelURL |
Since 3.2
void camel_settings_save_to_url (CamelSettings *settings
,CamelURL *url
);
Writes the values of all properties of settings
to url
as parameter
strings. The parameter name in url
matches the corresponding property
in settings
.
This function is highly Evolution-centric and is only temporary. Expect this function to be removed as early as version 3.4.
|
a CamelSettings |
|
a CamelURL |
Since 3.2