diff ext/guichan-0.8.1/include/guichan/mouselistener.hpp @ 0:4a0efb7baf70

* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ext/guichan-0.8.1/include/guichan/mouselistener.hpp	Sun Jun 29 18:44:17 2008 +0000
@@ -0,0 +1,183 @@
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef GCN_MOUSELISTENER_HPP
+#define GCN_MOUSELISTENER_HPP
+
+#include "guichan/mouseevent.hpp"
+#include "guichan/platform.hpp"
+
+namespace gcn
+{
+    /**
+     * Interface for listening for mouse events from widgets.
+     *
+     * @see Widget::addMouseListener, Widget::removeMouseListener
+     * @since 0.1.0
+     */
+    class GCN_CORE_DECLSPEC MouseListener
+    {
+    public:
+
+        /**
+         * Destructor.
+         */
+        virtual ~MouseListener() { }
+
+        /**
+         * Called when the mouse has entered into the widget area.
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseEntered(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when the mouse has exited the widget area.
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseExited(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when a mouse button has been pressed on the widget area.
+         *
+         * NOTE: A mouse press is NOT equal to a mouse click.
+         *       Use mouseClickMessage to check for mouse clicks.
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mousePressed(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when a mouse button has been released on the widget area.
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseReleased(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when a mouse button is pressed and released (clicked) on
+         * the widget area.
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseClicked(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when the mouse wheel has moved up on the widget area.
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseWheelMovedUp(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when the mouse wheel has moved down on the widget area.
+         *
+         * @param mousEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseWheelMovedDown(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when the mouse has moved in the widget area and no mouse button
+         * has been pressed (i.e no widget is being dragged).
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseMoved(MouseEvent& mouseEvent)
+        {
+
+        }
+
+        /**
+         * Called when the mouse has moved and the mouse has previously been
+         * pressed on the widget.
+         *
+         * @param mouseEvent Describes the event.
+         * @since 0.6.0
+         */
+        virtual void mouseDragged(MouseEvent& mouseEvent)
+        {
+
+        }
+
+    protected:
+        /**
+         * Constructor.
+         *
+         * You should not be able to make an instance of MouseListener,
+         * therefore its constructor is protected.
+         */
+        MouseListener() { }
+    };
+}
+
+#endif // end GCN_MOUSELISTENER_HPP