443 lines
20 KiB
HTML
443 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>GimpDialog</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
|
|
<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="GimpEnumStore.html" title="GimpEnumStore">
|
|
<meta name="generator" content="GTK-Doc V1.8 (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-gallery.html" title="Widget Gallery">
|
|
<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">
|
|
<link rel="index" href="libgimpwidgets-index.html" title="Index">
|
|
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table class="navigation" id="top" 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="GimpEnumStore.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
|
</tr>
|
|
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2509937" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2560661" class="shortcut">Description</a>
|
|
 | 
|
|
<a href="#id2604737" class="shortcut">Object Hierarchy</a>
|
|
 | 
|
|
<a href="#id2604804" class="shortcut">Implemented Interfaces</a>
|
|
 | 
|
|
<a href="#id2560617" class="shortcut">Properties</a></nobr></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>
|
|
<a name="id2509937"></a><span class="refentrytitle">GimpDialog</span>
|
|
</h2>
|
|
<p>GimpDialog — Constructors for <span class="type">GtkDialog</span>'s and action_areas as well as other
|
|
dialog-related stuff.</p>
|
|
</td>
|
|
<td valign="top" align="right"><img src="gimp-dialog.png"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a href="GimpDialog.html#GimpDialog-struct">GimpDialog</a>;
|
|
GtkWidget* <a href="GimpDialog.html#gimp-dialog-new">gimp_dialog_new</a> (const gchar *title,
|
|
const gchar *role,
|
|
GtkWidget *parent,
|
|
GtkDialogFlags flags,
|
|
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
|
const gchar *help_id,
|
|
...);
|
|
GtkWidget* <a href="GimpDialog.html#gimp-dialog-new-valist">gimp_dialog_new_valist</a> (const gchar *title,
|
|
const gchar *role,
|
|
GtkWidget *parent,
|
|
GtkDialogFlags flags,
|
|
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
|
const gchar *help_id,
|
|
va_list args);
|
|
GtkWidget* <a href="GimpDialog.html#gimp-dialog-add-button">gimp_dialog_add_button</a> (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog,
|
|
const gchar *button_text,
|
|
gint response_id);
|
|
void <a href="GimpDialog.html#gimp-dialog-add-buttons">gimp_dialog_add_buttons</a> (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog,
|
|
...);
|
|
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);
|
|
gint <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> (gboolean show);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2604737"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
GObject
|
|
+----GInitiallyUnowned
|
|
+----GtkObject
|
|
+----GtkWidget
|
|
+----GtkContainer
|
|
+----GtkBin
|
|
+----GtkWindow
|
|
+----GtkDialog
|
|
+----GimpDialog
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2604804"></a><h2>Implemented Interfaces</h2>
|
|
<p>
|
|
GimpDialog implements
|
|
AtkImplementorIface.</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2560617"></a><h2>Properties</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a href="GimpDialog.html#GimpDialog--help-func">help-func</a>" gpointer : Read / Write / Construct Only
|
|
"<a href="GimpDialog.html#GimpDialog--help-id">help-id</a>" gchararray : Read / Write / Construct Only
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2560661"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2560677"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2560687"></a><h3>
|
|
<a name="GimpDialog-struct"></a>GimpDialog</h3>
|
|
<a class="indexterm" name="id2560700"></a><pre class="programlisting">typedef struct _GimpDialog GimpDialog;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2560715"></a><h3>
|
|
<a name="gimp-dialog-new"></a>gimp_dialog_new ()</h3>
|
|
<a class="indexterm" name="id2560727"></a><pre class="programlisting">GtkWidget* gimp_dialog_new (const gchar *title,
|
|
const gchar *role,
|
|
GtkWidget *parent,
|
|
GtkDialogFlags flags,
|
|
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
|
const gchar *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 <code class="function">gtk_dialog_new_with_buttons()</code>.</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
|
|
<code class="function">gtk_window_set_title()</code>.
|
|
</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
|
|
<code class="function">gtk_window_set_role()</code>.
|
|
</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 <span class="type">GtkDialog</span> 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="id2605002"></a><h3>
|
|
<a name="gimp-dialog-new-valist"></a>gimp_dialog_new_valist ()</h3>
|
|
<a class="indexterm" name="id2605013"></a><pre class="programlisting">GtkWidget* gimp_dialog_new_valist (const gchar *title,
|
|
const gchar *role,
|
|
GtkWidget *parent,
|
|
GtkDialogFlags flags,
|
|
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
|
|
const gchar *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 <code class="function">gtk_dialog_new_with_buttons()</code>.</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
|
|
<code class="function">gtk_window_set_title()</code>.
|
|
</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
|
|
<code class="function">gtk_window_set_role()</code>.
|
|
</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 <span class="type">GtkDialog</span> 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="id2608110"></a><h3>
|
|
<a name="gimp-dialog-add-button"></a>gimp_dialog_add_button ()</h3>
|
|
<a class="indexterm" name="id2608122"></a><pre class="programlisting">GtkWidget* gimp_dialog_add_button (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog,
|
|
const gchar *button_text,
|
|
gint response_id);</pre>
|
|
<p>
|
|
This function is essentially the same as <code class="function">gtk_dialog_add_button()</code>
|
|
except it ensures there is only one help button and automatically
|
|
sets the RESPONSE_OK widget as the default response.</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 a button to.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>button_text</code></em> :</span></td>
|
|
<td> text of button, or stock ID.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>response_id</code></em> :</span></td>
|
|
<td> response ID for the button.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> the button widget that was added.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608243"></a><h3>
|
|
<a name="gimp-dialog-add-buttons"></a>gimp_dialog_add_buttons ()</h3>
|
|
<a class="indexterm" name="id2608254"></a><pre class="programlisting">void gimp_dialog_add_buttons (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog,
|
|
...);</pre>
|
|
<p>
|
|
This function is essentially the same as <code class="function">gtk_dialog_add_buttons()</code>
|
|
except it calls <a href="GimpDialog.html#gimp-dialog-add-button"><code class="function">gimp_dialog_add_button()</code></a> instead of <code class="function">gtk_dialog_add_button()</code></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>...</code></em> :</span></td>
|
|
<td> button_text-response_id pairs.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608351"></a><h3>
|
|
<a name="gimp-dialog-add-buttons-valist"></a>gimp_dialog_add_buttons_valist ()</h3>
|
|
<a class="indexterm" name="id2608364"></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="GimpDialog.html#gimp-dialog-add-buttons"><code class="function">gimp_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="id2608450"></a><h3>
|
|
<a name="gimp-dialog-run"></a>gimp_dialog_run ()</h3>
|
|
<a class="indexterm" name="id2608463"></a><pre class="programlisting">gint gimp_dialog_run (<a href="GimpDialog.html" title="GimpDialog">GimpDialog</a> *dialog);</pre>
|
|
<p>
|
|
This function does exactly the same as <code class="function">gtk_dialog_run()</code> except it
|
|
does not make the dialog modal while the <span class="type">GMainLoop</span> 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="id2608549"></a><h3>
|
|
<a name="gimp-dialogs-show-help-button"></a>gimp_dialogs_show_help_button ()</h3>
|
|
<a class="indexterm" name="id2608564"></a><pre class="programlisting">void gimp_dialogs_show_help_button (gboolean 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 class="since">Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2608624"></a><h2>Property Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608635"></a><h3>
|
|
<a name="GimpDialog--help-func"></a>The "<code class="literal">help-func</code>" property</h3>
|
|
<a class="indexterm" name="id2608649"></a><pre class="programlisting"> "help-func" gpointer : Read / Write / Construct Only</pre>
|
|
<p></p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2608670"></a><h3>
|
|
<a name="GimpDialog--help-id"></a>The "<code class="literal">help-id</code>" property</h3>
|
|
<a class="indexterm" name="id2608685"></a><pre class="programlisting"> "help-id" gchararray : Read / Write / Construct Only</pre>
|
|
<p></p>
|
|
<p>Default value: NULL</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|