diff options
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gtk3/GtkOverlay.html')
| -rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gtk3/GtkOverlay.html | 220 |
1 files changed, 0 insertions, 220 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkOverlay.html b/gtk+-mingw/share/gtk-doc/html/gtk3/GtkOverlay.html deleted file mode 100644 index 38fa9cf..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkOverlay.html +++ /dev/null @@ -1,220 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GtkOverlay</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="GTK+ 3 Reference Manual"> -<link rel="up" href="LayoutContainers.html" title="Layout Containers"> -<link rel="prev" href="GtkExpander.html" title="GtkExpander"> -<link rel="next" href="gtk3-Orientable.html" title="GtkOrientable"> -<meta name="generator" content="GTK-Doc V1.18.1 (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="2"> -<tr valign="middle"> -<td><a accesskey="p" href="GtkExpander.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="LayoutContainers.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">GTK+ 3 Reference Manual</th> -<td><a accesskey="n" href="gtk3-Orientable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#GtkOverlay.synopsis" class="shortcut">Top</a> - | - <a href="#GtkOverlay.description" class="shortcut">Description</a> - | - <a href="#GtkOverlay.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#GtkOverlay.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#GtkOverlay.signals" class="shortcut">Signals</a> -</td></tr> -</table> -<div class="refentry"> -<a name="GtkOverlay"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GtkOverlay.top_of_page"></a>GtkOverlay</span></h2> -<p>GtkOverlay — A container which overlays widgets on top of each other</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="GtkOverlay.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <gtk/gtk.h> - -struct <a class="link" href="GtkOverlay.html#GtkOverlay-struct" title="struct GtkOverlay">GtkOverlay</a>; -<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkOverlay.html#gtk-overlay-new" title="gtk_overlay_new ()">gtk_overlay_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -<span class="returnvalue">void</span> <a class="link" href="GtkOverlay.html#gtk-overlay-add-overlay" title="gtk_overlay_add_overlay ()">gtk_overlay_add_overlay</a> (<em class="parameter"><code><a class="link" href="GtkOverlay.html" title="GtkOverlay"><span class="type">GtkOverlay</span></a> *overlay</code></em>, - <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="GtkOverlay.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> - +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> - +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a> - +----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a> - +----GtkOverlay -</pre> -</div> -<div class="refsect1"> -<a name="GtkOverlay.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -GtkOverlay implements - AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p> -</div> -<div class="refsect1"> -<a name="GtkOverlay.signals"></a><h2>Signals</h2> -<pre class="synopsis"> - "<a class="link" href="GtkOverlay.html#GtkOverlay-get-child-position" title='The "get-child-position" signal'>get-child-position</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a> -</pre> -</div> -<div class="refsect1"> -<a name="GtkOverlay.description"></a><h2>Description</h2> -<p> -GtkOverlay is a container which contains a single main child, on top -of which it can place <em class="firstterm">overlay</em> widgets. The -position of each overlay widget is determined by its <a class="link" href="GtkWidget.html#GtkWidget--halign" title='The "halign" property'><span class="type">"halign"</span></a> -and <a class="link" href="GtkWidget.html#GtkWidget--valign" title='The "valign" property'><span class="type">"valign"</span></a> properties. E.g. a widget with both alignments -set to <a class="link" href="GtkWidget.html#GTK-ALIGN-START:CAPS"><code class="literal">GTK_ALIGN_START</code></a> will be placed at the top left corner of the -main widget, whereas an overlay with halign set to <a class="link" href="GtkWidget.html#GTK-ALIGN-CENTER:CAPS"><code class="literal">GTK_ALIGN_CENTER</code></a> -and valign set to <a class="link" href="GtkWidget.html#GTK-ALIGN-END:CAPS"><code class="literal">GTK_ALIGN_END</code></a> will be placed a the bottom edge of -the main widget, horizontally centered. The position can be adjusted -by setting the margin properties of the child to non-zero values. -</p> -<p> -More complicated placement of overlays is possible by connecting -to the <a class="link" href="GtkOverlay.html#GtkOverlay-get-child-position" title='The "get-child-position" signal'><span class="type">"get-child-position"</span></a> signal. -</p> -<p> -</p> -<div class="refsect2"> -<a name="GtkOverlay-BUILDER-UI"></a><h3>GtkOverlay as GtkBuildable</h3> -<p> -The GtkOverlay implementation of the GtkBuildable interface -supports placing a child as an overlay by specifying "overlay" as -the "type" attribute of a <code class="sgmltag-starttag"><child></code> element. -</p> -</div> -<p> -</p> -</div> -<div class="refsect1"> -<a name="GtkOverlay.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="GtkOverlay-struct"></a><h3>struct GtkOverlay</h3> -<pre class="programlisting">struct GtkOverlay;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-overlay-new"></a><h3>gtk_overlay_new ()</h3> -<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_overlay_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Creates a new <a class="link" href="GtkOverlay.html" title="GtkOverlay"><span class="type">GtkOverlay</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new <a class="link" href="GtkOverlay.html" title="GtkOverlay"><span class="type">GtkOverlay</span></a> object.</td> -</tr></tbody> -</table></div> -<p class="since">Since 3.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-overlay-add-overlay"></a><h3>gtk_overlay_add_overlay ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gtk_overlay_add_overlay (<em class="parameter"><code><a class="link" href="GtkOverlay.html" title="GtkOverlay"><span class="type">GtkOverlay</span></a> *overlay</code></em>, - <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre> -<p> -Adds <em class="parameter"><code>widget</code></em> to <em class="parameter"><code>overlay</code></em>. -</p> -<p> -The widget will be stacked on top of the main widget -added with <a class="link" href="GtkContainer.html#gtk-container-add" title="gtk_container_add ()"><code class="function">gtk_container_add()</code></a>. -</p> -<p> -The position at which <em class="parameter"><code>widget</code></em> is placed is determined -from its <a class="link" href="GtkWidget.html#GtkWidget--halign" title='The "halign" property'><span class="type">"halign"</span></a> and <a class="link" href="GtkWidget.html#GtkWidget--valign" title='The "valign" property'><span class="type">"valign"</span></a> properties. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>overlay</code></em> :</span></p></td> -<td>a <a class="link" href="GtkOverlay.html" title="GtkOverlay"><span class="type">GtkOverlay</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td> -<td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> to be added to the container</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 3.2</p> -</div> -</div> -<div class="refsect1"> -<a name="GtkOverlay.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="GtkOverlay-get-child-position"></a><h3>The <code class="literal">"get-child-position"</code> signal</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> user_function (<a class="link" href="GtkOverlay.html" title="GtkOverlay"><span class="type">GtkOverlay</span></a> *overlay, - <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget, - <a href="http://developer.gnome.org/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *allocation, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre> -<p> -The ::get-child-position signal is emitted to determine -the position and size of any overlay child widgets. A -handler for this signal should fill <em class="parameter"><code>allocation</code></em> with -the desired position and size for <em class="parameter"><code>widget</code></em>, relative to -the 'main' child of <em class="parameter"><code>overlay</code></em>. -</p> -<p> -The default handler for this signal uses the <em class="parameter"><code>widget</code></em>'s -halign and valign properties to determine the position -and gives the widget its natural size (except that an -alignment of <a class="link" href="GtkWidget.html#GTK-ALIGN-FILL:CAPS"><code class="literal">GTK_ALIGN_FILL</code></a> will cause the overlay to -be full-width/height). If the main child is a -<a class="link" href="GtkScrolledWindow.html" title="GtkScrolledWindow"><span class="type">GtkScrolledWindow</span></a>, the overlays are placed relative -to its contents. -</p> -<p> -Return: <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>allocation</code></em> has been filled -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>overlay</code></em> :</span></p></td> -<td>the <a class="link" href="GtkOverlay.html" title="GtkOverlay"><span class="type">GtkOverlay</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td> -<td>the child widget to position</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>allocation</code></em> :</span></p></td> -<td>return location for the allocation. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>user data set when the signal handler was connected.</td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |