1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="GimpGradientSelectButton">
7
<refentrytitle role="top_of_page">GimpGradientSelectButton</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
13
<refname>GimpGradientSelectButton</refname>
14
<refpurpose></refpurpose>
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
18
<refsynopsisdiv role="synopsis">
19
<title role="synopsis.title">Synopsis</title>
25
<link linkend="GimpGradientSelectButton-struct">GimpGradientSelectButton</link>;
26
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-gradient-select-button-new">gimp_gradient_select_button_new</link> (const <link linkend="gchar">gchar</link> *title,
27
const <link linkend="gchar">gchar</link> *gradient_name);
28
const <link linkend="gchar">gchar</link>* <link linkend="gimp-gradient-select-button-get-gradient">gimp_gradient_select_button_get_gradient</link>
29
(<link linkend="GimpGradientSelectButton">GimpGradientSelectButton</link> *button);
30
<link linkend="void">void</link> <link linkend="gimp-gradient-select-button-set-gradient">gimp_gradient_select_button_set_gradient</link>
31
(<link linkend="GimpGradientSelectButton">GimpGradientSelectButton</link> *button,
32
const <link linkend="gchar">gchar</link> *gradient_name);
37
<refsect1 role="object_hierarchy">
38
<title role="object_hierarchy.title">Object Hierarchy</title>
41
<link linkend="GObject">GObject</link>
42
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
43
+----<link linkend="GtkObject">GtkObject</link>
44
+----<link linkend="GtkWidget">GtkWidget</link>
45
+----<link linkend="GtkContainer">GtkContainer</link>
46
+----<link linkend="GtkBox">GtkBox</link>
47
+----<link linkend="GtkHBox">GtkHBox</link>
48
+----<link linkend="GimpSelectButton">GimpSelectButton</link>
49
+----GimpGradientSelectButton
56
<refsect1 role="impl_interfaces">
57
<title role="impl_interfaces.title">Implemented Interfaces</title>
59
GimpGradientSelectButton implements
60
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
65
<refsect1 role="properties">
66
<title role="properties.title">Properties</title>
69
"<link linkend="GimpGradientSelectButton--gradient-name">gradient-name</link>" <link linkend="gchararray">gchararray</link> : Read / Write
70
"<link linkend="GimpGradientSelectButton--title">title</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
74
<refsect1 role="signal_proto">
75
<title role="signal_proto.title">Signals</title>
78
"<link linkend="GimpGradientSelectButton-gradient-set">gradient-set</link>" : Run First
83
<refsect1 role="desc">
84
<title role="desc.title">Description</title>
90
<refsect1 role="details">
91
<title role="details.title">Details</title>
93
<title><anchor id="GimpGradientSelectButton-struct" role="struct"/>GimpGradientSelectButton</title>
94
<indexterm><primary>GimpGradientSelectButton</primary></indexterm><programlisting>typedef struct _GimpGradientSelectButton GimpGradientSelectButton;</programlisting>
99
<title><anchor id="gimp-gradient-select-button-new" role="function" condition="since:GIMP 2.4"/>gimp_gradient_select_button_new ()</title>
100
<indexterm role="GIMP 2.4"><primary>gimp_gradient_select_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_gradient_select_button_new (const <link linkend="gchar">gchar</link> *title,
101
const <link linkend="gchar">gchar</link> *gradient_name);</programlisting>
103
Creates a new <link linkend="GtkWidget"><type>GtkWidget</type></link> that completely controls the selection of
104
a gradient. This widget is suitable for placement in a table in a
105
plug-in dialog.</para>
108
</para><variablelist role="params">
109
<varlistentry><term><parameter>title</parameter> :</term>
110
<listitem><simpara> Title of the dialog to use or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use the default title.
111
</simpara></listitem></varlistentry>
112
<varlistentry><term><parameter>gradient_name</parameter> :</term>
113
<listitem><simpara> Initial gradient name.
114
</simpara></listitem></varlistentry>
115
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkWidget"><type>GtkWidget</type></link> that you can use in your UI.
117
</simpara></listitem></varlistentry>
118
</variablelist><para role="since">Since GIMP 2.4
121
<title><anchor id="gimp-gradient-select-button-get-gradient" role="function" condition="since:GIMP 2.4"/>gimp_gradient_select_button_get_gradient ()</title>
122
<indexterm role="GIMP 2.4"><primary>gimp_gradient_select_button_get_gradient</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_gradient_select_button_get_gradient
123
(<link linkend="GimpGradientSelectButton">GimpGradientSelectButton</link> *button);</programlisting>
125
Retrieves the name of currently selected gradient.</para>
128
</para><variablelist role="params">
129
<varlistentry><term><parameter>button</parameter> :</term>
130
<listitem><simpara> A <link linkend="GimpGradientSelectButton"><type>GimpGradientSelectButton</type></link>
131
</simpara></listitem></varlistentry>
132
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an internal copy of the gradient name which must not be freed.
134
</simpara></listitem></varlistentry>
135
</variablelist><para role="since">Since GIMP 2.4
138
<title><anchor id="gimp-gradient-select-button-set-gradient" role="function" condition="since:GIMP 2.4"/>gimp_gradient_select_button_set_gradient ()</title>
139
<indexterm role="GIMP 2.4"><primary>gimp_gradient_select_button_set_gradient</primary></indexterm><programlisting><link linkend="void">void</link> gimp_gradient_select_button_set_gradient
140
(<link linkend="GimpGradientSelectButton">GimpGradientSelectButton</link> *button,
141
const <link linkend="gchar">gchar</link> *gradient_name);</programlisting>
143
Sets the current gradient for the gradient select button.</para>
146
</para><variablelist role="params">
147
<varlistentry><term><parameter>button</parameter> :</term>
148
<listitem><simpara> A <link linkend="GimpGradientSelectButton"><type>GimpGradientSelectButton</type></link>
149
</simpara></listitem></varlistentry>
150
<varlistentry><term><parameter>gradient_name</parameter> :</term>
151
<listitem><simpara> Gradient name to set.
152
</simpara></listitem></varlistentry>
153
</variablelist><para role="since">Since GIMP 2.4
157
<refsect1 role="property_details">
158
<title role="property_details.title">Property Details</title>
159
<refsect2><title><anchor id="GimpGradientSelectButton--gradient-name"/>The "<literal>gradient-name</literal>" property</title>
160
<indexterm role="GIMP 2.4"><primary>GimpGradientSelectButton:gradient-name</primary></indexterm><programlisting> "gradient-name" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
162
The name of the currently selected gradient.</para>
165
</para><para>Default value: NULL</para>
169
<refsect2><title><anchor id="GimpGradientSelectButton--title"/>The "<literal>title</literal>" property</title>
170
<indexterm role="GIMP 2.4"><primary>GimpGradientSelectButton:title</primary></indexterm><programlisting> "title" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
172
The title to be used for the gradient selection popup dialog.</para>
175
</para><para>Default value: "Gradient Selection"</para>
182
<refsect1 role="signals">
183
<title role="signals.title">Signal Details</title>
184
<refsect2><title><anchor id="GimpGradientSelectButton-gradient-set"/>The "gradient-set" signal</title>
185
<indexterm role="GIMP 2.4"><primary>GimpGradientSelectButton::gradient-set</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpGradientSelectButton">GimpGradientSelectButton</link> *widget,
186
<link linkend="gchar">gchar</link> *gradient_name,
187
<link linkend="gint">gint</link> width,
188
<link linkend="gpointer">gpointer</link> grad_data,
189
<link linkend="gboolean">gboolean</link> dialog_closing,
190
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
192
The ::gradient-set signal is emitted when the user selects a gradient.</para>
195
</para><variablelist role="params">
196
<varlistentry><term><parameter>widget</parameter> :</term>
197
<listitem><simpara> the object which received the signal.
198
</simpara></listitem></varlistentry>
199
<varlistentry><term><parameter>gradient_name</parameter> :</term>
200
<listitem><simpara> the name of the currently selected gradient.
201
</simpara></listitem></varlistentry>
202
<varlistentry><term><parameter>width</parameter> :</term>
203
<listitem><simpara> width of the gradient
204
</simpara></listitem></varlistentry>
205
<varlistentry><term><parameter>grad_data</parameter> :</term>
206
<listitem><simpara> gradient data
207
</simpara></listitem></varlistentry>
208
<varlistentry><term><parameter>dialog_closing</parameter> :</term>
209
<listitem><simpara> whether the dialog was closed or not.
210
</simpara></listitem></varlistentry>
211
<varlistentry><term><parameter>user_data</parameter> :</term>
212
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
213
</variablelist><para>Since GIMP 2.4
added
removed
devel-docs/libgimp/xml/gimpgradientselectbutton.xml
