News

Documentation

Engrave_Group: Functions to work with an Engrave_Group.


Data Structures

struct  _Engrave_Group
 Stores the needed group information. More...

Typedefs

typedef _Engrave_Group Engrave_Group
 The Engrave_Group typedef.

Functions

EAPI Engrave_Groupengrave_group_new (void)
 engrave_group_new - create a new Engrave_Group object.
EAPI void engrave_group_free (Engrave_Group *eg)
 engrave_group_free - free the group data
EAPI void engrave_group_parent_set (Engrave_Group *eg, void *ef)
 engrave_group_parent_set - set the parent pointer
EAPI void * engrave_group_parent_get (Engrave_Group *eg)
 engrave_group_parent_get - get the parent pointer
EAPI void engrave_group_data_add (Engrave_Group *eg, Engrave_Data *ed)
 engrave_group_data_add - add the Engrave_Data to the group
EAPI void engrave_group_part_add (Engrave_Group *eg, Engrave_Part *ep)
 engrave_group_part_add - add the given part to the group
EAPI void engrave_group_program_add (Engrave_Group *eg, Engrave_Program *ep)
 engrave_group_program_add - add the program to the group
EAPI void engrave_group_script_set (Engrave_Group *eg, const char *script)
 engrave_group_script_set - attach the script to the given group
EAPI void engrave_group_name_set (Engrave_Group *eg, const char *name)
 engrave_group_name_set - set the name of the group to the given name.
EAPI void engrave_group_alias_set (Engrave_Group *eg, const char *alias)
 engrave_group_alias_set - set the alias of the group.
EAPI void engrave_group_min_size_set (Engrave_Group *eg, int w, int h)
 engrave_group_min_size_set - set the min size of the group.
EAPI void engrave_group_max_size_set (Engrave_Group *eg, int w, int h)
 engrave_group_max_size_set - set the max size of the group.
EAPI Engrave_Partengrave_group_part_last_get (Engrave_Group *eg)
 engrave_group_part_last_get - retrieve the last part in the group.
EAPI Engrave_Programengrave_group_program_last_get (Engrave_Group *eg)
 engrave_group_program_last_get - retrieve the last program in the group.
EAPI const char * engrave_group_name_get (Engrave_Group *eg)
 engrave_group_name_get - get the name attached to the group
EAPI const char * engrave_group_alias_get (Engrave_Group *eg)
 engrave_group_alias_get - get the alias attached to the group
EAPI const char * engrave_group_script_get (Engrave_Group *eg)
 engrave_group_script_get - get the script attached to the group
EAPI void engrave_group_min_size_get (Engrave_Group *eg, int *w, int *h)
 engrave_group_min_size_get - get the min size of the group
EAPI void engrave_group_max_size_get (Engrave_Group *eg, int *w, int *h)
 engrave_group_max_size_get - get the max size of the group
EAPI int engrave_group_data_count (Engrave_Group *eg)
 engrave_group_data_count - count the data blocks in the group
EAPI int engrave_group_parts_count (Engrave_Group *eg)
 engrave_group_parts_count - returns the number of parts in the group
EAPI int engrave_group_programs_count (Engrave_Group *eg)
 engrave_group_programs_count - get number of programs in the group
EAPI void engrave_group_data_foreach (Engrave_Group *eg, void(*func)(Engrave_Data *, void *), void *data)
 engrave_group_data_foreach - interate over the data in the group
EAPI void engrave_group_parts_foreach (Engrave_Group *eg, void(*func)(Engrave_Part *, void *), void *data)
 engrave_group_parts_foreach - Iterate over the parts in the Engrave_group
EAPI void engrave_group_programs_foreach (Engrave_Group *eg, void(*func)(Engrave_Program *, void *), void *data)
 engrave_group_programs_foreach - Iterate over the groups programs
EAPI Engrave_Partengrave_group_part_by_name_find (Engrave_Group *eg, const char *part)
 engrave_group_part_by_name_find - find the Engrave_Part by name
EAPI Engrave_Dataengrave_group_data_by_key_find (Engrave_Group *eg, const char *key)
 engrave_group_data_by_key_find - find the Engrave_Data by key

Function Documentation

EAPI const char* engrave_group_alias_get ( Engrave_Group eg  ) 

engrave_group_alias_get - get the alias attached to the group

Parameters:
eg,: The Engrave_Group to get the alias from
Returns:
Returns the alias of the group or NULL on failure.

EAPI void engrave_group_alias_set ( Engrave_Group eg,
const char *  alias 
)

engrave_group_alias_set - set the alias of the group.

Parameters:
eg,: The Engrave_Group to attach the alias too.
alias,: The alias to attach to the group.
Returns:
Returns no value.

EAPI void engrave_group_data_add ( Engrave_Group eg,
Engrave_Data ed 
)

engrave_group_data_add - add the Engrave_Data to the group

Parameters:
eg,: The Engrave_Group to add the data too.
ed,: The Engrave_Data to add to the group.
Returns:
Returns no value.

EAPI Engrave_Data* engrave_group_data_by_key_find ( Engrave_Group eg,
const char *  key 
)

engrave_group_data_by_key_find - find the Engrave_Data by key

Parameters:
eg,: The Engrave_Group to search
key,: They key to search for
Returns:
Returns the Engrave_Data with the matching key or NULL if no such data exists.

EAPI int engrave_group_data_count ( Engrave_Group eg  ) 

engrave_group_data_count - count the data blocks in the group

Parameters:
eg,: The Engrave_Group to check if there is data
Returns:
Returns number of data blocks, 0 otherwise.

EAPI void engrave_group_data_foreach ( Engrave_Group eg,
void(*)(Engrave_Data *, void *)  func,
void *  data 
)

engrave_group_data_foreach - interate over the data in the group

Parameters:
eg,: The Engrave_Group to iterate over the data
func,: The function to call on each data block
data,: any user data to pass to the function
Returns:
Returns no value.

EAPI void engrave_group_free ( Engrave_Group eg  ) 

engrave_group_free - free the group data

Parameters:
eg,: The Engrave_Group to free
Returns:
Returns no value

EAPI void engrave_group_max_size_get ( Engrave_Group eg,
int *  w,
int *  h 
)

engrave_group_max_size_get - get the max size of the group

Parameters:
eg,: The Engrave_Group to get the max size from
w,: Will be set to the max width of the group
h,: Will be set to the max height of the group
Returns:
Returns no value.

EAPI void engrave_group_max_size_set ( Engrave_Group eg,
int  w,
int  h 
)

engrave_group_max_size_set - set the max size of the group.

Parameters:
eg,: The Engrave_Group on which to set the max size.
w,: The max width to set on the group.
h,: The max height to set on the group.
Returns:
Returns no value.

EAPI void engrave_group_min_size_get ( Engrave_Group eg,
int *  w,
int *  h 
)

engrave_group_min_size_get - get the min size of the group

Parameters:
eg,: The Engrave_Group to get the min size from
w,: Will be set to the min width of the group
h,: Will be set to the min height of the group
Returns:
Returns no value.

EAPI void engrave_group_min_size_set ( Engrave_Group eg,
int  w,
int  h 
)

engrave_group_min_size_set - set the min size of the group.

Parameters:
eg,: The Engrave_Group on which to set the min size.
w,: The min width to set on the group.
h,: The min height to set on the group.
Returns:
Returns no value.

EAPI const char* engrave_group_name_get ( Engrave_Group eg  ) 

engrave_group_name_get - get the name attached to the group

Parameters:
eg,: The Engrave_Group to get the name from
Returns:
Returns the name of the group or NULL on failure.

EAPI void engrave_group_name_set ( Engrave_Group eg,
const char *  name 
)

engrave_group_name_set - set the name of the group to the given name.

Parameters:
eg,: The Engrave_Group to attach the name too.
name,: The name to attach to the group.
Returns:
Returns no value.

EAPI Engrave_Group* engrave_group_new ( void   ) 

