Download

Support

Ecore Config Structures

Functions that are used to create structures of properties. More...

Functions

EAPI int ecore_config_struct_create (const char *key)
 Sets the indicated property to a structure if the property has not yet been set.
EAPI int ecore_config_struct_int_add (const char *key, const char *name, int val)
 Add an int property to the named structure.
EAPI int ecore_config_struct_float_add (const char *key, const char *name, float val)
 Add a float property to the named structure.
EAPI int ecore_config_struct_string_add (const char *key, const char *name, const char *val)
 Add a string property to the named structure.
EAPI int ecore_config_struct_argb_add (const char *key, const char *name, int a, int r, int g, int b)
 Add an argb property to the named structure.
EAPI int ecore_config_struct_theme_add (const char *key, const char *name, const char *val)
 Add a theme property to the named structure.
EAPI int ecore_config_struct_boolean_add (const char *key, const char *name, int val)
 Add a boolean property to the named structure.
EAPI int ecore_config_struct_get (const char *key, void *data)
 Get the contents of a defined structure property and load it into the passed C struct.

Detailed Description

Functions that are used to create structures of properties.


Function Documentation

EAPI int ecore_config_struct_argb_add ( const char *  key,
const char *  name,
int  a,
int  r,
int  g,
int  b 
)

Add an argb property to the named structure.

The property is set if it has not yet been set.

Parameters:
key The key of the structure to add to.
name The name of the item to add - this will be appended to the key
a The alpha to default to
r The red to default to
g The green to default to
b The blue to default to
Returns:
ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ECORE_CONFIG_RGB.

EAPI int ecore_config_struct_boolean_add ( const char *  key,
const char *  name,
int  val 
)

Add a boolean property to the named structure.

The property is set if it has not yet been set.

Parameters:
key The key of the structure to add to.
name The name of the item to add - this will be appended to the key
val The boolean to default to
Returns:
ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ECORE_CONFIG_BLN.

EAPI int ecore_config_struct_create ( const char *  key  ) 

Sets the indicated property to a structure if the property has not yet been set.

Parameters:
key The property key.
Returns:
ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ECORE_CONFIG_SCT.

EAPI int ecore_config_struct_float_add ( const char *  key,
const char *  name,
float  val 
)

Add a float property to the named structure.

The property is set if it has not yet been set.

Parameters:
key The key of the structure to add to.
name The name of the item to add - this will be appended to the key
val The float to default to
Returns:
ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ECORE_CONFIG_FLT.

EAPI int ecore_config_struct_get ( const char *  key,
void *  data 
)

Get the contents of a defined structure property and load it into the passed C struct.

Parameters:
key The name of the structure property to look up.
data The struct to write into.
Returns:
ECORE_CONFIG_ERR_SUCC if the structure is written successfully.

References ECORE_CONFIG_BLN, ECORE_CONFIG_FLT, ecore_config_get(), ECORE_CONFIG_INT, ECORE_CONFIG_RGB, ECORE_CONFIG_STR, and ECORE_CONFIG_THM.

EAPI int ecore_config_struct_int_add ( const char *  key,
const char *  name,
int  val 
)

Add an int property to the named structure.

The property is set if it has not yet been set.

Parameters:
key The key of the structure to add to.
name The name of the item to add - this will be appended to the key
val the int to default to
Returns:
ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ECORE_CONFIG_INT.

EAPI int ecore_config_struct_string_add ( const char *  key,
const char *  name,
const char *  val 
)

Add a string property to the named structure.

The property is set if it has not yet been set.

Parameters:
key The key of the structure to add to.
name The name of the item to add - this will be appended to the key
val The string to default to
Returns:
ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ECORE_CONFIG_STR.

EAPI int ecore_config_struct_theme_add ( const char *  key,
const char *  name,
const char *  val 
)

Add a theme property to the named structure.

The property is set if it has not yet been set.

Parameters:
key The key of the structure to add to.
name The name of the item to add - this will be appended to the key
val The theme name to default to
Returns:
ECORE_CONFIG_ERR_SUCC if the property is set successfully.

References ECORE_CONFIG_THM.


Copyright © Enlightenment.org

Ecore Documentation