Redirected click to use hook

Author: th-jyu

hooks/tree_node_clicked.py

@@ -0,0 +1,72 @@
+"""Hook to call whenever a publish tree node is clicked (Qt tree item).
+
+`.tk_multi_publish2` related wordings and phrases used:
+
+- "tree node", or "node" for short:
+
+    - An instance of a subclass of
+      `.tk_multi_publish2.publish_tree_widget.tree_node_base.TreeNodeBase`
+
+      - Which itself subclasses `.QTreeWidgetItem`
+
+- "widget" of the node
+
+    - Behaves like a delegate, but not actually using the Qt delegate system
+      from model/view architecture
+
+    - An instance of a subclass of
+      `.tk_multi_publish2.publish_tree_widget.custom_widget_base.CustomWidgetBase`
+
+      - Which itself subclasses `.QFrame`
+
+- Publish "api" associated with the node, if any:
+
+    - `.tk_multi_publish2.api.item.PublishItem` for a `.TreeNodeItem`
+    - `.tk_multi_publish2.api.task.PublishTask` for a `.TreeNodeTask`
+    - otherwise `None`, i.e. for `.TreeNodeContext` and `.TreeNodeSummary`
+
+"""
+
+from typing import TypeVar, Union
+import sgtk
+from sgtk.platform.qt import QtCore, QtGui
+
+HookBaseClass = sgtk.get_hook_baseclass()
+
+TreeNode = TypeVar("TreeNode", bound=QtGui.QTreeWidgetItem)
+CustomTreeWidget = TypeVar("CustomTreeWidget", bound=QtGui.QFrame)
+API = Union[TypeVar("PublishItem"), TypeVar("PublishTask"), None]
+
+
+class TreeNodeClicked(HookBaseClass):
+    @staticmethod
+    def flipped_state(check_state: QtCore.Qt.CheckState) -> QtCore.Qt.CheckState:
+        """Flips a unchecked state to checked and any other state to unchecked."""
+        return (
+            QtCore.Qt.Checked
+            if check_state == QtCore.Qt.Unchecked
+            else QtCore.Qt.Unchecked
+        )
+
+    def single(
+        self,
+        node: TreeNode,
+        widget: CustomTreeWidget,
+        api: API,
+        buttons: QtCore.Qt.MouseButtons,
+        modifiers: QtCore.Qt.KeyboardModifiers,
+    ):  # type: (...) -> None
+        """Single click callback on a `.TreeNodeBase` (a `.QtGui.QTreeWidgetItem`)."""
+
+    def double(
+        self,
+        node: TreeNode,
+        widget: CustomTreeWidget,
+        api: API,
+        buttons: QtCore.Qt.MouseButtons,
+        modifiers: QtCore.Qt.KeyboardModifiers,
+    ):  # type: (...) -> None
+        """Double click callback on a `.TreeNodeBase` (a `.QtGui.QTreeWidgetItem`)."""
+        if buttons == QtCore.Qt.LeftButton:
+            # Ensure expansion states are correctly updated
+            node.setExpanded(node.isExpanded())

info.yml

@@ -48,6 +48,14 @@ configuration:
            identification, publish display name, image sequence paths, etc."
         default_value: "{self}/path_info.py"
 
+    tree_node_clicked:
+        type: hook
+        default_value: "{self}/tree_node_clicked.py"
+        description:
+          "Actions to take for clicking on a tree node (an instance of subclass
+          of TreeNodeBase). The methods 'single' and 'double' are called
+          respectively for single and double clicks."
+
     thumbnail_generator:
         type: hook
         description:

python/tk_multi_publish2/publish_tree_widget/publish_tree_widget.py

@@ -63,7 +63,8 @@ def __init__(self, parent):
         self._summary_node.setHidden(True)
 
         # forward double clicks on items to the items themselves
-        self.itemDoubleClicked.connect(lambda i, c: i.double_clicked(c))
+        self.itemDoubleClicked.connect(self._click_slot_factory("double"))
+        self.itemClicked.connect(self._click_slot_factory("single"))
 
         # Capture the native expand toggles and update the button state.
         self.itemExpanded.connect(self.on_item_expand_state_change)
@@ -559,6 +560,29 @@ def mouseMoveEvent(self, event):
             # bubble up all events that aren't drag select related
             super().mouseMoveEvent(event)
 
+    def _click_slot_factory(self, method_name):
+        """Create a slot to call the given hook method on click.
+
+        i.e. for both single and double clicks::
+
+            self.itemClicked.connect(self._click_slot_factory("single"))
+            self.itemDoubleClicked.connect(self._click_slot_factory("double"))
+
+        """
+
+        @QtCore.Slot(QtGui.QTreeWidgetItem, int)
+        def _on_click_slot(tree_node: QtGui.QTreeWidgetItem, column: int) -> None:
+            kwargs = {
+                "node": tree_node,
+                "widget": self.itemWidget(tree_node, column),
+                "api": tree_node.get_publish_instance(),
+                "buttons": QtGui.QApplication.mouseButtons(),
+                "modifiers": QtGui.QApplication.keyboardModifiers(),
+            }
+            self._bundle.execute_hook_method("tree_node_clicked", method_name, **kwargs)
+
+        return _on_click_slot
+
 
 def _init_item_r(parent_item):