summaryrefslogtreecommitdiff
path: root/src/guichan/include/guichan/mouseinput.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/guichan/include/guichan/mouseinput.hpp')
-rw-r--r--src/guichan/include/guichan/mouseinput.hpp241
1 files changed, 241 insertions, 0 deletions
diff --git a/src/guichan/include/guichan/mouseinput.hpp b/src/guichan/include/guichan/mouseinput.hpp
new file mode 100644
index 000000000..3825d5439
--- /dev/null
+++ b/src/guichan/include/guichan/mouseinput.hpp
@@ -0,0 +1,241 @@
+/* _______ __ __ __ ______ __ __ _______ __ __
+ * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
+ * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
+ * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * 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_MOUSEINPUT_HPP
+#define GCN_MOUSEINPUT_HPP
+
+#include "guichan/platform.hpp"
+
+namespace gcn
+{
+
+ /**
+ * Internal class that represents mouse input. Generally you won't have to
+ * bother using this class unless you implement an Input class for
+ * a back end.
+ *
+ * @author Olof Naessén
+ * @author Per Larsson
+ * @since 0.1.0
+ */
+ class GCN_CORE_DECLSPEC MouseInput
+ {
+ public:
+
+ /**
+ * Constructor.
+ */
+ MouseInput() :
+ mType(0),
+ mButton(0),
+ mTimeStamp(0),
+ mX(0),
+ mY(0)
+ { };
+
+ /**
+ * Constructor.
+ *
+ * @param button The button pressed.
+ * @param type The type of mouse input.
+ * @param x The mouse x coordinate.
+ * @param y The mouse y coordinate.
+ * @param timeStamp The timestamp of the mouse input. Used to
+ * check for double clicks.
+ */
+ MouseInput(unsigned int button,
+ unsigned int type,
+ int x,
+ int y,
+ int timeStamp);
+
+ /**
+ * Sets the type of the mouse input.
+ *
+ * @param type The type of the mouse input. Should be a value from the
+ * mouse event type enum
+ * @see getType
+ * @since 0.1.0
+ */
+ void setType(unsigned int type);
+
+ /**
+ * Gets the type of the mouse input.
+ *
+ * @return The type of the mouse input. A value from the mouse event
+ * type enum.
+ * @see setType
+ * @since 0.1.0
+ */
+ unsigned int getType() const;
+
+ /**
+ * Sets the button pressed.
+ *
+ * @param button The button pressed. Should be one of the values
+ * in the mouse event button enum.
+ * @see getButton.
+ * @since 0.1.0
+ */
+ void setButton(unsigned int button);
+
+ /**
+ * Gets the button pressed.
+ *
+ * @return The button pressed. A value from the mouse event
+ * button enum.
+ * @see setButton
+ * @since 0.1.0
+ */
+ unsigned int getButton() const;
+
+ /**
+ * Sets the timestamp for the mouse input.
+ * Used to check for double clicks.
+ *
+ * @param timeStamp The timestamp of the mouse input.
+ * @see getTimeStamp
+ * @since 0.1.0
+ */
+ void setTimeStamp(int timeStamp);
+
+ /**
+ * Gets the time stamp of the input.
+ * Used to check for double clicks.
+ *
+ * @return The time stamp of the mouse input.
+ * @see setTimeStamp
+ * @since 0.1.0
+ */
+ int getTimeStamp() const;
+
+ /**
+ * Sets the x coordinate of the mouse input.
+ *
+ * @param x The x coordinate of the mouse input.
+ * @see getX
+ * @since 0.6.0
+ */
+ void setX(int x);
+
+ /**
+ * Gets the x coordinate of the mouse input.
+ *
+ * @return The x coordinate of the mouse input.
+ * @see setX
+ * @since 0.6.0
+ */
+ int getX() const;
+
+ /**
+ * Sets the y coordinate of the mouse input.
+ *
+ * @param y The y coordinate of the mouse input.
+ * @see getY
+ * @since 0.6.0
+ */
+ void setY(int y);
+
+ /**
+ * Gets the y coordinate of the mouse input.
+ *
+ * @return The y coordinate of the mouse input.
+ * @see setY
+ * @since 0.6.0
+ */
+ int getY() const;
+
+ /**
+ * Mouse input event types. This enum partially corresponds
+ * to the enum with event types in MouseEvent for easy mapping.
+ */
+ enum
+ {
+ MOVED = 0,
+ PRESSED,
+ RELEASED,
+ WHEEL_MOVED_DOWN,
+ WHEEL_MOVED_UP
+ };
+
+ /**
+ * Mouse button types.
+ */
+ enum
+ {
+ EMPTY = 0,
+ LEFT,
+ RIGHT,
+ MIDDLE
+ };
+
+ protected:
+ /**
+ * Holds the type of the mouse input.
+ */
+ unsigned int mType;
+
+ /**
+ * Holds the button of the mouse input.
+ */
+ unsigned int mButton;
+
+ /**
+ * Holds the timestamp of the mouse input. Used to
+ * check for double clicks.
+ */
+ int mTimeStamp;
+
+ /**
+ * Holds the x coordinate of the mouse input.
+ */
+ int mX;
+
+ /**
+ * Holds the y coordinate of the mouse input.
+ */
+ int mY;
+ };
+}
+
+#endif // end GCN_MOUSEINPUT_HPP