Convert template listing into a tree view.

Change QListView to QTreeView.
Added optional group attribute to templates.

Author: Mtk112

arho_feature_template/core/feature_template_library.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import logging
+from collections import defaultdict
 
 from qgis.core import QgsFeature, QgsProject, QgsVectorLayer
 from qgis.gui import QgsMapToolDigitizeFeature
@@ -81,15 +82,19 @@ def __init__(self) -> None:
         self.template_model = QStandardItemModel()
         self.template_dock.template_list.setModel(self.template_model)
 
+        # Set the selection mode to allow single selection
+        self.template_dock.template_list.setSelectionMode(self.template_dock.template_list.SingleSelection)
+
         self._read_library_configs()
 
         self.template_dock.library_selection.addItems(self.get_library_names())
 
-        # Update template list when library selection changes
+        # Update template tree when library selection changes
         self.template_dock.library_selection.currentIndexChanged.connect(
             lambda: self.set_active_library(self.template_dock.library_selection.currentText())
         )
-        # Update template list when search text changes
+
+        # Update template tree when search text changes
         self.template_dock.search_box.valueChanged.connect(self.on_template_search_text_changed)
 
         # Activate map tool when template is selected
@@ -101,11 +106,17 @@ def __init__(self) -> None:
 
     def on_template_item_clicked(self, index):
         item = self.template_model.itemFromIndex(index)
+
+        # Do nothing if clicked item is a group
+        if item.hasChildren():
+            return
+
         try:
             layer = get_layer_from_project(item.config.feature.layer)
         except (LayerNotFoundError, LayerNotVectorTypeError):
             logger.exception("Failed to activate template")
             return
+
         self.active_template = item
         self.start_digitizing_for_layer(layer)
 
@@ -114,16 +125,29 @@ def on_template_item_clicked(self, index):
             index, QItemSelectionModel.Select | QItemSelectionModel.Rows
         )
 
-    def on_template_search_text_changed(self, search_text: str):
+    def on_template_search_text_changed(self, search_text: str) -> None:
+        search_text = search_text.lower()
+
         for row in range(self.template_model.rowCount()):
-            item = self.template_model.item(row)
+            group_item = self.template_model.item(row)
+            group_visible = False
+
+            for child_row in range(group_item.rowCount()):
+                template_item = group_item.child(child_row)
+                matches = search_text in template_item.text().lower()
+                template_item.setEnabled(matches)
+                group_item.setChild(child_row, template_item)
 
-            # If the search text is in the item's text, show the row
-            if search_text in item.text().lower():
-                self.template_dock.template_list.setRowHidden(row, False)
-            else:
-                # Otherwise, hide the row
-                self.template_dock.template_list.setRowHidden(row, True)
+                if matches:
+                    group_visible = True
+
+            # Show or hide the group based on child matches
+            group_item.setEnabled(group_visible)
+
+            index = self.template_model.indexFromItem(group_item)
+            self.template_dock.template_list.setExpanded(index, group_visible)
+
+            self.template_model.setItem(row, group_item)
 
     def start_digitizing_for_layer(self, layer: QgsVectorLayer) -> None:
         self.digitize_map_tool.clean()
@@ -163,10 +187,26 @@ def get_library_names(self) -> list[str]:
     def set_active_library(self, library_name: str) -> None:
         self.template_model.clear()
 
+        # Group templates by their 'group' attribute, defaulting to "Ryhmittelemättömät" for ungrouped templates
+        grouped_templates = defaultdict(list)
         for template in self.library_configs[library_name].templates:
-            item = TemplateItem(template)
-            item.setEditable(False)
-            self.template_model.appendRow(item)
+            group = getattr(template, "group", None)
+            if not group:
+                group = "Ryhmittelemättömät"
+            grouped_templates[group].append(template)
+
+        for group_name, templates in grouped_templates.items():
+            group_item = QStandardItem(group_name)
+            group_item.setEditable(False)
+
+            for template in templates:
+                template_item = TemplateItem(template)
+                template_item.setEditable(False)
+                group_item.appendRow(template_item)
+
+            self.template_model.appendRow(group_item)
+
+        self.template_dock.template_list.expandAll()
 
     def _read_library_configs(self) -> None:
         for config_file in library_config_files():

