<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkOverlayLayout">
<refmeta>
<refentrytitle role="top_of_page" id="GtkOverlayLayout.top_of_page">GtkOverlayLayout</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkOverlayLayout</refname>
<refpurpose>Layout manager that places widgets as overlays</refpurpose>
</refnamediv>

<refsect1 id="GtkOverlayLayout.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkLayoutManager"><returnvalue>GtkLayoutManager</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-overlay-layout-new">gtk_overlay_layout_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-overlay-layout-child-set-measure">gtk_overlay_layout_child_set_measure</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-overlay-layout-child-get-measure">gtk_overlay_layout_child_get_measure</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-overlay-layout-child-set-clip-overlay">gtk_overlay_layout_child_set_clip_overlay</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-overlay-layout-child-get-clip-overlay">gtk_overlay_layout_child_get_clip_overlay</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkOverlayLayout.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkOverlayLayoutChild--clip-overlay">clip-overlay</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkOverlayLayoutChild--measure">measure</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<anchor id="GtkOverlayLayoutChild"/><refsect1 id="GtkOverlayLayout.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkOverlayLayout-struct">GtkOverlayLayout</link></entry></row>

<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkOverlayLayoutChild-struct">GtkOverlayLayoutChild</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkOverlayLayout.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9500;&#9472;&#9472;</phrase> <link linkend="GtkLayoutChild">GtkLayoutChild</link>
    <phrase role="lineart">&#9474;</phrase>   <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkOverlayLayoutChild
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkLayoutManager">GtkLayoutManager</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkOverlayLayout
</screen>
</refsect1>

<refsect1 id="GtkOverlayLayout.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkOverlayLayout.description" role="desc">
<title role="desc.title">Description</title>
<para>GtkOverlayLayout is the layout manager used by <link linkend="GtkOverlay"><type>GtkOverlay</type></link>.
It places widgets as overlays on top of the main child.</para>
<para>This is not a reusable layout manager, since it expects its widget
to be a <link linkend="GtkOverlay"><type>GtkOverlay</type></link>. It only listed here so that its layout
properties get documented.</para>

</refsect1>
<refsect1 id="GtkOverlayLayout.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-overlay-layout-new" role="function">
<title>gtk_overlay_layout_new&#160;()</title>
<indexterm zone="gtk-overlay-layout-new"><primary>gtk_overlay_layout_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkLayoutManager"><returnvalue>GtkLayoutManager</returnvalue></link>&#160;*
gtk_overlay_layout_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="GtkOverlayLayout"><type>GtkOverlayLayout</type></link> instance.</para>
<refsect3 id="gtk-overlay-layout-new.returns" role="returns">
<title>Returns</title>
<para> the newly created instance</para>
</refsect3></refsect2>
<refsect2 id="gtk-overlay-layout-child-set-measure" role="function">
<title>gtk_overlay_layout_child_set_measure&#160;()</title>
<indexterm zone="gtk-overlay-layout-child-set-measure"><primary>gtk_overlay_layout_child_set_measure</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_overlay_layout_child_set_measure (<parameter><link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link> *child</parameter>,
                                      <parameter><link linkend="gboolean"><type>gboolean</type></link> measure</parameter>);</programlisting>
<para>Sets whether to measure this child.</para>
<refsect3 id="gtk-overlay-layout-child-set-measure.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>child</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>measure</para></entry>
<entry role="parameter_description"><para>whether to measure this child</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-overlay-layout-child-get-measure" role="function">
<title>gtk_overlay_layout_child_get_measure&#160;()</title>
<indexterm zone="gtk-overlay-layout-child-get-measure"><primary>gtk_overlay_layout_child_get_measure</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_overlay_layout_child_get_measure (<parameter><link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link> *child</parameter>);</programlisting>
<para>Retrieves whether the child is measured.</para>
<refsect3 id="gtk-overlay-layout-child-get-measure.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>child</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-overlay-layout-child-get-measure.returns" role="returns">
<title>Returns</title>
<para> whether the child is measured</para>
</refsect3></refsect2>
<refsect2 id="gtk-overlay-layout-child-set-clip-overlay" role="function">
<title>gtk_overlay_layout_child_set_clip_overlay&#160;()</title>
<indexterm zone="gtk-overlay-layout-child-set-clip-overlay"><primary>gtk_overlay_layout_child_set_clip_overlay</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_overlay_layout_child_set_clip_overlay
                               (<parameter><link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link> *child</parameter>,
                                <parameter><link linkend="gboolean"><type>gboolean</type></link> clip_overlay</parameter>);</programlisting>
<para>Sets whether to clip this child.</para>
<refsect3 id="gtk-overlay-layout-child-set-clip-overlay.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>child</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>clip_overlay</para></entry>
<entry role="parameter_description"><para>whether to clip this child</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-overlay-layout-child-get-clip-overlay" role="function">
<title>gtk_overlay_layout_child_get_clip_overlay&#160;()</title>
<indexterm zone="gtk-overlay-layout-child-get-clip-overlay"><primary>gtk_overlay_layout_child_get_clip_overlay</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_overlay_layout_child_get_clip_overlay
                               (<parameter><link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link> *child</parameter>);</programlisting>
<para>Retrieves whether the child is clipped.</para>
<refsect3 id="gtk-overlay-layout-child-get-clip-overlay.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>child</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkOverlayLayoutChild"><type>GtkOverlayLayoutChild</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-overlay-layout-child-get-clip-overlay.returns" role="returns">
<title>Returns</title>
<para> whether the child is clipped</para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkOverlayLayout.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkOverlayLayout-struct" role="struct">
<title>GtkOverlayLayout</title>
<indexterm zone="GtkOverlayLayout-struct"><primary>GtkOverlayLayout</primary></indexterm>
<programlisting language="C">typedef struct _GtkOverlayLayout GtkOverlayLayout;</programlisting>
</refsect2>
<refsect2 id="GtkOverlayLayoutChild-struct" role="struct">
<title>GtkOverlayLayoutChild</title>
<indexterm zone="GtkOverlayLayoutChild-struct"><primary>GtkOverlayLayoutChild</primary></indexterm>
<programlisting language="C">typedef struct _GtkOverlayLayoutChild GtkOverlayLayoutChild;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkOverlayLayout.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkOverlayLayoutChild--clip-overlay" role="property"><title>The <literal>“clip-overlay”</literal> property</title>
<indexterm zone="GtkOverlayLayoutChild--clip-overlay"><primary>GtkOverlayLayoutChild:clip-overlay</primary></indexterm>
<programlisting>  “clip-overlay”             <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the child should be clipped to fit the parent's size.</para>
<para>Owner: GtkOverlayLayoutChild</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkOverlayLayoutChild--measure" role="property"><title>The <literal>“measure”</literal> property</title>
<indexterm zone="GtkOverlayLayoutChild--measure"><primary>GtkOverlayLayoutChild:measure</primary></indexterm>
<programlisting>  “measure”                  <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the child size should contribute to the <link linkend="GtkOverlayLayout"><type>GtkOverlayLayout</type></link>'s
measurement.</para>
<para>Owner: GtkOverlayLayoutChild</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>

</refsect1>

</refentry>