engrave_group_new - create a new Engrave_Group object.

Returns:
Returns a pointer to a newly allocated Engrave_Group object on success or NULL on failure.

EAPI void* engrave_group_parent_get ( Engrave_Group eg  ) 

engrave_group_parent_get - get the parent pointer

Parameters:
eg,: The Engrave_Group to get the parent pointer from
Returns:
Returns the Engrave_File parent pointer or NULL if none set

EAPI void engrave_group_parent_set ( Engrave_Group eg,
void *  ef 
)

engrave_group_parent_set - set the parent pointer

Parameters:
eg,: The Engrave_Group to set the parent pointer into
ef,: The Engrave_File to set as the parent
Returns:
Returns no value.

EAPI void engrave_group_part_add ( Engrave_Group eg,
Engrave_Part ep 
)

engrave_group_part_add - add the given part to the group

Parameters:
eg,: The Engrave_Group to attach the part too.
ep,: The Engrave_Part to add too the group.
Returns:
Returns no value.

EAPI Engrave_Part* engrave_group_part_by_name_find ( Engrave_Group eg,
const char *  part 
)

engrave_group_part_by_name_find - find the Engrave_Part by name

Parameters:
eg,: The Engrave_Group to search
part,: They part name to search for
Returns:
Returns the Engrave_Part with the matching name or NULL if no such name exists.

EAPI Engrave_Part* engrave_group_part_last_get ( Engrave_Group eg  ) 

engrave_group_part_last_get - retrieve the last part in the group.

Parameters:
eg,: The Engrave_Group to retrieve the last part from.
Returns:
Returns the last Engrave_Part in the group or NULL if no such part exists.

EAPI int engrave_group_parts_count ( Engrave_Group eg  ) 

engrave_group_parts_count - returns the number of parts in the group

Parameters:
eg,: The Engrave_Group to check if there are parts
Returns:
Returns the number of parts, 0 otherwise.

EAPI void engrave_group_parts_foreach ( Engrave_Group eg,
void(*)(Engrave_Part *, void *)  func,
void *  data 
)

engrave_group_parts_foreach - Iterate over the parts in the Engrave_group

Parameters:
eg,: The Engrave_Group to get the parts from
func,: the function to call for each part
data,: The user data to pass to the function
Returns:
Returns no value.

EAPI void engrave_group_program_add ( Engrave_Group eg,
Engrave_Program ep 
)

engrave_group_program_add - add the program to the group

Parameters:
eg,: The Engrave_Group to add the program too.
ep,: The Engrave_Program to add to the group.
Returns:
Returns no value.

EAPI Engrave_Program* engrave_group_program_last_get ( Engrave_Group eg  ) 

engrave_group_program_last_get - retrieve the last program in the group.

Parameters:
eg,: The Engrave_Group to retrieve the last program from.
Returns:
Returns the last Engrave_Program in the group or NULL if no such program exists.

EAPI int engrave_group_programs_count ( Engrave_Group eg  ) 

engrave_group_programs_count - get number of programs in the group

Parameters:
eg,: The Engrave_Group to check if there are programs
Returns:
Returns number of programs, 0 otherwise.

EAPI void engrave_group_programs_foreach ( Engrave_Group eg,
void(*)(Engrave_Program *, void *)  func,
void *  data 
)

engrave_group_programs_foreach - Iterate over the groups programs

Parameters:
eg,: The Engrave_Group to iterate over
func,: The function to call for each program
data,: User data
Returns:
Returns no value.

EAPI const char* engrave_group_script_get ( Engrave_Group eg  ) 

engrave_group_script_get - get the script attached to the group

Parameters:
eg,: The Engrave_Group to get the script from
Returns:
Returns the script on success or NULL on failure.

EAPI void engrave_group_script_set ( Engrave_Group eg,
const char *  script 
)

engrave_group_script_set - attach the script to the given group

Parameters:
eg,: The Engrave_Group to attach the script too.
script,: The script to attach to the group.
Returns:
Returns no value.


Copyright © Enlightenment.org

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