feat: basic application library grid view

examples/app_library/README.md

@@ -0,0 +1,5 @@
+# ListView: Applications Launcher
+
+This example shows how to create a `gtk::ListView` and fill it with applications data from `gio::AppInfo` with the possibility to open an application when an item of the list is activated.
+
+![Screenshot](screenshot.png)

examples/app_library/application_row/application_row.ui

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <template class="ApplicationRow" parent="GtkBox">
+    <property name="orientation">vertical</property>
+    <property name="halign">center</property>
+    <property name="hexpand">true</property>
+    <property name="margin-top">4</property>
+    <property name="margin-end">4</property>
+    <property name="margin-bottom">4</property>
+    <child>
+       <object class="GtkImage" id="image">
+         <property name="margin-top">4</property>
+         <property name="margin-bottom">4</property>
+         <property name="pixel-size">80</property>
+       </object>
+     </child>
+    <child>
+      <object class="GtkLabel" id="name">
+        <property name="halign">center</property>
+        <property name="ellipsize">end</property>
+        <style>
+          <class name="title-5" />
+        </style>
+      </object>
+    </child>
+  </template>
+</interface>

examples/app_library/application_row/imp.rs

@@ -0,0 +1,34 @@
+use gtk::glib;
+use gtk::prelude::*;
+use gtk::subclass::prelude::*;
+use gtk4 as gtk;
+
+use gtk::CompositeTemplate;
+
+#[derive(Debug, Default, CompositeTemplate)]
+#[template(file = "application_row.ui")]
+pub struct ApplicationRow {
+    #[template_child]
+    pub name: TemplateChild<gtk::Label>,
+    #[template_child]
+    pub image: TemplateChild<gtk::Image>,
+}
+
+#[glib::object_subclass]
+impl ObjectSubclass for ApplicationRow {
+    const NAME: &'static str = "ApplicationRow";
+    type Type = super::ApplicationRow;
+    type ParentType = gtk::Box;
+
+    fn class_init(klass: &mut Self::Class) {
+        Self::bind_template(klass);
+    }
+
+    fn instance_init(obj: &glib::subclass::InitializingObject<Self>) {
+        obj.init_template();
+    }
+}
+
+impl ObjectImpl for ApplicationRow {}
+impl WidgetImpl for ApplicationRow {}
+impl BoxImpl for ApplicationRow {}

examples/app_library/application_row/mod.rs

