Skip to content

doc: Additional migration docs #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Rafostar merged 2 commits into from
Aug 8, 2025
Merged

doc: Additional migration docs #584

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31c230d
doc: clapper-gtk: Add migrating to 0.10 guide
Rafostar Aug 8, 2025
ff3df7a
doc: clapper: Fix typo
Rafostar Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: clapper-gtk: Add migrating to 0.10 guide
  • Loading branch information
@Rafostar
Rafostar committed Aug 8, 2025
commit 31c230dde6b67bb86a2454cdca6692db33503d04
1 change: 1 addition & 0 deletions doc/reference/clapper-gtk/clapper-gtk.toml.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
5 changes: 5 additions & 0 deletions doc/reference/clapper-gtk/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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'),
Expand Down
22 changes: 22 additions & 0 deletions doc/reference/clapper-gtk/migrating-to-010.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).