examples: Add a new ListBox based one

Modified version of the ListBox-Model example using a StringList that is
sorted.  The StringSorter object uses a PropertyExpression to specify
the sorted parameter.

Author: jimbrankelly

examples/Cargo.toml

@@ -174,6 +174,11 @@ name = "list_box_model"
 path = "list_box_model/main.rs"
 required-features = ["im-rc"]
 
+[[bin]]
+name = "list_box_sort_stringlist"
+path = "list_box_sort_stringlist/main.rs"
+required-features = ["v4_14"]
+
 [[bin]]
 name = "list_view_apps_launcher"
 path = "list_view_apps_launcher/main.rs"

examples/README.md

@@ -45,6 +45,7 @@ cargo run --bin basics
 - [Grid Packing](./grid_packing)
 - [GtkBuilder](./gtk_builder/)
 - [ListBox and ListModel](./list_box_model/)
+- [ListBox: StringList with Sorter](./listbox_sort_stringlist/)
 - [ListView: Applications Launcher](./list_view_apps_launcher/)
 - [Menubar](./menubar/)
 - [Rotation Bin](./rotation_bin/)

examples/list_box_sort_stringlist/README.md

@@ -0,0 +1,13 @@
+# ListBox and StringListModel with Sorter example
+
+This example demonstrates how to use `gtk::ListBox` in combination with
+a StringList model and StringSorter with a PropertyExpression.
+
+It sets up a `gtk::ListBox` containing an Inscription on each row.
+The rows are sorted alphabetically.
+
+Run it by executing:
+
+```bash
+cargo run --bin list_box_sort_stringlist --features v4_14
+``

examples/list_box_sort_stringlist/main.rs

@@ -0,0 +1,75 @@
+// Variation on ListBox model example to show use of StringList and StringSorter.
+
+use gtk::{glib, prelude::*};
+
+fn main() -> glib::ExitCode {
+    let application = gtk::Application::builder()
+        .application_id("com.github.gtk-rs.examples.SortedStringList")
+        .build();
+
+    application.connect_activate(build_ui);
+
+    application.run()
+}
+
+fn build_ui(application: &gtk::Application) {
+    let window = gtk::ApplicationWindow::builder()
+        .default_width(320)
+        .default_height(200)
+        .application(application)
+        .title("Sorted StringList")
+        .build();
+
+    // Create a StringSorter with a property expression to sort
+    // StringObjects in a StringList.  StringObject has a "string" property.
+    let expression = gtk::PropertyExpression::new(
+        gtk::StringObject::static_type(),
+        None::<gtk::Expression>,
+        "string",
+    );
+    let sorter = gtk::StringSorter::new(Some(expression));
+    sorter.set_ignore_case(true);
+
+    // Create our list store as a StringList and populate with some strings.
+    let model = gtk::StringList::new(&["zoo", "abba", "donkey", "sunrise", "river", "phoenix"]);
+
+    // Create a sort model and bind it to the ListStore and the sorter.
+    let sort_model = gtk::SortListModel::new(Some(model.clone()), Some(sorter));
+
+    // And then create the UI part, the listbox and bind the sort
+    // model to it. Whenever the UI needs to show a new row, e.g. because
+    // it was notified that the model changed, it will call the callback
+    // with the corresponding item from the model and will ask for a new
+    // gtk::ListBoxRow that should be displayed.
+    //
+    // The gtk::ListBoxRow can contain any possible widgets.
+    // Here we use an Inscription.
+
+    let listbox = gtk::ListBox::new();
+    listbox.bind_model(Some(&sort_model), move |obj| {
+        let list_object = obj
+            .downcast_ref::<gtk::StringObject>()
+            .expect("The object should be of type `StringObject`.");
+        gtk::Inscription::builder()
+            .xalign(0.0)
+            .text(list_object.string())
+            .build()
+            .upcast()
+    });
+
+    let scrolled_window = gtk::ScrolledWindow::builder()
+        .hscrollbar_policy(gtk::PolicyType::Never) // Disable horizontal scrolling
+        .min_content_height(200)
+        .min_content_width(360)
+        .build();
+
+    scrolled_window.set_child(Some(&listbox));
+
+    window.set_child(Some(&scrolled_window));
+
+    for i in 0..10 {
+        model.append(&format!("Name {i}"));
+    }
+
+    window.present();
+}