virtualkeyboard.h

/*
 * Copyright (C) 2018 Microchip Technology Inc.  All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef EGT_VIRTUALKEYBOARD_H
#define EGT_VIRTUALKEYBOARD_H
 
#include <egt/button.h>
#include <egt/detail/meta.h>
#include <egt/input.h>
#include <egt/keycode.h>
#include <egt/notebook.h>
#include <egt/popup.h>
#include <egt/sizer.h>
#include <memory>
#include <string>
#include <vector>
 
namespace egt
{
inline namespace v1
{
 
class EGT_API VirtualKeyboard : public Frame
{
protected:
    struct Panel;
 
public:
    class Key;
 
    using PanelKeys = std::vector<std::vector<std::shared_ptr<Key>>>;
 
    class Key
    {
    public:
 
        explicit Key(uint32_t unicode, double length = 1.0) noexcept;
 
        explicit Key(const std::string& label, KeyboardCode keycode,
                     double length = 1.0) noexcept;
 
        explicit Key(const Image& img, KeyboardCode keycode,
                     double length = 1.0) noexcept;
 
        explicit Key(const std::string& label, int link,
                     double length = 1.0) noexcept;
 
        explicit Key(const Image& img, int link, double length = 1.0) noexcept;
 
        explicit Key(uint32_t unicode,
                     PanelKeys keys_multichoice,
                     double length = 1.0) noexcept;
 
        void color(Palette::ColorId id, const Pattern& color,
                   Palette::GroupId group = Palette::GroupId::normal);
 
        void font(const Font& font);
 
    protected:
        std::shared_ptr<Button> m_button {nullptr};
 
        KeyboardCode m_keycode {EKEY_UNKNOWN};
 
        uint32_t m_unicode {0};
 
        double m_length;
 
        int m_link{-1};
 
        PanelKeys m_keys_multichoice;
 
        std::shared_ptr<Panel> m_multichoice_panel {nullptr};
 
        friend class VirtualKeyboard;
    };
 
    explicit VirtualKeyboard(const Rect& rect = {}) noexcept;
 
    explicit VirtualKeyboard(const std::vector<PanelKeys>& keys,
                             const Rect& rect = {});
 
    explicit VirtualKeyboard(Serializer::Properties& props) noexcept
        : VirtualKeyboard(props, false)
    {
    }
 
protected:
 
    explicit VirtualKeyboard(Serializer::Properties& props, bool is_derived) noexcept;
 
public:
 
    void resize(const Size& s) override;
 
    void key_space(unsigned key_space);
 
protected:
    struct Panel : public VerticalBoxSizer
    {
        // cppcheck-suppress noExplicitConstructor
        explicit Panel(const PanelKeys& keys);
        void update_key_space(unsigned key_space);
        void update_key_size(const Size& s);
 
        PanelKeys m_keys;
    };
 
    struct KeyboardInput : public Input
    {
        using Input::Input;
        friend class VirtualKeyboard;
    };
 
    void key_link(const std::shared_ptr<Key>& k);
 
    void key_input_value(const std::shared_ptr<Key>& k);
 
    void key_multichoice(const std::shared_ptr<Key>& k);
 
    std::shared_ptr<Popup> m_multichoice_popup {nullptr};
 
    std::vector<std::shared_ptr<Panel>> m_main_panels;
 
    Notebook m_main_panel;
 
    KeyboardInput m_in;
 
    unsigned m_max_rows {0};
 
    unsigned m_max_cols {0};
 
    unsigned m_key_space {2};
 
    double m_key_size_multichoice_factor {1.2};
 
    void initialize(const std::vector<PanelKeys>& keys);
};
 
class EGT_API PopupVirtualKeyboard : public Popup
{
public:
    explicit PopupVirtualKeyboard(const std::shared_ptr<VirtualKeyboard>& keyboard, Size size = {}) noexcept;
 
protected:
    VerticalBoxSizer m_vsizer;
 
    HorizontalBoxSizer m_hsizer;
 
    ImageButton m_close_button {Image("icon:cancel.png")};
 
    ImageButton m_top_bottom_button {Image("icon:arrow_up.png")};
 
    bool m_bottom_positionned {true};
};
 
PopupVirtualKeyboard*& popup_virtual_keyboard();
 
VirtualKeyboard::PanelKeys& multichoice_e();
VirtualKeyboard::PanelKeys& multichoice_E();
VirtualKeyboard::PanelKeys& multichoice_r();
VirtualKeyboard::PanelKeys& multichoice_R();
VirtualKeyboard::PanelKeys& multichoice_t();
VirtualKeyboard::PanelKeys& multichoice_T();
VirtualKeyboard::PanelKeys& multichoice_y();
VirtualKeyboard::PanelKeys& multichoice_Y();
VirtualKeyboard::PanelKeys& multichoice_u();
VirtualKeyboard::PanelKeys& multichoice_U();
VirtualKeyboard::PanelKeys& multichoice_i();
VirtualKeyboard::PanelKeys& multichoice_I();
VirtualKeyboard::PanelKeys& multichoice_o();
VirtualKeyboard::PanelKeys& multichoice_O();
VirtualKeyboard::PanelKeys& multichoice_a();
VirtualKeyboard::PanelKeys& multichoice_A();
VirtualKeyboard::PanelKeys& multichoice_s();
VirtualKeyboard::PanelKeys& multichoice_S();
VirtualKeyboard::PanelKeys& multichoice_d();
VirtualKeyboard::PanelKeys& multichoice_D();
VirtualKeyboard::PanelKeys& multichoice_g();
VirtualKeyboard::PanelKeys& multichoice_G();
VirtualKeyboard::PanelKeys& multichoice_k();
VirtualKeyboard::PanelKeys& multichoice_K();
VirtualKeyboard::PanelKeys& multichoice_l();
VirtualKeyboard::PanelKeys& multichoice_L();
VirtualKeyboard::PanelKeys& multichoice_z();
VirtualKeyboard::PanelKeys& multichoice_Z();
VirtualKeyboard::PanelKeys& multichoice_c();
VirtualKeyboard::PanelKeys& multichoice_C();
VirtualKeyboard::PanelKeys& multichoice_n();
VirtualKeyboard::PanelKeys& multichoice_N();
VirtualKeyboard::PanelKeys& QwertyLettersLowerCase();
VirtualKeyboard::PanelKeys& QwertyLettersUpperCase();
VirtualKeyboard::PanelKeys& QwertySymbols1();
VirtualKeyboard::PanelKeys& QwertySymbols2();
}
}
 
#endif