---

inputbuffer.h

Go to the documentation of this file.

/*
        $Id: inputbuffer.h,v 1.3 2001/03/15 12:14:46 mbn Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------
*/


#ifndef header_inputbuffer
#define header_inputbuffer

#include <queue>
#include "key.h"
#include "../../signals.h"

class CL_Component;

class CL_InputBuffer
//: Input buffer interface.
// Use this class to read buffered keys from the keyboard (or any other device).
{
public:
        CL_InputBuffer();
        // Constructs an input buffer that attaches itself to the first keyboard.

        CL_InputBuffer(CL_InputDevice *device);
        // Constructs an input buffer that attaches itself to the specified device.
        
        CL_InputBuffer(
                CL_Signal_v4<CL_Component *, CL_InputDevice *, CL_Key, bool &> &sig_key_down,
                CL_Signal_v3<CL_Component *, CL_InputDevice *, CL_Key> &sig_key_up);
        // Constructs an input buffer that attaches itself to the specified signals.
        // Use it to buffer input from a GUI component.

        virtual ~CL_InputBuffer();

        CL_Key peek_key() const;
        // Returns the next key in the buffer, but unlike get_key() it does not
        // pop it from the input buffer.

        CL_Key get_key();
        // Pops the next key in the buffer and returns it.

        int keys_left();
        // Returns number of keys still available in the buffer.

        void clear();
        // Clears the buffer. After this, the buffer will not contain any keys.

// implementation:
private:
        CL_Slot slot_button_press;
        CL_Slot slot_button_release;
        CL_Slot slot_key_down;
        CL_Slot slot_key_up;

        void on_button_press(CL_InputDevice *device, const CL_Key &key);
        void on_button_release(CL_InputDevice *device, const CL_Key &key);

        void on_key_down(CL_Component *, CL_InputDevice *device, CL_Key key, bool &retval);
        void on_key_up(CL_Component *, CL_InputDevice *device, CL_Key key);

        std::queue<CL_Key> buffer;
        CL_InputDevice *device;
};

#endif

---