← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpdialog.xml
4
4
 
5
5
<refentry id="GimpDialog">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpDialog</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpDialog</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
10
</refmeta>
16
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
17
</refnamediv>
18
18
 
19
 
<refsynopsisdiv id="synopsis">
20
 
<title id="synopsis.title">Synopsis</title>
 
19
<refsynopsisdiv role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
21
21
 
22
22
<synopsis>
23
23
 
24
24
 
25
25
 
26
 
            <link linkend="GimpDialog-struct">GimpDialog</link>;
27
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-dialog-new">gimp_dialog_new</link>                 (const <link linkend="gchar">gchar</link> *title,
28
 
                                             const <link linkend="gchar">gchar</link> *role,
29
 
                                             <link linkend="GtkWidget">GtkWidget</link> *parent,
30
 
                                             <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
31
 
                                             <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
32
 
                                             const <link linkend="gchar">gchar</link> *help_id,
33
 
                                             ...);
34
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-dialog-new-valist">gimp_dialog_new_valist</link>          (const <link linkend="gchar">gchar</link> *title,
35
 
                                             const <link linkend="gchar">gchar</link> *role,
36
 
                                             <link linkend="GtkWidget">GtkWidget</link> *parent,
37
 
                                             <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
38
 
                                             <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
39
 
                                             const <link linkend="gchar">gchar</link> *help_id,
40
 
                                             <link linkend="va-list">va_list</link> args);
41
 
<link linkend="void">void</link>        <link linkend="gimp-dialog-add-buttons-valist">gimp_dialog_add_buttons_valist</link>  (<link linkend="GimpDialog">GimpDialog</link> *dialog,
42
 
                                             <link linkend="va-list">va_list</link> args);
43
 
<link linkend="gint">gint</link>        <link linkend="gimp-dialog-run">gimp_dialog_run</link>                 (<link linkend="GimpDialog">GimpDialog</link> *dialog);
44
 
<link linkend="void">void</link>        <link linkend="gimp-dialogs-show-help-button">gimp_dialogs_show_help_button</link>   (<link linkend="gboolean">gboolean</link> show);
 
26
                    <link linkend="GimpDialog-struct">GimpDialog</link>;
 
27
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-dialog-new">gimp_dialog_new</link>                     (const <link linkend="gchar">gchar</link> *title,
 
28
                                                         const <link linkend="gchar">gchar</link> *role,
 
29
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
 
30
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
 
31
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
 
32
                                                         const <link linkend="gchar">gchar</link> *help_id,
 
33
                                                         ...);
 
34
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-dialog-new-valist">gimp_dialog_new_valist</link>              (const <link linkend="gchar">gchar</link> *title,
 
35
                                                         const <link linkend="gchar">gchar</link> *role,
 
36
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
 
37
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
 
38
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
 
39
                                                         const <link linkend="gchar">gchar</link> *help_id,
 
40
                                                         <link linkend="va-list">va_list</link> args);
 
41
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-dialog-add-button">gimp_dialog_add_button</link>              (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
42
                                                         const <link linkend="gchar">gchar</link> *button_text,
 
43
                                                         <link linkend="gint">gint</link> response_id);
 
44
<link linkend="void">void</link>                <link linkend="gimp-dialog-add-buttons">gimp_dialog_add_buttons</link>             (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
45
                                                         ...);
 
46
<link linkend="void">void</link>                <link linkend="gimp-dialog-add-buttons-valist">gimp_dialog_add_buttons_valist</link>      (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
47
                                                         <link linkend="va-list">va_list</link> args);
 
48
<link linkend="gint">gint</link>                <link linkend="gimp-dialog-run">gimp_dialog_run</link>                     (<link linkend="GimpDialog">GimpDialog</link> *dialog);
 
49
<link linkend="void">void</link>                <link linkend="gimp-dialogs-show-help-button">gimp_dialogs_show_help_button</link>       (<link linkend="gboolean">gboolean</link> show);
45
50
 
46
51
</synopsis>
47
52
</refsynopsisdiv>
48
53
 
49
 
<refsect1 id="object_hierarchy">
50
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
54
<refsect1 role="object_hierarchy">
 
55
<title role="object_hierarchy.title">Object Hierarchy</title>
51
56
<synopsis>
52
57
 
53
58
  <link linkend="GObject">GObject</link>
65
70
 
66
71
 
67
72
 
68
 
<refsect1 id="impl_interfaces">
69
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
73
<refsect1 role="impl_interfaces">
 
74
<title role="impl_interfaces.title">Implemented Interfaces</title>
70
75
<para>
71
76
GimpDialog implements
72
77
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
74
79
</refsect1>
75
80
 
76
81
 
77
 
<refsect1 id="properties">
78
 
<title id="properties.title">Properties</title>
 
82
<refsect1 role="properties">
 
83
<title role="properties.title">Properties</title>
79
84
<synopsis>
80
85
 
