From 3f588a5f8e2f9fbaf2c2329eb23a34c362d7a345 Mon Sep 17 00:00:00 2001
From: Walter Bender <walter.bender@gmail.com>
Date: Mon, 21 Mar 2011 22:25:27 +0000
Subject: added comments to Python samples (#2709)

---
(limited to 'pysamples/push_mouse_event.py')

diff --git a/pysamples/push_mouse_event.py b/pysamples/push_mouse_event.py
index 26301ac..154e395 100644
--- a/pysamples/push_mouse_event.py
+++ b/pysamples/push_mouse_event.py
@@ -22,6 +22,17 @@
 # This procedure is invoked when the user-definable block on the "extras"
 # palette is selected.
 
+# Usage: Import this code into a Python (user-definable) block; when
+# this code is run, the current mouse status will be pushed to the
+# FILO heap. If a mouse button event occurs, a y, x, and 1 are pushed
+# to the heap. If no button is pressed, a y, x, 0 is pushed to the
+# heap.
+
+# To use these data, pop the heap in a compare block to determine if a
+# button has been pushed. The conditional could be use to lower or
+# raise the pen, for example. After checking the button status, pop
+# the x and y coordinates.
+
 
 def myblock(tw, x):  # ignore second argument
 
@@ -38,4 +49,6 @@ def myblock(tw, x):  # ignore second argument
         tw.lc.heap.append(1) # mouse event
         tw.mouse_flag = 0
     else:
+        tw.lc.heap.append((tw.canvas.height / 2) - tw.mouse_y)
+        tw.lc.heap.append(tw.mouse_x - (tw.canvas.width / 2))
         tw.lc.heap.append(0) # no mouse event
--
cgit v0.9.1