1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpDialog">
<refmeta>
<refentrytitle role="top_of_page" id="GimpDialog.top_of_page">GimpDialog</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpDialog</refname>
<refpurpose>Constructors for <link linkend="GtkDialog"><type>GtkDialog</type></link>'s and action_areas as well as other
dialog-related stuff.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GimpDialog.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpDialog-struct">GimpDialog</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-dialog-new">gimp_dialog_new</link> (const <link linkend="gchar">gchar</link> *title,
const <link linkend="gchar">gchar</link> *role,
<link linkend="GtkWidget">GtkWidget</link> *parent,
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
const <link linkend="gchar">gchar</link> *help_id,
...);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-dialog-new-valist">gimp_dialog_new_valist</link> (const <link linkend="gchar">gchar</link> *title,
const <link linkend="gchar">gchar</link> *role,
<link linkend="GtkWidget">GtkWidget</link> *parent,
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
const <link linkend="gchar">gchar</link> *help_id,
<link linkend="va-list">va_list</link> args);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-dialog-add-button">gimp_dialog_add_button</link> (<link linkend="GimpDialog">GimpDialog</link> *dialog,
const <link linkend="gchar">gchar</link> *button_text,
<link linkend="gint">gint</link> response_id);
<link linkend="void">void</link> <link linkend="gimp-dialog-add-buttons">gimp_dialog_add_buttons</link> (<link linkend="GimpDialog">GimpDialog</link> *dialog,
...);
<link linkend="void">void</link> <link linkend="gimp-dialog-add-buttons-valist">gimp_dialog_add_buttons_valist</link> (<link linkend="GimpDialog">GimpDialog</link> *dialog,
<link linkend="va-list">va_list</link> args);
<link linkend="gint">gint</link> <link linkend="gimp-dialog-run">gimp_dialog_run</link> (<link linkend="GimpDialog">GimpDialog</link> *dialog);
<link linkend="void">void</link> <link linkend="gimp-dialogs-show-help-button">gimp_dialogs_show_help_button</link> (<link linkend="gboolean">gboolean</link> show);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GimpDialog.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkWindow">GtkWindow</link>
+----<link linkend="GtkDialog">GtkDialog</link>
+----GimpDialog
</synopsis>
</refsect1>
<refsect1 id="GimpDialog.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpDialog implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="GimpDialog.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GimpDialog--help-func">help-func</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
"<link linkend="GimpDialog--help-id">help-id</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="GimpDialog.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="GimpDialog.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpDialog-struct" role="struct">
<title>GimpDialog</title>
<indexterm zone="GimpDialog-struct"><primary>GimpDialog</primary></indexterm><programlisting>typedef struct _GimpDialog GimpDialog;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-dialog-new" role="function">
<title>gimp_dialog_new ()</title>
<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,
const <link linkend="gchar">gchar</link> *role,
<link linkend="GtkWidget">GtkWidget</link> *parent,
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
const <link linkend="gchar">gchar</link> *help_id,
...);</programlisting>
<para>
Creates a new <parameter>GimpDialog</parameter> widget.
</para>
<para>
This function simply packs the action_area arguments passed in "..."
into a <parameter>va_list</parameter> variable and passes everything to <link linkend="gimp-dialog-new-valist"><function>gimp_dialog_new_valist()</function></link>.
</para>
<para>
For a description of the format of the <parameter>va_list</parameter> describing the
action_area buttons see <link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> The dialog's title which will be set with
<link linkend="gtk-window-set-title"><function>gtk_window_set_title()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>role</parameter> :</term>
<listitem><simpara> The dialog's <parameter>role</parameter> which will be set with
<link linkend="gtk-window-set-role"><function>gtk_window_set_role()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter> :</term>
<listitem><simpara> The <parameter>parent</parameter> widget of this dialog.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> The <parameter>flags</parameter> (see the <link linkend="GtkDialog"><type>GtkDialog</type></link> documentation).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>help_func</parameter> :</term>
<listitem><simpara> The function which will be called if the user presses "F1".
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>help_id</parameter> :</term>
<listitem><simpara> The help_id which will be passed to <parameter>help_func</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> A <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated <parameter>va_list</parameter> destribing the
action_area buttons.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-dialog-new-valist" role="function">
<title>gimp_dialog_new_valist ()</title>
<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,
const <link linkend="gchar">gchar</link> *role,
<link linkend="GtkWidget">GtkWidget</link> *parent,
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
const <link linkend="gchar">gchar</link> *help_id,
<link linkend="va-list">va_list</link> args);</programlisting>
<para>
Creates a new <parameter>GimpDialog</parameter> widget. If a GtkWindow is specified as
<parameter>parent</parameter> then the dialog will be made transient for this window.
</para>
<para>
For a description of the format of the <parameter>va_list</parameter> describing the
action_area buttons see <link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> The dialog's title which will be set with
<link linkend="gtk-window-set-title"><function>gtk_window_set_title()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>role</parameter> :</term>
<listitem><simpara> The dialog's <parameter>role</parameter> which will be set with
<link linkend="gtk-window-set-role"><function>gtk_window_set_role()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter> :</term>
<listitem><simpara> The <parameter>parent</parameter> widget of this dialog or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> The <parameter>flags</parameter> (see the <link linkend="GtkDialog"><type>GtkDialog</type></link> documentation).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>help_func</parameter> :</term>
<listitem><simpara> The function which will be called if the user presses "F1".
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>help_id</parameter> :</term>
<listitem><simpara> The help_id which will be passed to <parameter>help_func</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter> :</term>
<listitem><simpara> A <parameter>va_list</parameter> destribing the action_area buttons.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-dialog-add-button" role="function">
<title>gimp_dialog_add_button ()</title>
<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,
const <link linkend="gchar">gchar</link> *button_text,
<link linkend="gint">gint</link> response_id);</programlisting>
<para>
This function is essentially the same as <link linkend="gtk-dialog-add-button"><function>gtk_dialog_add_button()</function></link>
except it ensures there is only one help button and automatically
sets the RESPONSE_OK widget as the default response.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dialog</parameter> :</term>
<listitem><simpara> The <parameter>dialog</parameter> to add a button to.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>button_text</parameter> :</term>
<listitem><simpara> text of button, or stock ID.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>response_id</parameter> :</term>
<listitem><simpara> response ID for the button.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the button widget that was added.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-dialog-add-buttons" role="function">
<title>gimp_dialog_add_buttons ()</title>
<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,
...);</programlisting>
<para>
This function is essentially the same as <link linkend="gtk-dialog-add-buttons"><function>gtk_dialog_add_buttons()</function></link>
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>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dialog</parameter> :</term>
<listitem><simpara> The <parameter>dialog</parameter> to add buttons to.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> button_text-response_id pairs.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-dialog-add-buttons-valist" role="function">
<title>gimp_dialog_add_buttons_valist ()</title>
<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,
<link linkend="va-list">va_list</link> args);</programlisting>
<para>
This function is essentially the same as <link linkend="gimp-dialog-add-buttons"><function>gimp_dialog_add_buttons()</function></link>
except it takes a va_list instead of '...'</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dialog</parameter> :</term>
<listitem><simpara> The <parameter>dialog</parameter> to add buttons to.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter> :</term>
<listitem><simpara> The buttons as va_list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-dialog-run" role="function">
<title>gimp_dialog_run ()</title>
<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>
<para>
This function does exactly the same as <link linkend="gtk-dialog-run"><function>gtk_dialog_run()</function></link> except it
does not make the dialog modal while the <link linkend="GMainLoop"><type>GMainLoop</type></link> is running.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dialog</parameter> :</term>
<listitem><simpara> a <link linkend="GimpDialog"><type>GimpDialog</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> response ID
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-dialogs-show-help-button" role="function" condition="since:GIMP 2.2">
<title>gimp_dialogs_show_help_button ()</title>
<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>
<para>
This function is for internal use only.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>show</parameter> :</term>
<listitem><simpara> whether a help button should be added when creating a GimpDialog
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</para></refsect2>
</refsect1>
<refsect1 id="GimpDialog.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GimpDialog--help-func"><title>The <literal>"help-func"</literal> property</title>
<indexterm zone="GimpDialog--help-func"><primary>GimpDialog:help-func</primary></indexterm><programlisting> "help-func" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2 id="GimpDialog--help-id"><title>The <literal>"help-id"</literal> property</title>
<indexterm zone="GimpDialog--help-id"><primary>GimpDialog:help-id</primary></indexterm><programlisting> "help-id" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
<para></para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
