diff options
Diffstat (limited to 'devel-docs/libgimpwidgets/html/GimpBrowser.html')
| -rw-r--r-- | devel-docs/libgimpwidgets/html/GimpBrowser.html | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/devel-docs/libgimpwidgets/html/GimpBrowser.html b/devel-docs/libgimpwidgets/html/GimpBrowser.html new file mode 100644 index 0000000..56e9669 --- /dev/null +++ b/devel-docs/libgimpwidgets/html/GimpBrowser.html @@ -0,0 +1,277 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpBrowser: 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-widgets.html" title="Part I. GIMP Widgets"> +<link rel="prev" href="libgimpwidgets-gallery.html" title="Widget Gallery"> +<link rel="next" href="GimpButton.html" title="GimpButton"> +<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="#GimpBrowser.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GimpBrowser.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#GimpBrowser.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#GimpBrowser.signals" class="shortcut">Signals</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-widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimpwidgets-gallery.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GimpButton.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GimpBrowser"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GimpBrowser.top_of_page"></a>GimpBrowser</span></h2> +<p>GimpBrowser — A base class for a documentation browser.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GimpBrowser.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"> +<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="GimpBrowser.html#gimp-browser-new" title="gimp_browser_new ()">gimp_browser_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpBrowser.html#gimp-browser-add-search-types" title="gimp_browser_add_search_types ()">gimp_browser_add_search_types</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpBrowser.html#gimp-browser-set-widget" title="gimp_browser_set_widget ()">gimp_browser_set_widget</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GimpBrowser.html#gimp-browser-show-message" title="gimp_browser_show_message ()">gimp_browser_show_message</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpBrowser.signals"></a><h2>Signals</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="signal_proto_type"> +<col width="300px" class="signal_proto_name"> +<col width="200px" class="signal_proto_flags"> +</colgroup> +<tbody><tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GimpBrowser.html#GimpBrowser-search" title="The “search” signal">search</a></td> +<td class="signal_flags">Run Last</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpBrowser.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GimpBrowser.html#GimpBrowser-struct" title="GimpBrowser">GimpBrowser</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpBrowser.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> GInitiallyUnowned + <span class="lineart">╰──</span> GtkObject + <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a> + <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a> + <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkPaned.html#GtkPaned-struct">GtkPaned</a> + <span class="lineart">╰──</span> <a href="https://developer.gnome.org/gtk3/GtkHPaned.html#GtkHPaned-struct">GtkHPaned</a> + <span class="lineart">╰──</span> GimpBrowser +</pre> +</div> +<div class="refsect1"> +<a name="GimpBrowser.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GimpBrowser implements + AtkImplementorIface, <a href="https://developer.gnome.org/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a> and <a href="https://developer.gnome.org/gtk3/gtk3-Orientable.html#GtkOrientable-struct">GtkOrientable</a>.</p> +</div> +<div class="refsect1"> +<a name="GimpBrowser.description"></a><h2>Description</h2> +<p>A base class for a documentation browser.</p> +</div> +<div class="refsect1"> +<a name="GimpBrowser.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-browser-new"></a><h3>gimp_browser_new ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> * +gimp_browser_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Create a new <a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> widget.</p> +<div class="refsect3"> +<a name="gimp-browser-new.returns"></a><h4>Returns</h4> +<p> a newly created <a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-browser-add-search-types"></a><h3>gimp_browser_add_search_types ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_browser_add_search_types (<em class="parameter"><code><a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> *browser</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *first_type_label</code></em>, + <em class="parameter"><code><span class="type">gint</span> first_type_id</code></em>, + <em class="parameter"><code>...</code></em>);</pre> +<p>Populates the <a href="https://developer.gnome.org/gtk3/GtkComboBox.html#GtkComboBox-struct"><span class="type">GtkComboBox</span></a> with search types.</p> +<div class="refsect3"> +<a name="gimp-browser-add-search-types.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>browser</p></td> +<td class="parameter_description"><p>a <a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> widget</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_type_label</p></td> +<td class="parameter_description"><p>the label of the first search type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>first_type_id</p></td> +<td class="parameter_description"><p>an integer that identifies the first search type</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>...</p></td> +<td class="parameter_description"><p>a <code class="literal">NULL</code>-terminated list of more labels and ids.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-browser-set-widget"></a><h3>gimp_browser_set_widget ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_browser_set_widget (<em class="parameter"><code><a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> *browser</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre> +<p>Sets the widget to appear on the right side of the <em class="parameter"><code>browser</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-browser-set-widget.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>browser</p></td> +<td class="parameter_description"><p>a <a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> widget</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>widget</p></td> +<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-browser-show-message"></a><h3>gimp_browser_show_message ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gimp_browser_show_message (<em class="parameter"><code><a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> *browser</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre> +<p>Displays <em class="parameter"><code>message</code></em> + in the right side of the <em class="parameter"><code>browser</code></em> +. Unless the right +side already contains a <a href="https://developer.gnome.org/gtk3/GtkLabel.html#GtkLabel-struct"><span class="type">GtkLabel</span></a>, the widget previously added with +<a class="link" href="GimpBrowser.html#gimp-browser-set-widget" title="gimp_browser_set_widget ()"><code class="function">gimp_browser_set_widget()</code></a> is removed and replaced by a <a href="https://developer.gnome.org/gtk3/GtkLabel.html#GtkLabel-struct"><span class="type">GtkLabel</span></a>.</p> +<div class="refsect3"> +<a name="gimp-browser-show-message.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>browser</p></td> +<td class="parameter_description"><p>a <a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> widget</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>message</p></td> +<td class="parameter_description"><p>text message</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +</div> +<div class="refsect1"> +<a name="GimpBrowser.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpBrowser-struct"></a><h3>GimpBrowser</h3> +<pre class="programlisting">typedef struct _GimpBrowser GimpBrowser;</pre> +</div> +</div> +<div class="refsect1"> +<a name="GimpBrowser.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="GimpBrowser-search"></a><h3>The <code class="literal">“search”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GimpBrowser.html" title="GimpBrowser"><span class="type">GimpBrowser</span></a> *gimpbrowser, + <span class="type">gchar</span> *arg1, + <span class="type">gint</span> arg2, + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run Last</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |