diff options
Diffstat (limited to 'devel-docs/libgimpwidgets/html/libgimpwidgets-GimpQueryBox.html')
| -rw-r--r-- | devel-docs/libgimpwidgets/html/libgimpwidgets-GimpQueryBox.html | 857 |
1 files changed, 857 insertions, 0 deletions
diff --git a/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpQueryBox.html b/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpQueryBox.html new file mode 100644 index 0000000..dbef685 --- /dev/null +++ b/devel-docs/libgimpwidgets/html/libgimpwidgets-GimpQueryBox.html @@ -0,0 +1,857 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpQueryBox: GIMP Widgets Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual"> +<link rel="up" href="libgimpwidgets-utils.html" title="Part VI. GIMP Widgets Utilities"> +<link rel="prev" href="libgimpwidgets-GimpHelpUI.html" title="GimpHelpUI"> +<link rel="next" href="libgimpwidgets-GimpIcons.html" title="GimpIcons"> +<meta name="generator" content="GTK-Doc V1.32 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimpwidgets-GimpQueryBox.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimpwidgets-utils.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimpwidgets-GimpHelpUI.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimpwidgets-GimpIcons.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimpwidgets-GimpQueryBox"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimpwidgets-GimpQueryBox.top_of_page"></a>GimpQueryBox</span></h2> +<p>GimpQueryBox — Some simple dialogs to enter a single int, +double, string or boolean value.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpQueryBox.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryStringCallback" title="GimpQueryStringCallback ()">*GimpQueryStringCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryIntCallback" title="GimpQueryIntCallback ()">*GimpQueryIntCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryDoubleCallback" title="GimpQueryDoubleCallback ()">*GimpQueryDoubleCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQuerySizeCallback" title="GimpQuerySizeCallback ()">*GimpQuerySizeCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryBooleanCallback" title="GimpQueryBooleanCallback ()">*GimpQueryBooleanCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpQueryBox.html#gimp-query-string-box" title="gimp_query_string_box ()">gimp_query_string_box</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpQueryBox.html#gimp-query-int-box" title="gimp_query_int_box ()">gimp_query_int_box</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpQueryBox.html#gimp-query-double-box" title="gimp_query_double_box ()">gimp_query_double_box</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpQueryBox.html#gimp-query-size-box" title="gimp_query_size_box ()">gimp_query_size_box</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpQueryBox.html#gimp-query-boolean-box" title="gimp_query_boolean_box ()">gimp_query_boolean_box</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="libgimpwidgets-GimpQueryBox.html#GIMP-QUERY-BOX-VBOX:CAPS" title="GIMP_QUERY_BOX_VBOX()">GIMP_QUERY_BOX_VBOX</a><span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpQueryBox.description"></a><h2>Description</h2> +<p>These functions provide simple dialogs for entering a single +string, integer, double, boolean or pixel size value.</p> +<p>They return a pointer to a <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> which has to be shown with +<a href="https://developer.gnome.org/gtk3/GtkWidget.html#gtk-widget-show"><code class="function">gtk_widget_show()</code></a> by the caller.</p> +<p>The dialogs contain an entry widget for the kind of value they ask +for and "OK" and "Cancel" buttons. On "Cancel", all query boxes +except the boolean one silently destroy themselves. On "OK" the +user defined callback function is called and returns the entered +value.</p> +</div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpQueryBox.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="GimpQueryStringCallback"></a><h3>GimpQueryStringCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpQueryStringCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *query_box</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>Note that you must not <code class="function">g_free()</code> the passed string.</p> +<div class="refsect3"> +<a name="GimpQueryStringCallback.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>query_box</p></td> +<td class="parameter_description"><p>The query box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>string</p></td> +<td class="parameter_description"><p>The entered string.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpQueryIntCallback"></a><h3>GimpQueryIntCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpQueryIntCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *query_box</code></em>, + <em class="parameter"><code><span class="type">gint</span> value</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>The callback for an int query box.</p> +<div class="refsect3"> +<a name="GimpQueryIntCallback.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>query_box</p></td> +<td class="parameter_description"><p>The query box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The entered integer value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpQueryDoubleCallback"></a><h3>GimpQueryDoubleCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpQueryDoubleCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *query_box</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> value</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>The callback for a double query box.</p> +<div class="refsect3"> +<a name="GimpQueryDoubleCallback.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>query_box</p></td> +<td class="parameter_description"><p>The query box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The entered double value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpQuerySizeCallback"></a><h3>GimpQuerySizeCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpQuerySizeCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *query_box</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> size</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a> unit</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>The callback for a size query box.</p> +<div class="refsect3"> +<a name="GimpQuerySizeCallback.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>query_box</p></td> +<td class="parameter_description"><p>The query box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>The entered size in pixels.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit</p></td> +<td class="parameter_description"><p>The selected unit from the <a class="link" href="GimpUnitMenu.html" title="GimpUnitMenu"><span class="type">GimpUnitMenu</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpQueryBooleanCallback"></a><h3>GimpQueryBooleanCallback ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*GimpQueryBooleanCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *query_box</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> value</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>The callback for a boolean query box.</p> +<div class="refsect3"> +<a name="GimpQueryBooleanCallback.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>query_box</p></td> +<td class="parameter_description"><p>The query box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>value</p></td> +<td class="parameter_description"><p>The entered boolean value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-query-string-box"></a><h3>gimp_query_string_box ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_query_string_box (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *initial</code></em>, + <em class="parameter"><code><span class="type">GObject</span> *object</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryStringCallback" title="GimpQueryStringCallback ()"><span class="type">GimpQueryStringCallback</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>Creates a new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> that queries the user for a string value.</p> +<div class="refsect3"> +<a name="gimp-query-string-box.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>The query box dialog's title.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>The dialog's parent widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_func</p></td> +<td class="parameter_description"><p>The help function to show this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_id</p></td> +<td class="parameter_description"><p>A string identifying this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>A string which will be shown above the dialog's entry widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>initial</p></td> +<td class="parameter_description"><p>The initial value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>The object this query box is associated with.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>signal</p></td> +<td class="parameter_description"><p>The object's signal which will cause the query box to be closed.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>The function which will be called when the user selects "OK".</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The callback's user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-query-string-box.returns"></a><h4>Returns</h4> +<p> A pointer to the new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-query-int-box"></a><h3>gimp_query_int_box ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_query_int_box (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>, + <em class="parameter"><code><span class="type">gint</span> initial</code></em>, + <em class="parameter"><code><span class="type">gint</span> lower</code></em>, + <em class="parameter"><code><span class="type">gint</span> upper</code></em>, + <em class="parameter"><code><span class="type">GObject</span> *object</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryIntCallback" title="GimpQueryIntCallback ()"><span class="type">GimpQueryIntCallback</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>Creates a new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> that queries the user for an integer value.</p> +<div class="refsect3"> +<a name="gimp-query-int-box.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>The query box dialog's title.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>The dialog's parent widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_func</p></td> +<td class="parameter_description"><p>The help function to show this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_id</p></td> +<td class="parameter_description"><p>A string identifying this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>A string which will be shown above the dialog's entry widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>initial</p></td> +<td class="parameter_description"><p>The initial value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>lower</p></td> +<td class="parameter_description"><p>The lower boundary of the range of possible values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>upper</p></td> +<td class="parameter_description"><p>The upper boundray of the range of possible values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>The object this query box is associated with.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>signal</p></td> +<td class="parameter_description"><p>The object's signal which will cause the query box to be closed.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>The function which will be called when the user selects "OK".</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The callback's user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-query-int-box.returns"></a><h4>Returns</h4> +<p> A pointer to the new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-query-double-box"></a><h3>gimp_query_double_box ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_query_double_box (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> initial</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> lower</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> upper</code></em>, + <em class="parameter"><code><span class="type">gint</span> digits</code></em>, + <em class="parameter"><code><span class="type">GObject</span> *object</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryDoubleCallback" title="GimpQueryDoubleCallback ()"><span class="type">GimpQueryDoubleCallback</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>Creates a new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> that queries the user for a double value.</p> +<div class="refsect3"> +<a name="gimp-query-double-box.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>The query box dialog's title.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>The dialog's parent widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_func</p></td> +<td class="parameter_description"><p>The help function to show this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_id</p></td> +<td class="parameter_description"><p>A string identifying this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>A string which will be shown above the dialog's entry widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>initial</p></td> +<td class="parameter_description"><p>The initial value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>lower</p></td> +<td class="parameter_description"><p>The lower boundary of the range of possible values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>upper</p></td> +<td class="parameter_description"><p>The upper boundray of the range of possible values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>digits</p></td> +<td class="parameter_description"><p>The number of decimal digits the <a href="https://developer.gnome.org/gtk3/GtkSpinButton.html#GtkSpinButton-struct"><span class="type">GtkSpinButton</span></a> will provide.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>The object this query box is associated with.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>signal</p></td> +<td class="parameter_description"><p>The object's signal which will cause the query box to be closed.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>The function which will be called when the user selects "OK".</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The callback's user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-query-double-box.returns"></a><h4>Returns</h4> +<p> A pointer to the new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-query-size-box"></a><h3>gimp_query_size_box ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_query_size_box (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> initial</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> lower</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> upper</code></em>, + <em class="parameter"><code><span class="type">gint</span> digits</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a> unit</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> resolution</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> dot_for_dot</code></em>, + <em class="parameter"><code><span class="type">GObject</span> *object</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQuerySizeCallback" title="GimpQuerySizeCallback ()"><span class="type">GimpQuerySizeCallback</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>Creates a new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> that queries the user for a size using a +<a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a>.</p> +<div class="refsect3"> +<a name="gimp-query-size-box.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>The query box dialog's title.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>The dialog's parent widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_func</p></td> +<td class="parameter_description"><p>The help function to show this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_id</p></td> +<td class="parameter_description"><p>A string identifying this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>A string which will be shown above the dialog's entry widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>initial</p></td> +<td class="parameter_description"><p>The initial value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>lower</p></td> +<td class="parameter_description"><p>The lower boundary of the range of possible values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>upper</p></td> +<td class="parameter_description"><p>The upper boundray of the range of possible values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>digits</p></td> +<td class="parameter_description"><p>The number of decimal digits the <a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a> provide in +"pixel" mode.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit</p></td> +<td class="parameter_description"><p>The unit initially shown by the <a class="link" href="GimpUnitMenu.html" title="GimpUnitMenu"><span class="type">GimpUnitMenu</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>resolution</p></td> +<td class="parameter_description"><p>The resolution (in dpi) which will be used for pixel/unit +calculations.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>dot_for_dot</p></td> +<td class="parameter_description"><p><code class="literal">TRUE</code> if the <a class="link" href="GimpUnitMenu.html" title="GimpUnitMenu"><span class="type">GimpUnitMenu</span></a>'s initial unit should be "pixels".</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>The object this query box is associated with.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>signal</p></td> +<td class="parameter_description"><p>The object's signal which will cause the query box +to be closed.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>The function which will be called when the user selects "OK".</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The callback's user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-query-size-box.returns"></a><h4>Returns</h4> +<p> A pointer to the new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-query-boolean-box"></a><h3>gimp_query_boolean_box ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_query_boolean_box (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *true_button</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *false_button</code></em>, + <em class="parameter"><code><span class="type">GObject</span> *object</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *signal</code></em>, + <em class="parameter"><code><a class="link" href="libgimpwidgets-GimpQueryBox.html#GimpQueryBooleanCallback" title="GimpQueryBooleanCallback ()"><span class="type">GimpQueryBooleanCallback</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>Creates a new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a> that asks the user to do a boolean decision.</p> +<div class="refsect3"> +<a name="gimp-query-boolean-box.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>title</p></td> +<td class="parameter_description"><p>The query box dialog's title.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>The dialog's parent widget.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_func</p></td> +<td class="parameter_description"><p>The help function to show this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help_id</p></td> +<td class="parameter_description"><p>A string identifying this dialog's help page.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>icon_name</p></td> +<td class="parameter_description"><p>An icon name to specify an icon to appear on the left +on the dialog's message.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>A string which will be shown in the query box.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>true_button</p></td> +<td class="parameter_description"><p>The string to be shown in the dialog's left button.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>false_button</p></td> +<td class="parameter_description"><p>The string to be shown in the dialog's right button.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>object</p></td> +<td class="parameter_description"><p>The object this query box is associated with.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>signal</p></td> +<td class="parameter_description"><p>The object's signal which will cause the query box +to be closed.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>The function which will be called when the user clicks one +of the buttons.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The callback's user data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-query-boolean-box.returns"></a><h4>Returns</h4> +<p> A pointer to the new <a href="https://developer.gnome.org/gtk3/GtkDialog.html#GtkDialog-struct"><span class="type">GtkDialog</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GIMP-QUERY-BOX-VBOX:CAPS"></a><h3>GIMP_QUERY_BOX_VBOX()</h3> +<pre class="programlisting">#define GIMP_QUERY_BOX_VBOX(qbox)</pre> +<p>A macro to access the <a href="https://developer.gnome.org/gtk3/GtkVBox.html#GtkVBox-struct"><span class="type">GtkVBox</span></a> in a <span class="type">libgimpwidgets-gimpquerybox</span>. +Useful if you want to add more widgets.</p> +<div class="refsect3"> +<a name="GIMP-QUERY-BOX-VBOX.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>qbox</p></td> +<td class="parameter_description"><p>The query box.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="libgimpwidgets-GimpQueryBox.see-also"></a><h2>See Also</h2> +<p><a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a>, <a class="link" href="GimpUnitMenu.html" title="GimpUnitMenu"><span class="type">GimpUnitMenu</span></a></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |