1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
|
<!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.10 (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="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"><nobr><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></nobr></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>;
GtkWidget* <a class="link" href="GimpGradientSelectButton.html#gimp-gradient-select-button-new" title="gimp_gradient_select_button_new ()">gimp_gradient_select_button_new</a> (const gchar *title,
const gchar *gradient_name);
const gchar* <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 gchar *gradient_name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpGradientSelectButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkHBox
+----<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 GtkBuildable.</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>" gchar* : Read / Write
"<a class="link" href="GimpGradientSelectButton.html#GimpGradientSelectButton--title" title='The "title" property'>title</a>" gchar* : 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">GtkWidget* gimp_gradient_select_button_new (const gchar *title,
const gchar *gradient_name);</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><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td> Title of the dialog to use or <code class="literal">NULL</code> 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 <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="gimp-gradient-select-button-get-gradient"></a><h3>gimp_gradient_select_button_get_gradient ()</h3>
<pre class="programlisting">const gchar* 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 gchar *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" gchar* : 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" gchar* : 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,
gchar *gradient_name,
gint width,
gpointer grad_data,
gboolean dialog_closing,
gpointer 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.10</div>
</body>
</html>
|