screen_keyboard.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2013-2015 SuperTuxKart-Team
//
//  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 3
//  of the License: or (at your option) 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, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
#ifndef HEADER_SCREEN_KEYBOARD_HPP
#define HEADER_SCREEN_KEYBOARD_HPP
 
#include <IGUIButton.h>
#include <IGUIWindow.h>
 
#include "guiengine/abstract_top_level_container.hpp"
#include "guiengine/skin.hpp"
#include "input/input_manager.hpp"
#include "utils/leak_check.hpp"
 
 
class CGUIEditBox;
 
namespace GUIEngine
{
    class ButtonWidget;
 
    class ScreenKeyboard : public SkinWidgetContainer, 
                           public AbstractTopLevelContainer
    {
    protected:
        typedef std::vector<std::vector<std::string> > KeyboardLayout;
        typedef std::vector<std::vector<int> > KeyboardLayoutProportions;
        enum ButtonsType
        {
            BUTTONS_NONE,
            BUTTONS_LOWER,
            BUTTONS_UPPER,
            BUTTONS_DIGITS,
            BUTTONS_DIGITS2,
            BUTTONS_EMOJI
        };
    private:
        static ScreenKeyboard* m_screen_keyboard;
        
        float m_percent_width;
        
        float m_percent_height;
        
        unsigned int m_repeat_time;
        
        bool m_back_button_pressed;
        
        bool m_schedule_close;
        
        CGUIEditBox* m_edit_box;
        
        irr::gui::IGUIButton* m_back_button;
        
        ButtonsType m_buttons_type;
        
        irr::gui::IGUIWindow* m_irrlicht_window;
        
        irr::core::rect<irr::s32> m_area;
        
        std::vector<ButtonWidget*> m_buttons;
        
        InputManager::InputDriverMode m_previous_mode;
 
        void createButtons();
        void assignButtons(ButtonsType buttons_type);
        core::stringw getKeyName(std::string key_id);
 
    public:
        LEAK_CHECK()
 
        ScreenKeyboard(float percent_width, float percent_height, 
                       CGUIEditBox* edit_box);
        ~ScreenKeyboard();
 
        void init();
 
        virtual EventPropagation processEvent(const std::string& eventSource);
 
        static void dismiss();
        static bool onEscapePressed();
        static ScreenKeyboard* getCurrent() {return m_screen_keyboard;}
        
        static bool isActive() {return m_screen_keyboard != NULL;}
 
        static bool shouldUseScreenKeyboard();
        static bool hasSystemScreenKeyboard();
 
        virtual void onUpdate(float dt);
        
        bool onEvent(const SEvent &event);
        
        irr::gui::IGUIWindow* getIrrlichtElement() {return m_irrlicht_window;}
 
        bool isMyIrrChild(irr::gui::IGUIElement* widget) const 
                                {return m_irrlicht_window->isMyChild(widget);}
 
        int getWidth()  {return m_area.getWidth();}
        
        int getHeight() {return m_area.getHeight();}
        
        CGUIEditBox* getEditBox() {return m_edit_box;}
 
        virtual KeyboardLayoutProportions getKeyboardLayoutProportions() const;
 
        virtual KeyboardLayout* getKeyboardLayout(ButtonsType bt) const;
 
        virtual ButtonsType getDefaultButtonsType() const
        {
            return BUTTONS_LOWER;
        }
    };
}
 
#endif