Mercurial > fife-parpg

comparison ext/guichan-0.8.2/include/guichan/input.hpp @ 378:64738befdf3b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
377:fe6fb0e0ed23 378:64738befdf3b
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_INPUT_HPP
45 #define GCN_INPUT_HPP
46
47 #include "guichan/platform.hpp"
48
49 namespace gcn
50 {
51 class KeyInput;
52 class MouseInput;
53
54 /**
55 * Abstract class for providing functions for user input.
56 *
57 * Guichan contains implementations of Input for common
58 * libraries like the Allegro library, the HGE library,
59 * and the SDL library.
60 * To make Guichan usable with other libraries, an Input
61 * class must be implemented.
62 *
63 * @see AllegroInput, HGEInput, OpenLayerInput,
64 * SDLInput
65 */
66 class GCN_CORE_DECLSPEC Input
67 {
68 public:
69
70 /**
71 * Destructor.
72 */
73 virtual ~Input(){ }
74
75 /**
76 * Checks if the key queue is empty, or not.
77 *
78 * @return True if the key queue is empty,
79 * false otherwise.
80 */
81 virtual bool isKeyQueueEmpty() = 0;
82
83 /**
84 * Dequeues the key input queue.
85 *
86 * @return The first key input in the key input queue.
87 */
88 virtual KeyInput dequeueKeyInput() = 0;
89
90 /**
91 * Checks if the mouse queue is empyt, or not.
92 *
93 * @return True if the mouse queue is empty,
94 * false otherwise.
95 */
96 virtual bool isMouseQueueEmpty() = 0;
97
98 /**
99 * Dequeues the mouse input queue.
100 *
101 * @return The first mouse input in the mouse input queue.
102 */
103 virtual MouseInput dequeueMouseInput() = 0;
104
105 /**
106 * Polls all exsisting input. Called when input should
107 * be polled. The function exists for compatibility reason
108 * where some libraries need to poll input at a certain
109 * logic rate.
110 */
111 virtual void _pollInput() = 0;
112 };
113 }
114
115 #endif // end GCN_INPUT_HPP