Project site | Online documentation
Rust bindings and wrappers for GLib, GDK 3, GTK+ 3 and Cairo.
gtk expects GTK+, GLib and Cairo development files to be installed on your system. See the requirements page.
We recommend using crates from crates.io, as demonstrated here.
If you want to track the bleeding edge, use the git dependency instead:
[dependencies]
gtk = { git = "https://github.com/gtk-rs/gtk.git" }Avoid mixing versioned and git crates like this:
# This will not compile
[dependencies]
gdk = "0.2"
gtk = { git = "https://github.com/gtk-rs/gtk.git" }The majority of the documentation is kept in a separate repo due to licensing issues. You can pull it in with cargo:
> cargo build --features embed-lgpl-docsChanges to those doc-comments should be submitted to the lgpl-docs repo. Avoid
including those embedded doc-comments in PRs to this repo.
The opposite feature removes all of those docs regardless of edits:
> cargo build --features purge-lgpl-docsThese features rewrite the crate sources so it's sufficient to enable them
once. Omitting them in the following cargo invocations will not undo their
effects!
Generate the docs:
> cargo doc --features v3_16(if the installed GTK+ version is lower than 3.16, adjust the feature name accordingly).
Contributor you're welcome!
See the general bindings documentation.
Most of the bindings (src/auto) are generated by gir using this configuration file. After editing Gir.toml the sources can be regenerated with
> make girWhen opening a PR please put the changes to the src/auto directory in a separate commit.
gtk is available under the MIT License, please refer to it.