Files
gimp/devel-docs/libgimp/html/libgimp-gimpbrushmenu.html
2021-07-18 14:31:43 -04:00

222 lines
11 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.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbrushmenu: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="prev" href="libgimp-gimpmenu.html" title="gimpmenu">
<link rel="next" href="libgimp-gimpfontmenu.html" title="gimpfontmenu">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#libgimp-gimpbrushmenu.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpui.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimpmenu.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpfontmenu.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimpbrushmenu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpbrushmenu.top_of_page"></a>gimpbrushmenu</span></h2>
<p>gimpbrushmenu — A widget for selecting brushes.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimpbrushmenu.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-new" title="gimp_brush_select_widget_new ()">gimp_brush_select_widget_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-close" title="gimp_brush_select_widget_close ()">gimp_brush_select_widget_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-set" title="gimp_brush_select_widget_set ()">gimp_brush_select_widget_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimpbrushmenu.description"></a><h2>Description</h2>
<p>A widget for selecting brushes.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpbrushmenu.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-brush-select-widget-new"></a><h3>gimp_brush_select_widget_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_brush_select_widget_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *brush_name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
<em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpbrushselect.html#GimpRunBrushCallback" title="GimpRunBrushCallback ()"><span class="type">GimpRunBrushCallback</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_brush_select_widget_new</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
a <span class="type">GimpBrush</span>. This widget is suitable for placement in a table in
a plug-in dialog.</p>
<div class="refsect3">
<a name="gimp-brush-select-widget-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>Title of the dialog to use or <code class="literal">NULL</code> to use the default title.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>brush_name</p></td>
<td class="parameter_description"><p>Initial brush name or <code class="literal">NULL</code> to use current selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>Initial opacity. -1 means to use current opacity.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>Initial spacing. -1 means to use current spacing.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>Initial paint mode. -1 means to use current paint mode.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>A function to call when the selected brush changes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A pointer to arbitrary data to be used in the call to <em class="parameter"><code>callback</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-select-widget-new.returns"></a><h4>Returns</h4>
<p> A <span class="type">GtkWidget</span> that you can use in your UI.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-select-widget-close"></a><h3>gimp_brush_select_widget_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_brush_select_widget_close (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_brush_select_widget_close</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Closes the popup window associated with <em class="parameter"><code>widget</code></em>
.</p>
<div class="refsect3">
<a name="gimp-brush-select-widget-close.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>A brush select widget.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-select-widget-set"></a><h3>gimp_brush_select_widget_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_brush_select_widget_set (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *brush_name</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
<em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_brush_select_widget_set</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Sets the current brush and other values for the brush select
widget. Calls the callback function if one was supplied in the
call to <a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-new" title="gimp_brush_select_widget_new ()"><code class="function">gimp_brush_select_widget_new()</code></a>.</p>
<div class="refsect3">
<a name="gimp-brush-select-widget-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>A brush select widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>brush_name</p></td>
<td class="parameter_description"><p>Brush name to set; <code class="literal">NULL</code> means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>Opacity to set. -1.0 means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>Spacing to set. -1 means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>Paint mode to set. -1 means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>