Keypad.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: Keypad
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Dictionary.h>
#include <NDEVR/ApplicationOptions.h>
#include <NDEVR/String.h>
#include <QWidget>
class QTextEdit;
class QLineEdit;
class QTimer;
namespace Ui
{
    class KeypadUI;
}
namespace NDEVR
{
    class QCustomLineEdit;
    class Button;
    /**--------------------------------------------------------------------------------------------------
    \brief A popup for showing a virtual keyboard or keypad. Changes based on the allowed input to a
        widget. Usually shown in touch mode.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_WIDGETS_API Keypad : public QWidget
    {
        Q_OBJECT
    public:
        Keypad(QWidget* parent = nullptr);
        ~Keypad();
        void setLineEdit(QLineEdit* line_edit);
        void setTextEdit(QTextEdit* line_edit);
        [[nodiscard]] QWidget* currentWidget() const;
        [[nodiscard]] QWidget* lastWidget() const;
        [[nodiscard]] QCustomLineEdit* editor() const;
        [[nodiscard]] static Keypad* DefaultKeypad();
        void setUpperCase(bool uppercase);
        QSize sizeHint() const override;
        QSize minimumSizeHint() const override;
        bool isFullKeyboard() const { return m_is_full_keyboard; }
        void slideInKeyboard(uint04 value);
        void focusInEvent(QFocusEvent* focus) override;
        void mousePressEvent(QMouseEvent* event) override;
        void setCurrentInputHints(Qt::InputMethodHints hints);
        void updateCurrentText();
        void updateUppercase();
    public slots:
        void onFocusObjectDeleted();
        void requestPopupSlot();
        void requestHideSlot();
    protected slots:
        void updateWindowTitle();
    signals:
        void requestPopupSignal();
        void requestHideSignal();
    public:
        static ApplicationOption<bool> use_keypad_in_touch;
    protected:
        void addChar(char value);
        void setupButton(Button* b, char insert_char, bool add_to_lookup = true);
        void setupButton(Button* b);
        void backspace();
        void focusPreviousWidget();
        void focusNextWidget();
        void updateFocusGroups();
        void complete();
        void clear();
        void unsetCurrent();
        Dictionary<char, Button*> m_buttons;
        Dictionary<String, Button*> m_symbols_a;
        Dictionary<String, Button*> m_symbols_b;
        QLineEdit* m_line_edit;
        QTextEdit* m_text_edit;
        QWidget* m_last_widget;
        String m_original_text;
        QString m_original_window_title;
        String m_current_text;
        bool m_is_file;
        bool m_is_folder;
        bool m_is_full_keyboard;
        Ui::KeypadUI* ui;
        QTimer* m_visibility_check_timer;
        Qt::InputMethodHints m_input_hints;
    };
}