gtk-layer-shell:

gtk-layer-shell

This is the safe wrapper for gtk-layer-shell, automatically generated from its .gir file. The unsafe bindings can be found here. This crate is GTK3 only. Use gtk4-layer-shell if you need to use it with GTK4.

Usage

Have a look at the simple example to see how the bindings can be used. It works analogous to the original. You can use the features to select the version of gtk-layer-shell. Currently v0_6 is the default.

Generating the wrapper

Generating the wrapper yourself is not necessary to be able to use it. You can just use the version published on crates.io. If you want to do it anyways, you need to start by generating the unsafe bindings. Follow the guide on how to do that and come back here.

Now that you have generated the bindings you will want to generate the safe wrapper.

cd gtk-layer-shell
gir -o .
cargo build
cargo test

There should not have been any errors. To make sure everything you need was created, run the following command.

gir -o . -m not_bound

There should not be any output to this command. Let me know if there is so I can fix it. In order to build the documentation, you have to run

gir -c Gir.toml --doc-target-path docs.md -m doc
cargo install rustdoc-stripper
rustdoc-stripper -s -n
rustdoc-stripper -g -o docs.md
cargo doc

Congratulations, you've done it :-)

If you want to learn more about gir, have a look at its repo or its book.

Maintenance status

This crate is just a safe wrapper for the C library so it is feature complete and not actively worked on. There are Github Actions keeping the dependencies up-to-date. If you encounter any problems, feel free to open a PR.

Contributing

Pull requests are very welcome but please keep the maintenance status in mind.

License

MIT