← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpdialog.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpdialog.xml
13
13
<refname>GimpDialog</refname>
14
14
<refpurpose>Constructors for <link linkend="GtkDialog"><type>GtkDialog</type></link>'s and action_areas as well as other
15
15
dialog-related stuff.</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
18
<refsynopsisdiv id="GimpDialog.synopsis" role="synopsis">
21
20
 
22
21
<synopsis>
23
22
                    <link linkend="GimpDialog-struct">GimpDialog</link>;
24
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-dialog-new">gimp_dialog_new</link>                     (const <link linkend="gchar">gchar</link> *title,
 
23
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-dialog-new">gimp_dialog_new</link>                     (const <link linkend="gchar">gchar</link> *title,
25
24
                                                         const <link linkend="gchar">gchar</link> *role,
26
25
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
27
26
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
28
27
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
29
28
                                                         const <link linkend="gchar">gchar</link> *help_id,
30
29
                                                         ...);
31
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-dialog-new-valist">gimp_dialog_new_valist</link>              (const <link linkend="gchar">gchar</link> *title,
 
30
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-dialog-new-valist">gimp_dialog_new_valist</link>              (const <link linkend="gchar">gchar</link> *title,
32
31
                                                         const <link linkend="gchar">gchar</link> *role,
33
32
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
34
33
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
35
34
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
36
35
                                                         const <link linkend="gchar">gchar</link> *help_id,
37
36
                                                         <link linkend="va-list">va_list</link> args);
38
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-dialog-add-button">gimp_dialog_add_button</link>              (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
37
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-dialog-add-button">gimp_dialog_add_button</link>              (<link linkend="GimpDialog">GimpDialog</link> *dialog,
39
38
                                                         const <link linkend="gchar">gchar</link> *button_text,
40
39
                                                         <link linkend="gint">gint</link> response_id);
41
40
<link linkend="void">void</link>                <link linkend="gimp-dialog-add-buttons">gimp_dialog_add_buttons</link>             (<link linkend="GimpDialog">GimpDialog</link> *dialog,
60
59
                                       +----<link linkend="GtkDialog">GtkDialog</link>
61
60
                                             +----GimpDialog
62
61
</synopsis>
63
 
 
64
62
</refsect1>
65
63
 
66
64
 
69
67
<title role="impl_interfaces.title">Implemented Interfaces</title>
70
68
<para>
71
69
GimpDialog implements
72
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
73
 
 
 
70
 <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
74
71
</refsect1>
75
72
 
76
73
 
87
84
<refsect1 id="GimpDialog.description" role="desc">
88
85
<title role="desc.title">Description</title>
89
86
<para>
90
 
 
91
87
</para>
92
88
</refsect1>
93
89
 
95
91
<title role="details.title">Details</title>
96
92
<refsect2 id="GimpDialog-struct" role="struct">
97
93
<title>GimpDialog</title>
98
 
<indexterm zone="GimpDialog-struct"><primary>GimpDialog</primary></indexterm><programlisting>typedef struct _GimpDialog GimpDialog;</programlisting>
 
94
<indexterm zone="GimpDialog-struct"><primary sortas="GimpDialog">GimpDialog</primary></indexterm><programlisting>typedef struct _GimpDialog GimpDialog;</programlisting>
99
95
<para>
100
 
 
101
96
</para></refsect2>
102
97
<refsect2 id="gimp-dialog-new" role="function">
103
98
<title>gimp_dialog_new ()</title>
104
 
<indexterm zone="gimp-dialog-new"><primary>gimp_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_dialog_new                     (const <link linkend="gchar">gchar</link> *title,
 
99
<indexterm zone="gimp-dialog-new"><primary sortas="gimp_dialog_new">gimp_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_dialog_new                     (const <link linkend="gchar">gchar</link> *title,
105
100
                                                         const <link linkend="gchar">gchar</link> *role,
106
101
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
107
102
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
119
114
For a description of the format of the <parameter>va_list</parameter> describing the
120
115
action_area buttons see <link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
121
116
<para>
122
 
 
123
117
</para><variablelist role="params">
124
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
118
<varlistentry><term><parameter>title</parameter>&#160;:</term>
125
119
<listitem><simpara>        The dialog's title which will be set with
126
120
               <link linkend="gtk-window-set-title"><function>gtk_window_set_title()</function></link>.
127
121
</simpara></listitem></varlistentry>
128
 
<varlistentry><term><parameter>role</parameter>&nbsp;:</term>
 
122
<varlistentry><term><parameter>role</parameter>&#160;:</term>
129
123
<listitem><simpara>         The dialog's <parameter>role</parameter> which will be set with
130
124
               <link linkend="gtk-window-set-role"><function>gtk_window_set_role()</function></link>.
131
125
</simpara></listitem></varlistentry>
132
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
126
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
133
127
<listitem><simpara>       The <parameter>parent</parameter> widget of this dialog.
134
128
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
129
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
136
130
<listitem><simpara>        The <parameter>flags</parameter> (see the <link linkend="GtkDialog"><type>GtkDialog</type></link> documentation).
137
131
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><parameter>help_func</parameter>&nbsp;:</term>
 
132
<varlistentry><term><parameter>help_func</parameter>&#160;:</term>
139
133
<listitem><simpara>    The function which will be called if the user presses "F1".
140
134
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><parameter>help_id</parameter>&nbsp;:</term>
 
135
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
142
136
<listitem><simpara>      The help_id which will be passed to <parameter>help_func</parameter>.
143
137
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
145
 
<listitem><simpara>          A <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated <parameter>va_list</parameter> destribing the
 
138
<varlistentry><term><parameter>...</parameter>&#160;:</term>
 
139
<listitem><simpara>          A <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated <parameter>va_list</parameter> destribing the
146
140
               action_area buttons.
147
141
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
 
142
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
149
143
</simpara></listitem></varlistentry>
150
144
</variablelist></refsect2>
151
145
<refsect2 id="gimp-dialog-new-valist" role="function">
152
146
<title>gimp_dialog_new_valist ()</title>
153
 
<indexterm zone="gimp-dialog-new-valist"><primary>gimp_dialog_new_valist</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_dialog_new_valist              (const <link linkend="gchar">gchar</link> *title,
 
147
<indexterm zone="gimp-dialog-new-valist"><primary sortas="gimp_dialog_new_valist">gimp_dialog_new_valist</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_dialog_new_valist              (const <link linkend="gchar">gchar</link> *title,
154
148
                                                         const <link linkend="gchar">gchar</link> *role,
155
149
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
156
150
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
165
159
For a description of the format of the <parameter>va_list</parameter> describing the
166
160
action_area buttons see <link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
167
161
<para>
168
 
 
169
162
</para><variablelist role="params">
170
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
163
<varlistentry><term><parameter>title</parameter>&#160;:</term>
171
164
<listitem><simpara>        The dialog's title which will be set with
172
165
               <link linkend="gtk-window-set-title"><function>gtk_window_set_title()</function></link>.
173
166
</simpara></listitem></varlistentry>
174
 
<varlistentry><term><parameter>role</parameter>&nbsp;:</term>
 
167
<varlistentry><term><parameter>role</parameter>&#160;:</term>
175
168
<listitem><simpara>         The dialog's <parameter>role</parameter> which will be set with
176
169
               <link linkend="gtk-window-set-role"><function>gtk_window_set_role()</function></link>.
177
170
</simpara></listitem></varlistentry>
178
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
179
 
<listitem><simpara>       The <parameter>parent</parameter> widget of this dialog or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
 
171
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
 
172
<listitem><simpara>       The <parameter>parent</parameter> widget of this dialog or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
180
173
</simpara></listitem></varlistentry>
181
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
174
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
182
175
<listitem><simpara>        The <parameter>flags</parameter> (see the <link linkend="GtkDialog"><type>GtkDialog</type></link> documentation).
183
176
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><parameter>help_func</parameter>&nbsp;:</term>
 
177
<varlistentry><term><parameter>help_func</parameter>&#160;:</term>
185
178
<listitem><simpara>    The function which will be called if the user presses "F1".
186
179
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><parameter>help_id</parameter>&nbsp;:</term>
 
180
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
188
181
<listitem><simpara>      The help_id which will be passed to <parameter>help_func</parameter>.
189
182
</simpara></listitem></varlistentry>
190
 
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
 
183
<varlistentry><term><parameter>args</parameter>&#160;:</term>
191
184
<listitem><simpara>         A <parameter>va_list</parameter> destribing the action_area buttons.
192
185
</simpara></listitem></varlistentry>
193
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
 
186
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
194
187
</simpara></listitem></varlistentry>
195
188
</variablelist></refsect2>
196
189
<refsect2 id="gimp-dialog-add-button" role="function">
197
190
<title>gimp_dialog_add_button ()</title>
198
 
<indexterm zone="gimp-dialog-add-button"><primary>gimp_dialog_add_button</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_dialog_add_button              (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
191
<indexterm zone="gimp-dialog-add-button"><primary sortas="gimp_dialog_add_button">gimp_dialog_add_button</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_dialog_add_button              (<link linkend="GimpDialog">GimpDialog</link> *dialog,
199
192
                                                         const <link linkend="gchar">gchar</link> *button_text,
200
193
                                                         <link linkend="gint">gint</link> response_id);</programlisting>
201
194
<para>
203
196
except it ensures there is only one help button and automatically
204
197
sets the RESPONSE_OK widget as the default response.</para>
205
198
<para>
206
 
 
207
199
</para><variablelist role="params">
208
 
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
 
200
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
209
201
<listitem><simpara> The <parameter>dialog</parameter> to add a button to.
210
202
</simpara></listitem></varlistentry>
211
 
<varlistentry><term><parameter>button_text</parameter>&nbsp;:</term>
 
203
<varlistentry><term><parameter>button_text</parameter>&#160;:</term>
212
204
<listitem><simpara> text of button, or stock ID.
213
205
</simpara></listitem></varlistentry>
214
 
<varlistentry><term><parameter>response_id</parameter>&nbsp;:</term>
 
206
<varlistentry><term><parameter>response_id</parameter>&#160;:</term>
215
207
<listitem><simpara> response ID for the button.
216
208
</simpara></listitem></varlistentry>
217
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the button widget that was added.
 
209
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the button widget that was added.
218
210
</simpara></listitem></varlistentry>
219
211
</variablelist></refsect2>
220
212
<refsect2 id="gimp-dialog-add-buttons" role="function">
221
213
<title>gimp_dialog_add_buttons ()</title>
222
 
<indexterm zone="gimp-dialog-add-buttons"><primary>gimp_dialog_add_buttons</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_dialog_add_buttons             (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
214
<indexterm zone="gimp-dialog-add-buttons"><primary sortas="gimp_dialog_add_buttons">gimp_dialog_add_buttons</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_dialog_add_buttons             (<link linkend="GimpDialog">GimpDialog</link> *dialog,
223
215
                                                         ...);</programlisting>
224
216
<para>
225
217
This function is essentially the same as <link linkend="gtk-dialog-add-buttons"><function>gtk_dialog_add_buttons()</function></link>
226
218
except it calls <link linkend="gimp-dialog-add-button"><function>gimp_dialog_add_button()</function></link> instead of <link linkend="gtk-dialog-add-button"><function>gtk_dialog_add_button()</function></link></para>
227
219
<para>
228
 
 
229
220
</para><variablelist role="params">
230
 
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
 
221
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
231
222
<listitem><simpara> The <parameter>dialog</parameter> to add buttons to.
232
223
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
224
<varlistentry><term><parameter>...</parameter>&#160;:</term>
234
225
<listitem><simpara> button_text-response_id pairs.
235
226
</simpara></listitem></varlistentry>
236
227
</variablelist></refsect2>
237
228
<refsect2 id="gimp-dialog-add-buttons-valist" role="function">
238
229
<title>gimp_dialog_add_buttons_valist ()</title>
239
 
<indexterm zone="gimp-dialog-add-buttons-valist"><primary>gimp_dialog_add_buttons_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_dialog_add_buttons_valist      (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
230
<indexterm zone="gimp-dialog-add-buttons-valist"><primary sortas="gimp_dialog_add_buttons_valist">gimp_dialog_add_buttons_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_dialog_add_buttons_valist      (<link linkend="GimpDialog">GimpDialog</link> *dialog,
240
231
                                                         <link linkend="va-list">va_list</link> args);</programlisting>
241
232
<para>
242
233
This function is essentially the same as <link linkend="gimp-dialog-add-buttons"><function>gimp_dialog_add_buttons()</function></link>
243
234
except it takes a va_list instead of '...'</para>
244
235
<para>
245
 
 
246
236
</para><variablelist role="params">
247
 
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
 
237
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
248
238
<listitem><simpara> The <parameter>dialog</parameter> to add buttons to.
249
239
</simpara></listitem></varlistentry>
250
 
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
 
240
<varlistentry><term><parameter>args</parameter>&#160;:</term>
251
241
<listitem><simpara>   The buttons as va_list.
252
242
</simpara></listitem></varlistentry>
253
243
</variablelist></refsect2>
254
244
<refsect2 id="gimp-dialog-run" role="function">
255
245
<title>gimp_dialog_run ()</title>
256
 
<indexterm zone="gimp-dialog-run"><primary>gimp_dialog_run</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_dialog_run                     (<link linkend="GimpDialog">GimpDialog</link> *dialog);</programlisting>
 
246
<indexterm zone="gimp-dialog-run"><primary sortas="gimp_dialog_run">gimp_dialog_run</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_dialog_run                     (<link linkend="GimpDialog">GimpDialog</link> *dialog);</programlisting>
257
247
<para>
258
248
This function does exactly the same as <link linkend="gtk-dialog-run"><function>gtk_dialog_run()</function></link> except it
259
249
does not make the dialog modal while the <link linkend="GMainLoop"><type>GMainLoop</type></link> is running.</para>
260
250
<para>
261
 
 
262
251
</para><variablelist role="params">
263
 
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
 
252
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
264
253
<listitem><simpara> a <link linkend="GimpDialog"><type>GimpDialog</type></link>
265
254
</simpara></listitem></varlistentry>
266
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> response ID
 
255
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> response ID
267
256
</simpara></listitem></varlistentry>
268
257
</variablelist></refsect2>
269
258
<refsect2 id="gimp-dialogs-show-help-button" role="function" condition="since:GIMP 2.2">
270
259
<title>gimp_dialogs_show_help_button ()</title>
271
 
<indexterm zone="gimp-dialogs-show-help-button" role="GIMP 2.2"><primary>gimp_dialogs_show_help_button</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_dialogs_show_help_button       (<link linkend="gboolean">gboolean</link> show);</programlisting>
 
260
<indexterm zone="gimp-dialogs-show-help-button" role="GIMP 2.2"><primary sortas="gimp_dialogs_show_help_button">gimp_dialogs_show_help_button</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_dialogs_show_help_button       (<link linkend="gboolean">gboolean</link> show);</programlisting>
272
261
<para>
273
262
This function is for internal use only.</para>
274
263
<para>
275
 
 
276
264
</para><variablelist role="params">
277
 
<varlistentry><term><parameter>show</parameter>&nbsp;:</term>
 
265
<varlistentry><term><parameter>show</parameter>&#160;:</term>
278
266
<listitem><simpara> whether a help button should be added when creating a GimpDialog
279
267
</simpara></listitem></varlistentry>
280
 
</variablelist><para role="since">Since  GIMP 2.2
281
 
</para></refsect2>
 
268
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
282
269
 
283
270
</refsect1>
284
271
<refsect1 id="GimpDialog.property-details" role="property_details">
285
272
<title role="property_details.title">Property Details</title>
286
 
<refsect2 id="GimpDialog--help-func"><title>The <literal>&quot;help-func&quot;</literal> property</title>
287
 
<indexterm zone="GimpDialog--help-func"><primary>GimpDialog:help-func</primary></indexterm><programlisting>  &quot;help-func&quot;                <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
 
273
<refsect2 id="GimpDialog--help-func" role="property"><title>The <literal>&quot;help-func&quot;</literal> property</title>
 
274
<indexterm zone="GimpDialog--help-func"><primary sortas="GimpDialog:help-func">GimpDialog:help-func</primary></indexterm><programlisting>  &quot;help-func&quot;                <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
288
275
<para></para></refsect2>
289
 
<refsect2 id="GimpDialog--help-id"><title>The <literal>&quot;help-id&quot;</literal> property</title>
290
 
<indexterm zone="GimpDialog--help-id"><primary>GimpDialog:help-id</primary></indexterm><programlisting>  &quot;help-id&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
 
276
<refsect2 id="GimpDialog--help-id" role="property"><title>The <literal>&quot;help-id&quot;</literal> property</title>
 
277
<indexterm zone="GimpDialog--help-id"><primary sortas="GimpDialog:help-id">GimpDialog:help-id</primary></indexterm><programlisting>  &quot;help-id&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
291
278
<para></para><para>Default value: NULL</para>
292
279
</refsect2>
293
 
 
294
280
</refsect1>
295
281
 
296
282