Crate gtk_resources

This crate defines the UIResource trait and its custom derive.

Usage

First, let's look at the example:

use gtk_resources::UIResource;

#[derive(UIResource, Debug)]
#[resource = "/com/name/project/window.ui"]
struct WindowResource {
    window: gtk::ApplicationWindow,
    display_label: gtk::Label,
    hello_btn: gtk::Button,
}

fn main() {
    gtk::init().unwrap();

    // Register resource bundles
    let res_bytes = include_bytes!("../test/test.gresource");
    let data = glib::Bytes::from(&res_bytes[..]);
    let resource = gio::Resource::new_from_data(&data).unwrap();
    gio::resources_register(&resource);

    let res = WindowResource::load().unwrap();
    println!("res: {:?}", res);

    // ...
}

The file test/test.gresource.xml defines the resource bundle which is used by this example.

<gresources>
    <gresource prefix="/com/name/project">
        <file preprocess="xml-stripblanks">window.ui</file>
    </gresource>
</gresources>

See Gio::Resource and glib-compile-resources for more info about resource bundles.

The #[resource = "/com/name/project/window.ui"] attribute at the WindowResource struct specifies the path to the corresponding resource.

The field names and types of the UIResource struct have to match the ids and types from the exported resource objects. Otherwise the gtk::Builder is unable to load them during runtime.

The code gerated for the previous example looks as follows:

impl UIResource for WindowResource {
    fn load() -> Result<WindowResource, ()> {
        use gtk::BuilderExtManual;
        let b = gtk::Builder::new_from_resource("/com/name/project/window.ui");
        Ok (WindowResource {
            window: b.get_object::<gtk::ApplicationWindow>("window").ok_or(())?,
            display_label: b.get_object::<gtk::Label>("display_label").ok_or(())?,
            hello_btn: b.get_object::<gtk::Button>("hello_btn").ok_or(())?,
        })
    }
}

Traits

UIResource

Trait for gtk::Builder resources.