Changeset 2301

Timestamp:

05/18/08 23:32:50 (7 months ago)

Author:

arj..@yirdis.nl

Message:

updated docstrings on HandleTool? connection hooks.

Files:

• gaphas/trunk/gaphas/tests/test_line.py (modified) (1 diff)
• gaphas/trunk/gaphas/tool.py (modified) (3 diffs)

gaphas/trunk/gaphas/tests/test_line.py

@@ -32 +32 @@
-
-    def test_orthogonal_horizontal_undo(self):
+        """
+        Orthogonal line constraints bug (#107)
+        """
-        canvas = Canvas()
-        line = Line()

gaphas/trunk/gaphas/tool.py

@@ -449 +449 @@
-        """
-        Move the handle to position ``(x,y)``. ``x`` and ``y`` are in
-
+ ``item`` is the item whose ``handle`` is moved.
-        """
-        handle.x = x
@@ -457 +457 @@
-    def glue(self, view, item, handle, vx, vy):
-        """
-
+
+
-        ``vx`` and ``vy`` are the pointer (view) coordinates.
+
+        The ``glue()`` code should take care of moving ``handle`` to the
+        correct position, creating a glue effect.
-        """
-
-    def connect(self, view, item, handle, vx, vy):
-        """
-
+
+
-        ``vx`` and ``vy`` are the pointer (view) coordinates.
+        
+        A typical connect action may involve the following:
+        
+        - Find an item near ``handle`` that can be connected to.
+        - Move ``handle`` to the right position.
+        - Set ``handle.connected_to`` to point to the new item.
+        - Add constraints to the constraint solver (``view.canvas.solver``).
+        - Set ``handle.disconnect`` to point to a method that can be called when
+          the handle is disconnected (no arguments).
+        
+        NOTE: ``connect()`` can not expect ``glue()`` has been called,
+        therefore it should ensure the handle is moved to the correct location
+        before.
-        """
-
@@ -470 +488 @@
-        """
-        Disconnect the handle. This mostly comes down to removing 
-
+
+
+
+
+
+
+
-        """
-