207 lines
10 KiB
XML
207 lines
10 KiB
XML
<?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-gimppatternselect">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">gimppatternselect</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimppatternselect</refname>
|
|
<refpurpose>Functions providing a pattern 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="GimpRunPatternCallback">*GimpRunPatternCallback</link>) (const <link linkend="gchar">gchar</link> *pattern_name,
|
|
<link linkend="gint">gint</link> width,
|
|
<link linkend="gint">gint</link> height,
|
|
<link linkend="gint">gint</link> bpp,
|
|
const <link linkend="guchar">guchar</link> *mask_data,
|
|
<link linkend="gboolean">gboolean</link> dialog_closing,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
const <link linkend="gchar">gchar</link>* <link linkend="gimp-pattern-select-new">gimp_pattern_select_new</link> (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *pattern_name,
|
|
<link linkend="GimpRunPatternCallback">GimpRunPatternCallback</link> callback,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> <link linkend="gimp-pattern-select-destroy">gimp_pattern_select_destroy</link> (const <link linkend="gchar">gchar</link> *pattern_callback);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-patterns-popup">gimp_patterns_popup</link> (const <link linkend="gchar">gchar</link> *pattern_callback,
|
|
const <link linkend="gchar">gchar</link> *popup_title,
|
|
const <link linkend="gchar">gchar</link> *initial_pattern);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-patterns-close-popup">gimp_patterns_close_popup</link> (const <link linkend="gchar">gchar</link> *pattern_callback);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-patterns-set-popup">gimp_patterns_set_popup</link> (const <link linkend="gchar">gchar</link> *pattern_callback,
|
|
const <link linkend="gchar">gchar</link> *pattern_name);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
Functions providing a pattern selection dialog.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpRunPatternCallback" role="function"/>GimpRunPatternCallback ()</title>
|
|
<indexterm><primary>GimpRunPatternCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRunPatternCallback) (const <link linkend="gchar">gchar</link> *pattern_name,
|
|
<link linkend="gint">gint</link> width,
|
|
<link linkend="gint">gint</link> height,
|
|
<link linkend="gint">gint</link> bpp,
|
|
const <link linkend="guchar">guchar</link> *mask_data,
|
|
<link linkend="gboolean">gboolean</link> dialog_closing,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>pattern_name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>width</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>height</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bpp</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_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-pattern-select-new" role="function"/>gimp_pattern_select_new ()</title>
|
|
<indexterm><primary>gimp_pattern_select_new</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_pattern_select_new (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *pattern_name,
|
|
<link linkend="GimpRunPatternCallback">GimpRunPatternCallback</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>pattern_name</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-pattern-select-destroy" role="function"/>gimp_pattern_select_destroy ()</title>
|
|
<indexterm><primary>gimp_pattern_select_destroy</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pattern_select_destroy (const <link linkend="gchar">gchar</link> *pattern_callback);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>pattern_callback</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-patterns-popup" role="function"/>gimp_patterns_popup ()</title>
|
|
<indexterm><primary>gimp_patterns_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_patterns_popup (const <link linkend="gchar">gchar</link> *pattern_callback,
|
|
const <link linkend="gchar">gchar</link> *popup_title,
|
|
const <link linkend="gchar">gchar</link> *initial_pattern);</programlisting>
|
|
<para>
|
|
Invokes the Gimp pattern selection.
|
|
</para>
|
|
<para>
|
|
This procedure opens the pattern selection dialog.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>pattern_callback</parameter> :</term>
|
|
<listitem><simpara> The callback PDB proc to call when pattern selection is made.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>popup_title</parameter> :</term>
|
|
<listitem><simpara> Title of the pattern selection dialog.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>initial_pattern</parameter> :</term>
|
|
<listitem><simpara> The name of the pattern to set as the first selected.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-patterns-close-popup" role="function"/>gimp_patterns_close_popup ()</title>
|
|
<indexterm><primary>gimp_patterns_close_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_patterns_close_popup (const <link linkend="gchar">gchar</link> *pattern_callback);</programlisting>
|
|
<para>
|
|
Close the pattern selection dialog.
|
|
</para>
|
|
<para>
|
|
This procedure closes an opened pattern selection dialog.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>pattern_callback</parameter> :</term>
|
|
<listitem><simpara> The name of the callback registered for this pop-up.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-patterns-set-popup" role="function"/>gimp_patterns_set_popup ()</title>
|
|
<indexterm><primary>gimp_patterns_set_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_patterns_set_popup (const <link linkend="gchar">gchar</link> *pattern_callback,
|
|
const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
|
|
<para>
|
|
Sets the current pattern in a pattern selection dialog.
|
|
</para>
|
|
<para>
|
|
Sets the current pattern in a pattern selection dialog.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>pattern_callback</parameter> :</term>
|
|
<listitem><simpara> The name of the callback registered for this pop-up.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pattern_name</parameter> :</term>
|
|
<listitem><simpara> The name of the pattern 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>
|