Files
gimp/devel-docs/libgimp/html/libgimp-gimpbrushselect.html
2010-08-11 01:21:23 -04:00

388 lines
15 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpbrushselect</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="prev" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">
<link rel="next" href="libgimp-gimpfontselect.html" title="gimpfontselect">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#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 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;II.&#160;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-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="GimpPatternSelectButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-selectors.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-gimpfontselect.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="#id2569711" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2702473" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpbrushselect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2569711"></a><span class="refentrytitle">gimpbrushselect</span>
</h2>
<p>gimpbrushselect &#8212; Functions providing a brush selection dialog.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
void (<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">*GimpRunBrushCallback</a>) (const gchar *brush_name,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
gint width,
gint height,
const guchar *mask_data,
gboolean dialog_closing,
gpointer user_data);
const gchar* <a href="libgimp-gimpbrushselect.html#gimp-brush-select-new">gimp_brush_select_new</a> (const gchar *title,
const gchar *brush_name,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
gpointer data);
void <a href="libgimp-gimpbrushselect.html#gimp-brush-select-destroy">gimp_brush_select_destroy</a> (const gchar *brush_callback);
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-popup">gimp_brushes_popup</a> (const gchar *brush_callback,
const gchar *popup_title,
const gchar *initial_brush,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-close-popup">gimp_brushes_close_popup</a> (const gchar *brush_callback);
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-set-popup">gimp_brushes_set_popup</a> (const gchar *brush_callback,
const gchar *brush_name,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2702473"></a><h2>Description</h2>
<p>
Functions providing a brush selection dialog.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2702490"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2702500"></a><h3>
<a name="GimpRunBrushCallback"></a>GimpRunBrushCallback ()</h3>
<a class="indexterm" name="id2702511"></a><pre class="programlisting">void (*GimpRunBrushCallback) (const gchar *brush_name,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
gint width,
gint height,
const guchar *mask_data,
gboolean dialog_closing,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>brush_name</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>dialog_closing</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2704769"></a><h3>
<a name="gimp-brush-select-new"></a>gimp_brush_select_new ()</h3>
<a class="indexterm" name="id2704781"></a><pre class="programlisting">const gchar* gimp_brush_select_new (const gchar *title,
const gchar *brush_name,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
gpointer data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>title</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>brush_name</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2705230"></a><h3>
<a name="gimp-brush-select-destroy"></a>gimp_brush_select_destroy ()</h3>
<a class="indexterm" name="id2705241"></a><pre class="programlisting">void gimp_brush_select_destroy (const gchar *brush_callback);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>brush_callback</code></em>&#160;:</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2705286"></a><h3>
<a name="gimp-brushes-popup"></a>gimp_brushes_popup ()</h3>
<a class="indexterm" name="id2705297"></a><pre class="programlisting">gboolean gimp_brushes_popup (const gchar *brush_callback,
const gchar *popup_title,
const gchar *initial_brush,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
<p>
Invokes the Gimp brush selection.
</p>
<p>
This procedure opens the brush selection dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>brush_callback</code></em>&#160;:</span></td>
<td> The callback PDB proc to call when brush selection is made.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>popup_title</code></em>&#160;:</span></td>
<td> Title of the brush selection dialog.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>initial_brush</code></em>&#160;:</span></td>
<td> The name of the brush to set as the first selected.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td> The initial opacity of the brush.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The initial spacing of the brush (if &lt; 0 then use brush default spacing).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td> The initial paint mode.
</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>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2708675"></a><h3>
<a name="gimp-brushes-close-popup"></a>gimp_brushes_close_popup ()</h3>
<a class="indexterm" name="id2708685"></a><pre class="programlisting">gboolean gimp_brushes_close_popup (const gchar *brush_callback);</pre>
<p>
Close the brush selection dialog.
</p>
<p>
This procedure closes an opened brush selection dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>brush_callback</code></em>&#160;:</span></td>
<td> The name of the callback registered for this pop-up.
</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>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2708744"></a><h3>
<a name="gimp-brushes-set-popup"></a>gimp_brushes_set_popup ()</h3>
<a class="indexterm" name="id2708754"></a><pre class="programlisting">gboolean gimp_brushes_set_popup (const gchar *brush_callback,
const gchar *brush_name,
gdouble opacity,
gint spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
<p>
Sets the current brush in a brush selection dialog.
</p>
<p>
Sets the current brush in a brush selection dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>brush_callback</code></em>&#160;:</span></td>
<td> The name of the callback registered for this pop-up.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>brush_name</code></em>&#160;:</span></td>
<td> The name of the brush to set as selected.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td> The initial opacity of the brush.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The initial spacing of the brush (if &lt; 0 then use brush default spacing).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td> The initial paint mode.
</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>
</div>
</div>
</div>
</body>
</html>