doc: clapper-gtk: Add migrating to 0.10 guide

This commit is contained in:
Rafał Dzięgiel
2025-08-08 10:00:46 +02:00
parent 91b7a0f1a5
commit 31c230dde6
3 changed files with 28 additions and 0 deletions

View File

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

View File

@@ -6,6 +6,10 @@ clappergtk_toml = configure_file(
install_dir: join_paths(datadir, 'doc', 'clapper-gtk'),
)
extra_md_files = [
'migrating-to-010.md',
]
custom_target('clapper-gtk-doc',
input: [
clappergtk_toml,
@@ -24,6 +28,7 @@ custom_target('clapper-gtk-doc',
'--content-dir=@0@'.format(meson.current_source_dir()),
'@INPUT1@',
],
depend_files: extra_md_files,
build_by_default: true,
install: true,
install_dir: join_paths(datadir, 'doc'),

View File

@@ -0,0 +1,22 @@
Title: Migrating to ClapperGtk 0.10
Slug: migrating-to-010
### AV widget
Code of [class@ClapperGtk.Video] was split into a base class [class@ClapperGtk.Av] from which
[class@ClapperGtk.Video] and newly added [class@ClapperGtk.Audio] widgets are made.
This code split implies following changes:
* Properties `auto-inhibit`, `inhibited` and `player` were moved into AV base class, since these
are usually used without explicit need to specify object class they belong to, this change should
not affect most use-cases.
* Methods to get above properties are now in AV, but also left in video widget for compatibility purposes.
* Built-in widget actions starting with `video.` prefix are deprecated (also left for compatibility).
Implementations that used them are encouraged to use `av.` actions now. All actions from video widget were
ported to AV widget as they were, so updating your app should be as easy as changing this action prefix.
### Other Info
Above describes changes to GTK integration library, for the playback library
check out [other migration guide](../clapper/migrating-to-010.html).