Files
gimp/devel-docs/libgimp/html/libgimp-gimpenums.html
2010-08-11 01:18:19 -04:00

421 lines
13 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpenums</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="prev" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="next" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;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&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</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="gimpdefinitions.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gimpdefinitions.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.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-gimpenums"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">gimpenums</span></h2>
<p>gimpenums &#8212; Enums and definitions.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
void <a href="libgimp-gimpenums.html#gimp-enums-init">gimp_enums_init</a> (void);
enum <a href="libgimp-gimpenums.html#GimpBrushApplicationMode">GimpBrushApplicationMode</a>;
enum <a href="libgimp-gimpenums.html#GimpConvertDitherType">GimpConvertDitherType</a>;
enum <a href="libgimp-gimpenums.html#GimpConvertPaletteType">GimpConvertPaletteType</a>;
enum <a href="libgimp-gimpenums.html#GimpConvolutionType">GimpConvolutionType</a>;
enum <a href="libgimp-gimpenums.html#GimpConvolveType">GimpConvolveType</a>;
enum <a href="libgimp-gimpenums.html#GimpFillType">GimpFillType</a>;
enum <a href="libgimp-gimpenums.html#GimpGradientSegmentColor">GimpGradientSegmentColor</a>;
enum <a href="libgimp-gimpenums.html#GimpGradientSegmentType">GimpGradientSegmentType</a>;
enum <a href="libgimp-gimpenums.html#GimpHistogramChannel">GimpHistogramChannel</a>;
enum <a href="libgimp-gimpenums.html#GimpHueRange">GimpHueRange</a>;
enum <a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a>;
enum <a href="libgimp-gimpenums.html#GimpMaskApplyMode">GimpMaskApplyMode</a>;
enum <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a>;
enum <a href="libgimp-gimpenums.html#GimpOffsetType">GimpOffsetType</a>;
enum <a href="libgimp-gimpenums.html#GimpOrientationType">GimpOrientationType</a>;
enum <a href="libgimp-gimpenums.html#GimpRotationType">GimpRotationType</a>;
enum <a href="libgimp-gimpenums.html#GimpRunMode">GimpRunMode</a>;
const gchar** <a href="libgimp-gimpenums.html#gimp-enums-get-type-names">gimp_enums_get_type_names</a> (gint *n_type_names);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2469229"></a><h2>Description</h2>
<p>
Enums and definitions.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2492088"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2492094"></a><h3>
<a name="gimp-enums-init"></a>gimp_enums_init ()</h3>
<a class="indexterm" name="id2492104"></a><pre class="programlisting">void gimp_enums_init (void);</pre>
<p>
This function makes sure all the enum types are registered
with the GObject type system. This is intended for use by
language bindings that need the symbols early, before gimp_main
is run. It's not necessary for plug-ins to call this directly,
as the normal plug-in initialization code will handle it
implicitly.</p>
<p>
</p>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492139"></a><h3>
<a name="GimpBrushApplicationMode"></a>enum GimpBrushApplicationMode</h3>
<a class="indexterm" name="id2492148"></a><pre class="programlisting">typedef enum
{
GIMP_BRUSH_HARD,
GIMP_BRUSH_SOFT
} GimpBrushApplicationMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492164"></a><h3>
<a name="GimpConvertDitherType"></a>enum GimpConvertDitherType</h3>
<a class="indexterm" name="id2492173"></a><pre class="programlisting">typedef enum
{
GIMP_NO_DITHER,
GIMP_FS_DITHER,
GIMP_FSLOWBLEED_DITHER,
GIMP_FIXED_DITHER
} GimpConvertDitherType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492191"></a><h3>
<a name="GimpConvertPaletteType"></a>enum GimpConvertPaletteType</h3>
<a class="indexterm" name="id2492200"></a><pre class="programlisting">typedef enum
{
GIMP_MAKE_PALETTE,
GIMP_REUSE_PALETTE,
GIMP_WEB_PALETTE,
GIMP_MONO_PALETTE,
GIMP_CUSTOM_PALETTE
} GimpConvertPaletteType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492217"></a><h3>
<a name="GimpConvolutionType"></a>enum GimpConvolutionType</h3>
<a class="indexterm" name="id2474136"></a><pre class="programlisting">typedef enum
{
GIMP_NORMAL_CONVOL,
GIMP_ABSOLUTE_CONVOL,
GIMP_NEGATIVE_CONVOL
} GimpConvolutionType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474153"></a><h3>
<a name="GimpConvolveType"></a>enum GimpConvolveType</h3>
<a class="indexterm" name="id2474164"></a><pre class="programlisting">typedef enum
{
GIMP_BLUR_CONVOLVE,
GIMP_SHARPEN_CONVOLVE
} GimpConvolveType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474180"></a><h3>
<a name="GimpFillType"></a>enum GimpFillType</h3>
<a class="indexterm" name="id2474190"></a><pre class="programlisting">typedef enum
{
GIMP_FOREGROUND_FILL,
GIMP_BACKGROUND_FILL,
GIMP_WHITE_FILL,
GIMP_TRANSPARENT_FILL,
GIMP_PATTERN_FILL
} GimpFillType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474208"></a><h3>
<a name="GimpGradientSegmentColor"></a>enum GimpGradientSegmentColor</h3>
<a class="indexterm" name="id2474217"></a><pre class="programlisting">typedef enum
{
GIMP_GRADIENT_SEGMENT_RGB,
GIMP_GRADIENT_SEGMENT_HSV_CCW,
GIMP_GRADIENT_SEGMENT_HSV_CW
} GimpGradientSegmentColor;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474235"></a><h3>
<a name="GimpGradientSegmentType"></a>enum GimpGradientSegmentType</h3>
<a class="indexterm" name="id2474244"></a><pre class="programlisting">typedef enum
{
GIMP_GRADIENT_SEGMENT_LINEAR,
GIMP_GRADIENT_SEGMENT_CURVED,
GIMP_GRADIENT_SEGMENT_SINE,
GIMP_GRADIENT_SEGMENT_SPHERE_INCREASING,
GIMP_GRADIENT_SEGMENT_SPHERE_DECREASING
} GimpGradientSegmentType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474262"></a><h3>
<a name="GimpHistogramChannel"></a>enum GimpHistogramChannel</h3>
<a class="indexterm" name="id2474271"></a><pre class="programlisting">typedef enum
{
GIMP_HISTOGRAM_VALUE,
GIMP_HISTOGRAM_RED,
GIMP_HISTOGRAM_GREEN,
GIMP_HISTOGRAM_BLUE,
GIMP_HISTOGRAM_ALPHA
} GimpHistogramChannel;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474289"></a><h3>
<a name="GimpHueRange"></a>enum GimpHueRange</h3>
<a class="indexterm" name="id2534536"></a><pre class="programlisting">typedef enum
{
GIMP_ALL_HUES,
GIMP_RED_HUES,
GIMP_YELLOW_HUES,
GIMP_GREEN_HUES,
GIMP_CYAN_HUES,
GIMP_BLUE_HUES,
GIMP_MAGENTA_HUES
} GimpHueRange;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534554"></a><h3>
<a name="GimpLayerModeEffects"></a>enum GimpLayerModeEffects</h3>
<a class="indexterm" name="id2534563"></a><pre class="programlisting">typedef enum
{
GIMP_NORMAL_MODE,
GIMP_DISSOLVE_MODE,
GIMP_BEHIND_MODE,
GIMP_MULTIPLY_MODE,
GIMP_SCREEN_MODE,
GIMP_OVERLAY_MODE,
GIMP_DIFFERENCE_MODE,
GIMP_ADDITION_MODE,
GIMP_SUBTRACT_MODE,
GIMP_DARKEN_ONLY_MODE,
GIMP_LIGHTEN_ONLY_MODE,
GIMP_HUE_MODE,
GIMP_SATURATION_MODE,
GIMP_COLOR_MODE,
GIMP_VALUE_MODE,
GIMP_DIVIDE_MODE,
GIMP_DODGE_MODE,
GIMP_BURN_MODE,
GIMP_HARDLIGHT_MODE,
GIMP_SOFTLIGHT_MODE,
GIMP_GRAIN_EXTRACT_MODE,
GIMP_GRAIN_MERGE_MODE,
GIMP_COLOR_ERASE_MODE
} GimpLayerModeEffects;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534586"></a><h3>
<a name="GimpMaskApplyMode"></a>enum GimpMaskApplyMode</h3>
<a class="indexterm" name="id2534596"></a><pre class="programlisting">typedef enum
{
GIMP_MASK_APPLY,
GIMP_MASK_DISCARD
} GimpMaskApplyMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534612"></a><h3>
<a name="GimpMergeType"></a>enum GimpMergeType</h3>
<a class="indexterm" name="id2534623"></a><pre class="programlisting">typedef enum
{
GIMP_EXPAND_AS_NECESSARY,
GIMP_CLIP_TO_IMAGE,
GIMP_CLIP_TO_BOTTOM_LAYER,
GIMP_FLATTEN_IMAGE
} GimpMergeType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534640"></a><h3>
<a name="GimpOffsetType"></a>enum GimpOffsetType</h3>
<a class="indexterm" name="id2534651"></a><pre class="programlisting">typedef enum
{
GIMP_OFFSET_BACKGROUND,
GIMP_OFFSET_TRANSPARENT
} GimpOffsetType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534668"></a><h3>
<a name="GimpOrientationType"></a>enum GimpOrientationType</h3>
<a class="indexterm" name="id2534678"></a><pre class="programlisting">typedef enum
{
GIMP_ORIENTATION_HORIZONTAL,
GIMP_ORIENTATION_VERTICAL,
GIMP_ORIENTATION_UNKNOWN
} GimpOrientationType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534695"></a><h3>
<a name="GimpRotationType"></a>enum GimpRotationType</h3>
<a class="indexterm" name="id2534705"></a><pre class="programlisting">typedef enum
{
GIMP_ROTATE_90,
GIMP_ROTATE_180,
GIMP_ROTATE_270
} GimpRotationType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534722"></a><h3>
<a name="GimpRunMode"></a>enum GimpRunMode</h3>
<a class="indexterm" name="id2534732"></a><pre class="programlisting">typedef enum
{
GIMP_RUN_INTERACTIVE,
GIMP_RUN_NONINTERACTIVE,
GIMP_RUN_WITH_LAST_VALS
} GimpRunMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534749"></a><h3>
<a name="gimp-enums-get-type-names"></a>gimp_enums_get_type_names ()</h3>
<a class="indexterm" name="id2534758"></a><pre class="programlisting">const gchar** gimp_enums_get_type_names (gint *n_type_names);</pre>
<p>
This function gives access to the list of enums registered by libgimp.
The returned array is static and must not be modified.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_type_names</code></em>&#160;:</span></td>
<td> return location for the number of names
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> an array with type names
</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="gimpdefinitions.html"><b>&lt;&lt;&#160;Part&#160;I.&#160;GIMP Constants</b></a></td>
<td align="right"><a accesskey="n" href="libgimp.html"><b>Part&#160;II.&#160;GIMP Library&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>