arho_feature_template/core/template_library_config.py

@@ -53,13 +53,15 @@ class TemplateLibraryMeta:
     """Describes the metadata of a template library"""
 
     name: str
+    group: str | None
     description: str | None
     version: str | None
 
     @classmethod
     def from_dict(cls, data: dict) -> TemplateLibraryMeta:
         return cls(
             name=data["name"],
+            group=data.get("group"),
             description=data.get("description"),
             version=data.get("version"),
         )
@@ -70,13 +72,15 @@ class FeatureTemplate:
     """Describes a feature template that can include nested features"""
 
     name: str
+    group: str | None
     description: str | None
     feature: Feature
 
     @classmethod
     def from_dict(cls, data: dict) -> FeatureTemplate:
         return cls(
             name=data["name"],
+            group=data.get("group"),
             description=data.get("description"),
             feature=Feature.from_dict(data["feature"]),
         )

arho_feature_template/gui/template_dock.py

@@ -6,7 +6,7 @@
 
 if TYPE_CHECKING:
     from qgis.gui import QgsFilterLineEdit
-    from qgis.PyQt.QtWidgets import QComboBox, QLabel, QListView
+    from qgis.PyQt.QtWidgets import QComboBox, QLabel, QTreeView
 
 ui_path = resources.files(__package__) / "template_dock.ui"
 DockClass, _ = uic.loadUiType(ui_path)
@@ -15,7 +15,8 @@
 class TemplateLibraryDock(QgsDockWidget, DockClass):  # type: ignore
     library_selection: "QComboBox"
     search_box: "QgsFilterLineEdit"
-    template_list: "QListView"
+    # template_list: "QListView"
+    template_list: "QTreeView"
     txt_tip: "QLabel"
 
     def __init__(self):

arho_feature_template/gui/template_dock.ui

@@ -40,7 +40,7 @@
      <widget class="QgsFilterLineEdit" name="search_box"/>
     </item>
     <item>
-     <widget class="QListView" name="template_list"/>
+     <widget class="QTreeView" name="template_list"/>
     </item>
     <item>
      <widget class="QLabel" name="txt_tip">

arho_feature_template/resources/template_libraries/ryhmitelty-asemakaava-sample.yaml

@@ -0,0 +1,51 @@
+version: 1
+meta:
+  name: Asemakaavan kaavamääräykset
+  version: "1.0"
+templates:
+  - name: Simppeli kaavakohde
+    group: Osa-alue
+    description: Kaavakohde ilman kikkareita
+    feature:
+      layer: land_use_area
+      attributes:
+        - attribute: name
+        - attribute: type_of_underground_id
+          default: 1
+
+  - name: Asuin-, liike- ja toimistorakennusten alue
+    group: Aluevaraus
+    description: Alueella kuvataan ...
+    feature:
+      layer: land_use_area
+      attributes:
+        - attribute: name
+        - attribute: type_of_underground_id
+          default: 1
+      child_features:
+        - layer: plan_requlation_group
+          attributes:
+            - attribute: name
+              default: Asuin-, liike- ja toimistorakennusten alue
+              allow_user_input: false
+          child_features:
+            - layer: plan_requlation
+              attributes:
+                - attribute: type_of_plan_regulation_id
+                  default: asumisenAlue
+                  hidden: true
+              child_features:
+                - layer: additional_information_of_plan_regulation
+                  attributes:
+                    - attribute: type_of_additional_information_id
+                      default: paakayttotarkoitus
+                      hidden: true
+
+  - name: Ryhmätön simppeli kaavakohde
+    description: Kaavakohde ilman kikkareita
+    feature:
+      layer: other_area
+      attributes:
+        - attribute: name
+        - attribute: type_of_underground_id
+          default: 1

arho_feature_template/resources/template_libraries/schema/template_library.schema.json

@@ -90,6 +90,10 @@
           "description": "The name of the template",
           "type": "string"
         },
+        "group": {
+          "description": "The group of the template",
+          "type": "string"
+        },
         "description": {
           "description": "The description of the template",
           "type": "string"