gimpfileops

Name

gimpfileops -- File operations (load, save, etc.)

Synopsis



gchar*      gimp_temp_name                  (gchar *extension);
gint32      gimp_file_load                  (GimpRunMode run_mode,
                                             gchar *filename,
                                             gchar *raw_filename);
gboolean    gimp_file_save                  (GimpRunMode run_mode,
                                             gint32 image_ID,
                                             gint32 drawable_ID,
                                             gchar *filename,
                                             gchar *raw_filename);
gboolean    gimp_register_magic_load_handler
                                            (gchar *procedure_name,
                                             gchar *extensions,
                                             gchar *prefixes,
                                             gchar *magics);
gboolean    gimp_register_load_handler      (gchar *procedure_name,
                                             gchar *extensions,
                                             gchar *prefixes);
gboolean    gimp_register_save_handler      (gchar *procedure_name,
                                             gchar *extensions,
                                             gchar *prefixes);

Description

File operations (load, save, etc.)

Details

gimp_temp_name ()

gchar*      gimp_temp_name                  (gchar *extension);

Generates a unique filename.

Generates a unique filename using the temp path supplied in the user's gimprc.

extension :

The extension the file will have.

Returns :

The new temp filename.


gimp_file_load ()

gint32      gimp_file_load                  (GimpRunMode run_mode,
                                             gchar *filename,
                                             gchar *raw_filename);

Loads a file by extension.

This procedure invokes the correct file load handler according to the file's extension and/or prefix. The name of the file to load is typically a full pathname, and the name entered is what the user actually typed before prepending a directory path. The reason for this is that if the user types http://www.xcf/~gimp/ he wants to fetch a URL, and the full pathname will not look like a URL.

run_mode :

The run mode.

filename :

The name of the file to load.

raw_filename :

The name as entered by the user.

Returns :

The output image.


gimp_file_save ()

gboolean    gimp_file_save                  (GimpRunMode run_mode,
                                             gint32 image_ID,
                                             gint32 drawable_ID,
                                             gchar *filename,
                                             gchar *raw_filename);

Saves a file by extension.

This procedure invokes the correct file save handler according to the file's extension and/or prefix. The name of the file to save is typically a full pathname, and the name entered is what the user actually typed before prepending a directory path. The reason for this is that if the user types http://www.xcf/~gimp/ she wants to fetch a URL, and the full pathname will not look like a URL.

run_mode :

The run mode.

image_ID :

Input image.

drawable_ID :

Drawable to save.

filename :

The name of the file to save the image in.

raw_filename :

The name as entered by the user.

Returns :

TRUE on success.


gimp_register_magic_load_handler ()

gboolean    gimp_register_magic_load_handler
                                            (gchar *procedure_name,
                                             gchar *extensions,
                                             gchar *prefixes,
                                             gchar *magics);

Registers a file load handler procedure.

Registers a procedural database procedure to be called to load files of a particular file format using magic file information.

procedure_name :

The name of the procedure to be used for loading.

extensions :

comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").

prefixes :

comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").

magics :

comma separated list of magic file information this handler can load (i.e. \"0,string,GIF\").

Returns :

TRUE on success.


gimp_register_load_handler ()

gboolean    gimp_register_load_handler      (gchar *procedure_name,
                                             gchar *extensions,
                                             gchar *prefixes);

Registers a file load handler procedure.

Registers a procedural database procedure to be called to load files of a particular file format.

procedure_name :

The name of the procedure to be used for loading.

extensions :

comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").

prefixes :

comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").

Returns :

TRUE on success.


gimp_register_save_handler ()

gboolean    gimp_register_save_handler      (gchar *procedure_name,
                                             gchar *extensions,
                                             gchar *prefixes);

Registers a file save handler procedure.

Registers a procedural database procedure to be called to save files in a particular file format.

procedure_name :

The name of the procedure to be used for saving.

extensions :

comma separated list of extensions this handler can save (i.e. \"jpg,jpeg\").

prefixes :

comma separated list of prefixes this handler can save (i.e. \"http:,ftp:\").

Returns :

TRUE on success.