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
|
<?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-gimppatternmenu">
<refmeta>
<refentrytitle role="top_of_page">gimppatternmenu</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimppatternmenu</refname>
<refpurpose>A widget for selecting patterns.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-pattern-select-widget-new">gimp_pattern_select_widget_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-widget-close">gimp_pattern_select_widget_close</link>
(<link linkend="GtkWidget">GtkWidget</link> *widget);
<link linkend="void">void</link> <link linkend="gimp-pattern-select-widget-set">gimp_pattern_select_widget_set</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *pattern_name);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
A widget for selecting patterns.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-pattern-select-widget-new" role="function"/>gimp_pattern_select_widget_new ()</title>
<indexterm><primary>gimp_pattern_select_widget_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_pattern_select_widget_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>
Creates a new <link linkend="GtkWidget"><type>GtkWidget</type></link> that completely controls the selection of
a pattern. This widget is suitable for placement in a table in a
plug-in dialog.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> Title of the dialog to use or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use the default title.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pattern_name</parameter> :</term>
<listitem><simpara> Initial pattern name or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use current selection.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> A function to call when the selected pattern changes.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> A pointer to arbitary data to be used in the call to <parameter>callback</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkWidget"><type>GtkWidget</type></link> that you can use in your UI.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pattern-select-widget-close" role="function"/>gimp_pattern_select_widget_close ()</title>
<indexterm><primary>gimp_pattern_select_widget_close</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pattern_select_widget_close
(<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
<para>
Closes the popup window associated with <parameter>widget</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> A pattern select widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pattern-select-widget-set" role="function"/>gimp_pattern_select_widget_set ()</title>
<indexterm><primary>gimp_pattern_select_widget_set</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pattern_select_widget_set (<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
<para>
Sets the current pattern for the pattern select widget. Calls the
callback function if one was supplied in the call to
<link linkend="gimp-pattern-select-widget-new"><function>gimp_pattern_select_widget_new()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> A pattern select widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pattern_name</parameter> :</term>
<listitem><simpara> Pattern name to set. NULL means no change.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|