diff ext/guichan-0.8.2/include/guichan/key.hpp @ 378:64738befdf3b

bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Mon, 11 Jan 2010 23:34:52 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ext/guichan-0.8.2/include/guichan/key.hpp	Mon Jan 11 23:34:52 2010 +0000
@@ -0,0 +1,182 @@
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * 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_KEY_HPP
+#define GCN_KEY_HPP
+
+#include "guichan/platform.hpp"
+
+// windows.h defines DELETE which breaks this file as we have a constant named
+// DELETE, hence we undefine DELETE if it is defined and hope people don't use
+// that windows define with Guichan.
+#if defined (_WIN32) && defined(DELETE)
+#undef DELETE
+#endif
+
+namespace gcn
+{
+    /**
+     * Represents a key or a character.
+     */
+    class GCN_CORE_DECLSPEC Key
+    {
+    public:
+
+        /**
+         * Constructor.
+         *
+         * @param value The ascii or enum value for the key.
+         */
+        Key(int value = 0);
+
+        /**
+         * Checks if a key is a character.
+         *
+         * @return True if the key is a letter, number or whitespace,
+         *         false otherwise.
+         */
+        bool isCharacter() const;
+
+        /**
+         * Checks if a key is a number.
+         *
+         * @return True if the key is a number (0-9),
+         *         false otherwise.
+         */
+        bool isNumber() const;
+
+        /**
+         * Checks if a key is a letter.
+         *
+         * @return True if the key is a letter (a-z,A-Z),
+         *         false otherwise.
+         */
+        bool isLetter() const;
+
+        /**
+         * Gets the value of the key. If an ascii value exists it 
+         * will be returned. Otherwise an enum value will be returned.
+         *
+         * @return the value of the key.
+         */
+        int getValue() const;
+
+        /**
+         * Compares two keys.
+         *
+         * @param key The key to compare this key with.
+         * @return True if the keys are equal, false otherwise.
+         */
+        bool operator==(const Key& key) const;
+
+        /**
+         * Compares two keys.
+         *
+         * @param key The key to compare this key with.
+         * @return True if the keys are not equal, false otherwise.
+         */
+        bool operator!=(const Key& key) const;
+
+        /**
+         * An enum with key values.
+         */
+        enum
+        {
+            SPACE              = ' ',
+            TAB                = '\t',
+            ENTER              = '\n',
+            LEFT_ALT           = -1000,
+            RIGHT_ALT,
+            LEFT_SHIFT,
+            RIGHT_SHIFT,
+            LEFT_CONTROL,
+            RIGHT_CONTROL,
+            LEFT_META,
+            RIGHT_META,
+            LEFT_SUPER,
+            RIGHT_SUPER,
+            INSERT,
+            HOME,
+            PAGE_UP,
+            DELETE,
+            END,
+            PAGE_DOWN,
+            ESCAPE,
+            CAPS_LOCK,
+            BACKSPACE,
+            F1,
+            F2,
+            F3,
+            F4,
+            F5,
+            F6,
+            F7,
+            F8,
+            F9,
+            F10,
+            F11,
+            F12,
+            F13,
+            F14,
+            F15,
+            PRINT_SCREEN,
+            SCROLL_LOCK,
+            PAUSE,
+            NUM_LOCK,
+            ALT_GR,
+            LEFT,
+            RIGHT,
+            UP,
+            DOWN
+        };
+
+    protected:
+        /**
+         * Holds the value of the key. It may be an ascii value
+         * or an enum value.
+         */
+        int mValue;
+    };
+}
+
+#endif // end GCN_KEY_HPP