Imported Upstream version 2.2.4
This commit is contained in:
Ari Pollak
145
devel-docs/libgimp/html/libgimp-gimpfileops.html
Normal file
145
devel-docs/libgimp/html/libgimp-gimpfileops.html
Normal file
@ -0,0 +1,145 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpfileops</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Library Reference Manual"><link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="prev" href="libgimp-gimpedit.html" title="gimpedit"><link rel="next" href="libgimp-gimpfloatingsel.html" title="gimpfloatingsel"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part<72>I.<2E>GIMP Constants"><link rel="part" href="libgimp.html" title="Part<72>II.<2E>GIMP Library"><link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images"><link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="chapter" href="libgimp-data.html" title="Data Objects"><link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs"><link rel="part" href="libgimpui.html" title="Part<72>III.<2E>GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimp-gimpedit.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Library Reference Manual</th><td><a accesskey="n" href="libgimp-gimpfloatingsel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimp-gimpfileops"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpfileops</span></h2><p>gimpfileops — File operations (load, save, etc.)</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
gchar* <a href="libgimp-gimpfileops.html#gimp-temp-name">gimp_temp_name</a> (const gchar *extension);
|
||||
gint32 <a href="libgimp-gimpfileops.html#gimp-file-load">gimp_file_load</a> (<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> run_mode,
|
||||
const gchar *filename,
|
||||
const gchar *raw_filename);
|
||||
gboolean <a href="libgimp-gimpfileops.html#gimp-file-save">gimp_file_save</a> (<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> run_mode,
|
||||
gint32 image_ID,
|
||||
gint32 drawable_ID,
|
||||
const gchar *filename,
|
||||
const gchar *raw_filename);
|
||||
gboolean <a href="libgimp-gimpfileops.html#gimp-register-magic-load-handler">gimp_register_magic_load_handler</a>
|
||||
(const gchar *procedure_name,
|
||||
const gchar *extensions,
|
||||
const gchar *prefixes,
|
||||
const gchar *magics);
|
||||
gboolean <a href="libgimp-gimpfileops.html#gimp-register-load-handler">gimp_register_load_handler</a> (const gchar *procedure_name,
|
||||
const gchar *extensions,
|
||||
const gchar *prefixes);
|
||||
gboolean <a href="libgimp-gimpfileops.html#gimp-register-save-handler">gimp_register_save_handler</a> (const gchar *procedure_name,
|
||||
const gchar *extensions,
|
||||
const gchar *prefixes);
|
||||
gboolean <a href="libgimp-gimpfileops.html#gimp-register-file-handler-mime">gimp_register_file_handler_mime</a> (const gchar *procedure_name,
|
||||
const gchar *mime_type);
|
||||
gboolean <a href="libgimp-gimpfileops.html#gimp-register-thumbnail-loader">gimp_register_thumbnail_loader</a> (const gchar *load_proc,
|
||||
const gchar *thumb_proc);
|
||||
</pre></div><div class="refsect1" lang="en"><a name="id2593153"></a><h2>Description</h2><p>
|
||||
File operations (load, save, etc.)
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2593163"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2593168"></a><h3><a name="gimp-temp-name"></a>gimp_temp_name ()</h3><a class="indexterm" name="id2593176"></a><pre class="programlisting">gchar* gimp_temp_name (const gchar *extension);</pre><p>
|
||||
Generates a unique filename.
|
||||
</p><p>
|
||||
Generates a unique filename using the temp path supplied in the
|
||||
user's gimprc.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>extension</tt></i><EFBFBD>:</span></td><td> The extension the file will have.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The new temp filename.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598982"></a><h3><a name="gimp-file-load"></a>gimp_file_load ()</h3><a class="indexterm" name="id2598990"></a><pre class="programlisting">gint32 gimp_file_load (<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> run_mode,
|
||||
const gchar *filename,
|
||||
const gchar *raw_filename);</pre><p>
|
||||
Loads a file by invoking the right load handler.
|
||||
</p><p>
|
||||
This procedure invokes the correct file load handler using magic if
|
||||
possible, and falling back on the file's extension and/or prefix if
|
||||
not. 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.\"</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>run_mode</tt></i><EFBFBD>:</span></td><td> The run mode.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i><EFBFBD>:</span></td><td> The name of the file to load.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>raw_filename</tt></i><EFBFBD>:</span></td><td> The name as entered by the user.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The output image.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2599083"></a><h3><a name="gimp-file-save"></a>gimp_file_save ()</h3><a class="indexterm" name="id2599092"></a><pre class="programlisting">gboolean gimp_file_save (<a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a> run_mode,
|
||||
gint32 image_ID,
|
||||
gint32 drawable_ID,
|
||||
const gchar *filename,
|
||||
const gchar *raw_filename);</pre><p>
|
||||
Saves a file by extension.
|
||||
</p><p>
|
||||
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.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>run_mode</tt></i><EFBFBD>:</span></td><td> The run mode.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>image_ID</tt></i><EFBFBD>:</span></td><td> Input image.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> Drawable to save.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i><EFBFBD>:</span></td><td> The name of the file to save the image in.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>raw_filename</tt></i><EFBFBD>:</span></td><td> The name as entered by the user.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2599218"></a><h3><a name="gimp-register-magic-load-handler"></a>gimp_register_magic_load_handler ()</h3><a class="indexterm" name="id2599230"></a><pre class="programlisting">gboolean gimp_register_magic_load_handler
|
||||
(const gchar *procedure_name,
|
||||
const gchar *extensions,
|
||||
const gchar *prefixes,
|
||||
const gchar *magics);</pre><p>
|
||||
Registers a file load handler procedure.
|
||||
</p><p>
|
||||
Registers a procedural database procedure to be called to load files
|
||||
of a particular file format using magic file information.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure_name</tt></i><EFBFBD>:</span></td><td> The name of the procedure to be used for loading.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>extensions</tt></i><EFBFBD>:</span></td><td> comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>prefixes</tt></i><EFBFBD>:</span></td><td> comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>magics</tt></i><EFBFBD>:</span></td><td> comma separated list of magic file information this handler can load (i.e. \"0,string,GIF\").
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2599964"></a><h3><a name="gimp-register-load-handler"></a>gimp_register_load_handler ()</h3><a class="indexterm" name="id2599974"></a><pre class="programlisting">gboolean gimp_register_load_handler (const gchar *procedure_name,
|
||||
const gchar *extensions,
|
||||
const gchar *prefixes);</pre><p>
|
||||
Registers a file load handler procedure.
|
||||
</p><p>
|
||||
Registers a procedural database procedure to be called to load files
|
||||
of a particular file format.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure_name</tt></i><EFBFBD>:</span></td><td> The name of the procedure to be used for loading.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>extensions</tt></i><EFBFBD>:</span></td><td> comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>prefixes</tt></i><EFBFBD>:</span></td><td> comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2600063"></a><h3><a name="gimp-register-save-handler"></a>gimp_register_save_handler ()</h3><a class="indexterm" name="id2600072"></a><pre class="programlisting">gboolean gimp_register_save_handler (const gchar *procedure_name,
|
||||
const gchar *extensions,
|
||||
const gchar *prefixes);</pre><p>
|
||||
Registers a file save handler procedure.
|
||||
</p><p>
|
||||
Registers a procedural database procedure to be called to save files
|
||||
in a particular file format.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure_name</tt></i><EFBFBD>:</span></td><td> The name of the procedure to be used for saving.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>extensions</tt></i><EFBFBD>:</span></td><td> comma separated list of extensions this handler can save (i.e. \"jpg,jpeg\").
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>prefixes</tt></i><EFBFBD>:</span></td><td> comma separated list of prefixes this handler can save (i.e. \"http:,ftp:\").
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2599515"></a><h3><a name="gimp-register-file-handler-mime"></a>gimp_register_file_handler_mime ()</h3><a class="indexterm" name="id2599525"></a><pre class="programlisting">gboolean gimp_register_file_handler_mime (const gchar *procedure_name,
|
||||
const gchar *mime_type);</pre><p>
|
||||
Associates a MIME type with a file handler procedure.
|
||||
</p><p>
|
||||
Registers a MIME type for a file handler procedure. This allows GIMP
|
||||
to determine the MIME type of the file opened or saved using this
|
||||
procedure.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>procedure_name</tt></i><EFBFBD>:</span></td><td> The name of the procedure to associate a MIME type with.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mime_type</tt></i><EFBFBD>:</span></td><td> A single MIME type, like for example \"image/jpeg\".
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2599604"></a><h3><a name="gimp-register-thumbnail-loader"></a>gimp_register_thumbnail_loader ()</h3><a class="indexterm" name="id2599615"></a><pre class="programlisting">gboolean gimp_register_thumbnail_loader (const gchar *load_proc,
|
||||
const gchar *thumb_proc);</pre><p>
|
||||
Associates a thumbnail loader with a file load procedure.
|
||||
</p><p>
|
||||
Some file formats allow for embedded thumbnails, other file formats
|
||||
contain a scalable image or provide the image data in different
|
||||
resolutions. A file plug-in for such a format may register a special
|
||||
procedure that allows GIMP to load a thumbnail preview of the image.
|
||||
This procedure is then associated with the standard load procedure
|
||||
using this function.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>load_proc</tt></i><EFBFBD>:</span></td><td> The name of the procedure the thumbnail loader with.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>thumb_proc</tt></i><EFBFBD>:</span></td><td> The name of the thumbnail load procedure.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimpedit.html"><b><<<EFBFBD>gimpedit</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpfloatingsel.html"><b>gimpfloatingsel<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
Reference in New Issue
Block a user