| 1 | /**************************************************************************** |
| 2 | ** |
| 3 | ** Copyright (C) 2016 The Qt Company Ltd. |
| 4 | ** Contact: https://www.qt.io/licensing/ |
| 5 | ** |
| 6 | ** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit. |
| 7 | ** |
| 8 | ** $QT_BEGIN_LICENSE:GPL$ |
| 9 | ** Commercial License Usage |
| 10 | ** Licensees holding valid commercial Qt licenses may use this file in |
| 11 | ** accordance with the commercial license agreement provided with the |
| 12 | ** Software or, alternatively, in accordance with the terms contained in |
| 13 | ** a written agreement between you and The Qt Company. For licensing terms |
| 14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at https://www.qt.io/contact-us. |
| 16 | ** |
| 17 | ** GNU General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU |
| 19 | ** General Public License version 3 or (at your option) any later version |
| 20 | ** approved by the KDE Free Qt Foundation. The licenses are as published by |
| 21 | ** the Free Software Foundation and appearing in the file LICENSE.GPL3 |
| 22 | ** included in the packaging of this file. Please review the following |
| 23 | ** information to ensure the GNU General Public License requirements will |
| 24 | ** be met: https://www.gnu.org/licenses/gpl-3.0.html. |
| 25 | ** |
| 26 | ** $QT_END_LICENSE$ |
| 27 | ** |
| 28 | ****************************************************************************/ |
| 29 | |
| 30 | #ifndef SHIFTHANDLER_P_H |
| 31 | #define SHIFTHANDLER_P_H |
| 32 | |
| 33 | // |
| 34 | // W A R N I N G |
| 35 | // ------------- |
| 36 | // |
| 37 | // This file is not part of the Qt API. It exists purely as an |
| 38 | // implementation detail. This header file may change from version to |
| 39 | // version without notice, or even be removed. |
| 40 | // |
| 41 | // We mean it. |
| 42 | // |
| 43 | |
| 44 | #include <QObject> |
| 45 | #include <QtVirtualKeyboard/qvirtualkeyboard_global.h> |
| 46 | |
| 47 | QT_BEGIN_NAMESPACE |
| 48 | |
| 49 | class QVirtualKeyboardInputContext; |
| 50 | class QVirtualKeyboardInputContextPrivate; |
| 51 | |
| 52 | namespace QtVirtualKeyboard { |
| 53 | |
| 54 | class ShiftHandlerPrivate; |
| 55 | |
| 56 | class QVIRTUALKEYBOARD_EXPORT ShiftHandler : public QObject |
| 57 | { |
| 58 | Q_OBJECT |
| 59 | Q_DISABLE_COPY(ShiftHandler) |
| 60 | Q_DECLARE_PRIVATE(ShiftHandler) |
| 61 | Q_PROPERTY(QString sentenceEndingCharacters READ sentenceEndingCharacters WRITE setSentenceEndingCharacters NOTIFY sentenceEndingCharactersChanged) |
| 62 | Q_PROPERTY(bool autoCapitalizationEnabled READ isAutoCapitalizationEnabled NOTIFY autoCapitalizationEnabledChanged) |
| 63 | Q_PROPERTY(bool toggleShiftEnabled READ isToggleShiftEnabled NOTIFY toggleShiftEnabledChanged) |
| 64 | Q_PROPERTY(bool shiftActive READ isShiftActive WRITE setShiftActive NOTIFY shiftActiveChanged) |
| 65 | Q_PROPERTY(bool capsLockActive READ isCapsLockActive WRITE setCapsLockActive NOTIFY capsLockActiveChanged) |
| 66 | Q_PROPERTY(bool uppercase READ isUppercase NOTIFY uppercaseChanged) |
| 67 | |
| 68 | explicit ShiftHandler(QVirtualKeyboardInputContext *parent = nullptr); |
| 69 | void init(); |
| 70 | |
| 71 | public: |
| 72 | ~ShiftHandler(); |
| 73 | |
| 74 | QString sentenceEndingCharacters() const; |
| 75 | void setSentenceEndingCharacters(const QString &value); |
| 76 | bool isAutoCapitalizationEnabled() const; |
| 77 | bool isToggleShiftEnabled() const; |
| 78 | bool isShiftActive() const; |
| 79 | void setShiftActive(bool active); |
| 80 | bool isCapsLockActive() const; |
| 81 | void setCapsLockActive(bool active); |
| 82 | bool isUppercase() const; |
| 83 | |
| 84 | Q_INVOKABLE void toggleShift(); |
| 85 | Q_INVOKABLE void clearToggleShiftTimer(); |
| 86 | |
| 87 | signals: |
| 88 | void sentenceEndingCharactersChanged(); |
| 89 | void toggleShiftEnabledChanged(); |
| 90 | void autoCapitalizationEnabledChanged(); |
| 91 | void shiftActiveChanged(); |
| 92 | void capsLockActiveChanged(); |
| 93 | void uppercaseChanged(); |
| 94 | |
| 95 | private slots: |
| 96 | void reset(); |
| 97 | void autoCapitalize(); |
| 98 | void restart(); |
| 99 | void localeChanged(); |
| 100 | void inputMethodVisibleChanged(); |
| 101 | |
| 102 | private: |
| 103 | void setAutoCapitalizationEnabled(bool enabled); |
| 104 | void setToggleShiftEnabled(bool enabled); |
| 105 | |
| 106 | private: |
| 107 | friend class ::QVirtualKeyboardInputContext; |
| 108 | friend class ::QVirtualKeyboardInputContextPrivate; |
| 109 | }; |
| 110 | |
| 111 | } // namespace QtVirtualKeyboard |
| 112 | QT_END_NAMESPACE |
| 113 | |
| 114 | #endif // SHIFTHANDLER_P_H |
| 115 | |