347 lines
16 KiB
HTML
347 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>GimpGradientSelectButton</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
||
<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="GimpFontSelectButton.html" title="GimpFontSelectButton">
|
||
<link rel="next" href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">
|
||
<meta name="generator" content="GTK-Doc V1.11 (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-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
|
||
<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="GimpFontSelectButton.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="GimpPaletteSelectButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
||
</tr>
|
||
<tr><td colspan="5" class="shortcuts">
|
||
<a href="#GimpGradientSelectButton.synopsis" class="shortcut">Top</a>
|
||
|
|
||
<a href="#GimpGradientSelectButton.description" class="shortcut">Description</a>
|
||
|
|
||
<a href="#GimpGradientSelectButton.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
||
|
|
||
<a href="#GimpGradientSelectButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
||
|
|
||
<a href="#GimpGradientSelectButton.properties" class="shortcut">Properties</a>
|
||
|
|
||
<a href="#GimpGradientSelectButton.signals" class="shortcut">Signals</a>
|
||
</td></tr>
|
||
</table>
|
||
<div class="refentry" lang="en">
|
||
<a name="GimpGradientSelectButton"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GimpGradientSelectButton.top_of_page"></a>GimpGradientSelectButton</span></h2>
|
||
<p>GimpGradientSelectButton</p>
|
||
</td>
|
||
<td valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsynopsisdiv">
|
||
<a name="GimpGradientSelectButton.synopsis"></a><h2>Synopsis</h2>
|
||
<pre class="synopsis">
|
||
<a class="link" href="GimpGradientSelectButton.html#GimpGradientSelectButton-struct" title="GimpGradientSelectButton">GimpGradientSelectButton</a>;
|
||
<a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
|
||
>GtkWidget</a> * <a class="link" href="GimpGradientSelectButton.html#gimp-gradient-select-button-new" title="gimp_gradient_select_button_new ()">gimp_gradient_select_button_new</a> (const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *gradient_name);
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> * <a class="link" href="GimpGradientSelectButton.html#gimp-gradient-select-button-get-gradient" title="gimp_gradient_select_button_get_gradient ()">gimp_gradient_select_button_get_gradient</a>
|
||
(<a class="link" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton">GimpGradientSelectButton</a> *button);
|
||
void <a class="link" href="GimpGradientSelectButton.html#gimp-gradient-select-button-set-gradient" title="gimp_gradient_select_button_set_gradient ()">gimp_gradient_select_button_set_gradient</a>
|
||
(<a class="link" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton">GimpGradientSelectButton</a> *button,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *gradient_name);
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="synopsis">
|
||
<a
|
||
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
|
||
>GObject</a>
|
||
+----<a
|
||
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
|
||
>GInitiallyUnowned</a>
|
||
+----<a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
|
||
>GtkObject</a>
|
||
+----<a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
|
||
>GtkWidget</a>
|
||
+----<a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
|
||
>GtkContainer</a>
|
||
+----<a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
|
||
>GtkBox</a>
|
||
+----<a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkHBox.html"
|
||
>GtkHBox</a>
|
||
+----<a class="link" href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
|
||
+----GimpGradientSelectButton
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
|
||
<p>
|
||
GimpGradientSelectButton implements
|
||
AtkImplementorIface and <a
|
||
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
|
||
>GtkBuildable</a>.</p>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.properties"></a><h2>Properties</h2>
|
||
<pre class="synopsis">
|
||
"<a class="link" href="GimpGradientSelectButton.html#GimpGradientSelectButton--gradient-name" title='The "gradient-name" property'>gradient-name</a>" <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* : Read / Write
|
||
"<a class="link" href="GimpGradientSelectButton.html#GimpGradientSelectButton--title" title='The "title" property'>title</a>" <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* : Read / Write / Construct Only
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.signals"></a><h2>Signals</h2>
|
||
<pre class="synopsis">
|
||
"<a class="link" href="GimpGradientSelectButton.html#GimpGradientSelectButton-gradient-set" title='The "gradient-set" signal'>gradient-set</a>" : Run First
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.description"></a><h2>Description</h2>
|
||
<p>
|
||
</p>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.details"></a><h2>Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpGradientSelectButton-struct"></a><h3>GimpGradientSelectButton</h3>
|
||
<pre class="programlisting">typedef struct _GimpGradientSelectButton GimpGradientSelectButton;</pre>
|
||
<p>
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-gradient-select-button-new"></a><h3>gimp_gradient_select_button_new ()</h3>
|
||
<pre class="programlisting"><a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
|
||
>GtkWidget</a> * gimp_gradient_select_button_new (const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *gradient_name);</pre>
|
||
<p>
|
||
Creates a new <a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
|
||
><span class="type">GtkWidget</span></a> 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><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
|
||
<td> Title of the dialog to use or <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
|
||
><code class="literal">NULL</code></a> to use the default title.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>gradient_name</code></em> :</span></p></td>
|
||
<td> Initial gradient name.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> A <a
|
||
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
|
||
><span class="type">GtkWidget</span></a> 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="gimp-gradient-select-button-get-gradient"></a><h3>gimp_gradient_select_button_get_gradient ()</h3>
|
||
<pre class="programlisting">const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> * gimp_gradient_select_button_get_gradient
|
||
(<a class="link" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton">GimpGradientSelectButton</a> *button);</pre>
|
||
<p>
|
||
Retrieves the name of currently selected gradient.</p>
|
||
<p>
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
|
||
<td> A <a class="link" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton"><span class="type">GimpGradientSelectButton</span></a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> an internal copy of the gradient 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="gimp-gradient-select-button-set-gradient"></a><h3>gimp_gradient_select_button_set_gradient ()</h3>
|
||
<pre class="programlisting">void gimp_gradient_select_button_set_gradient
|
||
(<a class="link" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton">GimpGradientSelectButton</a> *button,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *gradient_name);</pre>
|
||
<p>
|
||
Sets the current gradient for the gradient select button.</p>
|
||
<p>
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
|
||
<td> A <a class="link" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton"><span class="type">GimpGradientSelectButton</span></a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>gradient_name</code></em> :</span></p></td>
|
||
<td> Gradient name to set.
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.property-details"></a><h2>Property Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpGradientSelectButton--gradient-name"></a><h3>The <code class="literal">"gradient-name"</code> property</h3>
|
||
<pre class="programlisting"> "gradient-name" <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* : Read / Write</pre>
|
||
<p>
|
||
The name of the currently selected gradient.</p>
|
||
<p>
|
||
</p>
|
||
<p>Default value: NULL</p>
|
||
<p>Since GIMP 2.4</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpGradientSelectButton--title"></a><h3>The <code class="literal">"title"</code> property</h3>
|
||
<pre class="programlisting"> "title" <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* : Read / Write / Construct Only</pre>
|
||
<p>
|
||
The title to be used for the gradient selection popup dialog.</p>
|
||
<p>
|
||
</p>
|
||
<p>Default value: "Gradient Selection"</p>
|
||
<p>Since GIMP 2.4</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpGradientSelectButton.signal-details"></a><h2>Signal Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpGradientSelectButton-gradient-set"></a><h3>The <code class="literal">"gradient-set"</code> signal</h3>
|
||
<pre class="programlisting">void user_function (<a class="link" href="GimpGradientSelectButton.html" title="GimpGradientSelectButton">GimpGradientSelectButton</a> *widget,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *gradient_name,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
|
||
>gint</a> width,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
|
||
>gpointer</a> grad_data,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> dialog_closing,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
|
||
>gpointer</a> user_data) : Run First</pre>
|
||
<p>
|
||
The ::gradient-set signal is emitted when the user selects a gradient.</p>
|
||
<p>
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
|
||
<td> the object which received the signal.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>gradient_name</code></em> :</span></p></td>
|
||
<td> the name of the currently selected gradient.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
||
<td> width of the gradient
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>grad_data</code></em> :</span></p></td>
|
||
<td> gradient data
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>dialog_closing</code></em> :</span></p></td>
|
||
<td> whether the dialog was closed or not.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></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>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.11</div>
|
||
</body>
|
||
</html>
|