Imported Upstream version 2.3.7

This commit is contained in:
Ari Pollak
2010-08-11 01:18:40 -04:00
parent de5dc4f4c2
commit 5bef548947
772 changed files with 75842 additions and 66943 deletions

View File

@ -76,27 +76,29 @@ gchar* <a href="libgimp-gimpcontext.html#gimp-context-get-palette">gimp_con
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-palette">gimp_context_set_palette</a> (const gchar *name);
gchar* <a href="libgimp-gimpcontext.html#gimp-context-get-font">gimp_context_get_font</a> (void);
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-font">gimp_context_set_font</a> (const gchar *name);
gchar* <a href="libgimp-gimpcontext.html#gimp-context-get-paint-method">gimp_context_get_paint_method</a> (void);
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-paint-method">gimp_context_set_paint_method</a> (const gchar *name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2537353"></a><h2>Description</h2>
<a name="id2534135"></a><h2>Description</h2>
<p>
Functions to manipulate a plug-in's context.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2537365"></a><h2>Details</h2>
<a name="id2534147"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2537371"></a><h3>
<a name="id2534153"></a><h3>
<a name="gimp-context-push"></a>gimp_context_push ()</h3>
<a class="indexterm" name="id2537381"></a><pre class="programlisting">gboolean gimp_context_push (void);</pre>
<a class="indexterm" name="id2537710"></a><pre class="programlisting">gboolean gimp_context_push (void);</pre>
<p>
Pushes a context to the top of the plug-in's context stack.
</p>
<p>
This procedure creates a new context by copying the current context.
This copy becomes the new current context for the calling plug-in
until it is popped again.</p>
until it is popped again using gimp-context-pop.</p>
<p>
</p>
@ -115,15 +117,17 @@ until it is popped again.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537431"></a><h3>
<a name="id2537760"></a><h3>
<a name="gimp-context-pop"></a>gimp_context_pop ()</h3>
<a class="indexterm" name="id2537441"></a><pre class="programlisting">gboolean gimp_context_pop (void);</pre>
<a class="indexterm" name="id2537770"></a><pre class="programlisting">gboolean gimp_context_pop (void);</pre>
<p>
Pops the topmost context from the plug-in's context stack.
</p>
<p>
This procedure creates a new context and makes it the current
context for the calling plug-in.</p>
This procedure removes the topmost context from the plug-in's
context stack. The context that was active before the corresponding
call to gimp-context-push becomes the new current context of the
plug-in.</p>
<p>
</p>
@ -142,9 +146,9 @@ context for the calling plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537491"></a><h3>
<a name="id2537822"></a><h3>
<a name="gimp-context-get-foreground"></a>gimp_context_get_foreground ()</h3>
<a class="indexterm" name="id2537500"></a><pre class="programlisting">gboolean gimp_context_get_foreground (<a
<a class="indexterm" name="id2537831"></a><pre class="programlisting">gboolean gimp_context_get_foreground (<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *foreground);</pre>
<p>
@ -180,9 +184,9 @@ blending, and bucket fill.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537788"></a><h3>
<a name="id2537901"></a><h3>
<a name="gimp-context-set-foreground"></a>gimp_context_set_foreground ()</h3>
<a class="indexterm" name="id2537797"></a><pre class="programlisting">gboolean gimp_context_set_foreground (const <a
<a class="indexterm" name="id2537910"></a><pre class="programlisting">gboolean gimp_context_set_foreground (const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *foreground);</pre>
<p>
@ -218,9 +222,9 @@ and bucket fill will use the new value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537867"></a><h3>
<a name="id2559302"></a><h3>
<a name="gimp-context-get-background"></a>gimp_context_get_background ()</h3>
<a class="indexterm" name="id2537876"></a><pre class="programlisting">gboolean gimp_context_get_background (<a
<a class="indexterm" name="id2559310"></a><pre class="programlisting">gboolean gimp_context_get_background (<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *background);</pre>
<p>
@ -256,9 +260,9 @@ erasing (with non-alpha images), and image filling.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537946"></a><h3>
<a name="id2559381"></a><h3>
<a name="gimp-context-set-background"></a>gimp_context_set_background ()</h3>
<a class="indexterm" name="id2537955"></a><pre class="programlisting">gboolean gimp_context_set_background (const <a
<a class="indexterm" name="id2559390"></a><pre class="programlisting">gboolean gimp_context_set_background (const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *background);</pre>
<p>
@ -295,9 +299,9 @@ value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2561942"></a><h3>
<a name="id2559460"></a><h3>
<a name="gimp-context-set-default-colors"></a>gimp_context_set_default_colors ()</h3>
<a class="indexterm" name="id2561950"></a><pre class="programlisting">gboolean gimp_context_set_default_colors (void);</pre>
<a class="indexterm" name="id2559470"></a><pre class="programlisting">gboolean gimp_context_set_default_colors (void);</pre>
<p>
Set the current GIMP foreground and background colors to black and
white.
@ -323,9 +327,9 @@ colors to their initial default values, black and white.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562001"></a><h3>
<a name="id2559521"></a><h3>
<a name="gimp-context-swap-colors"></a>gimp_context_swap_colors ()</h3>
<a class="indexterm" name="id2562010"></a><pre class="programlisting">gboolean gimp_context_swap_colors (void);</pre>
<a class="indexterm" name="id2559530"></a><pre class="programlisting">gboolean gimp_context_swap_colors (void);</pre>
<p>
Swap the current GIMP foreground and background colors.
</p>
@ -351,9 +355,9 @@ color and vice versa.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562062"></a><h3>
<a name="id2560013"></a><h3>
<a name="gimp-context-get-opacity"></a>gimp_context_get_opacity ()</h3>
<a class="indexterm" name="id2562071"></a><pre class="programlisting">gdouble gimp_context_get_opacity (void);</pre>
<a class="indexterm" name="id2560022"></a><pre class="programlisting">gdouble gimp_context_get_opacity (void);</pre>
<p>
Get the opacity.
</p>
@ -378,9 +382,9 @@ floating point number between 0 and 100.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562121"></a><h3>
<a name="id2560072"></a><h3>
<a name="gimp-context-set-opacity"></a>gimp_context_set_opacity ()</h3>
<a class="indexterm" name="id2562130"></a><pre class="programlisting">gboolean gimp_context_set_opacity (gdouble opacity);</pre>
<a class="indexterm" name="id2560081"></a><pre class="programlisting">gboolean gimp_context_set_opacity (gdouble opacity);</pre>
<p>
Set the opacity.
</p>
@ -413,9 +417,9 @@ floating point number between 0 and 100.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562200"></a><h3>
<a name="id2560150"></a><h3>
<a name="gimp-context-get-paint-mode"></a>gimp_context_get_paint_mode ()</h3>
<a class="indexterm" name="id2559512"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_context_get_paint_mode
<a class="indexterm" name="id2560160"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_context_get_paint_mode
(void);</pre>
<p>
Get the paint mode.
@ -442,9 +446,9 @@ description.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559563"></a><h3>
<a name="id2560210"></a><h3>
<a name="gimp-context-set-paint-mode"></a>gimp_context_set_paint_mode ()</h3>
<a class="indexterm" name="id2559572"></a><pre class="programlisting">gboolean gimp_context_set_paint_mode (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
<a class="indexterm" name="id2560220"></a><pre class="programlisting">gboolean gimp_context_set_paint_mode (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
<p>
Set the paint mode.
</p>
@ -476,14 +480,14 @@ This procedure modifies the paint_mode setting.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559639"></a><h3>
<a name="id2560289"></a><h3>
<a name="gimp-context-get-brush"></a>gimp_context_get_brush ()</h3>
<a class="indexterm" name="id2559648"></a><pre class="programlisting">gchar* gimp_context_get_brush (void);</pre>
<a class="indexterm" name="id2560298"></a><pre class="programlisting">gchar* gimp_context_get_brush (void);</pre>
<p>
Retrieve the currently active brush.
</p>
<p>
This procedure returns the nme of the currently active brush. All
This procedure returns the name of the currently active brush. All
paint operations and stroke operations use this brush to control the
application of paint to the image.</p>
<p>
@ -504,9 +508,9 @@ application of paint to the image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559700"></a><h3>
<a name="id2560349"></a><h3>
<a name="gimp-context-set-brush"></a>gimp_context_set_brush ()</h3>
<a class="indexterm" name="id2559708"></a><pre class="programlisting">gboolean gimp_context_set_brush (const gchar *name);</pre>
<a class="indexterm" name="id2560358"></a><pre class="programlisting">gboolean gimp_context_set_brush (const gchar *name);</pre>
<p>
Set the specified brush as the active brush.
</p>
@ -525,7 +529,7 @@ becomes active and will be used in all subsequent paint operations.</p>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name o the brush.
<td> The name of the brush.
</td>
</tr>
<tr>
@ -542,9 +546,9 @@ becomes active and will be used in all subsequent paint operations.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559783"></a><h3>
<a name="id2560433"></a><h3>
<a name="gimp-context-get-pattern"></a>gimp_context_get_pattern ()</h3>
<a class="indexterm" name="id2559792"></a><pre class="programlisting">gchar* gimp_context_get_pattern (void);</pre>
<a class="indexterm" name="id2560442"></a><pre class="programlisting">gchar* gimp_context_get_pattern (void);</pre>
<p>
Retrieve the currently active pattern.
</p>
@ -570,9 +574,9 @@ to control the application of paint to the image.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559843"></a><h3>
<a name="id2560494"></a><h3>
<a name="gimp-context-set-pattern"></a>gimp_context_set_pattern ()</h3>
<a class="indexterm" name="id2559852"></a><pre class="programlisting">gboolean gimp_context_set_pattern (const gchar *name);</pre>
<a class="indexterm" name="id2560503"></a><pre class="programlisting">gboolean gimp_context_set_pattern (const gchar *name);</pre>
<p>
Set the specified pattern as the active pattern.
</p>
@ -609,9 +613,9 @@ operations.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559927"></a><h3>
<a name="id2560577"></a><h3>
<a name="gimp-context-get-gradient"></a>gimp_context_get_gradient ()</h3>
<a class="indexterm" name="id2559936"></a><pre class="programlisting">gchar* gimp_context_get_gradient (void);</pre>
<a class="indexterm" name="id2560587"></a><pre class="programlisting">gchar* gimp_context_get_gradient (void);</pre>
<p>
Retrieve the currently active gradient.
</p>
@ -635,9 +639,9 @@ This procedure returns the name of the currently active gradient.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559986"></a><h3>
<a name="id2560637"></a><h3>
<a name="gimp-context-set-gradient"></a>gimp_context_set_gradient ()</h3>
<a class="indexterm" name="id2559996"></a><pre class="programlisting">gboolean gimp_context_set_gradient (const gchar *name);</pre>
<a class="indexterm" name="id2560647"></a><pre class="programlisting">gboolean gimp_context_set_gradient (const gchar *name);</pre>
<p>
Sets the specified gradient as the active gradient.
</p>
@ -674,9 +678,9 @@ operations.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560070"></a><h3>
<a name="id2560721"></a><h3>
<a name="gimp-context-get-palette"></a>gimp_context_get_palette ()</h3>
<a class="indexterm" name="id2560079"></a><pre class="programlisting">gchar* gimp_context_get_palette (void);</pre>
<a class="indexterm" name="id2560730"></a><pre class="programlisting">gchar* gimp_context_get_palette (void);</pre>
<p>
Retrieve the currently active palette.
</p>
@ -700,9 +704,9 @@ This procedure returns the name of the the currently active palette.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560129"></a><h3>
<a name="id2560781"></a><h3>
<a name="gimp-context-set-palette"></a>gimp_context_set_palette ()</h3>
<a class="indexterm" name="id2560138"></a><pre class="programlisting">gboolean gimp_context_set_palette (const gchar *name);</pre>
<a class="indexterm" name="id2560790"></a><pre class="programlisting">gboolean gimp_context_set_palette (const gchar *name);</pre>
<p>
Set the specified palette as the active palette.
</p>
@ -739,9 +743,9 @@ operations.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560213"></a><h3>
<a name="id2560864"></a><h3>
<a name="gimp-context-get-font"></a>gimp_context_get_font ()</h3>
<a class="indexterm" name="id2560222"></a><pre class="programlisting">gchar* gimp_context_get_font (void);</pre>
<a class="indexterm" name="id2560873"></a><pre class="programlisting">gchar* gimp_context_get_font (void);</pre>
<p>
Retrieve the currently active font.
</p>
@ -765,9 +769,9 @@ This procedure returns the name of the currently active font.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560272"></a><h3>
<a name="id2560923"></a><h3>
<a name="gimp-context-set-font"></a>gimp_context_set_font ()</h3>
<a class="indexterm" name="id2560281"></a><pre class="programlisting">gboolean gimp_context_set_font (const gchar *name);</pre>
<a class="indexterm" name="id2560932"></a><pre class="programlisting">gboolean gimp_context_set_font (const gchar *name);</pre>
<p>
Set the specified font as the active font.
</p>
@ -801,6 +805,72 @@ becomes active and will be used in all subsequent font operations.</p>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2561006"></a><h3>
<a name="gimp-context-get-paint-method"></a>gimp_context_get_paint_method ()</h3>
<a class="indexterm" name="id2566808"></a><pre class="programlisting">gchar* gimp_context_get_paint_method (void);</pre>
<p>
Retrieve the currently active paint method.
</p>
<p>
This procedure returns the name of the currently active paint
method.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The name of the active paint method.
</td>
</tr></tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2566854"></a><h3>
<a name="gimp-context-set-paint-method"></a>gimp_context_set_paint_method ()</h3>
<a class="indexterm" name="id2566864"></a><pre class="programlisting">gboolean gimp_context_set_paint_method (const gchar *name);</pre>
<p>
Set the specified paint method as the active paint method.
</p>
<p>
This procedure allows the active paint method to be set by
specifying its name. The name is simply a string which corresponds
to one of the names of the available paint methods. If there is no
matching method found, this procedure will return an error.
Otherwise, the specified method becomes active and will be used in
all subsequent paint operations.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the paint method.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">