summaryrefslogtreecommitdiff
path: root/src/gui/base/input.hpp
diff options
context:
space:
mode:
authorAndrei Karas <akaras@inbox.ru>2014-02-15 18:07:17 +0300
committerAndrei Karas <akaras@inbox.ru>2014-02-15 18:38:03 +0300
commitcde42202d69e178da73c698065deca54b24054fd (patch)
treed636965ecde85db8de36fa65735920826e8e191b /src/gui/base/input.hpp
parent21e63bbf54679ec236d1f09ed435959ff6a04db2 (diff)
downloadplus-cde42202d69e178da73c698065deca54b24054fd.tar.gz
plus-cde42202d69e178da73c698065deca54b24054fd.tar.bz2
plus-cde42202d69e178da73c698065deca54b24054fd.tar.xz
plus-cde42202d69e178da73c698065deca54b24054fd.zip
move exguichan files into gui/base/
Diffstat (limited to 'src/gui/base/input.hpp')
-rw-r--r--src/gui/base/input.hpp134
1 files changed, 134 insertions, 0 deletions
diff --git a/src/gui/base/input.hpp b/src/gui/base/input.hpp
new file mode 100644
index 000000000..71a15ce85
--- /dev/null
+++ b/src/gui/base/input.hpp
@@ -0,0 +1,134 @@
+/*
+ * The ManaPlus Client
+ * Copyright (C) 2011-2014 The ManaPlus Developers
+ *
+ * This file is part of The ManaPlus Client.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/* _______ __ __ __ ______ __ __ _______ __ __
+ * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
+ * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
+ * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * 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_INPUT_HPP
+#define GCN_INPUT_HPP
+
+#include "localconsts.h"
+
+namespace gcn
+{
+ class KeyInput;
+ class MouseInput;
+
+ /**
+ * Abstract class for providing functions for user input.
+ *
+ * Guichan contains implementations of Input for common
+ * libraries like the Allegro library, the HGE library,
+ * and the SDL library.
+ * To make Guichan usable with other libraries, an Input
+ * class must be implemented.
+ *
+ * @see AllegroInput, HGEInput, OpenLayerInput,
+ * SDLInput
+ */
+ class Input
+ {
+ public:
+ /**
+ * Destructor.
+ */
+ virtual ~Input(){ }
+
+ /**
+ * Checks if the key queue is empty, or not.
+ *
+ * @return True if the key queue is empty,
+ * false otherwise.
+ */
+ virtual bool isKeyQueueEmpty() A_WARN_UNUSED = 0;
+
+ /**
+ * Dequeues the key input queue.
+ *
+ * @return The first key input in the key input queue.
+ */
+ virtual KeyInput dequeueKeyInput() = 0;
+
+ /**
+ * Checks if the mouse queue is empyt, or not.
+ *
+ * @return True if the mouse queue is empty,
+ * false otherwise.
+ */
+ virtual bool isMouseQueueEmpty() A_WARN_UNUSED = 0;
+
+ /**
+ * Dequeues the mouse input queue.
+ *
+ * @return The first mouse input in the mouse input queue.
+ */
+ virtual MouseInput dequeueMouseInput() = 0;
+
+ /**
+ * Polls all exsisting input. Called when input should
+ * be polled. The function exists for compatibility reason
+ * where some libraries need to poll input at a certain
+ * logic rate.
+ */
+ virtual void _pollInput() = 0;
+ };
+} // namespace gcn
+
+#endif // end GCN_INPUT_HPP