News

Documentation

Engrave_File: Functions to work with the Engrave file object


Data Structures

struct  _Engrave_File
 Structure to hold the file information. More...

Typedefs

typedef _Engrave_File Engrave_File
 The Engrave_File typedef.

Functions

EAPI Engrave_Fileengrave_file_new (void)
 engrave_file_new - create a new Engrave_File object
EAPI void engrave_file_free (Engrave_File *ef)
 engrave_file_free - free the file object
EAPI void engrave_file_image_dir_set (Engrave_File *ef, const char *dir)
 engrave_file_image_dir_set - set the image directory for the file
EAPI void engrave_file_font_dir_set (Engrave_File *ef, const char *dir)
 engrave_file_font_dir_set - set the font dir for the file
EAPI const char * engrave_file_image_dir_get (Engrave_File *ef)
 engrave_file_image_dir_get - get the image directory
EAPI const char * engrave_file_font_dir_get (Engrave_File *ef)
 engrave_file_font_dir_get - get the font directory
EAPI void engrave_file_font_add (Engrave_File *e, Engrave_Font *ef)
 engrave_file_font_add - add the font to the engrave file.
EAPI void engrave_file_spectrum_add (Engrave_File *e, Engrave_Spectrum *es)
 engrave_file_spectrum_add - add the spectrum to the engrave file.
EAPI void engrave_file_style_add (Engrave_File *e, Engrave_Style *es)
 engrave_file_style_add - add the style to the engrave file.
EAPI void engrave_file_image_add (Engrave_File *ef, Engrave_Image *ei)
 engrave_file_image_add - add the image to the engrave file.
EAPI void engrave_file_data_add (Engrave_File *ef, Engrave_Data *ed)
 engrave_file_data_add - add the data to the engrave file.
EAPI void engrave_file_group_add (Engrave_File *ef, Engrave_Group *eg)
 engrave_file_group_add - add the group to the given file
EAPI Engrave_Styleengrave_file_style_last_get (Engrave_File *ef)
 engrave_file_style_last_get - returns the last style in the file
EAPI Engrave_Spectrumengrave_file_spectrum_last_get (Engrave_File *ef)
 engrave_file_spectrum_last_get - returns the last spectrum in the file
EAPI Engrave_Groupengrave_file_group_last_get (Engrave_File *ef)
 engrave_file_group_last_get - returns the last group in the file
EAPI Engrave_Groupengrave_file_group_by_name_find (Engrave_File *ef, const char *name)
 engrave_file_group_by_name_find - returns the Engrave_Group with the given name.
EAPI Engrave_Fontengrave_file_font_by_name_find (Engrave_File *ef, const char *name)
 engrave_file_font_by_name_find - find the Engrave_Font by name
EAPI Engrave_Imageengrave_file_image_by_name_find (Engrave_File *ef, const char *name)
 engrave_file_image_by_name_find - returns the Engrave_Image with the given name.
EAPI int engrave_file_images_count (Engrave_File *ef)
 engrave_file_images_count - get the number of images
EAPI int engrave_file_data_count (Engrave_File *ef)
 engrave_file_data_count - count data blocks in file
EAPI int engrave_file_groups_count (Engrave_File *ef)
 engrave_file_groups_count - count the groups in the file
EAPI int engrave_file_fonts_count (Engrave_File *ef)
 engrave_file_fonts_count - count the fonts in the file
EAPI int engrave_file_spectra_count (Engrave_File *ef)
 engrave_file_spectra_count - count the spectra in the file
EAPI int engrave_file_styles_count (Engrave_File *ef)
 engrave_file_styles_count - count the styles in the file
EAPI Engrave_Dataengrave_file_data_by_key_find (Engrave_File *ef, const char *key)
 engrave_file_data_by_key_find - find the Engrave_Data by key

Function Documentation

EAPI void engrave_file_data_add ( Engrave_File ef,
Engrave_Data ed 
)

engrave_file_data_add - add the data to the engrave file.

Parameters:
ef,: The Engrave_File to add the data too.
ed,: The Engrave_Data to add to the file.
Returns:
Returns no value.

EAPI Engrave_Data* engrave_file_data_by_key_find ( Engrave_File ef,
const char *  key 
)

engrave_file_data_by_key_find - find the Engrave_Data by key

Parameters:
ef,: The Engrave_File 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_file_data_count ( Engrave_File ef  ) 

engrave_file_data_count - count data blocks in file

Parameters:
ef,: The Engrave_File to check for data
Returns:
Returns number of data blocks, 0 otherwise

EAPI void engrave_file_font_add ( Engrave_File e,
Engrave_Font ef 
)

engrave_file_font_add - add the font to the engrave file.

Parameters:
e,: The Engrave_File to add the font too.
ef,: The Engrave_Font to add to the file.
Returns:
Returns no value.

EAPI Engrave_Font* engrave_file_font_by_name_find ( Engrave_File ef,
const char *  name 
)

engrave_file_font_by_name_find - find the Engrave_Font by name

Parameters:
ef,: The Engrave_File to search
name,: They name to search for
Returns:
Returns the Engrave_Font with the matching name or NULL if no such font exists.

EAPI const char* engrave_file_font_dir_get ( Engrave_File ef  ) 

engrave_file_font_dir_get - get the font directory

Parameters:
ef,: The Engrave_File to get the directory from
Returns:
Returns the current font directory

