input_device.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
*/


#pragma once

#include "../api_display.h"
#include "../../Core/System/sharedptr.h"
#include "../../Core/System/weakptr.h"
#include "../../Core/Text/string_types.h"
#include "../../Core/Signals/signal_v2.h"
#include "../../Core/Math/point.h"

class CL_InputEvent;
class CL_InputState;
class CL_InputDeviceProvider;
class CL_InputDevice_Impl;

class CL_API_DISPLAY CL_InputDevice
{
public:
        enum Type
        {
                keyboard,
                pointer,
                joystick,
                tablet,
                unknown
        };


public:
        CL_InputDevice();

        CL_InputDevice(CL_InputDeviceProvider *provider);

        CL_InputDevice(CL_WeakPtr<CL_InputDevice_Impl> impl);

        CL_InputDevice(const CL_InputDevice &copy);

        ~CL_InputDevice();


public:
        CL_InputDeviceProvider *get_provider() const;

        CL_String get_name() const;

        CL_String get_device_name() const;

        Type get_type() const;


        CL_String get_key_name(int id) const;

        CL_String keyid_to_string(int keycode) const;

        int string_to_keyid(const CL_String &str) const;


        bool get_keycode(int keycode) const;


        CL_Point get_position() const;


        int get_x() const;


        int get_y() const;

        double get_axis(int index) const;

        int get_axis_count() const;


        int get_button_count() const;


        bool in_proximity() const;


public:
        CL_InputDevice &operator =(const CL_InputDevice &copy);


        void set_position(int x, int y);

        bool poll(bool peek_only);


public:
        CL_Signal_v2<const CL_InputEvent &, const CL_InputState &> &sig_key_down();

        CL_Signal_v2<const CL_InputEvent &, const CL_InputState &> &sig_key_up();

        CL_Signal_v2<const CL_InputEvent &, const CL_InputState &> &sig_pointer_move();

        CL_Signal_v2<const CL_InputEvent &, const CL_InputState &> &sig_ball_move();

        CL_Signal_v2<const CL_InputEvent &, const CL_InputState &> &sig_axis_move();

        CL_Signal_v2<const CL_InputEvent &, const CL_InputState &> &sig_key_dblclk();

        CL_Signal_v2<const CL_InputEvent &, const CL_InputState &> &sig_proximity_change();


private:
        CL_SharedPtr<CL_InputDevice_Impl> impl;

        friend class CL_InputContext_Impl;
};

---