812 lines
25 KiB
HTML
812 lines
25 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>gimpcontext</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="libgimp-general.html" title="Functions not Related to Specific Images">
|
|
<link rel="prev" href="libgimp-gimpbuffer.html" title="gimpbuffer">
|
|
<link rel="next" href="libgimp-gimpgimprc.html" title="gimpgimprc">
|
|
<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 I. GIMP Constants">
|
|
<link rel="part" href="libgimp.html" title="Part II. 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 III. 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="libgimp-gimpbuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimp-general.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-gimpgimprc.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-gimpcontext"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2><span class="refentrytitle">gimpcontext</span></h2>
|
|
<p>gimpcontext — Functions to manipulate a plug-in's context.</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-push">gimp_context_push</a> (void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-pop">gimp_context_pop</a> (void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-get-foreground">gimp_context_get_foreground</a> (<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *foreground);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-foreground">gimp_context_set_foreground</a> (const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *foreground);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-get-background">gimp_context_get_background</a> (<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *background);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-background">gimp_context_set_background</a> (const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *background);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-default-colors">gimp_context_set_default_colors</a> (void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-swap-colors">gimp_context_swap_colors</a> (void);
|
|
gdouble <a href="libgimp-gimpcontext.html#gimp-context-get-opacity">gimp_context_get_opacity</a> (void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-opacity">gimp_context_set_opacity</a> (gdouble opacity);
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> <a href="libgimp-gimpcontext.html#gimp-context-get-paint-mode">gimp_context_get_paint_mode</a>
|
|
(void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-paint-mode">gimp_context_set_paint_mode</a> (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
|
|
gchar* <a href="libgimp-gimpcontext.html#gimp-context-get-brush">gimp_context_get_brush</a> (void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-brush">gimp_context_set_brush</a> (const gchar *name);
|
|
gchar* <a href="libgimp-gimpcontext.html#gimp-context-get-pattern">gimp_context_get_pattern</a> (void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-pattern">gimp_context_set_pattern</a> (const gchar *name);
|
|
gchar* <a href="libgimp-gimpcontext.html#gimp-context-get-gradient">gimp_context_get_gradient</a> (void);
|
|
gboolean <a href="libgimp-gimpcontext.html#gimp-context-set-gradient">gimp_context_set_gradient</a> (const gchar *name);
|
|
gchar* <a href="libgimp-gimpcontext.html#gimp-context-get-palette">gimp_context_get_palette</a> (void);
|
|
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);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2537353"></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>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2537371"></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>
|
|
<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>
|
|
<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> :</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="id2537431"></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>
|
|
<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>
|
|
<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> :</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="id2537491"></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
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *foreground);</pre>
|
|
<p>
|
|
Get the current GIMP foreground color.
|
|
</p>
|
|
<p>
|
|
This procedure returns the current GIMP foreground color. The
|
|
foreground color is used in a variety of tools such as paint tools,
|
|
blending, and bucket fill.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>foreground</code></em> :</span></td>
|
|
<td> The foreground color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2537788"></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
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *foreground);</pre>
|
|
<p>
|
|
Set the current GIMP foreground color.
|
|
</p>
|
|
<p>
|
|
This procedure sets the current GIMP foreground color. After this is
|
|
set, operations which use foreground such as paint tools, blending,
|
|
and bucket fill will use the new value.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>foreground</code></em> :</span></td>
|
|
<td> The foreground color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2537867"></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
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *background);</pre>
|
|
<p>
|
|
Get the current GIMP background color.
|
|
</p>
|
|
<p>
|
|
This procedure returns the current GIMP background color. The
|
|
background color is used in a variety of tools such as blending,
|
|
erasing (with non-alpha images), and image filling.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>background</code></em> :</span></td>
|
|
<td> The background color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2537946"></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
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *background);</pre>
|
|
<p>
|
|
Set the current GIMP background color.
|
|
</p>
|
|
<p>
|
|
This procedure sets the current GIMP background color. After this is
|
|
set, operations which use background such as blending, filling
|
|
images, clearing, and erasing (in non-alpha images) will use the new
|
|
value.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>background</code></em> :</span></td>
|
|
<td> The background color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2561942"></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>
|
|
<p>
|
|
Set the current GIMP foreground and background colors to black and
|
|
white.
|
|
</p>
|
|
<p>
|
|
This procedure sets the current GIMP foreground and background
|
|
colors to their initial default values, black and white.</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> :</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="id2562001"></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>
|
|
<p>
|
|
Swap the current GIMP foreground and background colors.
|
|
</p>
|
|
<p>
|
|
This procedure swaps the current GIMP foreground and background
|
|
colors, so that the new foreground color becomes the old background
|
|
color and vice versa.</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> :</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="id2562062"></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>
|
|
<p>
|
|
Get the opacity.
|
|
</p>
|
|
<p>
|
|
This procedure returns the opacity setting. The return value is a
|
|
floating point number between 0 and 100.</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> :</span></td>
|
|
<td> The opacity.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2562121"></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>
|
|
<p>
|
|
Set the opacity.
|
|
</p>
|
|
<p>
|
|
This procedure modifies the opacity setting. The value should be a
|
|
floating point number between 0 and 100.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The opacity.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2562200"></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
|
|
(void);</pre>
|
|
<p>
|
|
Get the paint mode.
|
|
</p>
|
|
<p>
|
|
This procedure returns the paint-mode setting. The return value is
|
|
an integer which corresponds to the values listed in the argument
|
|
description.</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> :</span></td>
|
|
<td> The paint mode.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2559563"></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>
|
|
<p>
|
|
Set the paint mode.
|
|
</p>
|
|
<p>
|
|
This procedure modifies the paint_mode setting.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> The paint mode.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2559639"></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>
|
|
<p>
|
|
Retrieve the currently active brush.
|
|
</p>
|
|
<p>
|
|
This procedure returns the nme 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>
|
|
|
|
</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> :</span></td>
|
|
<td> The name of the active brush.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2559700"></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>
|
|
<p>
|
|
Set the specified brush as the active brush.
|
|
</p>
|
|
<p>
|
|
This procedure allows the active brush to be set by specifying its
|
|
name. The name is simply a string which corresponds to one of the
|
|
names of the installed brushes. If there is no matching brush found,
|
|
this procedure will return an error. Otherwise, the specified brush
|
|
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> :</span></td>
|
|
<td> The name o the brush.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2559783"></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>
|
|
<p>
|
|
Retrieve the currently active pattern.
|
|
</p>
|
|
<p>
|
|
This procedure returns name of the the currently active pattern. All
|
|
clone and bucket-fill operations with patterns will use this pattern
|
|
to control the application of paint to the image.</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> :</span></td>
|
|
<td> The name of the active pattern.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2559843"></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>
|
|
<p>
|
|
Set the specified pattern as the active pattern.
|
|
</p>
|
|
<p>
|
|
This procedure allows the active pattern to be set by specifying its
|
|
name. The name is simply a string which corresponds to one of the
|
|
names of the installed patterns. If there is no matching pattern
|
|
found, this procedure will return an error. Otherwise, the specified
|
|
pattern 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> :</span></td>
|
|
<td> The name of the pattern.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2559927"></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>
|
|
<p>
|
|
Retrieve the currently active gradient.
|
|
</p>
|
|
<p>
|
|
This procedure returns the name of the currently active gradient.</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> :</span></td>
|
|
<td> The name of the active gradient.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2559986"></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>
|
|
<p>
|
|
Sets the specified gradient as the active gradient.
|
|
</p>
|
|
<p>
|
|
This procedure lets you set the specified gradient as the active or
|
|
\"current\" one. The name is simply a string which corresponds to
|
|
one of the loaded gradients. If no matching gradient is found, this
|
|
procedure will return an error. Otherwise, the specified gradient
|
|
will become active and will be used for subsequent custom gradient
|
|
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> :</span></td>
|
|
<td> The name of the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2560070"></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>
|
|
<p>
|
|
Retrieve the currently active palette.
|
|
</p>
|
|
<p>
|
|
This procedure returns the name of the the currently active palette.</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> :</span></td>
|
|
<td> The name of the active palette.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2560129"></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>
|
|
<p>
|
|
Set the specified palette as the active palette.
|
|
</p>
|
|
<p>
|
|
This procedure allows the active palette to be set by specifying its
|
|
name. The name is simply a string which corresponds to one of the
|
|
names of the installed palettes. If no matching palette is found,
|
|
this procedure will return an error. Otherwise, the specified
|
|
palette becomes active and will be used in all subsequent palette
|
|
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> :</span></td>
|
|
<td> The name of the palette.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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="id2560213"></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>
|
|
<p>
|
|
Retrieve the currently active font.
|
|
</p>
|
|
<p>
|
|
This procedure returns the name of the currently active font.</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> :</span></td>
|
|
<td> The name of the active font.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2560272"></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>
|
|
<p>
|
|
Set the specified font as the active font.
|
|
</p>
|
|
<p>
|
|
This procedure allows the active font to be set by specifying its
|
|
name. The name is simply a string which corresponds to one of the
|
|
names of the installed fonts. If no matching font is found, this
|
|
procedure will return an error. Otherwise, the specified font
|
|
becomes active and will be used in all subsequent font 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> :</span></td>
|
|
<td> The name of the font.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</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-gimpbuffer.html"><b><< gimpbuffer</b></a></td>
|
|
<td align="right"><a accesskey="n" href="libgimp-gimpgimprc.html"><b>gimpgimprc >></b></a></td>
|
|
</tr></table>
|
|
</body>
|
|
</html>
|