| 1 | // Copyright (C) 2016 The Qt Company Ltd. |
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only |
| 3 | |
| 4 | #include <QtVirtualKeyboard/private/abstractinputpanel_p.h> |
| 5 | #include <QtCore/QRect> |
| 6 | |
| 7 | QT_BEGIN_NAMESPACE |
| 8 | namespace QtVirtualKeyboard { |
| 9 | |
| 10 | /*! |
| 11 | \class QtVirtualKeyboard::AbstractInputPanel |
| 12 | \internal |
| 13 | \inmodule QtVirtualKeyboard |
| 14 | |
| 15 | \brief Base class for an input panel. |
| 16 | |
| 17 | Input panel is a container for InputPanel qml view. |
| 18 | |
| 19 | The virtual keyboard currently supports the following input panels: |
| 20 | \list |
| 21 | \li AppInputPanel Input panel type that is integrated directly into the |
| 22 | application. |
| 23 | \li DesktopInputPanel Input panel type for Desktop systems. |
| 24 | \endlist |
| 25 | */ |
| 26 | |
| 27 | /*! |
| 28 | Creates an input panel container with \a dd as private data and |
| 29 | \a parent but does not construct the view. The view is explicitly |
| 30 | constructed by the AbstractInputPanel::createView() method. |
| 31 | */ |
| 32 | AbstractInputPanel::AbstractInputPanel(QObjectPrivate &dd, QObject *parent) : |
| 33 | QObject(dd, parent) |
| 34 | { |
| 35 | } |
| 36 | |
| 37 | /*! |
| 38 | Creates an input panel container with \a parent but does not construct |
| 39 | the view. The view is explicitly constructed by the |
| 40 | AbstractInputPanel::createView() method. |
| 41 | */ |
| 42 | AbstractInputPanel::AbstractInputPanel(QObject *parent) : |
| 43 | QObject(parent) |
| 44 | { |
| 45 | } |
| 46 | |
| 47 | /*! |
| 48 | Destroys the input panel container. |
| 49 | */ |
| 50 | AbstractInputPanel::~AbstractInputPanel() |
| 51 | { |
| 52 | } |
| 53 | |
| 54 | /*! |
| 55 | \fn void QtVirtualKeyboard::AbstractInputPanel::show() = 0 |
| 56 | \internal |
| 57 | |
| 58 | Shows the input panel. |
| 59 | */ |
| 60 | |
| 61 | /*! |
| 62 | \fn void QtVirtualKeyboard::AbstractInputPanel::hide() = 0 |
| 63 | \internal |
| 64 | |
| 65 | Hides the input panel. |
| 66 | */ |
| 67 | |
| 68 | /*! |
| 69 | \fn bool QtVirtualKeyboard::AbstractInputPanel::isVisible() const = 0 |
| 70 | \internal |
| 71 | |
| 72 | Returns \c true if the input panel is currently visible. |
| 73 | */ |
| 74 | |
| 75 | /*! |
| 76 | This method adjusts the input rectangle of the input panel. |
| 77 | The \a inputRect specifies the area in which mouse input is accepted. |
| 78 | */ |
| 79 | void AbstractInputPanel::setInputRect(const QRect &inputRect) |
| 80 | { |
| 81 | Q_UNUSED(inputRect); |
| 82 | } |
| 83 | |
| 84 | /*! |
| 85 | Creates the view of the input panel. If the view is already created, |
| 86 | this method does nothing. |
| 87 | */ |
| 88 | void AbstractInputPanel::createView() |
| 89 | { |
| 90 | } |
| 91 | |
| 92 | /*! |
| 93 | \fn void QtVirtualKeyboard::AbstractInputPanel::destroyView() |
| 94 | \internal |
| 95 | |
| 96 | Destroys the view of the input panel. |
| 97 | */ |
| 98 | void AbstractInputPanel::destroyView() |
| 99 | { |
| 100 | } |
| 101 | |
| 102 | } // namespace QtVirtualKeyboard |
| 103 | QT_END_NAMESPACE |
| 104 | |