Files
clapper/doc/clapper-gtk/class.EngageLayer.html
2024-01-21 20:51:05 +01:00

1311 lines
53 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>ClapperGtk.EngageLayer</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="ClapperGtk-0.0"/>
<meta property="og:title" content="ClapperGtk.EngageLayer"/>
<meta property="og:description" content="Reference for ClapperGtk.EngageLayer"/>
<meta name="twitter:title" content="ClapperGtk.EngageLayer"/>
<meta name="twitter:description" content="Reference for ClapperGtk.EngageLayer"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="ClapperGtk" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">ClapperGtk</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.EngageLayer.html#description">EngageLayer</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.EngageLayer.new.html">new</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">ClapperGtk</a><span class="sep" role="presentation"></span>EngageLayer</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper-gtk/clapper-gtk-engage-layer.c#L20">[src]</a>
</h4>
<pre><code>final class ClapperGtk.EngageLayer : ClapperGtk.LeadContainer
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
}</pre></code>
<div class="docblock">
<p>A layer with big <code>play</code> button, engaging user to start the&nbsp;playback.</p>
<p><code>ClapperGtkEngageLayer</code> widget is meant to be overlaid on top of
<a href="class.Video.html"><code>ClapperGtkVideo</code></a> as a normal (non-fading) overlay. It takes
care of fading itself once clicked and/or playback is&nbsp;started.</p>
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for ClapperGtk.EngageLayer">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="405pt" height="476pt"
viewBox="0.00 0.00 404.50 476.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 472)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperGtkEngageLayer">
<path fill="none" stroke="black" d="M241,-108C241,-108 113,-108 113,-108 107,-108 101,-102 101,-96 101,-96 101,-84 101,-84 101,-78 107,-72 113,-72 113,-72 241,-72 241,-72 247,-72 253,-78 253,-84 253,-84 253,-96 253,-96 253,-102 247,-108 241,-108"/>
<text text-anchor="middle" x="177" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperGtkEngageLayer</text>
</a>
</g>
</g>
<!-- implements_0 -->
<g id="node7" class="node">
<title>implements_0</title>
<g id="a_node7"><a xlink:title="Gtk.Accessible">
<polygon fill="none" stroke="black" points="108,-36 0,-36 0,0 108,0 108,-36"/>
<text text-anchor="middle" x="54" y="-14.3" font-family="sans-serif" font-size="14.00">GtkAccessible</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_0 -->
<g id="edge6" class="edge">
<title>this&#45;&#45;implements_0</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M146.28,-71.52C127.35,-60.74 103.18,-46.99 84.33,-36.26"/>
</g>
<!-- implements_1 -->
<g id="node8" class="node">
<title>implements_1</title>
<g id="a_node8"><a xlink:title="Gtk.Buildable">
<polygon fill="none" stroke="black" points="227.5,-36 126.5,-36 126.5,0 227.5,0 227.5,-36"/>
<text text-anchor="middle" x="177" y="-14.3" font-family="sans-serif" font-size="14.00">GtkBuildable</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_1 -->
<g id="edge7" class="edge">
<title>this&#45;&#45;implements_1</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M177,-71.7C177,-60.85 177,-46.92 177,-36.1"/>
</g>
<!-- implements_2 -->
<g id="node9" class="node">
<title>implements_2</title>
<g id="a_node9"><a xlink:title="Gtk.ConstraintTarget">
<polygon fill="none" stroke="black" points="396.5,-36 245.5,-36 245.5,0 396.5,0 396.5,-36"/>
<text text-anchor="middle" x="321" y="-14.3" font-family="sans-serif" font-size="14.00">GtkConstraintTarget</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_2 -->
<g id="edge8" class="edge">
<title>this&#45;&#45;implements_2</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M212.97,-71.52C235.12,-60.74 263.42,-46.99 285.49,-36.26"/>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node link">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:href="class.LeadContainer.html" xlink:title="ClapperGtkLeadContainer">
<path fill="none" stroke="black" d="M245.5,-180C245.5,-180 108.5,-180 108.5,-180 102.5,-180 96.5,-174 96.5,-168 96.5,-168 96.5,-156 96.5,-156 96.5,-150 102.5,-144 108.5,-144 108.5,-144 245.5,-144 245.5,-144 251.5,-144 257.5,-150 257.5,-156 257.5,-156 257.5,-168 257.5,-168 257.5,-174 251.5,-180 245.5,-180"/>
<text text-anchor="middle" x="177" y="-158.3" font-family="Times,serif" font-size="14.00">ClapperGtkLeadContainer</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge5" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M177,-143.7C177,-132.85 177,-118.92 177,-108.1"/>
</g>
<!-- ancestor_1 -->
<g id="node3" class="node link">
<title>ancestor_1</title>
<g id="a_node3"><a xlink:href="class.Container.html" xlink:title="ClapperGtkContainer">
<path fill="none" stroke="black" d="M231.5,-252C231.5,-252 122.5,-252 122.5,-252 116.5,-252 110.5,-246 110.5,-240 110.5,-240 110.5,-228 110.5,-228 110.5,-222 116.5,-216 122.5,-216 122.5,-216 231.5,-216 231.5,-216 237.5,-216 243.5,-222 243.5,-228 243.5,-228 243.5,-240 243.5,-240 243.5,-246 237.5,-252 231.5,-252"/>
<text text-anchor="middle" x="177" y="-230.3" font-family="Times,serif" font-size="14.00">ClapperGtkContainer</text>
</a>
</g>
</g>
<!-- ancestor_1&#45;&#45;ancestor_0 -->
<g id="edge4" class="edge">
<title>ancestor_1&#45;&#45;ancestor_0</title>
<path fill="none" stroke="black" d="M177,-215.7C177,-204.85 177,-190.92 177,-180.1"/>
</g>
<!-- ancestor_2 -->
<g id="node4" class="node">
<title>ancestor_2</title>
<g id="a_node4"><a xlink:title="Gtk.Widget">
<path fill="none" stroke="black" d="M203.5,-324C203.5,-324 150.5,-324 150.5,-324 144.5,-324 138.5,-318 138.5,-312 138.5,-312 138.5,-300 138.5,-300 138.5,-294 144.5,-288 150.5,-288 150.5,-288 203.5,-288 203.5,-288 209.5,-288 215.5,-294 215.5,-300 215.5,-300 215.5,-312 215.5,-312 215.5,-318 209.5,-324 203.5,-324"/>
<text text-anchor="middle" x="177" y="-302.3" font-family="Times,serif" font-size="14.00">GtkWidget</text>
</a>
</g>
</g>
<!-- ancestor_2&#45;&#45;ancestor_1 -->
<g id="edge3" class="edge">
<title>ancestor_2&#45;&#45;ancestor_1</title>
<path fill="none" stroke="black" d="M177,-287.7C177,-276.85 177,-262.92 177,-252.1"/>
</g>
<!-- ancestor_3 -->
<g id="node5" class="node">
<title>ancestor_3</title>
<g id="a_node5"><a xlink:title="GObject.InitiallyUnowned">
<path fill="none" stroke="black" d="M226,-396C226,-396 128,-396 128,-396 122,-396 116,-390 116,-384 116,-384 116,-372 116,-372 116,-366 122,-360 128,-360 128,-360 226,-360 226,-360 232,-360 238,-366 238,-372 238,-372 238,-384 238,-384 238,-390 232,-396 226,-396"/>
<text text-anchor="middle" x="177" y="-374.3" font-family="Times,serif" font-size="14.00">GInitiallyUnowned</text>
</a>
</g>
</g>
<!-- ancestor_3&#45;&#45;ancestor_2 -->
<g id="edge2" class="edge">
<title>ancestor_3&#45;&#45;ancestor_2</title>
<path fill="none" stroke="black" d="M177,-359.7C177,-348.85 177,-334.92 177,-324.1"/>
</g>
<!-- ancestor_4 -->
<g id="node6" class="node">
<title>ancestor_4</title>
<g id="a_node6"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M196,-468C196,-468 158,-468 158,-468 152,-468 146,-462 146,-456 146,-456 146,-444 146,-444 146,-438 152,-432 158,-432 158,-432 196,-432 196,-432 202,-432 208,-438 208,-444 208,-444 208,-456 208,-456 208,-462 202,-468 196,-468"/>
<text text-anchor="middle" x="177" y="-446.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_4&#45;&#45;ancestor_3 -->
<g id="edge1" class="edge">
<title>ancestor_4&#45;&#45;ancestor_3</title>
<path fill="none" stroke="black" d="M177,-431.7C177,-420.85 177,-406.92 177,-396.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a href="class.LeadContainer.html" title="LeadContainer">ClapperGtkLeadContainer</a></li>
<li class="class"><a href="class.Container.html" title="Container">ClapperGtkContainer</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Widget.html" data-namespace="Gtk">GtkWidget</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.InitiallyUnowned.html" data-namespace="GObject">GInitiallyUnowned</a></li>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper implements">
<h4 id="implements">
Implements
<a href="#implements" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.Accessible.html" data-namespace="Gtk">GtkAccessible</a></li>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.Buildable.html" data-namespace="Gtk">GtkBuildable</a></li>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.ConstraintTarget.html" data-namespace="Gtk">GtkConstraintTarget</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper constructors">
<h4 id="constructors">
Constructors
<a href="#constructors" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="ctor.EngageLayer.new.html">clapper_gtk_engage_layer_new</a></h6>
<div class="docblock">
<p>Creates a new <code>ClapperGtkEngageLayer</code> instance.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
</div>
<div class="toggle-wrapper default-hide ancestor-methods">
<h5 style="display:block;">Methods inherited from <a href="class.LeadContainer.html">ClapperGtkLeadContainer</a> (4)</h5><div class="docblock">
<h6><a href="method.LeadContainer.get_blocked_actions.html">clapper_gtk_lead_container_get_blocked_actions</a></h6><div class="docblock">
<p>Get <code>actions</code> that were set for this <code>lead_container</code> to&nbsp;block.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.LeadContainer.get_leading.html">clapper_gtk_lead_container_get_leading</a></h6><div class="docblock">
<p>Get a whenever <code>lead_container</code> has leadership&nbsp;set.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.LeadContainer.set_blocked_actions.html">clapper_gtk_lead_container_set_blocked_actions</a></h6><div class="docblock">
<p>Set <code>actions</code> that <code>ClapperGtkVideo</code> should skip when <code>GdkEvent</code> which
would normally trigger them happens inside <code>lead_container</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.LeadContainer.set_leading.html">clapper_gtk_lead_container_set_leading</a></h6><div class="docblock">
<p>Set if <code>lead_container</code> leadership should be&nbsp;enabled.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods">
<h5 style="display:block;">Methods inherited from <a href="class.Container.html">ClapperGtkContainer</a> (10)</h5><div class="docblock">
<h6><a href="method.Container.get_adaptive_height.html">clapper_gtk_container_get_adaptive_height</a></h6><div class="docblock">
<p>Get a <code>container</code> adaptive height&nbsp;threshold.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.get_adaptive_width.html">clapper_gtk_container_get_adaptive_width</a></h6><div class="docblock">
<p>Get a <code>container</code> adaptive width&nbsp;threshold.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.get_child.html">clapper_gtk_container_get_child</a></h6><div class="docblock">
<p>Get a child <code>GtkWidget</code> of <code>container</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.get_height_target.html">clapper_gtk_container_get_height_target</a></h6><div class="docblock">
<p>Get a <code>container</code> height&nbsp;target.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.get_width_target.html">clapper_gtk_container_get_width_target</a></h6><div class="docblock">
<p>Get a <code>container</code> width&nbsp;target.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.set_adaptive_height.html">clapper_gtk_container_set_adaptive_height</a></h6><div class="docblock">
<p>Set an adaptive height threshold. When widget is resized to value or lower,
an <code>ClapperGtkContainer::adapt</code> signal will be emitted with <code>TRUE</code> to
notify implementation about mobile adaptation request, otherwise <code>FALSE</code> when
both threshold values are&nbsp;exceeded.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.set_adaptive_width.html">clapper_gtk_container_set_adaptive_width</a></h6><div class="docblock">
<p>Set an adaptive width threshold. When widget is resized to value or lower,
an <code>ClapperGtkContainer::adapt</code> signal will be emitted with <code>TRUE</code> to
notify implementation about mobile adaptation request, otherwise <code>FALSE</code> when
both threshold values are&nbsp;exceeded.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.set_child.html">clapper_gtk_container_set_child</a></h6><div class="docblock">
<p>Set a child <code>GtkWidget</code> of <code>container</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.set_height_target.html">clapper_gtk_container_set_height_target</a></h6><div class="docblock">
<p>Same as <code>clapper_gtk_container_set_width_target()</code> but for widget&nbsp;height.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="method.Container.set_width_target.html">clapper_gtk_container_set_width_target</a></h6><div class="docblock">
<p>Set a width that <code>container</code> should target. When set container
will not stretch beyond set <code>width</code> while still expanding into
possible boundaries trying to reach its&nbsp;target.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Widget.html" data-namespace="Gtk">GtkWidget</a> (161)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Widget.html#methods" data-namespace="Gtk">GtkWidget</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="iface.Accessible.html" data-namespace="Gtk">GtkAccessible</a> (18)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_accessible_parent.html">gtk_accessible_get_accessible_parent</a></h6>
<div class="docblock">
<p>Retrieves the accessible parent for an accessible&nbsp;object.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_accessible_role.html">gtk_accessible_get_accessible_role</a></h6>
<div class="docblock">
<p>Retrieves the accessible role of an accessible&nbsp;object.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_at_context.html">gtk_accessible_get_at_context</a></h6>
<div class="docblock">
<p>Retrieves the accessible implementation for the given <code>GtkAccessible</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_bounds.html">gtk_accessible_get_bounds</a></h6>
<div class="docblock">
<p>Queries the coordinates and dimensions of this&nbsp;accessible.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_first_accessible_child.html">gtk_accessible_get_first_accessible_child</a></h6>
<div class="docblock">
<p>Retrieves the first accessible child of an accessible&nbsp;object.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_next_accessible_sibling.html">gtk_accessible_get_next_accessible_sibling</a></h6>
<div class="docblock">
<p>Retrieves the next accessible sibling of an accessible&nbsp;object.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.get_platform_state.html">gtk_accessible_get_platform_state</a></h6>
<div class="docblock">
<p>Query a platform state, such as&nbsp;focus.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.reset_property.html">gtk_accessible_reset_property</a></h6>
<div class="docblock">
<p>Resets the accessible <code>property</code> to its default&nbsp;value.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.reset_relation.html">gtk_accessible_reset_relation</a></h6>
<div class="docblock">
<p>Resets the accessible <code>relation</code> to its default&nbsp;value.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.reset_state.html">gtk_accessible_reset_state</a></h6>
<div class="docblock">
<p>Resets the accessible <code>state</code> to its default&nbsp;value.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.set_accessible_parent.html">gtk_accessible_set_accessible_parent</a></h6>
<div class="docblock">
<p>Sets the parent and sibling of an accessible&nbsp;object.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_next_accessible_sibling.html">gtk_accessible_update_next_accessible_sibling</a></h6>
<div class="docblock">
<p>Updates the next accessible sibling of <code>self</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 4.10</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_property.html">gtk_accessible_update_property</a></h6>
<div class="docblock">
<p>Updates a list of accessible&nbsp;properties.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_property_value.html">gtk_accessible_update_property_value</a></h6>
<div class="docblock">
<p>Updates an array of accessible&nbsp;properties.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_relation.html">gtk_accessible_update_relation</a></h6>
<div class="docblock">
<p>Updates a list of accessible&nbsp;relations.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_relation_value.html">gtk_accessible_update_relation_value</a></h6>
<div class="docblock">
<p>Updates an array of accessible&nbsp;relations.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_state.html">gtk_accessible_update_state</a></h6>
<div class="docblock">
<p>Updates a list of accessible states. See the <code>GtkAccessibleState</code>
documentation for the value types of accessible&nbsp;states.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Accessible.update_state_value.html">gtk_accessible_update_state_value</a></h6>
<div class="docblock">
<p>Updates an array of accessible&nbsp;states.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="iface.Buildable.html" data-namespace="Gtk">GtkBuildable</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.Buildable.get_buildable_id.html">gtk_buildable_get_buildable_id</a></h6>
<div class="docblock">
<p>Gets the <span class="caps">ID</span> of the <code>buildable</code> object.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper properties">
<h4 id="properties">
Properties
<a href="#properties" class="anchor"></a>
</h4>
<div class="toggle-wrapper default-hide ancestor-properties">
<h5 style="display:block;">Properties inherited from <a href="class.LeadContainer.html">ClapperGtkLeadContainer</a> (2)</h5><div class="docblock">
<h6><a href="property.LeadContainer.blocked-actions.html">ClapperGtk.LeadContainer:blocked-actions</a></h6><div class="docblock">
<p>Mask of actions that container blocks from being triggered on&nbsp;video.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="property.LeadContainer.leading.html">ClapperGtk.LeadContainer:leading</a></h6><div class="docblock">
<p>Width that container should&nbsp;target.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-properties">
<h5 style="display:block;">Properties inherited from <a href="class.Container.html">ClapperGtkContainer</a> (4)</h5><div class="docblock">
<h6><a href="property.Container.adaptive-height.html">ClapperGtk.Container:adaptive-height</a></h6><div class="docblock">
<p>Adaptive height threshold that triggers <code>ClapperGtkContainer::adapt</code> signal.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="property.Container.adaptive-width.html">ClapperGtk.Container:adaptive-width</a></h6><div class="docblock">
<p>Adaptive width threshold that triggers <code>ClapperGtkContainer::adapt</code> signal.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="property.Container.height-target.html">ClapperGtk.Container:height-target</a></h6><div class="docblock">
<p>Height that container should&nbsp;target.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a href="property.Container.width-target.html">ClapperGtk.Container:width-target</a></h6><div class="docblock">
<p>Width that container should&nbsp;target.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-properties"><h5 style="display:block;">Properties inherited from <a class="external" href="javascript:void(0)" data-link="class.Widget.html" data-namespace="Gtk">GtkWidget</a> (34)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.can-focus.html">Gtk.Widget:can-focus</a></h6>
<div class="docblock">
<p>Whether the widget or any of its descendents can accept
the input&nbsp;focus.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.can-target.html">Gtk.Widget:can-target</a></h6>
<div class="docblock">
<p>Whether the widget can receive pointer&nbsp;events.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.css-classes.html">Gtk.Widget:css-classes</a></h6>
<div class="docblock">
<p>A list of css classes applied to this&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.css-name.html">Gtk.Widget:css-name</a></h6>
<div class="docblock">
<p>The name of this widget in the <span class="caps">CSS</span>&nbsp;tree.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.cursor.html">Gtk.Widget:cursor</a></h6>
<div class="docblock">
<p>The cursor used by <code>widget</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.focus-on-click.html">Gtk.Widget:focus-on-click</a></h6>
<div class="docblock">
<p>Whether the widget should grab focus when it is clicked with the&nbsp;mouse.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.focusable.html">Gtk.Widget:focusable</a></h6>
<div class="docblock">
<p>Whether this widget itself will accept the input&nbsp;focus.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.halign.html">Gtk.Widget:halign</a></h6>
<div class="docblock">
<p>How to distribute horizontal space if widget gets extra&nbsp;space.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.has-default.html">Gtk.Widget:has-default</a></h6>
<div class="docblock">
<p>Whether the widget is the default&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.has-focus.html">Gtk.Widget:has-focus</a></h6>
<div class="docblock">
<p>Whether the widget has the input&nbsp;focus.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.has-tooltip.html">Gtk.Widget:has-tooltip</a></h6>
<div class="docblock">
<p>Enables or disables the emission of the ::query-tooltip signal on <code>widget</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.height-request.html">Gtk.Widget:height-request</a></h6>
<div class="docblock">
<p>Override for height request of the&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.hexpand.html">Gtk.Widget:hexpand</a></h6>
<div class="docblock">
<p>Whether to expand&nbsp;horizontally.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.hexpand-set.html">Gtk.Widget:hexpand-set</a></h6>
<div class="docblock">
<p>Whether to use the <code>hexpand</code> property.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.layout-manager.html">Gtk.Widget:layout-manager</a></h6>
<div class="docblock">
<p>The <code>GtkLayoutManager</code> instance to use to compute the preferred size
of the widget, and allocate its&nbsp;children.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-bottom.html">Gtk.Widget:margin-bottom</a></h6>
<div class="docblock">
<p>Margin on bottom side of&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-end.html">Gtk.Widget:margin-end</a></h6>
<div class="docblock">
<p>Margin on end of widget,&nbsp;horizontally.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-start.html">Gtk.Widget:margin-start</a></h6>
<div class="docblock">
<p>Margin on start of widget,&nbsp;horizontally.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.margin-top.html">Gtk.Widget:margin-top</a></h6>
<div class="docblock">
<p>Margin on top side of&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.name.html">Gtk.Widget:name</a></h6>
<div class="docblock">
<p>The name of the&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.opacity.html">Gtk.Widget:opacity</a></h6>
<div class="docblock">
<p>The requested opacity of the&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.overflow.html">Gtk.Widget:overflow</a></h6>
<div class="docblock">
<p>How content outside the widget&#8217;s content area is&nbsp;treated.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.parent.html">Gtk.Widget:parent</a></h6>
<div class="docblock">
<p>The parent widget of this&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.receives-default.html">Gtk.Widget:receives-default</a></h6>
<div class="docblock">
<p>Whether the widget will receive the default action when it is&nbsp;focused.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.root.html">Gtk.Widget:root</a></h6>
<div class="docblock">
<p>The <code>GtkRoot</code> widget of the widget tree containing this&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.scale-factor.html">Gtk.Widget:scale-factor</a></h6>
<div class="docblock">
<p>The scale factor of the&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.sensitive.html">Gtk.Widget:sensitive</a></h6>
<div class="docblock">
<p>Whether the widget responds to&nbsp;input.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.tooltip-markup.html">Gtk.Widget:tooltip-markup</a></h6>
<div class="docblock">
<p>Sets the text of tooltip to be the given string, which is marked up
with Pango&nbsp;markup.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.tooltip-text.html">Gtk.Widget:tooltip-text</a></h6>
<div class="docblock">
<p>Sets the text of tooltip to be the given&nbsp;string.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.valign.html">Gtk.Widget:valign</a></h6>
<div class="docblock">
<p>How to distribute vertical space if widget gets extra&nbsp;space.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.vexpand.html">Gtk.Widget:vexpand</a></h6>
<div class="docblock">
<p>Whether to expand&nbsp;vertically.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.vexpand-set.html">Gtk.Widget:vexpand-set</a></h6>
<div class="docblock">
<p>Whether to use the <code>vexpand</code> property.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.visible.html">Gtk.Widget:visible</a></h6>
<div class="docblock">
<p>Whether the widget is&nbsp;visible.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Widget.width-request.html">Gtk.Widget:width-request</a></h6>
<div class="docblock">
<p>Override for width request of the&nbsp;widget.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-properties"><h5 style="display:block;">Properties inherited from <a class="external" href="javascript:void(0)" data-link="iface.Accessible.html" data-namespace="Gtk">GtkAccessible</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="property.Accessible.accessible-role.html">Gtk.Accessible:accessible-role</a></h6>
<div class="docblock">
<p>The accessible role of the given <code>GtkAccessible</code> implementation.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="toggle-wrapper default-hide ancestor-signals">
<h5 style="display:block;">Signals inherited from <a href="class.Container.html">ClapperGtkContainer</a> (1)</h5><div class="docblock">
<h6><a href="signal.Container.adapt.html">ClapperGtkContainer::adapt</a></h6><div class="docblock">
<p>A helper signal for implementing mobile/narrow adaptive
behavior on&nbsp;descendants.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Widget.html" data-namespace="Gtk">GtkWidget</a> (13)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.destroy.html">GtkWidget::destroy</a></h6>
<div class="docblock">
<p>Signals that all holders of a reference to the widget should release
the reference that they&nbsp;hold.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.direction-changed.html">GtkWidget::direction-changed</a></h6>
<div class="docblock">
<p>Emitted when the text direction of a widget&nbsp;changes.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.hide.html">GtkWidget::hide</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is&nbsp;hidden.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.keynav-failed.html">GtkWidget::keynav-failed</a></h6>
<div class="docblock">
<p>Emitted if keyboard navigation&nbsp;fails.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.map.html">GtkWidget::map</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is going to be&nbsp;mapped.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.mnemonic-activate.html">GtkWidget::mnemonic-activate</a></h6>
<div class="docblock">
<p>Emitted when a widget is activated via a&nbsp;mnemonic.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.move-focus.html">GtkWidget::move-focus</a></h6>
<div class="docblock">
<p>Emitted when the focus is&nbsp;moved.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.query-tooltip.html">GtkWidget::query-tooltip</a></h6>
<div class="docblock">
<p>Emitted when the widgets tooltip is about to be&nbsp;shown.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.realize.html">GtkWidget::realize</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is associated with a <code>GdkSurface</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.show.html">GtkWidget::show</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is&nbsp;shown.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.state-flags-changed.html">GtkWidget::state-flags-changed</a></h6>
<div class="docblock">
<p>Emitted when the widget state&nbsp;changes.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.unmap.html">GtkWidget::unmap</a></h6>
<div class="docblock">
<p>Emitted when <code>widget</code> is going to be&nbsp;unmapped.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.Widget.unrealize.html">GtkWidget::unrealize</a></h6>
<div class="docblock">
<p>Emitted when the <code>GdkSurface</code> associated with <code>widget</code> is&nbsp;destroyed.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ClapperGtkEngageLayerClass {
ClapperGtkLeadContainerClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: ClapperGtkLeadContainerClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#implements"><span class="link-text">Implements</span></a></li>
<li class="toc-list-item"><a href="#constructors"><span class="link-text">Constructors</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>