81
 
  &quot;<link linkend="GimpDialog--help-func">help-func</link>&quot;            <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
82
 
  &quot;<link linkend="GimpDialog--help-id">help-id</link>&quot;              <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only
 
86
  &quot;<link linkend="GimpDialog--help-func">help-func</link>&quot;                <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
 
87
  &quot;<link linkend="GimpDialog--help-id">help-id</link>&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only
83
88
</synopsis>
84
89
</refsect1>
85
90
 
86
91
 
87
92
 
88
 
<refsect1 id="desc">
89
 
<title id="desc.title">Description</title>
 
93
<refsect1 role="desc">
 
94
<title role="desc.title">Description</title>
90
95
<para>
91
96
 
92
97
</para>
93
98
</refsect1>
94
99
 
95
 
<refsect1 id="details">
96
 
<title id="details.title">Details</title>
 
100
<refsect1 role="details">
 
101
<title role="details.title">Details</title>
97
102
<refsect2>
98
103
<title><anchor id="GimpDialog-struct" role="struct"/>GimpDialog</title>
99
104
<indexterm><primary>GimpDialog</primary></indexterm><programlisting>typedef struct _GimpDialog GimpDialog;</programlisting>
102
107
</para></refsect2>
103
108
<refsect2>
104
109
<title><anchor id="gimp-dialog-new" role="function"/>gimp_dialog_new ()</title>
105
 
<indexterm><primary>gimp_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_dialog_new                 (const <link linkend="gchar">gchar</link> *title,
106
 
                                             const <link linkend="gchar">gchar</link> *role,
107
 
                                             <link linkend="GtkWidget">GtkWidget</link> *parent,
108
 
                                             <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
109
 
                                             <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
110
 
                                             const <link linkend="gchar">gchar</link> *help_id,
111
 
                                             ...);</programlisting>
 
110
<indexterm><primary>gimp_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_dialog_new                     (const <link linkend="gchar">gchar</link> *title,
 
111
                                                         const <link linkend="gchar">gchar</link> *role,
 
112
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
 
113
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
 
114
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
 
115
                                                         const <link linkend="gchar">gchar</link> *help_id,
 
116
                                                         ...);</programlisting>
112
117
<para>
113
118
Creates a new <parameter>GimpDialog</parameter> widget.
114
119
</para>
151
156
</variablelist></refsect2>
152
157
<refsect2>
153
158
<title><anchor id="gimp-dialog-new-valist" role="function"/>gimp_dialog_new_valist ()</title>
154
 
<indexterm><primary>gimp_dialog_new_valist</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_dialog_new_valist          (const <link linkend="gchar">gchar</link> *title,
155
 
                                             const <link linkend="gchar">gchar</link> *role,
156
 
                                             <link linkend="GtkWidget">GtkWidget</link> *parent,
157
 
                                             <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
158
 
                                             <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
159
 
                                             const <link linkend="gchar">gchar</link> *help_id,
160
 
                                             <link linkend="va-list">va_list</link> args);</programlisting>
 
159
<indexterm><primary>gimp_dialog_new_valist</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_dialog_new_valist              (const <link linkend="gchar">gchar</link> *title,
 
160
                                                         const <link linkend="gchar">gchar</link> *role,
 
161
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
 
162
                                                         <link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
 
163
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
 
164
                                                         const <link linkend="gchar">gchar</link> *help_id,
 
165
                                                         <link linkend="va-list">va_list</link> args);</programlisting>
161
166
<para>
162
167
Creates a new <parameter>GimpDialog</parameter> widget. If a GtkWindow is specified as
163
168
<parameter>parent</parameter> then the dialog will be made transient for this window.
195
200
</simpara></listitem></varlistentry>
196
201
</variablelist></refsect2>
197
202
<refsect2>
 
203
<title><anchor id="gimp-dialog-add-button" role="function"/>gimp_dialog_add_button ()</title>
 
204
<indexterm><primary>gimp_dialog_add_button</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_dialog_add_button              (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
205
                                                         const <link linkend="gchar">gchar</link> *button_text,
 
206
                                                         <link linkend="gint">gint</link> response_id);</programlisting>
 
207
<para>
 
208
This function is essentially the same as <link linkend="gtk-dialog-add-button"><function>gtk_dialog_add_button()</function></link>
 
209
except it ensures there is only one help button and automatically
 
210
sets the RESPONSE_OK widget as the default response.</para>
 
211
<para>
 
212
 
 
213
</para><variablelist role="params">
 
214
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
 
215
<listitem><simpara> The <parameter>dialog</parameter> to add a button to.
 
216
</simpara></listitem></varlistentry>
 
217
<varlistentry><term><parameter>button_text</parameter>&nbsp;:</term>
 
218
<listitem><simpara> text of button, or stock ID.
 
219
</simpara></listitem></varlistentry>
 
