File: gimpgradientselect.xml

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (206 lines) | stat: -rw-r--r-- 10,474 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="libgimp-gimpgradientselect">
<refmeta>
<refentrytitle role="top_of_page">gimpgradientselect</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gimpgradientselect</refname>
<refpurpose>Functions providing a gradient selection dialog.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



<link linkend="void">void</link>        (<link linkend="GimpRunGradientCallback">*GimpRunGradientCallback</link>)      (const <link linkend="gchar">gchar</link> *gradient_name,
                                             <link linkend="gint">gint</link> width,
                                             const <link linkend="gdouble">gdouble</link> *grad_data,
                                             <link linkend="gboolean">gboolean</link> dialog_closing,
                                             <link linkend="gpointer">gpointer</link> user_data);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-gradient-select-new">gimp_gradient_select_new</link>       (const <link linkend="gchar">gchar</link> *title,
                                             const <link linkend="gchar">gchar</link> *gradient_name,
                                             <link linkend="gint">gint</link> sample_size,
                                             <link linkend="GimpRunGradientCallback">GimpRunGradientCallback</link> callback,
                                             <link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link>        <link linkend="gimp-gradient-select-destroy">gimp_gradient_select_destroy</link>    (const <link linkend="gchar">gchar</link> *gradient_callback);
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-gradients-popup">gimp_gradients_popup</link>            (const <link linkend="gchar">gchar</link> *gradient_callback,
                                             const <link linkend="gchar">gchar</link> *popup_title,
                                             const <link linkend="gchar">gchar</link> *initial_gradient,
                                             <link linkend="gint">gint</link> sample_size);
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-gradients-close-popup">gimp_gradients_close_popup</link>      (const <link linkend="gchar">gchar</link> *gradient_callback);
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-gradients-set-popup">gimp_gradients_set_popup</link>        (const <link linkend="gchar">gchar</link> *gradient_callback,
                                             const <link linkend="gchar">gchar</link> *gradient_name);
</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions providing a gradient selection dialog.
</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpRunGradientCallback" role="function"/>GimpRunGradientCallback ()</title>
<indexterm><primary>GimpRunGradientCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*GimpRunGradientCallback)      (const <link linkend="gchar">gchar</link> *gradient_name,
                                             <link linkend="gint">gint</link> width,
                                             const <link linkend="gdouble">gdouble</link> *grad_data,
                                             <link linkend="gboolean">gboolean</link> dialog_closing,
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gradient_name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>grad_data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dialog_closing</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradient-select-new" role="function"/>gimp_gradient_select_new ()</title>
<indexterm><primary>gimp_gradient_select_new</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_gradient_select_new       (const <link linkend="gchar">gchar</link> *title,
                                             const <link linkend="gchar">gchar</link> *gradient_name,
                                             <link linkend="gint">gint</link> sample_size,
                                             <link linkend="GimpRunGradientCallback">GimpRunGradientCallback</link> callback,
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>gradient_name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sample_size</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradient-select-destroy" role="function"/>gimp_gradient_select_destroy ()</title>
<indexterm><primary>gimp_gradient_select_destroy</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_gradient_select_destroy    (const <link linkend="gchar">gchar</link> *gradient_callback);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gradient_callback</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-popup" role="function"/>gimp_gradients_popup ()</title>
<indexterm><primary>gimp_gradients_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_gradients_popup            (const <link linkend="gchar">gchar</link> *gradient_callback,
                                             const <link linkend="gchar">gchar</link> *popup_title,
                                             const <link linkend="gchar">gchar</link> *initial_gradient,
                                             <link linkend="gint">gint</link> sample_size);</programlisting>
<para>
Invokes the Gimp gradients selection.
</para>
<para>
This procedure popups the gradients selection dialog.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gradient_callback</parameter>&nbsp;:</term>
<listitem><simpara> The callback PDB proc to call when gradient selection is made.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>popup_title</parameter>&nbsp;:</term>
<listitem><simpara> Title to give the gradient popup window.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>initial_gradient</parameter>&nbsp;:</term>
<listitem><simpara> The name of the pattern to set as the first selected.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sample_size</parameter>&nbsp;:</term>
<listitem><simpara> Size of the sample to return when the gradient is changed.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-close-popup" role="function"/>gimp_gradients_close_popup ()</title>
<indexterm><primary>gimp_gradients_close_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_gradients_close_popup      (const <link linkend="gchar">gchar</link> *gradient_callback);</programlisting>
<para>
Popdown the Gimp gradient selection.
</para>
<para>
This procedure closes an opened gradient selection dialog.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gradient_callback</parameter>&nbsp;:</term>
<listitem><simpara> The name of the callback registered for this popup.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-set-popup" role="function"/>gimp_gradients_set_popup ()</title>
<indexterm><primary>gimp_gradients_set_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_gradients_set_popup        (const <link linkend="gchar">gchar</link> *gradient_callback,
                                             const <link linkend="gchar">gchar</link> *gradient_name);</programlisting>
<para>
Sets the current gradient selection in a popup.
</para>
<para>
Sets the current gradient selection in a popup.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gradient_callback</parameter>&nbsp;:</term>
<listitem><simpara> The name of the callback registered for this popup.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>gradient_name</parameter>&nbsp;:</term>
<listitem><simpara> The name of the gradient to set as selected.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>