News

Documentation

Engrave_Data: Functions to work with data blocks


Data Structures

struct  _Engrave_Data
 Stores the information for the data object. More...

Typedefs

typedef _Engrave_Data Engrave_Data
 The Engrave_Data typedef.

Functions

EAPI Engrave_Dataengrave_data_new (const char *key, const char *value)
 engrave_data_new - create a new data block
EAPI void engrave_data_free (Engrave_Data *ed)
 engrave_data_free - free the given data block
EAPI void engrave_data_parent_set (Engrave_Data *ed, void *parent)
 engrave_data_parent_set - set the parent pointer on this node This will set the parent pointer, in the case of Engrave_Data this can be either an Engrave_File or an Engrave_Group.
EAPI void * engrave_data_parent_get (Engrave_Data *ed)
 engrave_data_parent_get - get the parent pointer on this node
EAPI const char * engrave_data_key_get (Engrave_Data *ed)
 engrave_data_key_get - get the key for this data
EAPI const char * engrave_data_value_get (Engrave_Data *ed)
 engrave_data_value_get - get the string value of the data object
EAPI int engrave_data_int_value_get (Engrave_Data *ed)
 engrave_data_int_value_get - get the int value of the data object
EAPI void engrave_data_value_set (Engrave_Data *ed, const char *value)
 engrave_data_value_set - set the value of the data object
EAPI void engrave_data_int_value_set (Engrave_Data *ed, int value)
 engrave_data_int_value_set - set the int value of the data object

Function Documentation

EAPI void engrave_data_free ( Engrave_Data ed  ) 

engrave_data_free - free the given data block

Parameters:
ed,: The Engrave_Data to free
Returns:
Returns no value.

EAPI int engrave_data_int_value_get ( Engrave_Data ed  ) 

engrave_data_int_value_get - get the int value of the data object

Parameters:
ed,: The Engrave_Data to get the value from
Returns:
Returns the int value of the data or 0 if its not set.

EAPI void engrave_data_int_value_set ( Engrave_Data ed,
int  value 
)

engrave_data_int_value_set - set the int value of the data object

Parameters:
ed,: The Engrave_Data to set the value into
value,: The value to set
Returns:
Returns no value

EAPI const char* engrave_data_key_get ( Engrave_Data ed  ) 

engrave_data_key_get - get the key for this data

Parameters:
ed,: The Engrave_Data to get the key from
Returns:
Returns the key for this data or NULL on failure.

EAPI Engrave_Data* engrave_data_new ( const char *  key,
const char *  value 
)

engrave_data_new - create a new data block

Parameters:
key,: the key to access the block
value,: the value to store in the block
Returns:
Returns a pointer to a newly allocated data block on success, NULL on failure.

EAPI void* engrave_data_parent_get ( Engrave_Data ed  ) 

engrave_data_parent_get - get the parent pointer on this node

Parameters:
ed,: The Engrave_Data to get the pointer from
Returns:
Returns the parent pointer, or NULL if none set.

EAPI void engrave_data_parent_set ( Engrave_Data ed,
void *  parent 
)

engrave_data_parent_set - set the parent pointer on this node This will set the parent pointer, in the case of Engrave_Data this can be either an Engrave_File or an Engrave_Group.

Parameters:
ed,: The Engrave_Data to set the parent on
parent,: The parent pointer to set
Returns:
Returns no value.

EAPI const char* engrave_data_value_get ( Engrave_Data ed  ) 

engrave_data_value_get - get the string value of the data object

Parameters:
ed,: The Engrave_Data to get the string value from.
Returns:
Returns the value of the data on success or NULL on failure.

EAPI void engrave_data_value_set ( Engrave_Data ed,
const char *  value 
)

engrave_data_value_set - set the value of the data object

Parameters:
ed,: The Engrave_Data to set the value into
value,: The value to set.
Returns:
Returns no value.


Copyright © Enlightenment.org

Engrave Documentation Generated: Sat Apr 7 18:28:00 2007