Configuration Retrieve Functions
Functions that retrieve configuration values, based on type. More...Functions | |
EAPI Ecore_Config_Prop * | ecore_config_get (const char *key) |
Returns the property with the given key. | |
EAPI char * | ecore_config_string_get (const char *key) |
Returns the specified property as a string. | |
EAPI int | ecore_config_boolean_get (const char *key) |
Returns the specified property as an integer. | |
EAPI long | ecore_config_int_get (const char *key) |
Returns the specified property as a long integer. | |
EAPI float | ecore_config_float_get (const char *key) |
Returns the specified property as a float. | |
EAPI int | ecore_config_argb_get (const char *key, int *a, int *r, int *g, int *b) |
Finds the alpha, red, green and blue values of a color property. | |
EAPI long | ecore_config_argbint_get (const char *key) |
Returns a color property as a long. | |
EAPI char * | ecore_config_argbstr_get (const char *key) |
Returns a color property as a string of hexadecimal characters. | |
EAPI char * | ecore_config_theme_get (const char *key) |
Returns a theme property. | |
EAPI char * | ecore_config_as_string_get (const char *key) |
Retrieves the key as a string. |
Detailed Description
Functions that retrieve configuration values, based on type.
Function Documentation
EAPI int ecore_config_argb_get | ( | const char * | key, | |
int * | a, | |||
int * | r, | |||
int * | g, | |||
int * | b | |||
) |
Finds the alpha, red, green and blue values of a color property.
- Parameters:
-
key The property key. a A pointer to an integer to store the alpha value into. r A pointer to an integer to store the red value into. g A pointer to an integer to store the green value into. b A pointer to an integer to store the blue value into.
- Returns:
ECORE_CONFIG_ERR_SUCC
on success.ECORE_CONFIG_ERR_FAIL
otherwise.
References ecore_config_get().
EAPI long ecore_config_argbint_get | ( | const char * | key | ) |
Returns a color property as a long.
- Parameters:
-
key The property key.
- Returns:
- ARGB data as long
References ecore_config_get().
EAPI char* ecore_config_argbstr_get | ( | const char * | key | ) |
Returns a color property as a string of hexadecimal characters.
- Parameters:
-
key The property key.
- Returns:
- A string of hexadecimal characters in the format aarrggbb.
References ecore_config_get().
EAPI char* ecore_config_as_string_get | ( | const char * | key | ) |
Retrieves the key as a string.
- Parameters:
-
key The property key.
- Returns:
- Returns a character array in the form of 'key:type=value'.
NULL
is returned if the property does not exist.
References ECORE_CONFIG_BLN, ECORE_CONFIG_FLT, ecore_config_get(), ECORE_CONFIG_INT, ECORE_CONFIG_NIL, ECORE_CONFIG_RGB, ECORE_CONFIG_SCT, ECORE_CONFIG_STR, ECORE_CONFIG_THM, and Ecore_Config_Prop::type.
EAPI int ecore_config_boolean_get | ( | const char * | key | ) |
Returns the specified property as an integer.
- Parameters:
-
key The property key.
- Returns:
- The value of the property. The function returns -1 if the property is not an integer or is not set.
References ecore_config_get().
EAPI float ecore_config_float_get | ( | const char * | key | ) |
Returns the specified property as a float.
- Parameters:
-
key The property key.
- Returns:
- The float value of the property. The function returns 0.0 if the property is not a float or is not set.
References ecore_config_get().
EAPI Ecore_Config_Prop* ecore_config_get | ( | const char * | key | ) |
Returns the property with the given key.
- Parameters:
-
key The unique name of the wanted property.
- Returns:
- The property that corresponds to the given key.
NULL
if the key could not be found.
References Ecore_Config_Prop::data, Ecore_Config_Prop::key, and Ecore_Config_Prop::next.
Referenced by ecore_config_argb_get(), ecore_config_argbint_get(), ecore_config_argbstr_get(), ecore_config_as_string_get(), ecore_config_boolean_get(), ecore_config_deaf(), ecore_config_default(), ecore_config_describe(), ecore_config_float_create_bound(), ecore_config_float_default_bound(), ecore_config_float_get(), ecore_config_init(), ecore_config_int_create_bound(), ecore_config_int_default_bound(), ecore_config_int_get(), ecore_config_listen(), ecore_config_long_opt_set(), ecore_config_short_opt_set(), ecore_config_string_get(), ecore_config_struct_get(), ecore_config_theme_get(), ecore_config_theme_preview_group_set(), ecore_config_theme_search_path_append(), ecore_config_type_guess(), and ecore_config_typed_set().
EAPI long ecore_config_int_get | ( | const char * | key | ) |
Returns the specified property as a long integer.
- Parameters:
-
key The property key.
- Returns:
- The integer value of the property. The function returns 0 if the property is not an integer or is not set.
References ecore_config_get().
EAPI char* ecore_config_string_get | ( | const char * | key | ) |
Returns the specified property as a string.
- Parameters:
-
key The property key.
- Returns:
- The string value of the property. The function returns
NULL
if the property is not a string or is not set.
References ecore_config_get().
Referenced by ecore_config_evas_font_path_apply(), and ecore_config_theme_search_path_get().
EAPI char* ecore_config_theme_get | ( | const char * | key | ) |
Returns a theme property.
- Parameters:
-
key The property key.
- Returns:
- The name of the theme the property refers to. The function returns
NULL
if the property is not a theme or is not set.
References ecore_config_get().
Referenced by ecore_config_theme_with_path_get().