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

232 lines
17 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpbrushselect</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><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="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs"><link rel="next" href="libgimp-gimpfontselect.html" title="gimpfontselect"><meta name="generator" content="GTK-Doc V1.3 (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"></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-selectors.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></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><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 <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *mask_data,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> dialog_closing,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimp-gimpbrushselect.html#gimp-brush-select-new">gimp_brush_select_new</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
void <a href="libgimp-gimpbrushselect.html#gimp-brush-select-destroy">gimp_brush_select_destroy</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpbrushselect.html#gimp-brushes-popup">gimp_brushes_popup</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *popup_title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *initial_brush,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpbrushselect.html#gimp-brushes-close-popup">gimp_brushes_close_popup</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpbrushselect.html#gimp-brushes-set-popup">gimp_brushes_set_popup</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
</pre></div><div class="refsect1" lang="en"><a name="id2647938"></a><h2>Description</h2><p>
Functions providing a brush selection dialog.
</p></div><div class="refsect1" lang="en"><a name="id2647948"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2647954"></a><h3><a name="GimpRunBrushCallback"></a>GimpRunBrushCallback ()</h3><a class="indexterm" name="id2647962"></a><pre class="programlisting">void (*GimpRunBrushCallback) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *mask_data,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> dialog_closing,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>brush_name</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>paint_mode</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mask_data</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dialog_closing</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2648585"></a><h3><a name="gimp-brush-select-new"></a>gimp_brush_select_new ()</h3><a class="indexterm" name="id2648593"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_brush_select_new (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>title</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>brush_name</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>paint_mode</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>callback</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i> :</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2648988"></a><h3><a name="gimp-brush-select-destroy"></a>gimp_brush_select_destroy ()</h3><a class="indexterm" name="id2648996"></a><pre class="programlisting">void gimp_brush_select_destroy (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>brush_callback</tt></i> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2649031"></a><h3><a name="gimp-brushes-popup"></a>gimp_brushes_popup ()</h3><a class="indexterm" name="id2649040"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brushes_popup (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *popup_title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *initial_brush,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre><p>
Invokes the Gimp brush selection.
</p><p>
This procedure popups the brush selection dialog.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>brush_callback</tt></i> :</span></td><td> The callback PDB proc to call when brush selection is made.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>popup_title</tt></i> :</span></td><td> Title to give the brush popup window.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>initial_brush</tt></i> :</span></td><td> The name of the brush to set as the first selected.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td> The initial opacity of the brush.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i> :</span></td><td> The initial spacing of the brush (if &lt; 0 then use brush default spacing).
</td></tr><tr><td><span class="term"><i class="parameter"><tt>paint_mode</tt></i> :</span></td><td> The initial 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></div><hr><div class="refsect2" lang="en"><a name="id2649179"></a><h3><a name="gimp-brushes-close-popup"></a>gimp_brushes_close_popup ()</h3><a class="indexterm" name="id2649187"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brushes_close_popup (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback);</pre><p>
Popdown the Gimp brush selection.
</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"><i class="parameter"><tt>brush_callback</tt></i> :</span></td><td> The name of the callback registered for this popup.
</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></div><hr><div class="refsect2" lang="en"><a name="id2656054"></a><h3><a name="gimp-brushes-set-popup"></a>gimp_brushes_set_popup ()</h3><a class="indexterm" name="id2656063"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brushes_set_popup (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *brush_name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> opacity,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre><p>
Sets the current brush selection in a popup.
</p><p>
Sets the current brush selection in a popup.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>brush_callback</tt></i> :</span></td><td> The name of the callback registered for this popup.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>brush_name</tt></i> :</span></td><td> The name of the brush to set as selected.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td> The initial opacity of the brush.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i> :</span></td><td> The initial spacing of the brush (if &lt; 0 then use brush default spacing).
</td></tr><tr><td><span class="term"><i class="parameter"><tt>paint_mode</tt></i> :</span></td><td> The initial 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></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-selectors.html"><b>&lt;&lt; Controlling the Core's Selection Dialogs</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpfontselect.html"><b>gimpfontselect &gt;&gt;</b></a></td></tr></table></body></html>