Imported Upstream version 2.2.4
This commit is contained in:
Ari Pollak
203
devel-docs/libgimp/xml/gimpgradientselect.xml
Normal file
203
devel-docs/libgimp/xml/gimpgradientselect.xml
Normal file
@ -0,0 +1,203 @@
|
||||
<?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>gimpgradientselect</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimpgradientselect</refname><refpurpose>Functions providing a gradient selection dialog.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><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>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Functions providing a gradient selection dialog.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpRunGradientCallback"/>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> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>grad_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>dialog_closing</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-gradient-select-new"/>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> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>gradient_name</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>sample_size</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-gradient-select-destroy"/>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> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-gradients-popup"/>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> :</term>
|
||||
<listitem><simpara> The callback PDB proc to call when gradient selection is made.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>popup_title</parameter> :</term>
|
||||
<listitem><simpara> Title to give the gradient popup window.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>initial_gradient</parameter> :</term>
|
||||
<listitem><simpara> The name of the pattern to set as the first selected.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>sample_size</parameter> :</term>
|
||||
<listitem><simpara> Size of the sample to return when the gradient is changed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-gradients-close-popup"/>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> :</term>
|
||||
<listitem><simpara> The name of the callback registered for this popup.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-gradients-set-popup"/>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> :</term>
|
||||
<listitem><simpara> The name of the callback registered for this popup.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>gradient_name</parameter> :</term>
|
||||
<listitem><simpara> The name of the gradient to set as selected.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
Reference in New Issue
Block a user