@@ -0,0 +1,31 @@
+use gtk4 as gtk;
+mod imp;
+
+use gtk::prelude::*;
+use gtk::subclass::prelude::*;
+use gtk::{gio, glib};
+
+glib::wrapper! {
+    pub struct ApplicationRow(ObjectSubclass<imp::ApplicationRow>)
+        @extends gtk::Widget, gtk::Box;
+}
+
+impl Default for ApplicationRow {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl ApplicationRow {
+    pub fn new() -> Self {
+        glib::Object::new(&[]).expect("Failed to create ApplicationRow")
+    }
+
+    pub fn set_app_info(&self, app_info: &gio::AppInfo) {
+        let self_ = imp::ApplicationRow::from_instance(self);
+        self_.name.set_text(&app_info.name());
+        if let Some(icon) = app_info.icon() {
+            self_.image.set_from_gicon(&icon);
+        }
+    }
+}

examples/app_library/main.rs

@@ -0,0 +1,34 @@
+mod application_row;
+mod window;
+
+use gtk::gdk::Display;
+use gtk::prelude::*;
+use gtk4 as gtk;
+
+use window::Window;
+
+fn main() {
+    let application = gtk::Application::new(
+        Some("com.github.gtk-rs.examples.apps_launcher"),
+        Default::default(),
+    );
+
+    application.connect_activate(|app| {
+        let provider = gtk::CssProvider::new();
+        provider.load_from_data(include_bytes!("style.css"));
+        gtk::StyleContext::add_provider_for_display(
+            &Display::default().expect("Error initializing gtk css provider."),
+            &provider,
+            gtk::STYLE_PROVIDER_PRIORITY_APPLICATION,
+        );
+        new_build_ui(app);
+    });
+
+    application.run();
+}
+
+fn new_build_ui(app: &gtk::Application) {
+    // Create a new custom window and show it
+    let window = Window::new(app);
+    window.show();
+}

examples/app_library/style.css

@@ -0,0 +1,15 @@
+description {
+    line-height: 1.5em;
+    background-image: none;
+    background-color: red;
+}
+
+row.row1 {
+    background-image: none;
+    background-color: black;
+}
+
+shortcut {
+    background-image: none;
+    background-color: green;
+}

examples/app_library/window/imp.rs

@@ -0,0 +1,56 @@
+use gtk4 as gtk;
+
+use glib::subclass::InitializingObject;
+use gtk::prelude::*;
+use gtk::subclass::prelude::*;
+use gtk::{gio, glib};
+use gtk::{CompositeTemplate, GridView, SearchEntry};
+use once_cell::sync::OnceCell;
+
+// Object holding the state
+#[derive(CompositeTemplate, Default)]
+#[template(file = "window.ui")]
+pub struct Window {
+    #[template_child]
+    pub entry: TemplateChild<SearchEntry>,
+    #[template_child]
+    pub app_grid_view: TemplateChild<GridView>,
+    pub app_model: OnceCell<gio::ListStore>,
+}
+
+// The central trait for subclassing a GObject
+#[glib::object_subclass]
+impl ObjectSubclass for Window {
+    // `NAME` needs to match `class` attribute of template
+    const NAME: &'static str = "LauncherWindow";
+    type Type = super::Window;
+    type ParentType = gtk::ApplicationWindow;
+
+    fn class_init(klass: &mut Self::Class) {
+        Self::bind_template(klass);
+    }
+
+    fn instance_init(obj: &InitializingObject<Self>) {
+        obj.init_template();
+    }
+}
+// Trait shared by all GObjects
+impl ObjectImpl for Window {
+    fn constructed(&self, obj: &Self::Type) {
+        // Call "constructed" on parent
+        self.parent_constructed(obj);
+
+        // Setup
+        obj.setup_model();
+        obj.setup_callbacks();
+        obj.setup_factory();
+    }
+}
+// Trait shared by all widgets
+impl WidgetImpl for Window {}
+
+// Trait shared by all windows
+impl WindowImpl for Window {}
+
+// Trait shared by all application
+impl ApplicationWindowImpl for Window {}

examples/app_library/window/mod.rs

@@ -0,0 +1,209 @@
+mod imp;
+use gtk4 as gtk;
+
+use crate::application_row::ApplicationRow;
+use glib::Object;
+use gtk::prelude::*;
+use gtk::subclass::prelude::*;
+use gtk::{gio, glib};
+use gtk::{Application, SignalListItemFactory};
+
+use libcosmic::x;
+
+glib::wrapper! {
+    pub struct Window(ObjectSubclass<imp::Window>)
+        @extends gtk::ApplicationWindow, gtk::Window, gtk::Widget,
+        @implements gio::ActionGroup, gio::ActionMap, gtk::Accessible, gtk::Buildable,
+                    gtk::ConstraintTarget, gtk::Native, gtk::Root, gtk::ShortcutManager;
+}
+
+impl Window {
+    pub fn new(app: &Application) -> Self {
+        //quit shortcut
+        app.set_accels_for_action("win.quit", &["<primary>W", "Escape"]);
+        //launch shortcuts
+        for i in 1..10 {
+            app.set_accels_for_action(&format!("win.launch{}", i), &[&format!("<primary>{}", i)]);
+        }
+        Object::new(&[("application", app)]).expect("Failed to create `Window`.")
+    }
+
+    fn model(&self) -> &gio::ListStore {
+        // Get state
+        let imp = imp::Window::from_instance(self);
+        imp.app_model.get().expect("Could not get model")
+    }
+
+    fn setup_model(&self) {
+        // Create new model
+        let model = gio::ListStore::new(gio::AppInfo::static_type());
+        gio::AppInfo::all().iter().for_each(|app_info| {
+            model.append(app_info);
+        });
+
+        // Get state and set model
+        let imp = imp::Window::from_instance(self);
+        imp.app_model
+            .set(model.clone())
+            .expect("Could not set model");
+
+        // A sorter used to sort AppInfo in the model by their name
+        let sorter = gtk::CustomSorter::new(move |obj1, obj2| {
+            let app_info1 = obj1.downcast_ref::<gio::AppInfo>().unwrap();
+            let app_info2 = obj2.downcast_ref::<gio::AppInfo>().unwrap();
+
+            app_info1
+                .name()
+                .to_lowercase()
+                .cmp(&app_info2.name().to_lowercase())
+                .into()
+        });
+        let filter = gtk::CustomFilter::new(|_obj| true);
+        let filter_model = gtk::FilterListModel::new(Some(&model), Some(filter).as_ref());
+        let sorted_model = gtk::SortListModel::new(Some(&filter_model), Some(&sorter));
+        let selection_model = gtk::SingleSelection::new(Some(&sorted_model));
+
+        // Wrap model with selection and pass it to the list view
+        imp.app_grid_view.set_model(Some(&selection_model));
+    }
+
+    fn setup_callbacks(&self) {
+        // Get state
+        let imp = imp::Window::from_instance(self);
+        let window = self.clone().upcast::<gtk::Window>();
+        let app_grid_view = &imp.app_grid_view;
+        let sorted_model = app_grid_view
+            .model()
+            .expect("List view missing selection model")
+            .downcast::<gtk::SingleSelection>()
+            .expect("could not downcast listview model to single selection model")
+            .model()
+            .downcast::<gtk::SortListModel>()
+            .expect("sorted list model could not be downcast");
+        let filter_model = sorted_model
+            .model()
+            .expect("missing model for sort list model.")
+            .downcast::<gtk::FilterListModel>()
+            .expect("could not downcast sort list model to filter list model");
+
+        let entry = &imp.entry;
+
+        // Launch the application when an item of the list is activated
+        app_grid_view.connect_activate(move |grid_view, position| {
+            let model = grid_view.model().unwrap();
+            let app_info = model
+                .item(position)
+                .unwrap()
+                .downcast::<gio::AppInfo>()
+                .unwrap();
+
+            let context = grid_view.display().app_launch_context();
+            if let Err(err) = app_info.launch(&[], Some(&context)) {
+                let parent_window = grid_view.root().unwrap().downcast::<gtk::Window>().unwrap();
+
+                gtk::MessageDialog::builder()
+                    .text(&format!("Failed to start {}", app_info.name()))
+                    .secondary_text(&err.to_string())
+                    .message_type(gtk::MessageType::Error)
+                    .modal(true)
+                    .transient_for(&parent_window)
+                    .build()
+                    .show();
+            }
+        });
+
+        entry.connect_changed(
+            glib::clone!(@weak filter_model, @weak sorted_model => move |search: &gtk::SearchEntry| {
+                let search_text = search.text().to_string().to_lowercase();
+                let new_filter: gtk::CustomFilter = gtk::CustomFilter::new(move |obj| {
+                    let search_res = obj.downcast_ref::<gio::AppInfo>()
+                        .expect("The Object needs to be of type AppInfo");
+                    search_res.name().to_string().to_lowercase().contains(&search_text)
+                });
+                let search_text = search.text().to_string().to_lowercase();
+                let new_sorter: gtk::CustomSorter = gtk::CustomSorter::new(move |obj1, obj2| {
+                    let app_info1 = obj1.downcast_ref::<gio::AppInfo>().unwrap();
+                    let app_info2 = obj2.downcast_ref::<gio::AppInfo>().unwrap();
+                    if search_text == "" {
+                        return app_info1
+                            .name()
+                            .to_lowercase()
+                            .cmp(&app_info2.name().to_lowercase())
+                            .into();
+                    }
+
+                    let i_1 = app_info1.name().to_lowercase().find(&search_text);
+                    let i_2 = app_info2.name().to_lowercase().find(&search_text);
+                    match (i_1, i_2) {
+                        (Some(i_1), Some(i_2)) => i_1.cmp(&i_2).into(),
+                        (Some(_), None) => std::cmp::Ordering::Less.into(),
+                        (None, Some(_)) => std::cmp::Ordering::Greater.into(),
+                        _ => app_info1
+                            .name()
+                            .to_lowercase()
+                            .cmp(&app_info2.name().to_lowercase())
+                            .into()
+                    }
+                });
+
+                filter_model.set_filter(Some(new_filter).as_ref());
+                sorted_model.set_sorter(Some(new_sorter).as_ref());
+            }),
+        );
+
+        window.connect_realize(move |window| {
+            if let Some((display, surface)) = x::get_window_x11(window) {
+                unsafe {
+                    x::change_property(
+                        &display,
+                        &surface,
+                        "_NET_WM_WINDOW_TYPE",
+                        x::PropMode::Replace,
+                        &[x::Atom::new(&display, "_NET_WM_WINDOW_TYPE_DIALOG").unwrap()],
+                    );
+                }
+            } else {
+                println!("failed to get X11 window");
+            }
+        });
+
+        let action_quit = gio::SimpleAction::new("quit", None);
+        action_quit.connect_activate(glib::clone!(@weak window => move |_, _| {
+            window.close();
+        }));
+        self.add_action(&action_quit);
+
+        window.connect_is_active_notify(|win| {
+            if !win.is_active() {
+                win.close();
+            }
+        });
+    }
+
+    fn setup_factory(&self) {
+        let factory = SignalListItemFactory::new();
+        factory.connect_setup(move |_factory, item| {
+            let row = ApplicationRow::new();
+            item.set_child(Some(&row));
+        });
+
+        // the bind stage is used for "binding" the data to the created widgets on the "setup" stage
+        factory.connect_bind(move |_factory, grid_item| {
+            let app_info = grid_item
+                .item()
+                .unwrap()
+                .downcast::<gio::AppInfo>()
+                .unwrap();
+
+            let child = grid_item
+                .child()
+                .unwrap()
+                .downcast::<ApplicationRow>()
+                .unwrap();
+            child.set_app_info(&app_info);
+        });
+        // Set the factory of the list view
+        let imp = imp::Window::from_instance(self);
+        imp.app_grid_view.set_factory(Some(&factory));
+    }
+}

examples/app_library/window/window.ui

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <template class="LauncherWindow" parent="GtkApplicationWindow">
+    <property name="width-request">1200</property>
+    <property name="title">Pop App Library</property>
+    <property name="decorated">false</property>
+    <child>
+      <object class="GtkBox">
+        <property name="orientation">vertical</property>
+        <property name="margin-top">12</property>
+        <property name="margin-bottom">12</property>
+        <property name="margin-start">12</property>
+        <property name="margin-end">12</property>
+        <child>
+          <object class="GtkSearchEntry" id="entry">
+            <property name="width-request">300</property>
+            <property name="halign">center</property>
+            <property name="margin-bottom">12</property>
+            <property name="margin-top">12</property>
+          </object>
+        </child>
+        <child>
+          <object class="GtkScrolledWindow">
+            <property name="hscrollbar-policy">never</property>
+            <property name="min-content-height">500</property>
+            <property name="vexpand">true</property>
+            <property name="margin-top">12</property>
+            <child>
+              <object class="GtkGridView" id="app_grid_view">
+                <property name="min-columns">7</property>
+                <property name="max-columns">7</property>
+                <property name="single-click-activate">true</property>
+                <property name="enable-rubberband">true</property>
+              </object>
+            </child>
+          </object>
+        </child>
+        <child>
+          <object class="GtkSeparator">
+            <property name="orientation">horizontal</property>
+            <property name="hexpand">true</property>
+            <property name="margin-bottom">12</property>
+            <property name="margin-top">12</property>
+          </object>
+        </child>
+        <child>
+          <object class="GtkScrolledWindow">
+            <property name="hscrollbar-policy">never</property>
+            <property name="min-content-height">100</property>
+            <property name="max-content-height">200</property>
+            <property name="vexpand">true</property>
+            <child>
+              <object class="GtkGridView" id="group_grid_view">
+                <property name="min-columns">8</property>
+                <property name="max-columns">8</property>
+                <property name="single-click-activate">true</property>
+                <property name="enable-rubberband">true</property>
+              </object>
+            </child>
+          </object>
+        </child>
+      </object>
+    </child>
+  </template>
+</interface>

examples/launcher/application_row/application_row.ui

@@ -29,6 +29,7 @@
         <child>
           <object class="GtkLabel" id="name">
             <property name="halign">start</property>
+            <property name="ellipsize">end</property>
             <style>
               <class name="title-4" />
             </style>