doc: Update

This commit is contained in:
github-actions[bot]
2025-08-08 17:14:02 +00:00
parent f1364955e8
commit f0aad34e5b
6 changed files with 155 additions and 4 deletions

File diff suppressed because one or more lines are too long

View File

@@ -56,6 +56,7 @@ base_url = "https://github.com/Rafostar/clapper/tree/master/"
[extra] [extra]
# The same order will be used when generating the index # The same order will be used when generating the index
content_files = [ content_files = [
"migrating-to-010.md",
] ]
content_images = [ content_images = [
"images/clapper-logo.svg", "images/clapper-logo.svg",

View File

@@ -349,6 +349,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
<div class="docblock"> <div class="docblock">
<ul> <ul>
<li><a href="migrating-to-010.html">Migrating to ClapperGtk 0.10</a></li>
<li><a href="classes_hierarchy.html">Classes Hierarchy</a></li> <li><a href="classes_hierarchy.html">Classes Hierarchy</a></li>
</ul> </ul>

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,148 @@
<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>ClapperGtk &ndash; 0.0: Migrating to ClapperGtk 0.10</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: Migrating to ClapperGtk 0.10"/>
<meta property="og:description" content="Reference for ClapperGtk-0.0: Migrating to ClapperGtk 0.10"/>
<meta name="twitter:title" content="ClapperGtk: Migrating to ClapperGtk 0.10"/>
<meta name="twitter:description" content="Reference for ClapperGtk-0.0: Migrating to ClapperGtk 0.10"/>
<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">
<a href="index.html"><img src="clapper-logo.svg" class="logo"/></a>
</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.9.1</p>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2025.4</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<h4 id="title" style="display:flex;">
Migrating to ClapperGtk 0.10
<a href="#title" class="anchor"></a>
</h4>
<section>
<div class="docblock">
<h3 id="av-widget">AV widget<a class="md-anchor" href="#av-widget" title="Permanent link"></a></h3>
<p>Code of <a href="class.Video.html"><code>ClapperGtkVideo</code></a> was split into a base class <a href="class.Av.html"><code>ClapperGtkAv</code></a> from which
<a href="class.Video.html"><code>ClapperGtkVideo</code></a> and newly added <a href="class.Audio.html"><code>ClapperGtkAudio</code></a> widgets are&nbsp;made.</p>
<p>This code split implies following&nbsp;changes:</p>
<ul>
<li>Properties <code>auto-inhibit</code>, <code>inhibited</code> and <code>player</code> were moved into <span class="caps">AV</span> base class, since these
are usually used without explicit need to specify object class they belong to, this change should
not affect most&nbsp;use-cases.</li>
<li>Methods to get above properties are now in <span class="caps">AV</span>, but also left in video widget for compatibility&nbsp;purposes.</li>
<li>Built-in widget actions starting with <code>video.</code> prefix are deprecated (also left for compatibility).
Implementations that used them are encouraged to use <code>av.</code> actions now. All actions from video widget were
ported to <span class="caps">AV</span> widget as they were, so updating your app should be as easy as changing this action&nbsp;prefix.</li>
</ul>
<h3 id="other-info">Other Info<a class="md-anchor" href="#other-info" title="Permanent link"></a></h3>
<p>Above describes changes to <span class="caps">GTK</span> integration library, for the playback library
check out <a href="../clapper/migrating-to-010.html">other migration guide</a>.</p>
</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="#av-widget"><span class="link-text">AV widget</span></a></li>
<li class="toc-list-item"><a href="#other-info"><span class="link-text">Other Info</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>

View File

@@ -104,8 +104,8 @@ used via <a href="class.EnhancerProxy.html"><code>ClapperEnhancerProxy</code></a
<p>Old <a href="class.Feature.html"><code>ClapperFeature</code></a> objects (including <code>mpris</code>, <code>discoverer</code> and <code>server</code>) are left for compatibility <p>Old <a href="class.Feature.html"><code>ClapperFeature</code></a> objects (including <code>mpris</code>, <code>discoverer</code> and <code>server</code>) are left for compatibility
reasons, but all apps using them are advised to migrate to enhancer plugins which already surpassed former reasons, but all apps using them are advised to migrate to enhancer plugins which already surpassed former
ones in what can be achieved with&nbsp;them.</p> ones in what can be achieved with&nbsp;them.</p>
<p>Since these are now in the form of plugins scanned during init, one of the differences is that you now check <p>Since these are in the form of plugins scanned during init, one of the differences is that you now check
their availablity at runtime instead of compile time like&nbsp;before.</p> their availability at runtime instead of compile time like&nbsp;before.</p>
<p>Something like&nbsp;this:</p> <p>Something like&nbsp;this:</p>
<div class="codehilite"><pre><span></span><code><span class="cp">#if CLAPPER_HAVE_MPRIS</span> <div class="codehilite"><pre><span></span><code><span class="cp">#if CLAPPER_HAVE_MPRIS</span>
<span class="w"> </span><span class="n">ClapperFeature</span><span class="w"> </span><span class="o">*</span><span class="n">feature</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">CLAPPER_FEATURE</span><span class="w"> </span><span class="p">(</span><span class="n">clapper_mpris_new</span><span class="w"> </span><span class="p">(</span> <span class="w"> </span><span class="n">ClapperFeature</span><span class="w"> </span><span class="o">*</span><span class="n">feature</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">CLAPPER_FEATURE</span><span class="w"> </span><span class="p">(</span><span class="n">clapper_mpris_new</span><span class="w"> </span><span class="p">(</span>