EAPI void engrave_file_font_dir_set ( Engrave_File ef,
const char *  dir 
)

engrave_file_font_dir_set - set the font dir for the file

Parameters:
ef,: The Engrave_File to set the font dir on
dir,: The directory to set the font dir too
Returns:
Returns no value.

EAPI int engrave_file_fonts_count ( Engrave_File ef  ) 

engrave_file_fonts_count - count the fonts in the file

Parameters:
ef,: The Engrave_File to check for fonts
Returns:
Returns the number of fonts in the file, 0 otherwise

EAPI void engrave_file_free ( Engrave_File ef  ) 

engrave_file_free - free the file object

Parameters:
ef,: The Engrave_File to free
Returns:
Returns no value.

EAPI void engrave_file_group_add ( Engrave_File ef,
Engrave_Group eg 
)

engrave_file_group_add - add the group to the given file

Parameters:
ef,: The Engrave_File to add the group too.
eg,: The Engrave_Group to add to the file.
Returns:
Returns no value.

EAPI Engrave_Group* engrave_file_group_by_name_find ( Engrave_File ef,
const char *  name 
)

engrave_file_group_by_name_find - returns the Engrave_Group with the given name.

Parameters:
ef,: The Engrave_File to search for the group in.
name,: The name of the group to search for.
Returns:
Returns the Engrave_Group with the given name or NULL if no corresponding group can be found.

EAPI Engrave_Group* engrave_file_group_last_get ( Engrave_File ef  ) 

engrave_file_group_last_get - returns the last group in the file

Parameters:
ef,: The Engrave_File from which to retrieve the group
Returns:
Returns the last Engrave_Group in the engrave file ef or NULL if there are no available groups.

EAPI int engrave_file_groups_count ( Engrave_File ef  ) 

engrave_file_groups_count - count the groups in the file

Parameters:
ef,: The Engrave_File to check for groups
Returns:
Returns then number of groups, 0 otherwise

EAPI void engrave_file_image_add ( Engrave_File ef,
Engrave_Image ei 
)

engrave_file_image_add - add the image to the engrave file.

Parameters:
ef,: The Engrave_File to add the image too.
ei,: The Engrave_Image to add to the file.
Returns:
Returns no value.

EAPI Engrave_Image* engrave_file_image_by_name_find ( Engrave_File ef,
const char *  name 
)

engrave_file_image_by_name_find - returns the Engrave_Image with the given name.

Parameters:
ef,: The Engrave_File to search for the image in.
name,: The name of the image to search for.
Returns:
Returns the Engrave_Image with the given name or NULL if no corresponding image can be found.

EAPI const char* engrave_file_image_dir_get ( Engrave_File ef  ) 

engrave_file_image_dir_get - get the image directory

Parameters:
ef,: The Engrave_File to get the directory from
Returns:
Returns the current image directory or NULL on failure

EAPI void engrave_file_image_dir_set ( Engrave_File ef,
const char *  dir 
)

engrave_file_image_dir_set - set the image directory for the file

Parameters:
ef,: The Engrave_File to set the image dir into
dir,: The directory to set
Returns:
Returns no value.

EAPI int engrave_file_images_count ( Engrave_File ef  ) 

engrave_file_images_count - get the number of images

Parameters:
ef,: The Engrave_File to check for images
Returns:
Returns the number of images, 0 otherwise

EAPI Engrave_File* engrave_file_new ( void   ) 

engrave_file_new - create a new Engrave_File object

Returns:
Returns a pointer to a newly allocated file object on success, NULL on failure.

EAPI int engrave_file_spectra_count ( Engrave_File ef  ) 

engrave_file_spectra_count - count the spectra in the file

Parameters:
ef,: The Engrave_File to check for spectra
Returns:
Returns the number of spectra in the file, 0 otherwise

EAPI void engrave_file_spectrum_add ( Engrave_File e,
Engrave_Spectrum es 
)

engrave_file_spectrum_add - add the spectrum to the engrave file.

Parameters:
e,: The Engrave_File to add the font too.
es,: The Engrave_Spectrum to add to the file.
Returns:
Returns no value.

EAPI Engrave_Spectrum* engrave_file_spectrum_last_get ( Engrave_File ef  ) 

engrave_file_spectrum_last_get - returns the last spectrum in the file

Parameters:
ef,: The Engrave_File from which to retrieve the group
Returns:
Returns the last Engrave_Spectrum in the engrave file ef or NULL

EAPI void engrave_file_style_add ( Engrave_File e,
Engrave_Style es 
)

engrave_file_style_add - add the style to the engrave file.

Parameters:
e,: The Engrave_File to add the style too.
es,: The Engrave_Style to add to the file.
Returns:
Returns no value.

EAPI Engrave_Style* engrave_file_style_last_get ( Engrave_File ef  ) 

engrave_file_style_last_get - returns the last style in the file

Parameters:
ef,: The Engrave_File from which to retrieve the group
Returns:
Returns the last Engrave_Style in the engrave file ef or NULL if there are no available groups.

EAPI int engrave_file_styles_count ( Engrave_File ef  ) 

engrave_file_styles_count - count the styles in the file

Parameters:
ef,: The Engrave_File to check for styles
Returns:
Returns the number of styles in the file, 0 otherwise


Copyright © Enlightenment.org

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