Ecore_Config_Property_Group (3) - Linux Manuals

Ecore_Config_Property_Group: Functions that retrieve or set the attributes relating to a property.

NAME

Ecore Config Property Functions - Functions that retrieve or set the attributes relating to a property.

Functions

EAPI Ecore_Config_Prop * ecore_config_dst (Ecore_Config_Prop *e)
Removes the given property from the local configuration and destroys it.
EAPI const char * ecore_config_type_get (const Ecore_Config_Prop *e)
Returns the type of the property.
EAPI int ecore_config_describe (const char *key, const char *desc)
Sets the description field of the indicated property.
EAPI int ecore_config_short_opt_set (const char *key, char short_opt)
Set the short option character of a property.
EAPI int ecore_config_long_opt_set (const char *key, const char *long_opt)
Set the long option string of the property.
EAPI int ecore_config_typed_set (const char *key, const void *val, int type)
Sets the indicated property to the given value and type.

Detailed Description

Functions that retrieve or set the attributes relating to a property.

Function Documentation

EAPI int ecore_config_describe (const char * key, const char * desc)

Sets the description field of the indicated property.

Parameters:

key The property key.
desc Description string.

Note:

The description string is copied for the property's use. You can free desc once this function is called.

References ecore_config_get().

Referenced by ecore_config_typed_create().

EAPI Ecore_Config_Prop* ecore_config_dst (Ecore_Config_Prop * e)

Removes the given property from the local configuration and destroys it.

Parameters:

e Property to destroy.

Returns:

NULL

References ECORE_CONFIG_STR, ECORE_CONFIG_THM, and Ecore_Config_Prop::listeners.

Referenced by ecore_config_system_shutdown().

EAPI int ecore_config_long_opt_set (const char * key, const char * long_opt)

Set the long option string of the property.

Parameters:

key The property key.
long_opt String used to indicate the value of a property given on the command line.

Returns:

ECORE_CONFIG_ERR_SUCC on success. ECORE_CONFIG_ERR_NODATA is returned if the property does not exist.

References ecore_config_get().

Referenced by ecore_config_typed_create().

EAPI int ecore_config_short_opt_set (const char * key, char short_opt)

Set the short option character of a property.

Parameters:

key The property key.
short_opt Character used to indicate the value of a property given on the command line.

Returns:

ECORE_CONFIG_ERR_SUCC on success. ECORE_CONFIG_ERR_NODATA is returned if the property does not exist.

References ecore_config_get().

Referenced by ecore_config_typed_create().

EAPI const char* ecore_config_type_get (const Ecore_Config_Prop * e)

Returns the type of the property.

Parameters:

e Property to get the type of.

Returns:

The type of the property. If the property is invalid, then the string 'not found' is returned.

EAPI int ecore_config_typed_set (const char * key, const void * val, int type)

Sets the indicated property to the given value and type.

Parameters:

key The property key.
val A pointer to the value to set the property to.
type The type of the property.

Returns:

ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ecore_config_get().

Referenced by ecore_config_argb_set(), ecore_config_argbint_set(), ecore_config_argbstr_set(), ecore_config_boolean_set(), ecore_config_float_set(), ecore_config_int_set(), ecore_config_set(), ecore_config_string_set(), and ecore_config_theme_set().

Author

Generated automatically by Doxygen for Ecore from the source code.