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

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/GimpPatternSelectButton.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-08-22 11:50:05 UTC
  • mfrom: (0.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20080822115005-yxj5svf3v9x1mkr7
Tags: upstream-2.4.7
Import upstream version 2.4.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
56
56
<a name="GimpPatternSelectButton.synopsis"></a><h2>Synopsis</h2>
57
57
<pre class="synopsis">
58
58
                    <a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-struct" title="GimpPatternSelectButton">GimpPatternSelectButton</a>;
59
 
<a
60
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
61
 
>GtkWidget</a>*          <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-new" title="gimp_pattern_select_button_new ()">gimp_pattern_select_button_new</a>      (const <a
62
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
63
 
>gchar</a> *title,
64
 
                                                         const <a
65
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
66
 
>gchar</a> *pattern_name);
67
 
const <a
68
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
69
 
>gchar</a>*        <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-get-pattern" title="gimp_pattern_select_button_get_pattern ()">gimp_pattern_select_button_get_pattern</a>
 
59
GtkWidget*          <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-new" title="gimp_pattern_select_button_new ()">gimp_pattern_select_button_new</a>      (const gchar *title,
 
60
                                                         const gchar *pattern_name);
 
61
const gchar*        <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-get-pattern" title="gimp_pattern_select_button_get_pattern ()">gimp_pattern_select_button_get_pattern</a>
70
62
                                                        (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);
71
63
void                <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-set-pattern" title="gimp_pattern_select_button_set_pattern ()">gimp_pattern_select_button_set_pattern</a>
72
64
                                                        (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
73
 
                                                         const <a
74
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
75
 
>gchar</a> *pattern_name);
 
65
                                                         const gchar *pattern_name);
76
66
</pre>
77
67
</div>
78
68
<div class="refsect1" lang="en">
79
69
<a name="GimpPatternSelectButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
80
70
<pre class="synopsis">
81
 
  <a
82
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
83
 
>GObject</a>
84
 
   +----<a
85
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
86
 
>GInitiallyUnowned</a>
87
 
         +----<a
88
 
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
89
 
>GtkObject</a>
90
 
               +----<a
91
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
92
 
>GtkWidget</a>
93
 
                     +----<a
94
 
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
95
 
>GtkContainer</a>
96
 
                           +----<a
97
 
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
98
 
>GtkBox</a>
99
 
                                 +----<a
100
 
href="/usr/share/gtk-doc/html/gtk/GtkHBox.html"
101
 
>GtkHBox</a>
 
71
  GObject
 
72
   +----GInitiallyUnowned
 
73
         +----GtkObject
 
74
               +----GtkWidget
 
75
                     +----GtkContainer
 
76
                           +----GtkBox
 
77
                                 +----GtkHBox
102
78
                                       +----<a class="link" href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
103
79
                                             +----GimpPatternSelectButton
104
80
</pre>
112
88
<div class="refsect1" lang="en">
113
89
<a name="GimpPatternSelectButton.properties"></a><h2>Properties</h2>
114
90
<pre class="synopsis">
115
 
  "<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name" title='The "pattern-name" property'>pattern-name</a>"             <a
116
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
117
 
>gchar</a>*                : Read / Write
118
 
  "<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--title" title='The "title" property'>title</a>"                    <a
119
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
120
 
>gchar</a>*                : Read / Write / Construct Only
 
91
  "<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name" title='The "pattern-name" property'>pattern-name</a>"             gchar*                : Read / Write
 
92
  "<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--title" title='The "title" property'>title</a>"                    gchar*                : Read / Write / Construct Only
121
93
</pre>
122
94
</div>
123
95
<div class="refsect1" lang="en">
144
116
<hr>
145
117
<div class="refsect2" lang="en">
146
118
<a name="gimp-pattern-select-button-new"></a><h3>gimp_pattern_select_button_new ()</h3>
147
 
<pre class="programlisting"><a
148
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
149
 
>GtkWidget</a>*          gimp_pattern_select_button_new      (const <a
150
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
151
 
>gchar</a> *title,
152
 
                                                         const <a
153
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
154
 
>gchar</a> *pattern_name);</pre>
 
119
<pre class="programlisting">GtkWidget*          gimp_pattern_select_button_new      (const gchar *title,
 
120
                                                         const gchar *pattern_name);</pre>
155
121
<p>
156
 
Creates a new <a
157
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
158
 
><span class="type">GtkWidget</span></a> that completely controls the selection of
 
122
Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
159
123
a pattern.  This widget is suitable for placement in a table in a
160
124
plug-in dialog.</p>
161
125
<p>
166
130
<tbody>
167
131
<tr>
168
132
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
169
 
<td>        Title of the dialog to use or <a
170
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
171
 
><code class="literal">NULL</code></a> to use the default title.
 
133
<td>        Title of the dialog to use or <code class="literal">NULL</code> to use the default title.
172
134
</td>
173
135
</tr>
174
136
<tr>
175
137
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
176
 
<td> Initial pattern name or <a
177
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
178
 
><code class="literal">NULL</code></a> to use current selection.
 
138
<td> Initial pattern name or <code class="literal">NULL</code> to use current selection.
179
139
</td>
180
140
</tr>
181
141
<tr>
182
142
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
183
 
<td> A <a
184
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
185
 
><span class="type">GtkWidget</span></a> that you can use in your UI.
 
143
<td> A <span class="type">GtkWidget</span> that you can use in your UI.
186
144
 
187
145
</td>
188
146
</tr>
194
152
<hr>
195
153
<div class="refsect2" lang="en">
196
154
<a name="gimp-pattern-select-button-get-pattern"></a><h3>gimp_pattern_select_button_get_pattern ()</h3>
197
 
<pre class="programlisting">const <a
198
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
199
 
>gchar</a>*        gimp_pattern_select_button_get_pattern
 
155
<pre class="programlisting">const gchar*        gimp_pattern_select_button_get_pattern
200
156
                                                        (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);</pre>
201
157
<p>
202
158
Retrieves the name of currently selected pattern.</p>
227
183
<a name="gimp-pattern-select-button-set-pattern"></a><h3>gimp_pattern_select_button_set_pattern ()</h3>
228
184
<pre class="programlisting">void                gimp_pattern_select_button_set_pattern
229
185
                                                        (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
230
 
                                                         const <a
231
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
232
 
>gchar</a> *pattern_name);</pre>
 
186
                                                         const gchar *pattern_name);</pre>
233
187
<p>
234
188
Sets the current pattern for the pattern select button.</p>
235
189
<p>
245
199
</tr>
246
200
<tr>
247
201
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
248
 
<td> Pattern name to set; <a
249
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
250
 
><code class="literal">NULL</code></a> means no change.
 
202
<td> Pattern name to set; <code class="literal">NULL</code> means no change.
251
203
</td>
252
204
</tr>
253
205
</tbody>
260
212
<a name="GimpPatternSelectButton.property-details"></a><h2>Property Details</h2>
261
213
<div class="refsect2" lang="en">
262
214
<a name="GimpPatternSelectButton--pattern-name"></a><h3>The <code class="literal">"pattern-name"</code> property</h3>
263
 
<pre class="programlisting">  "pattern-name"             <a
264
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
265
 
>gchar</a>*                : Read / Write</pre>
 
215
<pre class="programlisting">  "pattern-name"             gchar*                : Read / Write</pre>
266
216
<p>
267
217
The name of the currently selected pattern.</p>
268
218
<p>
275
225
<hr>
276
226
<div class="refsect2" lang="en">
277
227
<a name="GimpPatternSelectButton--title"></a><h3>The <code class="literal">"title"</code> property</h3>
278
 
<pre class="programlisting">  "title"                    <a
279
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
280
 
>gchar</a>*                : Read / Write / Construct Only</pre>
 
228
<pre class="programlisting">  "title"                    gchar*                : Read / Write / Construct Only</pre>
281
229
<p>
282
230
The title to be used for the pattern selection popup dialog.</p>
283
231
<p>
293
241
<div class="refsect2" lang="en">
294
242
<a name="GimpPatternSelectButton-pattern-set"></a><h3>The <code class="literal">"pattern-set"</code> signal</h3>
295
243
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *widget,
296
 
                                                        <a
297
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
298
 
>gchar</a>                   *pattern_name,
299
 
                                                        <a
300
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
301
 
>gint</a>                     width,
302
 
                                                        <a
303
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
304
 
>gint</a>                     height,
305
 
                                                        <a
306
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
307
 
>gint</a>                     bpp,
308
 
                                                        <a
309
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
310
 
>gpointer</a>                 mask_data,
311
 
                                                        <a
312
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
313
 
>gboolean</a>                 dialog_closing,
314
 
                                                        <a
315
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
316
 
>gpointer</a>                 user_data)           : Run First</pre>
 
244
                                                        gchar                   *pattern_name,
 
245
                                                        gint                     width,
 
246
                                                        gint                     height,
 
247
                                                        gint                     bpp,
 
248
                                                        gpointer                 mask_data,
 
249
                                                        gboolean                 dialog_closing,
 
250
                                                        gpointer                 user_data)           : Run First</pre>
317
251
<p>
318
252
The ::pattern-set signal is emitted when the user selects a pattern.</p>
319
253
<p>