← Back to branch summary

~ubuntu-branches/ubuntu/vivid/manaplus/vivid-proposed

« back to all changes in this revision

Viewing changes to src/guichan/include/guichan/input.hpp

  • Committer: Package Import Robot
  • Author(s): Patrick Matthäi, Andrei Karas, Patrick Matthäi
  • Date: 2014-03-06 09:57:20 UTC
  • mfrom: (1.1.21)
  • Revision ID: package-import@ubuntu.com-20140306095720-wmv8yg5s180fcnmx
Tags: 1.4.3.1.1-1
[ Andrei Karas ]
* Remove guichan from dependency.

[ Patrick Matthäi ]
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/guichan/include/guichan/input.hpp
1
 
/*
2
 
 *  The ManaPlus Client
3
 
 *  Copyright (C) 2011-2014  The ManaPlus Developers
4
 
 *
5
 
 *  This file is part of The ManaPlus Client.
6
 
 *
7
 
 *  This program is free software; you can redistribute it and/or modify
8
 
 *  it under the terms of the GNU General Public License as published by
9
 
 *  the Free Software Foundation; either version 2 of the License, or
10
 
 *  any later version.
11
 
 *
12
 
 *  This program is distributed in the hope that it will be useful,
13
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 
 *  GNU General Public License for more details.
16
 
 *
17
 
 *  You should have received a copy of the GNU General Public License
18
 
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
 
 */
20
 
 
21
 
/*      _______   __   __   __   ______   __   __   _______   __   __
22
 
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
23
 
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
24
 
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
25
 
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
26
 
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
27
 
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
28
 
 *
29
 
 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
30
 
 *
31
 
 *
32
 
 * Per Larsson a.k.a finalman
33
 
 * Olof Naessén a.k.a jansem/yakslem
34
 
 *
35
 
 * Visit: http://guichan.sourceforge.net
36
 
 *
37
 
 * License: (BSD)
38
 
 * Redistribution and use in source and binary forms, with or without
39
 
 * modification, are permitted provided that the following conditions
40
 
 * are met:
41
 
 * 1. Redistributions of source code must retain the above copyright
42
 
 *    notice, this list of conditions and the following disclaimer.
43
 
 * 2. Redistributions in binary form must reproduce the above copyright
44
 
 *    notice, this list of conditions and the following disclaimer in
45
 
 *    the documentation and/or other materials provided with the
46
 
 *    distribution.
47
 
 * 3. Neither the name of Guichan nor the names of its contributors may
48
 
 *    be used to endorse or promote products derived from this software
49
 
 *    without specific prior written permission.
50
 
 *
51
 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52
 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53
 
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54
 
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55
 
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56
 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
57
 
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
58
 
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
59
 
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
60
 
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
61
 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62
 
 */
63
 
 
64
 
#ifndef GCN_INPUT_HPP
65
 
#define GCN_INPUT_HPP
66
 
 
67
 
#include "localconsts.h"
68
 
 
69
 
namespace gcn
70
 
{
71
 
    class KeyInput;
72
 
    class MouseInput;
73
 
 
74
 
    /**
75
 
     * Abstract class for providing functions for user input. 
76
 
     *
77
 
     * Guichan contains implementations of Input for common 
78
 
     * libraries like the Allegro library, the HGE library, 
79
 
     * and the SDL library. 
80
 
     * To make Guichan usable with other libraries, an Input 
81
 
     * class must be implemented.
82
 
     *
83
 
     * @see AllegroInput, HGEInput, OpenLayerInput, 
84
 
     *      SDLInput
85
 
     */
86
 
    class Input
87
 
    {
88
 
    public:
89
 
        /**
90
 
         * Destructor.
91
 
         */
92
 
        virtual ~Input(){ }
93
 
 
94
 
        /**
95
 
         * Checks if the key queue is empty, or not.
96
 
         *
97
 
         * @return True if the key queue is empty, 
98
 
         *         false otherwise.
99
 
         */
100
 
        virtual bool isKeyQueueEmpty() A_WARN_UNUSED = 0;
101
 
 
102
 
        /**
103
 
         * Dequeues the key input queue.
104
 
         *
105
 
         * @return The first key input in the key input queue.
106
 
         */
107
 
        virtual KeyInput dequeueKeyInput() = 0;
108
 
 
109
 
        /**
110
 
         * Checks if the mouse queue is empyt, or not.
111
 
         *
112
 
         * @return True if the mouse queue is empty,
113
 
         *         false otherwise.
114
 
         */
115
 
        virtual bool isMouseQueueEmpty() A_WARN_UNUSED = 0;
116
 
 
117
 
        /**
118
 
         * Dequeues the mouse input queue.
119
 
         *
120
 
         * @return The first mouse input in the mouse input queue.
121
 
         */
122
 
        virtual MouseInput dequeueMouseInput() = 0;
123
 
 
124
 
        /**
125
 
         * Polls all exsisting input. Called when input should
126
 
         * be polled. The function exists for compatibility reason
127
 
         * where some libraries need to poll input at a certain
128
 
         * logic rate.
129
 
         */
130
 
        virtual void _pollInput() = 0;
131
 
    };
132
 
}  // namespace gcn
133
 
 
134
 
#endif  // end GCN_INPUT_HPP