216 lines
17 KiB
HTML
216 lines
17 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpDialog</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual"><link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets"><link rel="prev" href="GimpColorSelection.html" title="GimpColorSelection"><link rel="next" href="GimpFileEntry.html" title="GimpFileEntry"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets"><link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy"><link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView"><link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters"><link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors"><link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers"><link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities"><link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="GimpColorSelection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Widgets Library Reference Manual</th><td><a accesskey="n" href="GimpFileEntry.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="GimpDialog"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">GimpDialog</span></h2><p>GimpDialog — Constructors for <a
|
||
href="../gtk/GtkDialog.html"
|
||
><span class="type">GtkDialog</span></a>'s and action_areas as well as other
|
||
dialog-related stuff.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||
|
||
|
||
|
||
<a href="GimpDialog.html#GimpDialog-struct">GimpDialog</a>;
|
||
<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a>* <a href="GimpDialog.html#gimp-dialog-new">gimp_dialog_new</a> (const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *role,
|
||
<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a> *parent,
|
||
<a
|
||
href="../gtk/GtkDialog.html#GtkDialogFlags"
|
||
>GtkDialogFlags</a> flags,
|
||
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *help_id,
|
||
...);
|
||
<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a>* <a href="GimpDialog.html#gimp-dialog-new-valist">gimp_dialog_new_valist</a> (const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *role,
|
||
<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a> *parent,
|
||
<a
|
||
href="../gtk/GtkDialog.html#GtkDialogFlags"
|
||
>GtkDialogFlags</a> flags,
|
||
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *help_id,
|
||
va_list args);
|
||
void <a href="GimpDialog.html#gimp-dialog-add-buttons-valist">gimp_dialog_add_buttons_valist</a> (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog,
|
||
va_list args);
|
||
<a
|
||
href="../glib/glib-Basic-Types.html#gint"
|
||
>gint</a> <a href="GimpDialog.html#gimp-dialog-run">gimp_dialog_run</a> (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog);
|
||
void <a href="GimpDialog.html#gimp-dialogs-show-help-button">gimp_dialogs_show_help_button</a> (<a
|
||
href="../glib/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> show);
|
||
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2553762"></a><h2>Object Hierarchy</h2><pre class="synopsis">
|
||
|
||
<a
|
||
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
|
||
>GObject</a>
|
||
+----<a
|
||
href="../gtk/GtkObject.html"
|
||
>GtkObject</a>
|
||
+----<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a>
|
||
+----<a
|
||
href="../gtk/GtkContainer.html"
|
||
>GtkContainer</a>
|
||
+----<a
|
||
href="../gtk/GtkBin.html"
|
||
>GtkBin</a>
|
||
+----<a
|
||
href="../gtk/GtkWindow.html"
|
||
>GtkWindow</a>
|
||
+----<a
|
||
href="../gtk/GtkDialog.html"
|
||
>GtkDialog</a>
|
||
+----GimpDialog
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2553809"></a><h2>Implemented Interfaces</h2><p>
|
||
GimpDialog implements
|
||
AtkImplementorIface.</p></div><div class="refsect1" lang="en"><a name="id2553823"></a><h2>Properties</h2><pre class="synopsis">
|
||
|
||
"<a href="GimpDialog.html#GimpDialog--help-func">help-func</a>" <a
|
||
href="../glib/glib-Basic-Types.html#gpointer"
|
||
>gpointer</a> : Read / Write / Construct Only
|
||
"<a href="GimpDialog.html#GimpDialog--help-id">help-id</a>" <a
|
||
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
|
||
>gchararray</a> : Read / Write / Construct Only
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2553856"></a><h2>Description</h2><p>
|
||
|
||
</p></div><div class="refsect1" lang="en"><a name="id2553865"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2553871"></a><h3><a name="GimpDialog-struct"></a>GimpDialog</h3><a class="indexterm" name="id2553879"></a><pre class="programlisting">typedef struct _GimpDialog GimpDialog;</pre><p>
|
||
|
||
</p></div><hr><div class="refsect2" lang="en"><a name="id2553889"></a><h3><a name="gimp-dialog-new"></a>gimp_dialog_new ()</h3><a class="indexterm" name="id2589421"></a><pre class="programlisting"><a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a>* gimp_dialog_new (const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *role,
|
||
<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a> *parent,
|
||
<a
|
||
href="../gtk/GtkDialog.html#GtkDialogFlags"
|
||
>GtkDialogFlags</a> flags,
|
||
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *help_id,
|
||
...);</pre><p>
|
||
Creates a new <em class="parameter"><code>GimpDialog</code></em> widget.
|
||
</p><p>
|
||
This function simply packs the action_area arguments passed in "..."
|
||
into a <em class="parameter"><code>va_list</code></em> variable and passes everything to <a href="GimpDialog.html#gimp-dialog-new-valist"><code class="function">gimp_dialog_new_valist()</code></a>.
|
||
</p><p>
|
||
For a description of the format of the <em class="parameter"><code>va_list</code></em> describing the
|
||
action_area buttons see <a
|
||
href="../gtk/GtkDialog.html#gtk-dialog-new-with-buttons"
|
||
><code class="function">gtk_dialog_new_with_buttons()</code></a>.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>title</code></em> :</span></td><td> The dialog's title which will be set with
|
||
<a
|
||
href="../gtk/GtkWindow.html#gtk-window-set-title"
|
||
><code class="function">gtk_window_set_title()</code></a>.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>role</code></em> :</span></td><td> The dialog's <em class="parameter"><code>role</code></em> which will be set with
|
||
<a
|
||
href="../gtk/GtkWindow.html#gtk-window-set-role"
|
||
><code class="function">gtk_window_set_role()</code></a>.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>parent</code></em> :</span></td><td> The <em class="parameter"><code>parent</code></em> widget of this dialog.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>flags</code></em> :</span></td><td> The <em class="parameter"><code>flags</code></em> (see the <a
|
||
href="../gtk/GtkDialog.html"
|
||
><span class="type">GtkDialog</span></a> documentation).
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>help_func</code></em> :</span></td><td> The function which will be called if the user presses "F1".
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>help_id</code></em> :</span></td><td> The help_id which will be passed to <em class="parameter"><code>help_func</code></em>.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td> A <code class="literal">NULL</code>-terminated <em class="parameter"><code>va_list</code></em> destribing the
|
||
action_area buttons.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A <a href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a>.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2589642"></a><h3><a name="gimp-dialog-new-valist"></a>gimp_dialog_new_valist ()</h3><a class="indexterm" name="id2589651"></a><pre class="programlisting"><a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a>* gimp_dialog_new_valist (const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *role,
|
||
<a
|
||
href="../gtk/GtkWidget.html"
|
||
>GtkWidget</a> *parent,
|
||
<a
|
||
href="../gtk/GtkDialog.html#GtkDialogFlags"
|
||
>GtkDialogFlags</a> flags,
|
||
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
||
const <a
|
||
href="../glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *help_id,
|
||
va_list args);</pre><p>
|
||
Creates a new <em class="parameter"><code>GimpDialog</code></em> widget. If a GtkWindow is specified as
|
||
<em class="parameter"><code>parent</code></em> then the dialog will be made transient for this window.
|
||
</p><p>
|
||
For a description of the format of the <em class="parameter"><code>va_list</code></em> describing the
|
||
action_area buttons see <a
|
||
href="../gtk/GtkDialog.html#gtk-dialog-new-with-buttons"
|
||
><code class="function">gtk_dialog_new_with_buttons()</code></a>.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>title</code></em> :</span></td><td> The dialog's title which will be set with
|
||
<a
|
||
href="../gtk/GtkWindow.html#gtk-window-set-title"
|
||
><code class="function">gtk_window_set_title()</code></a>.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>role</code></em> :</span></td><td> The dialog's <em class="parameter"><code>role</code></em> which will be set with
|
||
<a
|
||
href="../gtk/GtkWindow.html#gtk-window-set-role"
|
||
><code class="function">gtk_window_set_role()</code></a>.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>parent</code></em> :</span></td><td> The <em class="parameter"><code>parent</code></em> widget of this dialog or <code class="literal">NULL</code>.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>flags</code></em> :</span></td><td> The <em class="parameter"><code>flags</code></em> (see the <a
|
||
href="../gtk/GtkDialog.html"
|
||
><span class="type">GtkDialog</span></a> documentation).
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>help_func</code></em> :</span></td><td> The function which will be called if the user presses "F1".
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>help_id</code></em> :</span></td><td> The help_id which will be passed to <em class="parameter"><code>help_func</code></em>.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>args</code></em> :</span></td><td> A <em class="parameter"><code>va_list</code></em> destribing the action_area buttons.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A <a href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a>.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2531906"></a><h3><a name="gimp-dialog-add-buttons-valist"></a>gimp_dialog_add_buttons_valist ()</h3><a class="indexterm" name="id2531914"></a><pre class="programlisting">void gimp_dialog_add_buttons_valist (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog,
|
||
va_list args);</pre><p>
|
||
This function is essentially the same as <a
|
||
href="../gtk/GtkDialog.html#gtk-dialog-add-buttons"
|
||
><code class="function">gtk_dialog_add_buttons()</code></a>
|
||
except it takes a va_list instead of '...'</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>dialog</code></em> :</span></td><td> The <em class="parameter"><code>dialog</code></em> to add buttons to.
|
||
</td></tr><tr><td><span class="term"><em class="parameter"><code>args</code></em> :</span></td><td> The buttons as va_list.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2591246"></a><h3><a name="gimp-dialog-run"></a>gimp_dialog_run ()</h3><a class="indexterm" name="id2591255"></a><pre class="programlisting"><a
|
||
href="../glib/glib-Basic-Types.html#gint"
|
||
>gint</a> gimp_dialog_run (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog);</pre><p>
|
||
This function does exactly the same as <a
|
||
href="../gtk/GtkDialog.html#gtk-dialog-run"
|
||
><code class="function">gtk_dialog_run()</code></a> except it
|
||
does not make the dialog modal while the <a
|
||
href="../glib/glib-The-Main-Event-Loop.html#GMainLoop"
|
||
><span class="type">GMainLoop</span></a> is running.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>dialog</code></em> :</span></td><td> a <a href="GimpDialog.html" title="GimpDialog"><span class="type">GimpDialog</span></a>
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> response ID
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2591323"></a><h3><a name="gimp-dialogs-show-help-button"></a>gimp_dialogs_show_help_button ()</h3><a class="indexterm" name="id2591334"></a><pre class="programlisting">void gimp_dialogs_show_help_button (<a
|
||
href="../glib/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> show);</pre><p>
|
||
This function is for internal use only.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>show</code></em> :</span></td><td> whether a help button should be added when creating a GimpDialog
|
||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||
</p></div></div><div class="refsect1" lang="en"><a name="id2591379"></a><h2>Properties</h2><div class="refsect2" lang="en"><a name="id2591385"></a><h3><a name="GimpDialog--help-func"></a>The "<code class="literal">help-func</code>" property</h3><pre class="programlisting"> "help-func" <a
|
||
href="../glib/glib-Basic-Types.html#gpointer"
|
||
>gpointer</a> : Read / Write / Construct Only</pre><p></p></div><hr><div class="refsect2" lang="en"><a name="id2591407"></a><h3><a name="GimpDialog--help-id"></a>The "<code class="literal">help-id</code>" property</h3><pre class="programlisting"> "help-id" <a
|
||
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
|
||
>gchararray</a> : Read / Write / Construct Only</pre><p></p><p>Default value: NULL</p></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="GimpColorSelection.html"><b><< GimpColorSelection</b></a></td><td align="right"><a accesskey="n" href="GimpFileEntry.html"><b>GimpFileEntry >></b></a></td></tr></table></body></html>
|