428 lines
18 KiB
HTML
428 lines
18 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>GimpBrushSelectButton</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="GimpSelectButton.html" title="GimpSelectButton">
|
|
<link rel="next" href="GimpFontSelectButton.html" title="GimpFontSelectButton">
|
|
<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 I. 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 II. 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="GimpSelectButton.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="GimpFontSelectButton.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="#id2584476" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2692015" class="shortcut">Description</a>
|
|
 | 
|
|
<a href="#id2671193" class="shortcut">Object Hierarchy</a>
|
|
 | 
|
|
<a href="#id2671256" class="shortcut">Implemented Interfaces</a>
|
|
 | 
|
|
<a href="#id2691918" class="shortcut">Properties</a>
|
|
 | 
|
|
<a href="#id2691992" class="shortcut">Signals</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="GimpBrushSelectButton"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2584476"></a><span class="refentrytitle">GimpBrushSelectButton</span>
|
|
</h2>
|
|
<p>GimpBrushSelectButton</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a href="GimpBrushSelectButton.html#GimpBrushSelectButton-struct">GimpBrushSelectButton</a>;
|
|
GtkWidget* <a href="GimpBrushSelectButton.html#gimp-brush-select-button-new">gimp_brush_select_button_new</a> (const gchar *title,
|
|
const gchar *brush_name,
|
|
gdouble opacity,
|
|
gint spacing,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
|
|
const gchar* <a href="GimpBrushSelectButton.html#gimp-brush-select-button-get-brush">gimp_brush_select_button_get_brush</a> (<a href="GimpBrushSelectButton.html" title="GimpBrushSelectButton">GimpBrushSelectButton</a> *button,
|
|
gdouble *opacity,
|
|
gint *spacing,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode);
|
|
void <a href="GimpBrushSelectButton.html#gimp-brush-select-button-set-brush">gimp_brush_select_button_set_brush</a> (<a href="GimpBrushSelectButton.html" title="GimpBrushSelectButton">GimpBrushSelectButton</a> *button,
|
|
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="id2671193"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
GObject
|
|
+----GInitiallyUnowned
|
|
+----GtkObject
|
|
+----GtkWidget
|
|
+----GtkContainer
|
|
+----GtkBox
|
|
+----GtkHBox
|
|
+----<a href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
|
|
+----GimpBrushSelectButton
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2671256"></a><h2>Implemented Interfaces</h2>
|
|
<p>
|
|
GimpBrushSelectButton implements
|
|
AtkImplementorIface.</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2691918"></a><h2>Properties</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a href="GimpBrushSelectButton.html#GimpBrushSelectButton--brush-name">brush-name</a>" gchararray : Read / Write
|
|
"<a href="GimpBrushSelectButton.html#GimpBrushSelectButton--brush-opacity">brush-opacity</a>" gdouble : Read / Write
|
|
"<a href="GimpBrushSelectButton.html#GimpBrushSelectButton--brush-paint-mode">brush-paint-mode</a>" gint : Read / Write
|
|
"<a href="GimpBrushSelectButton.html#GimpBrushSelectButton--brush-spacing">brush-spacing</a>" gint : Read / Write
|
|
"<a href="GimpBrushSelectButton.html#GimpBrushSelectButton--title">title</a>" gchararray : Read / Write / Construct Only
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2691992"></a><h2>Signals</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a href="GimpBrushSelectButton.html#GimpBrushSelectButton-brush-set">brush-set</a>" : Run First
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2692015"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2692031"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2692042"></a><h3>
|
|
<a name="GimpBrushSelectButton-struct"></a>GimpBrushSelectButton</h3>
|
|
<a class="indexterm" name="id2692053"></a><pre class="programlisting">typedef struct _GimpBrushSelectButton GimpBrushSelectButton;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2692069"></a><h3>
|
|
<a name="gimp-brush-select-button-new"></a>gimp_brush_select_button_new ()</h3>
|
|
<a class="indexterm" name="id2701679"></a><pre class="programlisting">GtkWidget* gimp_brush_select_button_new (const gchar *title,
|
|
const gchar *brush_name,
|
|
gdouble opacity,
|
|
gint spacing,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
|
|
<p>
|
|
Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
|
|
a <a
|
|
href="../app/GimpBrush.html"
|
|
><span class="type">GimpBrush</span></a>. This widget is suitable for placement in a table in
|
|
a plug-in 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>title</code></em> :</span></td>
|
|
<td> Title of the dialog to use or <code class="literal">NULL</code> means to use the default
|
|
title.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
|
|
<td> Initial brush name or <code class="literal">NULL</code> to use current selection.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> Initial opacity. -1 means to use current opacity.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
|
|
<td> Initial spacing. -1 means to use current spacing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> Initial paint mode. -1 means to use current paint mode.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> A <span class="type">GtkWidget</span> that you can use in your UI.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2701873"></a><h3>
|
|
<a name="gimp-brush-select-button-get-brush"></a>gimp_brush_select_button_get_brush ()</h3>
|
|
<a class="indexterm" name="id2701886"></a><pre class="programlisting">const gchar* gimp_brush_select_button_get_brush (<a href="GimpBrushSelectButton.html" title="GimpBrushSelectButton">GimpBrushSelectButton</a> *button,
|
|
gdouble *opacity,
|
|
gint *spacing,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode);</pre>
|
|
<p>
|
|
Retrieves the properties of currently selected brush.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>button</code></em> :</span></td>
|
|
<td> A <a href="GimpBrushSelectButton.html" title="GimpBrushSelectButton"><span class="type">GimpBrushSelectButton</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> Opacity of the selected brush.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
|
|
<td> Spacing of the selected brush.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> Paint mode of the selected brush.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> an internal copy of the brush name which must not be freed.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2669843"></a><h3>
|
|
<a name="gimp-brush-select-button-set-brush"></a>gimp_brush_select_button_set_brush ()</h3>
|
|
<a class="indexterm" name="id2669856"></a><pre class="programlisting">void gimp_brush_select_button_set_brush (<a href="GimpBrushSelectButton.html" title="GimpBrushSelectButton">GimpBrushSelectButton</a> *button,
|
|
const gchar *brush_name,
|
|
gdouble opacity,
|
|
gint spacing,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
|
|
<p>
|
|
Sets the current brush and other values for the brush select
|
|
button.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>button</code></em> :</span></td>
|
|
<td> A <a href="GimpBrushSelectButton.html" title="GimpBrushSelectButton"><span class="type">GimpBrushSelectButton</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
|
|
<td> Brush name to set; <code class="literal">NULL</code> means no change.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> Opacity to set. -1.0 means no change.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
|
|
<td> Spacing to set. -1 means no change.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> Paint mode to set. -1 means no change.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2670012"></a><h2>Property Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2703282"></a><h3>
|
|
<a name="GimpBrushSelectButton--brush-name"></a>The "<code class="literal">brush-name</code>" property</h3>
|
|
<a class="indexterm" name="id2703295"></a><pre class="programlisting"> "brush-name" gchararray : Read / Write</pre>
|
|
<p>
|
|
The name of the currently selected brush.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>Default value: NULL</p>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2703327"></a><h3>
|
|
<a name="GimpBrushSelectButton--brush-opacity"></a>The "<code class="literal">brush-opacity</code>" property</h3>
|
|
<a class="indexterm" name="id2703342"></a><pre class="programlisting"> "brush-opacity" gdouble : Read / Write</pre>
|
|
<p>The opacity of the currently selected brush.</p>
|
|
<p>Allowed values: [-1,100]</p>
|
|
<p>Default value: -1</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2703370"></a><h3>
|
|
<a name="GimpBrushSelectButton--brush-paint-mode"></a>The "<code class="literal">brush-paint-mode</code>" property</h3>
|
|
<a class="indexterm" name="id2703384"></a><pre class="programlisting"> "brush-paint-mode" gint : Read / Write</pre>
|
|
<p>The paint mode of the currently selected brush.</p>
|
|
<p>Allowed values: [-1,22]</p>
|
|
<p>Default value: -1</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2703411"></a><h3>
|
|
<a name="GimpBrushSelectButton--brush-spacing"></a>The "<code class="literal">brush-spacing</code>" property</h3>
|
|
<a class="indexterm" name="id2703426"></a><pre class="programlisting"> "brush-spacing" gint : Read / Write</pre>
|
|
<p>The spacing of the currently selected brush.</p>
|
|
<p>Allowed values: [-2147483647,1000]</p>
|
|
<p>Default value: -1</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2703455"></a><h3>
|
|
<a name="GimpBrushSelectButton--title"></a>The "<code class="literal">title</code>" property</h3>
|
|
<a class="indexterm" name="id2703470"></a><pre class="programlisting"> "title" gchararray : Read / Write / Construct Only</pre>
|
|
<p>
|
|
The title to be used for the brush selection popup dialog.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>Default value: "Brush Selection"</p>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2703503"></a><h2>Signal Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2703512"></a><h3>
|
|
<a name="GimpBrushSelectButton-brush-set"></a>The "brush-set" signal</h3>
|
|
<a class="indexterm" name="id2703522"></a><pre class="programlisting">void user_function (<a href="GimpBrushSelectButton.html" title="GimpBrushSelectButton">GimpBrushSelectButton</a> *widget,
|
|
gchar *brush_name,
|
|
gdouble opacity,
|
|
gint spacing,
|
|
gint paint_mode,
|
|
gint width,
|
|
gint height,
|
|
gpointer mask_data,
|
|
gboolean dialog_closing,
|
|
gpointer user_data) : Run First</pre>
|
|
<p>
|
|
The ::brush-set signal is emitted when the user selects a brush.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
|
|
<td> the object which received the signal.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
|
|
<td> the name of the currently selected brush.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> opacity of the brush
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
|
|
<td> spacing of the brush
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> paint mode of the brush
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
|
|
<td> width of the brush
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
|
|
<td> height of the brush
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>mask_data</code></em> :</span></td>
|
|
<td> brush mask data
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>dialog_closing</code></em> :</span></td>
|
|
<td> whether the dialog was closed or not.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
|
|
<td>user data set when the signal handler was connected.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|