First examples

Author: amolenaar

.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+.venv
+*.sw[op]

README.md

@@ -0,0 +1,28 @@
+# GTK4 ListView examples
+
+[`Gtk.ListView`](https://docs.gtk.org/gtk4/section-list-widget.html) is the new list and tree widget for GTK4.
+
+I started with a simple list model ([simple_list.py](gtk4_list_view/simple_list.py)).
+The next step is to add some hierarchy, make it a tree ([simple_tree.py](gtk4_list_view/simple_tree.py)).
+
+Note that, in the _.ui_ files, `type="__main__+Demo"`. This is because the Demo class is defined in the module
+we start (`__main__`).
+
+
+#Set up
+
+```
+poetry install
+```
+
+To enable the Python virtual environment:
+
+```
+poetry shell
+```
+
+To run an example:
+
+```
+python -m gtk4_list_view.simple_list
+```

gtk4_list_view/__init__.py

@@ -0,0 +1,5 @@
+__version__ = '0.1.0'
+
+import gi
+
+gi.require_version("Gtk", "4.0")

gtk4_list_view/simple_list.py

@@ -0,0 +1,45 @@
+import importlib.resources
+
+from gi.repository import Gio, GLib, GObject, Gtk
+
+
+def new_list_item_ui():
+    with importlib.resources.path("gtk4_list_view", "simple_list.ui") as ui_path:
+        return GLib.Bytes.new(ui_path.read_bytes())
+
+
+class Demo(GObject.GObject):
+    def __init__(self, name):
+        super().__init__()
+        self._name = name
+
+    @GObject.Property(type=str)
+    def name(self):
+        return self._name
+
+
+if __name__ == "__main__":
+
+    model = Gio.ListStore.new(Demo)
+    model.append(Demo("one"))
+    model.append(Demo("two"))
+    model.append(Demo("three"))
+
+    app = Gtk.Application.new("gtk4.listview.SimpleList", 0)
+
+    def activate(app):
+        w = Gtk.Window()
+        w.set_title("Listview test")
+        w.set_default_size(400, 400)
+        app.add_window(w)
+
+        # wrap in gtk_tree_list_model_new
+        selection = Gtk.SingleSelection.new(model)
+        factory = Gtk.BuilderListItemFactory.new_from_bytes(None, new_list_item_ui())
+
+        lv = Gtk.ListView.new(selection, factory)
+        w.set_child(lv)
+        w.show()
+
+    app.connect("activate", activate)
+    app.run()

gtk4_list_view/simple_list.ui

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <template class="GtkListItem">
+    <property name="child">
+      <object class="GtkLabel">
+        <property name="xalign">0</property>
+        <binding name="label">
+          <lookup name="name" type="__main__+Demo">
+            <lookup name="item">GtkListItem</lookup>
+          </lookup>
+        </binding>
+      </object>
+    </property>
+  </template>
+</interface>

gtk4_list_view/simple_tree.py

@@ -0,0 +1,56 @@
+import importlib.resources
+
+from gi.repository import Gio, GLib, GObject, Gtk
+
+
+def new_list_item_ui():
+    with importlib.resources.path("gtk4_list_view", "simple_tree.ui") as ui_path:
+        return GLib.Bytes.new(ui_path.read_bytes())
+
+
+class Demo(GObject.GObject):
+    def __init__(self, name):
+        super().__init__()
+        self._name = name
+
+    @GObject.Property(type=str)
+    def name(self):
+        return self._name
+
+
+if __name__ == "__main__":
+
+    model = Gio.ListStore.new(Demo)
+    model.append(Demo("one"))
+    model.append(Demo("two"))
+    model.append(Demo("three"))
+
+    app = Gtk.Application.new("gtk4.listview.SimpleTree", 0)
+
+    def activate(app):
+        w = Gtk.Window()
+        w.set_title("Simple tree")
+        w.set_default_size(400, 400)
+        app.add_window(w)
+
+        def child_model(item, user_data):
+            return model
+
+        # Our data objects are wrapped by a Gtk.TreeListRow
+        tree = Gtk.TreeListModel.new(
+            model,
+            passthrough=False,
+            autoexpand=False,
+            create_func=child_model,
+            user_data=None,
+        )
+
+        selection = Gtk.SingleSelection.new(tree)
+        factory = Gtk.BuilderListItemFactory.new_from_bytes(None, new_list_item_ui())
+
+        lv = Gtk.ListView.new(selection, factory)
+        w.set_child(lv)
+        w.show()
+
+    app.connect("activate", activate)
+    app.run()

gtk4_list_view/simple_tree.ui

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <template class="GtkListItem">
+    <property name="child">
+      <object class="GtkTreeExpander" id="expander">
+        <property name="indent-for-icon">yes</property>
+        <binding name="list-row">
+          <lookup name="item">GtkListItem</lookup>
+        </binding>
+        <property name="child">
+          <object class="GtkLabel">
+            <property name="xalign">0</property>
+            <binding name="label">
+              <lookup name="name" type="__main__+Demo">
+                <lookup name="item">expander</lookup>
+              </lookup>
+            </binding>
+          </object>
+        </property>
+      </object>
+    </property>
+  </template>
+</interface>

poetry.lock

@@ -0,0 +1,16 @@
+[tool.poetry]
+name = "gtk4-list-view"
+version = "0.1.0"
+description = ""
+authors = ["Arjan Molenaar <gaphor@gmail.com>"]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+PyGObject = "^3.42.1"
+
+[tool.poetry.dev-dependencies]
+pytest = "^5.2"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,5 @@
+from python_gtk4_list_view import __version__
+
+
+def test_version():
+    assert __version__ == '0.1.0'