Files
gimp/devel-docs/libgimp/html/libgimp-gimpgradientmenu.html
2010-08-11 01:16:57 -04:00

177 lines
7.4 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>gimpgradientmenu</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="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="prev" href="libgimp-gimpfontmenu.html" title="gimpfontmenu">
<link rel="next" href="libgimp-gimppalettemenu.html" title="gimppalettemenu">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#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 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&#160;III.&#160;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" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpfontmenu.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpui.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-gimppalettemenu.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="#id2566190" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2660182" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpgradientmenu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2566190"></a><span class="refentrytitle">gimpgradientmenu</span>
</h2>
<p>gimpgradientmenu &#8212; A widget for selecting gradients.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
GtkWidget* <a href="libgimp-gimpgradientmenu.html#gimp-gradient-select-widget-new">gimp_gradient_select_widget_new</a> (const gchar *title,
const gchar *gradient_name,
<a href="libgimp-gimpgradientselect.html#GimpRunGradientCallback">GimpRunGradientCallback</a> callback,
gpointer data);
void <a href="libgimp-gimpgradientmenu.html#gimp-gradient-select-widget-close">gimp_gradient_select_widget_close</a>
(GtkWidget *widget);
void <a href="libgimp-gimpgradientmenu.html#gimp-gradient-select-widget-set">gimp_gradient_select_widget_set</a> (GtkWidget *widget,
const gchar *gradient_name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2660182"></a><h2>Description</h2>
<p>
A widget for selecting gradients.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2660197"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2660208"></a><h3>
<a name="gimp-gradient-select-widget-new"></a>gimp_gradient_select_widget_new ()</h3>
<a class="indexterm" name="id2660219"></a><pre class="programlisting">GtkWidget* gimp_gradient_select_widget_new (const gchar *title,
const gchar *gradient_name,
<a href="libgimp-gimpgradientselect.html#GimpRunGradientCallback">GimpRunGradientCallback</a> callback,
gpointer data);</pre>
<p>
Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
a gradient. 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>&#160;:</span></td>
<td> Title of the dialog to use or <code class="literal">NULL</code> to use the default title.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>gradient_name</code></em>&#160;:</span></td>
<td> Initial gradient name or <code class="literal">NULL</code> to use current selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></td>
<td> A function to call when the selected gradient changes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> A pointer to arbitary data to be used in the call to
<em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A <span class="type">GtkWidget</span> that you can use in your UI.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2660382"></a><h3>
<a name="gimp-gradient-select-widget-close"></a>gimp_gradient_select_widget_close ()</h3>
<a class="indexterm" name="id2653072"></a><pre class="programlisting">void gimp_gradient_select_widget_close
(GtkWidget *widget);</pre>
<p>
Closes the popup window associated with <em class="parameter"><code>widget</code></em>.</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>&#160;:</span></td>
<td> A gradient select widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2653127"></a><h3>
<a name="gimp-gradient-select-widget-set"></a>gimp_gradient_select_widget_set ()</h3>
<a class="indexterm" name="id2653138"></a><pre class="programlisting">void gimp_gradient_select_widget_set (GtkWidget *widget,
const gchar *gradient_name);</pre>
<p>
Sets the current gradient for the gradient select widget. Calls
the callback function if one was supplied in the call to
<a href="libgimp-gimpgradientmenu.html#gimp-gradient-select-widget-new"><code class="function">gimp_gradient_select_widget_new()</code></a>.</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>&#160;:</span></td>
<td> A gradient select widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>gradient_name</code></em>&#160;:</span></td>
<td> Gradient name to set.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>