This commit was generated by cvs2svn to compensate for changes in r2,

which included commits to RCS files with non-trunk default branches.


git-svn-id: svn://svn.cc65.org/cc65/trunk@3 b7a2c559-68d2-44c3-8de9-860c34a00d81

include/mouse.h

@@ -0,0 +1,88 @@
+/*
+ * mouse.h
+ *
+ * Ullrich von Bassewitz, 24.04.1999
+ */
+
+
+
+#ifndef _MOUSE_H
+#define _MOUSE_H
+
+
+
+/* Define __MOUSE__ for systems that support a proportional mouse */
+#ifdef __C64__
+#  define __MOUSE__
+#endif
+#ifdef __C128__
+#  define __MOUSE__
+#endif
+
+
+
+void __fastcall__ mouse_init (unsigned char port, unsigned char sprite);
+/* Setup the mouse interrupt handler. If the sprite value is != zero, the
+ * mouse routines will manage the sprite with this number. That means, it
+ * is moved if the mouse is moved (provided that the mouse cursor is visible),
+ * and switch on and off in the show and hide functions.
+ * The port parameter gives the joystick port used for the mouse and is only
+ * needed to read the mouse button state.
+ * After calling this function, the mouse is invisble, the cursor is placed
+ * at 0/0 (upper left corner), and the bounding box is reset to cover the
+ * whole screen. Call mouse_show once to make the mouse cursor visible.
+ */
+
+void mouse_done (void);
+/* Disable the mouse, remove the interrupt handler. This function MUST be
+ * called before terminating the program, otherwise odd things may happen.
+ * If in doubt, install an exit handler (using atexit) that calls this
+ * function.
+ */
+
+void mouse_hide (void);
+/* Hide the mouse. This function doesn't do anything visible if no sprite is
+ * used. The function manages a counter and may be called more than once.
+ * For each call to mouse_hide there must be a call to mouse_show to make
+ * the mouse visible again.
+ */
+
+void mouse_show (void);
+/* Show the mouse. This function doesn't do anything visible if no sprite is
+ * used. See mouse_hide for more information.
+ */
+
+void __fastcall__ mouse_box (int minx, int miny, int maxx, int maxy);
+/* Set the bounding box for the mouse pointer movement. The mouse X and Y
+ * coordinates will never go outside the given box.
+ * NOTE: The function does *not* check if the mouse is currently inside the
+ * given margins. The proper way to use this function therefore is:
+ *
+ * 	- Hide the mouse
+ * 	- Set the bounding box
+ * 	- Place the mouse at the desired position
+ * 	- Show the mouse again.
+ *
+ * NOTE2: When setting the box to something that is larger than the actual
+ * screen, the positioning of the mouse cursor will fail. If such margins
+ * are really what you want, you have to use your own cursor routines.
+ */
+
+void __fastcall__ mouse_move (int x, int y);
+/* Set the mouse cursor to the given position. If a mouse cursor is defined
+ * and currently visible, the mouse cursor is also moved.
+ * NOTE: This function does not check if the given position is valid and
+ * inside the bounding box.
+ */
+
+void mouse_info (void);
+/* Hmmm...
+ */
+
+
+
+/* End of mouse.h */
+#endif
+
+
+