← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimppatternselect.xml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimppatternselect.xml
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">
4
 
 
5
 
<refentry id="libgimp-gimppatternselect">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="libgimp-gimppatternselect.top_of_page">gimppatternselect</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimppatternselect</refname>
14
 
<refpurpose>Functions providing a pattern selection dialog.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimp-gimppatternselect.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
<link linkend="void">void</link>                (<link linkend="GimpRunPatternCallback">*GimpRunPatternCallback</link>)           (const <link linkend="gchar">gchar</link> *pattern_name,
22
 
                                                         <link linkend="gint">gint</link> width,
23
 
                                                         <link linkend="gint">gint</link> height,
24
 
                                                         <link linkend="gint">gint</link> bpp,
25
 
                                                         const <link linkend="guchar">guchar</link> *mask_data,
26
 
                                                         <link linkend="gboolean">gboolean</link> dialog_closing,
27
 
                                                         <link linkend="gpointer">gpointer</link> user_data);
28
 
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-pattern-select-new">gimp_pattern_select_new</link>             (const <link linkend="gchar">gchar</link> *title,
29
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name,
30
 
                                                         <link linkend="GimpRunPatternCallback">GimpRunPatternCallback</link> callback,
31
 
                                                         <link linkend="gpointer">gpointer</link> data);
32
 
<link linkend="void">void</link>                <link linkend="gimp-pattern-select-destroy">gimp_pattern_select_destroy</link>         (const <link linkend="gchar">gchar</link> *pattern_callback);
33
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-patterns-popup">gimp_patterns_popup</link>                 (const <link linkend="gchar">gchar</link> *pattern_callback,
34
 
                                                         const <link linkend="gchar">gchar</link> *popup_title,
35
 
                                                         const <link linkend="gchar">gchar</link> *initial_pattern);
36
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-patterns-close-popup">gimp_patterns_close_popup</link>           (const <link linkend="gchar">gchar</link> *pattern_callback);
37
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-patterns-set-popup">gimp_patterns_set_popup</link>             (const <link linkend="gchar">gchar</link> *pattern_callback,
38
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name);
39
 
</synopsis>
40
 
</refsynopsisdiv>
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
 
<refsect1 id="libgimp-gimppatternselect.description" role="desc">
51
 
<title role="desc.title">Description</title>
52
 
<para>
53
 
Functions providing a pattern selection dialog.
54
 
</para>
55
 
</refsect1>
56
 
 
57
 
<refsect1 id="libgimp-gimppatternselect.details" role="details">
58
 
<title role="details.title">Details</title>
59
 
<refsect2 id="GimpRunPatternCallback" role="function">
60
 
<title>GimpRunPatternCallback ()</title>
61
 
<indexterm zone="GimpRunPatternCallback"><primary sortas="GimpRunPatternCallback">GimpRunPatternCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpRunPatternCallback)           (const <link linkend="gchar">gchar</link> *pattern_name,
62
 
                                                         <link linkend="gint">gint</link> width,
63
 
                                                         <link linkend="gint">gint</link> height,
64
 
                                                         <link linkend="gint">gint</link> bpp,
65
 
                                                         const <link linkend="guchar">guchar</link> *mask_data,
66
 
                                                         <link linkend="gboolean">gboolean</link> dialog_closing,
67
 
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
68
 
<para>
69
 
</para><variablelist role="params">
70
 
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
71
 
<listitem><simpara>
72
 
</simpara></listitem></varlistentry>
73
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
74
 
<listitem><simpara>
75
 
</simpara></listitem></varlistentry>
76
 
<varlistentry><term><parameter>height</parameter>&#160;:</term>
77
 
<listitem><simpara>
78
 
</simpara></listitem></varlistentry>
79
 
<varlistentry><term><parameter>bpp</parameter>&#160;:</term>
80
 
<listitem><simpara>
81
 
</simpara></listitem></varlistentry>
82
 
<varlistentry><term><parameter>mask_data</parameter>&#160;:</term>
83
 
<listitem><simpara>
84
 
</simpara></listitem></varlistentry>
85
 
<varlistentry><term><parameter>dialog_closing</parameter>&#160;:</term>
86
 
<listitem><simpara>
87
 
</simpara></listitem></varlistentry>
88
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
89
 
<listitem><simpara>
90
 
</simpara></listitem></varlistentry>
91
 
</variablelist></refsect2>
92
 
<refsect2 id="gimp-pattern-select-new" role="function">
93
 
<title>gimp_pattern_select_new ()</title>
94
 
<indexterm zone="gimp-pattern-select-new"><primary sortas="gimp_pattern_select_new">gimp_pattern_select_new</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_pattern_select_new             (const <link linkend="gchar">gchar</link> *title,
95
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name,
96
 
                                                         <link linkend="GimpRunPatternCallback">GimpRunPatternCallback</link> callback,
97
 
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
98
 
<para>
99
 
</para><variablelist role="params">
100
 
<varlistentry><term><parameter>title</parameter>&#160;:</term>
101
 
<listitem><simpara>
102
 
</simpara></listitem></varlistentry>
103
 
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
104
 
<listitem><simpara>
105
 
</simpara></listitem></varlistentry>
106
 
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
107
 
<listitem><simpara>
108
 
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
110
 
<listitem><simpara>
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
113
 
</simpara></listitem></varlistentry>
114
 
</variablelist></refsect2>
115
 
<refsect2 id="gimp-pattern-select-destroy" role="function">
116
 
<title>gimp_pattern_select_destroy ()</title>
117
 
<indexterm zone="gimp-pattern-select-destroy"><primary sortas="gimp_pattern_select_destroy">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>
118
 
<para>
119
 
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>pattern_callback</parameter>&#160;:</term>
121
 
<listitem><simpara>
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist></refsect2>
124
 
<refsect2 id="gimp-patterns-popup" role="function">
125
 
<title>gimp_patterns_popup ()</title>
126
 
<indexterm zone="gimp-patterns-popup"><primary sortas="gimp_patterns_popup">gimp_patterns_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_patterns_popup                 (const <link linkend="gchar">gchar</link> *pattern_callback,
127
 
                                                         const <link linkend="gchar">gchar</link> *popup_title,
128
 
                                                         const <link linkend="gchar">gchar</link> *initial_pattern);</programlisting>
129
 
<para>
130
 
Invokes the Gimp pattern selection.
131
 
</para>
132
 
<para>
133
 
This procedure opens the pattern selection dialog.</para>
134
 
<para>
135
 
</para><variablelist role="params">
136
 
<varlistentry><term><parameter>pattern_callback</parameter>&#160;:</term>
137
 
<listitem><simpara> The callback PDB proc to call when pattern selection is made.
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>popup_title</parameter>&#160;:</term>
140
 
<listitem><simpara> Title of the pattern selection dialog.
141
 
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><parameter>initial_pattern</parameter>&#160;:</term>
143
 
<listitem><simpara> The name of the pattern to set as the first selected.
144
 
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
146
 
</simpara></listitem></varlistentry>
147
 
</variablelist></refsect2>
148
 
<refsect2 id="gimp-patterns-close-popup" role="function">
149
 
<title>gimp_patterns_close_popup ()</title>
150
 
<indexterm zone="gimp-patterns-close-popup"><primary sortas="gimp_patterns_close_popup">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>
151
 
<para>
152
 
Close the pattern selection dialog.
153
 
</para>
154
 
<para>
155
 
This procedure closes an opened pattern selection dialog.</para>
156
 
<para>
157
 
</para><variablelist role="params">
158
 
<varlistentry><term><parameter>pattern_callback</parameter>&#160;:</term>
159
 
<listitem><simpara> The name of the callback registered for this pop-up.
160
 
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
162
 
</simpara></listitem></varlistentry>
163
 
</variablelist></refsect2>
164
 
<refsect2 id="gimp-patterns-set-popup" role="function">
165
 
<title>gimp_patterns_set_popup ()</title>
166
 
<indexterm zone="gimp-patterns-set-popup"><primary sortas="gimp_patterns_set_popup">gimp_patterns_set_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_patterns_set_popup             (const <link linkend="gchar">gchar</link> *pattern_callback,
167
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
168
 
<para>
169
 
Sets the current pattern in a pattern selection dialog.
170
 
</para>
171
 
<para>
172
 
Sets the current pattern in a pattern selection dialog.</para>
173
 
<para>
174
 
</para><variablelist role="params">
175
 
<varlistentry><term><parameter>pattern_callback</parameter>&#160;:</term>
176
 
<listitem><simpara> The name of the callback registered for this pop-up.
177
 
</simpara></listitem></varlistentry>
178
 
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
179
 
<listitem><simpara> The name of the pattern to set as selected.
180
 
</simpara></listitem></varlistentry>
181
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
182
 
</simpara></listitem></varlistentry>
183
 
</variablelist></refsect2>
184
 
 
185
 
</refsect1>
186
 
 
187
 
 
188
 
 
189
 
 
190
 
</refentry>