183 lines
8.9 KiB
HTML
183 lines
8.9 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>gimpexport</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
||
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
|
||
<link rel="up" href="libgimpui.html" title="Part II. GIMP User Interface Library">
|
||
<link rel="prev" href="libgimp-gimpui.html" title="gimpui">
|
||
<link rel="next" href="GimpDrawablePreview.html" title="GimpDrawablePreview">
|
||
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
<link rel="part" href="libgimp.html" title="Part I. 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 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 II. GIMP User Interface Library">
|
||
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
||
<link rel="index" href="libgimp-index.html" title="Index">
|
||
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
||
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
||
<link rel="index" href="libgimp-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
|
||
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
||
<tr valign="middle">
|
||
<td><a accesskey="p" href="libgimp-gimpui.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="u" href="libgimpui.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="GimpDrawablePreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
||
</tr>
|
||
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgimp-gimpexport.synopsis" class="shortcut">Top</a>
|
||
|
|
||
<a href="#libgimp-gimpexport.description" class="shortcut">Description</a></nobr></td></tr>
|
||
</table>
|
||
<div class="refentry" lang="en">
|
||
<a name="libgimp-gimpexport"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="libgimp-gimpexport.top_of_page"></a>gimpexport</span></h2>
|
||
<p>gimpexport — Export an image before it is saved.</p>
|
||
</td>
|
||
<td valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsynopsisdiv">
|
||
<a name="libgimp-gimpexport.synopsis"></a><h2>Synopsis</h2>
|
||
<pre class="synopsis">
|
||
enum <a class="link" href="libgimp-gimpexport.html#GimpExportCapabilities" title="enum GimpExportCapabilities">GimpExportCapabilities</a>;
|
||
enum <a class="link" href="libgimp-gimpexport.html#GimpExportReturn" title="enum GimpExportReturn">GimpExportReturn</a>;
|
||
<a class="link" href="libgimp-gimpexport.html#GimpExportReturn" title="enum GimpExportReturn">GimpExportReturn</a> <a class="link" href="libgimp-gimpexport.html#gimp-export-image" title="gimp_export_image ()">gimp_export_image</a> (gint32 *image_ID,
|
||
gint32 *drawable_ID,
|
||
const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *format_name,
|
||
<a class="link" href="libgimp-gimpexport.html#GimpExportCapabilities" title="enum GimpExportCapabilities">GimpExportCapabilities</a> capabilities);
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="libgimp-gimpexport.description"></a><h2>Description</h2>
|
||
<p>
|
||
This function should be called by all save_plugins unless they are
|
||
able to save all image formats GIMP knows about. It takes care
|
||
of asking the user if she wishes to export the image to a format the
|
||
save_plugin can handle. It then performs the necessary conversions
|
||
(e.g. Flatten) on a copy of the image so that the image can be saved
|
||
without changing the original image.
|
||
|
||
The capabilities of the save_plugin are specified by combining
|
||
<a class="link" href="libgimp-gimpexport.html#GimpExportCapabilities" title="enum GimpExportCapabilities"><span class="type">GimpExportCapabilities</span></a> using a bitwise OR.
|
||
|
||
Make sure you have initialized GTK+ before you call this function
|
||
as it will most probably have to open a dialog.
|
||
</p>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="libgimp-gimpexport.details"></a><h2>Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpExportCapabilities"></a><h3>enum GimpExportCapabilities</h3>
|
||
<pre class="programlisting">typedef enum
|
||
{
|
||
GIMP_EXPORT_CAN_HANDLE_RGB = 1 << 0,
|
||
GIMP_EXPORT_CAN_HANDLE_GRAY = 1 << 1,
|
||
GIMP_EXPORT_CAN_HANDLE_INDEXED = 1 << 2,
|
||
GIMP_EXPORT_CAN_HANDLE_BITMAP = 1 << 3,
|
||
GIMP_EXPORT_CAN_HANDLE_ALPHA = 1 << 4,
|
||
GIMP_EXPORT_CAN_HANDLE_LAYERS = 1 << 5,
|
||
GIMP_EXPORT_CAN_HANDLE_LAYERS_AS_ANIMATION = 1 << 6,
|
||
GIMP_EXPORT_CAN_HANDLE_LAYER_MASKS = 1 << 7,
|
||
GIMP_EXPORT_NEEDS_ALPHA = 1 << 8
|
||
} GimpExportCapabilities;
|
||
</pre>
|
||
<p>
|
||
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpExportReturn"></a><h3>enum GimpExportReturn</h3>
|
||
<pre class="programlisting">typedef enum
|
||
{
|
||
GIMP_EXPORT_CANCEL,
|
||
GIMP_EXPORT_IGNORE,
|
||
GIMP_EXPORT_EXPORT
|
||
} GimpExportReturn;
|
||
</pre>
|
||
<p>
|
||
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-export-image"></a><h3>gimp_export_image ()</h3>
|
||
<pre class="programlisting"><a class="link" href="libgimp-gimpexport.html#GimpExportReturn" title="enum GimpExportReturn">GimpExportReturn</a> gimp_export_image (gint32 *image_ID,
|
||
gint32 *drawable_ID,
|
||
const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *format_name,
|
||
<a class="link" href="libgimp-gimpexport.html#GimpExportCapabilities" title="enum GimpExportCapabilities">GimpExportCapabilities</a> capabilities);</pre>
|
||
<p>
|
||
Takes an image and a drawable to be saved together with a
|
||
description of the capabilities of the image_format. If the
|
||
type of image doesn't match the capabilities of the format
|
||
a dialog is opened that informs the user that the image has
|
||
to be exported and offers to do the necessary conversions.
|
||
</p>
|
||
<p>
|
||
If the user chooses to export the image, a copy is created.
|
||
This copy is then converted, the image_ID and drawable_ID
|
||
are changed to point to the new image and the procedure returns
|
||
GIMP_EXPORT_EXPORT. The save_plugin has to take care of deleting the
|
||
created image using <a class="link" href="libgimp-gimpimage.html#gimp-image-delete" title="gimp_image_delete ()"><code class="function">gimp_image_delete()</code></a> when it has saved it.
|
||
</p>
|
||
<p>
|
||
If the user chooses to Ignore the export problem, the image_ID
|
||
and drawable_ID is not altered, GIMP_EXPORT_IGNORE is returned and
|
||
the save_plugin should try to save the original image. If the
|
||
user chooses Cancel, GIMP_EXPORT_CANCEL is returned and the
|
||
save_plugin should quit itself with status <span class="type">GIMP_PDB_CANCEL</span>.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td> Pointer to the image_ID.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></p></td>
|
||
<td> Pointer to the drawable_ID.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>format_name</code></em> :</span></p></td>
|
||
<td> The (short) name of the image_format (e.g. JPEG or GIF).
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>capabilities</code></em> :</span></p></td>
|
||
<td> What can the image_format do?
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> An enum of <a class="link" href="libgimp-gimpexport.html#GimpExportReturn" title="enum GimpExportReturn"><span class="type">GimpExportReturn</span></a> describing the user_action.
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.10</div>
|
||
</body>
|
||
</html>
|