dany/clapper
1
0
Fork 0
mirror of https://github.com/Rafostar/clapper.git synced 2025-08-31 16:31:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update

Browse Source
This commit is contained in:
Rafał Dzięgiel
2024-03-19 22:36:43 +01:00
parent 36d62a3a1c
commit 17bb9fdb02
396 changed files with 10339 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
doc/clapper-gtk/class.TitleHeader.html
View File

@@ -101,9 +101,33 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.TitleHeader.get_current_title.html">get_current_title</a>
<a class="method" href="method.TitleHeader.get_fallback_to_uri.html">get_fallback_to_uri</a>
<a class="method" href="method.TitleHeader.set_fallback_to_uri.html">set_fallback_to_uri</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.TitleHeader.current-title.html">current-title</a>
<a class="property" href="property.TitleHeader.fallback-to-uri.html">fallback-to-uri</a>
</div>
</div>
@@ -141,7 +165,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
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-title-header.c#L20">[src]</a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/src/lib/clapper-gtk/clapper-gtk-title-header.c#L20">[src]</a>
</h4>
@@ -155,6 +179,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<p><code>ClapperGtkTitleHeader</code> is a simple, ready to be used header widget that
displays current media title. It can be placed as-is as a <a href="class.Video.html"><code>ClapperGtkVideo</code></a>
overlay (either fading or&nbsp;not).</p>
<p>If you need a further customized header, you can use <a href="class.TitleLabel.html"><code>ClapperGtkTitleLabel</code></a>
which is used by this widget to build your own implementation&nbsp;instead.</p>
</div>
<div class="docblock">
@@ -177,19 +203,19 @@ overlay (either fading or&nbsp;not).</p>
<?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)
<!-- Generated by graphviz version 8.1.0 (20230707.0739)
-->
<!-- 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">
<svg width="403pt" height="476pt"
viewBox="0.00 0.00 402.88 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="ClapperGtkTitleHeader">
<path fill="none" stroke="black" d="M237,-108C237,-108 117,-108 117,-108 111,-108 105,-102 105,-96 105,-96 105,-84 105,-84 105,-78 111,-72 117,-72 117,-72 237,-72 237,-72 243,-72 249,-78 249,-84 249,-84 249,-96 249,-96 249,-102 243,-108 237,-108"/>
<text text-anchor="middle" x="177" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperGtkTitleHeader</text>
<path fill="none" stroke="black" d="M235.5,-108C235.5,-108 116,-108 116,-108 110,-108 104,-102 104,-96 104,-96 104,-84 104,-84 104,-78 110,-72 116,-72 116,-72 235.5,-72 235.5,-72 241.5,-72 247.5,-78 247.5,-84 247.5,-84 247.5,-96 247.5,-96 247.5,-102 241.5,-108 235.5,-108"/>
<text text-anchor="middle" x="175.75" y="-84.95" font-family="Times,serif" font-size="14.00">ClapperGtkTitleHeader</text>
</a>
</g>
</g>
@@ -197,113 +223,113 @@ overlay (either fading or&nbsp;not).</p>
<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>
<polygon fill="none" stroke="black" points="107.5,-36 0,-36 0,0 107.5,0 107.5,-36"/>
<text text-anchor="middle" x="53.75" y="-14.45" 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"/>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M145.28,-71.52C126.51,-60.74 102.53,-46.99 83.83,-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>
<polygon fill="none" stroke="black" points="226.12,-36 125.38,-36 125.38,0 226.12,0 226.12,-36"/>
<text text-anchor="middle" x="175.75" y="-14.45" 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"/>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M175.75,-71.7C175.75,-60.85 175.75,-46.92 175.75,-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>
<polygon fill="none" stroke="black" points="394.88,-36 244.62,-36 244.62,0 394.88,0 394.88,-36"/>
<text text-anchor="middle" x="319.75" y="-14.45" 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"/>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M211.72,-71.52C233.87,-60.74 262.17,-46.99 284.24,-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>
<path fill="none" stroke="black" d="M243.38,-180C243.38,-180 108.12,-180 108.12,-180 102.12,-180 96.12,-174 96.12,-168 96.12,-168 96.12,-156 96.12,-156 96.12,-150 102.12,-144 108.12,-144 108.12,-144 243.38,-144 243.38,-144 249.38,-144 255.38,-150 255.38,-156 255.38,-156 255.38,-168 255.38,-168 255.38,-174 249.38,-180 243.38,-180"/>
<text text-anchor="middle" x="175.75" y="-156.95" 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"/>
<path fill="none" stroke="black" d="M175.75,-143.7C175.75,-132.85 175.75,-118.92 175.75,-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>
<path fill="none" stroke="black" d="M229.88,-252C229.88,-252 121.62,-252 121.62,-252 115.62,-252 109.62,-246 109.62,-240 109.62,-240 109.62,-228 109.62,-228 109.62,-222 115.62,-216 121.62,-216 121.62,-216 229.88,-216 229.88,-216 235.88,-216 241.88,-222 241.88,-228 241.88,-228 241.88,-240 241.88,-240 241.88,-246 235.88,-252 229.88,-252"/>
<text text-anchor="middle" x="175.75" y="-228.95" 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"/>
<path fill="none" stroke="black" d="M175.75,-215.7C175.75,-204.85 175.75,-190.92 175.75,-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>
<path fill="none" stroke="black" d="M201.75,-324C201.75,-324 149.75,-324 149.75,-324 143.75,-324 137.75,-318 137.75,-312 137.75,-312 137.75,-300 137.75,-300 137.75,-294 143.75,-288 149.75,-288 149.75,-288 201.75,-288 201.75,-288 207.75,-288 213.75,-294 213.75,-300 213.75,-300 213.75,-312 213.75,-312 213.75,-318 207.75,-324 201.75,-324"/>
<text text-anchor="middle" x="175.75" y="-300.95" 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"/>
<path fill="none" stroke="black" d="M175.75,-287.7C175.75,-276.85 175.75,-262.92 175.75,-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>
<path fill="none" stroke="black" d="M224.25,-396C224.25,-396 127.25,-396 127.25,-396 121.25,-396 115.25,-390 115.25,-384 115.25,-384 115.25,-372 115.25,-372 115.25,-366 121.25,-360 127.25,-360 127.25,-360 224.25,-360 224.25,-360 230.25,-360 236.25,-366 236.25,-372 236.25,-372 236.25,-384 236.25,-384 236.25,-390 230.25,-396 224.25,-396"/>
<text text-anchor="middle" x="175.75" y="-372.95" 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"/>
<path fill="none" stroke="black" d="M175.75,-359.7C175.75,-348.85 175.75,-334.92 175.75,-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>
<path fill="none" stroke="black" d="M194.62,-468C194.62,-468 156.88,-468 156.88,-468 150.88,-468 144.88,-462 144.88,-456 144.88,-456 144.88,-444 144.88,-444 144.88,-438 150.88,-432 156.88,-432 156.88,-432 194.62,-432 194.62,-432 200.62,-432 206.62,-438 206.62,-444 206.62,-444 206.62,-456 206.62,-456 206.62,-462 200.62,-468 194.62,-468"/>
<text text-anchor="middle" x="175.75" y="-444.95" 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"/>
<path fill="none" stroke="black" d="M175.75,-431.7C175.75,-420.85 175.75,-406.92 175.75,-396.1"/>
</g>
</g>
</svg>
@@ -388,7 +414,7 @@ overlay (either fading or&nbsp;not).</p>
<div class="">
<h6><a href="ctor.TitleHeader.new.html">clapper_gtk_title_header_new</a></h6>
<div class="docblock">
<p>Creates a new <code>GtkWidget</code> with title&nbsp;header.</p>
<p>Creates a new <code>ClapperGtkTitleHeader</code> instance.</p>
</div>
<div class="docblock">
<p></p>
@@ -410,6 +436,38 @@ overlay (either fading or&nbsp;not).</p>
<div class="docblock">
<div class="">
<h6><a href="method.TitleHeader.get_current_title.html">clapper_gtk_title_header_get_current_title</a></h6>
<div class="docblock">
<p>Get currently displayed title by <code>header</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.TitleHeader.get_fallback_to_uri.html">clapper_gtk_title_header_get_fallback_to_uri</a></h6>
<div class="docblock">
<p>Get whether a <code>ClapperMediaItem:uri</code> property is going
be displayed as a header text when no other title could be&nbsp;determined.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.TitleHeader.set_fallback_to_uri.html">clapper_gtk_title_header_set_fallback_to_uri</a></h6>
<div class="docblock">
<p>Set whether a <code>ClapperMediaItem:uri</code> property should
be displayed as a header text when no other title could be&nbsp;determined.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
@@ -537,7 +595,7 @@ possible boundaries trying to reach its&nbsp;target.</p>
<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="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> (162)</h5>
<div class="docblock">
<div class="docblock">
@@ -727,6 +785,30 @@ documentation for the value types of accessible&nbsp;states.</p>
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.TitleHeader.current-title.html">ClapperGtk.TitleHeader:current-title</a></h6>
<div class="docblock">
<p>Currently displayed&nbsp;title.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="property.TitleHeader.fallback-to-uri.html">ClapperGtk.TitleHeader:fallback-to-uri</a></h6>
<div class="docblock">
<p>When title cannot be determined, show <span class="caps">URI</span>&nbsp;instead.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
@@ -1287,8 +1369,12 @@ its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>