← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2009-03-17 03:00:24 UTC
  • mfrom: (1.1.20 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317030024-gnp1dhd0hnt80f4h
Tags: 2.6.6-0ubuntu1
https://launchpad.net/bugs/344052
* New upstream release (LP: #344052)
* debian/patches/04_from_bugzilla_572403.patch:
  - Dropped, the fix is in the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimppatternselectbutton.xml
12
12
<refnamediv>
13
13
<refname>GimpPatternSelectButton</refname>
14
14
<refpurpose></refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpPatternSelectButton.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpPatternSelectButton-struct">GimpPatternSelectButton</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-pattern-select-button-new">gimp_pattern_select_button_new</link>      (const <link linkend="gchar">gchar</link> *title,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-pattern-select-button-new">gimp_pattern_select_button_new</link>      (const <link linkend="gchar">gchar</link> *title,
24
23
                                                         const <link linkend="gchar">gchar</link> *pattern_name);
25
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-pattern-select-button-get-pattern">gimp_pattern_select_button_get_pattern</link>
 
24
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-pattern-select-button-get-pattern">gimp_pattern_select_button_get_pattern</link>
26
25
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button);
27
26
<link linkend="void">void</link>                <link linkend="gimp-pattern-select-button-set-pattern">gimp_pattern_select_button_set_pattern</link>
28
27
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button,
43
42
                                       +----<link linkend="GimpSelectButton">GimpSelectButton</link>
44
43
                                             +----GimpPatternSelectButton
45
44
</synopsis>
46
 
 
47
45
</refsect1>
48
46
 
49
47
 
53
51
<para>
54
52
GimpPatternSelectButton implements
55
53
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
56
 
 
57
54
</refsect1>
58
55
 
59
56
 
76
73
<refsect1 id="GimpPatternSelectButton.description" role="desc">
77
74
<title role="desc.title">Description</title>
78
75
<para>
79
 
 
80
76
</para>
81
77
</refsect1>
82
78
 
84
80
<title role="details.title">Details</title>
85
81
<refsect2 id="GimpPatternSelectButton-struct" role="struct">
86
82
<title>GimpPatternSelectButton</title>
87
 
<indexterm zone="GimpPatternSelectButton-struct"><primary>GimpPatternSelectButton</primary></indexterm><programlisting>typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</programlisting>
 
83
<indexterm zone="GimpPatternSelectButton-struct"><primary sortas="GimpPatternSelectButton">GimpPatternSelectButton</primary></indexterm><programlisting>typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</programlisting>
88
84
<para>
89
 
 
90
85
</para></refsect2>
91
86
<refsect2 id="gimp-pattern-select-button-new" role="function" condition="since:GIMP 2.4">
92
87
<title>gimp_pattern_select_button_new ()</title>
93
 
<indexterm zone="gimp-pattern-select-button-new" role="GIMP 2.4"><primary>gimp_pattern_select_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_pattern_select_button_new      (const <link linkend="gchar">gchar</link> *title,
 
88
<indexterm zone="gimp-pattern-select-button-new" role="GIMP 2.4"><primary sortas="gimp_pattern_select_button_new">gimp_pattern_select_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_pattern_select_button_new      (const <link linkend="gchar">gchar</link> *title,
94
89
                                                         const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
95
90
<para>
96
91
Creates a new <link linkend="GtkWidget"><type>GtkWidget</type></link> that completely controls the selection of
97
92
a pattern.  This widget is suitable for placement in a table in a
98
93
plug-in dialog.</para>
99
94
<para>
100
 
 
101
95
</para><variablelist role="params">
102
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
103
 
<listitem><simpara>        Title of the dialog to use or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use the default title.
104
 
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><parameter>pattern_name</parameter>&nbsp;:</term>
106
 
<listitem><simpara> Initial pattern name or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use current selection.
107
 
</simpara></listitem></varlistentry>
108
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GtkWidget"><type>GtkWidget</type></link> that you can use in your UI.
 
96
<varlistentry><term><parameter>title</parameter>&#160;:</term>
 
97
<listitem><simpara>        Title of the dialog to use or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to use the default title.
 
98
</simpara></listitem></varlistentry>
 
99
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
 
100
<listitem><simpara> Initial pattern name or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to use current selection.
 
101
</simpara></listitem></varlistentry>
 
102
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GtkWidget"><type>GtkWidget</type></link> that you can use in your UI.
109
103
 
110
104
</simpara></listitem></varlistentry>
111
 
</variablelist><para role="since">Since  GIMP 2.4
112
 
</para></refsect2>
 
105
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
113
106
<refsect2 id="gimp-pattern-select-button-get-pattern" role="function" condition="since:GIMP 2.4">
114
107
<title>gimp_pattern_select_button_get_pattern ()</title>
115
 
<indexterm zone="gimp-pattern-select-button-get-pattern" role="GIMP 2.4"><primary>gimp_pattern_select_button_get_pattern</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_pattern_select_button_get_pattern
 
108
<indexterm zone="gimp-pattern-select-button-get-pattern" role="GIMP 2.4"><primary sortas="gimp_pattern_select_button_get_pattern">gimp_pattern_select_button_get_pattern</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_pattern_select_button_get_pattern
116
109
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button);</programlisting>
117
110
<para>
118
111
Retrieves the name of currently selected pattern.</para>
119
112
<para>
120
 
 
121
113
</para><variablelist role="params">
122
 
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
114
<varlistentry><term><parameter>button</parameter>&#160;:</term>
123
115
<listitem><simpara> A <link linkend="GimpPatternSelectButton"><type>GimpPatternSelectButton</type></link>
124
116
</simpara></listitem></varlistentry>
125
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an internal copy of the pattern name which must not be freed.
 
117
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an internal copy of the pattern name which must not be freed.
126
118
 
127
119
</simpara></listitem></varlistentry>
128
 
</variablelist><para role="since">Since  GIMP 2.4
129
 
</para></refsect2>
 
120
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
130
121
<refsect2 id="gimp-pattern-select-button-set-pattern" role="function" condition="since:GIMP 2.4">
131
122
<title>gimp_pattern_select_button_set_pattern ()</title>
132
 
<indexterm zone="gimp-pattern-select-button-set-pattern" role="GIMP 2.4"><primary>gimp_pattern_select_button_set_pattern</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_pattern_select_button_set_pattern
 
123
<indexterm zone="gimp-pattern-select-button-set-pattern" role="GIMP 2.4"><primary sortas="gimp_pattern_select_button_set_pattern">gimp_pattern_select_button_set_pattern</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_pattern_select_button_set_pattern
133
124
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button,
134
125
                                                         const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
135
126
<para>
136
127
Sets the current pattern for the pattern select button.</para>
137
128
<para>
138
 
 
139
129
</para><variablelist role="params">
140
 
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
 
130
<varlistentry><term><parameter>button</parameter>&#160;:</term>
141
131
<listitem><simpara> A <link linkend="GimpPatternSelectButton"><type>GimpPatternSelectButton</type></link>
142
132
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><parameter>pattern_name</parameter>&nbsp;:</term>
144
 
<listitem><simpara> Pattern name to set; <link linkend="NULL:CAPS"><literal>NULL</literal></link> means no change.
 
133
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
 
134
<listitem><simpara> Pattern name to set; <link linkend="NULL--CAPS"><literal>NULL</literal></link> means no change.
145
135
</simpara></listitem></varlistentry>
146
 
</variablelist><para role="since">Since  GIMP 2.4
147
 
</para></refsect2>
 
136
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
148
137
 
149
138
</refsect1>
150
139
<refsect1 id="GimpPatternSelectButton.property-details" role="property_details">
151
140
<title role="property_details.title">Property Details</title>
152
 
<refsect2 id="GimpPatternSelectButton--pattern-name"><title>The <literal>&quot;pattern-name&quot;</literal> property</title>
153
 
<indexterm zone="GimpPatternSelectButton--pattern-name" role="GIMP 2.4"><primary>GimpPatternSelectButton:pattern-name</primary></indexterm><programlisting>  &quot;pattern-name&quot;             <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
 
141
<refsect2 id="GimpPatternSelectButton--pattern-name" role="property"><title>The <literal>&quot;pattern-name&quot;</literal> property</title>
 
142
<indexterm zone="GimpPatternSelectButton--pattern-name" role="GIMP 2.4"><primary sortas="GimpPatternSelectButton:pattern-name">GimpPatternSelectButton:pattern-name</primary></indexterm><programlisting>  &quot;pattern-name&quot;             <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
154
143
<para>
155
144
The name of the currently selected pattern.</para>
156
145
<para>
157
 
 
158
146
</para><para>Default value: NULL</para>
159
 
<para>Since  GIMP 2.4
160
 
</para>
 
147
<para>Since GIMP 2.4</para>
161
148
</refsect2>
162
 
<refsect2 id="GimpPatternSelectButton--title"><title>The <literal>&quot;title&quot;</literal> property</title>
163
 
<indexterm zone="GimpPatternSelectButton--title" role="GIMP 2.4"><primary>GimpPatternSelectButton:title</primary></indexterm><programlisting>  &quot;title&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
149
<refsect2 id="GimpPatternSelectButton--title" role="property"><title>The <literal>&quot;title&quot;</literal> property</title>
 
150
<indexterm zone="GimpPatternSelectButton--title" role="GIMP 2.4"><primary sortas="GimpPatternSelectButton:title">GimpPatternSelectButton:title</primary></indexterm><programlisting>  &quot;title&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
164
151
<para>
165
152
The title to be used for the pattern selection popup dialog.</para>
166
153
<para>
167
 
 
168
154
</para><para>Default value: "Pattern Selection"</para>
169
 
<para>Since  GIMP 2.4
170
 
</para>
 
155
<para>Since GIMP 2.4</para>
171
156
</refsect2>
172
 
 
173
157
</refsect1>
174
158
 
175
159
<refsect1 id="GimpPatternSelectButton.signal-details" role="signals">
176
160
<title role="signals.title">Signal Details</title>
177
 
<refsect2 id="GimpPatternSelectButton-pattern-set"><title>The <literal>&quot;pattern-set&quot;</literal> signal</title>
178
 
<indexterm zone="GimpPatternSelectButton-pattern-set" role="GIMP 2.4"><primary>GimpPatternSelectButton::pattern-set</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *widget,
 
161
<refsect2 id="GimpPatternSelectButton-pattern-set" role="signal"><title>The <literal>&quot;pattern-set&quot;</literal> signal</title>
 
162
<indexterm zone="GimpPatternSelectButton-pattern-set" role="GIMP 2.4"><primary sortas="GimpPatternSelectButton::pattern-set">GimpPatternSelectButton::pattern-set</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *widget,
179
163
                                                        <link linkend="gchar">gchar</link>                   *pattern_name,
180
164
                                                        <link linkend="gint">gint</link>                     width,
181
165
                                                        <link linkend="gint">gint</link>                     height,
186
170
<para>
187
171
The ::pattern-set signal is emitted when the user selects a pattern.</para>
188
172
<para>
189
 
 
190
173
</para><variablelist role="params">
191
 
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
174
<varlistentry><term><parameter>widget</parameter>&#160;:</term>
192
175
<listitem><simpara> the object which received the signal.
193
176
</simpara></listitem></varlistentry>
194
 
<varlistentry><term><parameter>pattern_name</parameter>&nbsp;:</term>
 
177
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
195
178
<listitem><simpara> the name of the currently selected pattern.
196
179
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
180
<varlistentry><term><parameter>width</parameter>&#160;:</term>
198
181
<listitem><simpara> width of the pattern
199
182
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
183
<varlistentry><term><parameter>height</parameter>&#160;:</term>
201
184
<listitem><simpara> height of the pattern
202
185
</simpara></listitem></varlistentry>
203
 
<varlistentry><term><parameter>bpp</parameter>&nbsp;:</term>
 
186
<varlistentry><term><parameter>bpp</parameter>&#160;:</term>
204
187
<listitem><simpara> bpp of the pattern
205
188
</simpara></listitem></varlistentry>
206
 
<varlistentry><term><parameter>mask_data</parameter>&nbsp;:</term>
 
189
<varlistentry><term><parameter>mask_data</parameter>&#160;:</term>
207
190
<listitem><simpara> pattern mask data
208
191
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>dialog_closing</parameter>&nbsp;:</term>
 
192
<varlistentry><term><parameter>dialog_closing</parameter>&#160;:</term>
210
193
<listitem><simpara> whether the dialog was closed or not.
211
194
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
195
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
213
196
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
214
 
</variablelist><para>Since  GIMP 2.4
215
 
</para></refsect2>
 
197
</variablelist><para>Since GIMP 2.4</para></refsect2>
216
198
</refsect1>
217
199
 
218
200