220
<varlistentry><term><parameter>response_id</parameter>&nbsp;:</term>
 
221
<listitem><simpara> response ID for the button.
 
222
</simpara></listitem></varlistentry>
 
223
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the button widget that was added.
 
224
</simpara></listitem></varlistentry>
 
225
</variablelist></refsect2>
 
226
<refsect2>
 
227
<title><anchor id="gimp-dialog-add-buttons" role="function"/>gimp_dialog_add_buttons ()</title>
 
228
<indexterm><primary>gimp_dialog_add_buttons</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_dialog_add_buttons             (<link linkend="GimpDialog">GimpDialog</link> *dialog,
 
229
                                                         ...);</programlisting>
 
230
<para>
 
231
This function is essentially the same as <link linkend="gtk-dialog-add-buttons"><function>gtk_dialog_add_buttons()</function></link>
 
232
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>
 
233
<para>
 
234
 
 
235
</para><variablelist role="params">
 
236
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
 
237
<listitem><simpara> The <parameter>dialog</parameter> to add buttons to.
 
238
</simpara></listitem></varlistentry>
 
239
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
240
<listitem><simpara> button_text-response_id pairs.
 
241
</simpara></listitem></varlistentry>
 
242
</variablelist></refsect2>
 
243
<refsect2>
198
244
<title><anchor id="gimp-dialog-add-buttons-valist" role="function"/>gimp_dialog_add_buttons_valist ()</title>
199
 
<indexterm><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,
200
 
                                             <link linkend="va-list">va_list</link> args);</programlisting>
 
245
<indexterm><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,
 
246
                                                         <link linkend="va-list">va_list</link> args);</programlisting>
201
247
<para>
202
 
This function is essentially the same as <link linkend="gtk-dialog-add-buttons"><function>gtk_dialog_add_buttons()</function></link>
 
248
This function is essentially the same as <link linkend="gimp-dialog-add-buttons"><function>gimp_dialog_add_buttons()</function></link>
203
249
except it takes a va_list instead of '...'</para>
204
250
<para>
205
251
 
213
259
</variablelist></refsect2>
214
260
<refsect2>
215
261
<title><anchor id="gimp-dialog-run" role="function"/>gimp_dialog_run ()</title>
216
 
<indexterm><primary>gimp_dialog_run</primary></indexterm><programlisting><link linkend="gint">gint</link>        gimp_dialog_run                 (<link linkend="GimpDialog">GimpDialog</link> *dialog);</programlisting>
 
262
<indexterm><primary>gimp_dialog_run</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_dialog_run                     (<link linkend="GimpDialog">GimpDialog</link> *dialog);</programlisting>
217
263
<para>
218
264
This function does exactly the same as <link linkend="gtk-dialog-run"><function>gtk_dialog_run()</function></link> except it
219
265
does not make the dialog modal while the <link linkend="GMainLoop"><type>GMainLoop</type></link> is running.</para>
228
274
</variablelist></refsect2>
229
275
<refsect2>
230
276
<title><anchor id="gimp-dialogs-show-help-button" role="function" condition="since:GIMP 2.2"/>gimp_dialogs_show_help_button ()</title>
231
 
<indexterm 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>
 
277
<indexterm 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>
232
278
<para>
233
279
This function is for internal use only.</para>
234
280
<para>
237
283
<varlistentry><term><parameter>show</parameter>&nbsp;:</term>
238
284
<listitem><simpara> whether a help button should be added when creating a GimpDialog
239
285
</simpara></listitem></varlistentry>
240
 
</variablelist><para>Since  GIMP 2.2
 
286
</variablelist><para role="since">Since  GIMP 2.2
241
287
</para></refsect2>
242
288
 
243
289
</refsect1>
244
 
<refsect1 id="property_details">
245
 
<title id="property_details.title">Property Details</title>
 
290
<refsect1 role="property_details">
 
291
<title role="property_details.title">Property Details</title>
246
292
<refsect2><title><anchor id="GimpDialog--help-func"/>The &quot;<literal>help-func</literal>&quot; property</title>
247
 
<indexterm><primary>GimpDialog:help-func</primary></indexterm><programlisting>  &quot;help-func&quot;            <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
 
293
<indexterm><primary>GimpDialog:help-func</primary></indexterm><programlisting>  &quot;help-func&quot;                <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
248
294
<para></para></refsect2>
249
295
<refsect2><title><anchor id="GimpDialog--help-id"/>The &quot;<literal>help-id</literal>&quot; property</title>
250
 
<indexterm><primary>GimpDialog:help-id</primary></indexterm><programlisting>  &quot;help-id&quot;              <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only</programlisting>
 
296
<indexterm><primary>GimpDialog:help-id</primary></indexterm><programlisting>  &quot;help-id&quot;                  <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only</programlisting>
251
297
<para></para><para>Default value: NULL</para>
252
298
</refsect2>
253
299