Commit 9778eb24 authored by Mitch Curtis's avatar Mitch Curtis Committed by Frederik Gladhorn
Browse files

Restructure and rename.


This restructures the repo to match other Qt modules, like the
Enterprise Controls. It also renames the plugin and usages of its name
in the documentation so that the abbreviated "VKB" is not used
anywhere.

Change-Id: I5de3fc67846a50438e52f4be057abfa0d9be0d91
Reviewed-by: default avatarFrederik Gladhorn <frederik.gladhorn@digia.com>
Showing with 34 additions and 79 deletions
# This file is used to ignore files which are generated in the Qt build system # This file is used to ignore files that should not be committed
# ---------------------------------------------------------------------------- # --------------------------------------------------------------
demo/virtualkeyboard qtvirtualkeyboard/examples/quick/enterprise/virtualkeyboard/virtualkeyboard/virtualkeyboard
!qtvkb/hunspell/config.h !qtvirtualkeyboard/src/virtualkeyboard/hunspell/config.h
!qtvkb/hunspell/hunspell.pro !qtvirtualkeyboard/src/virtualkeyboard/hunspell/hunspell.pro
qtvkb/hunspell/* qtvirtualkeyboard/src/virtualkeyboard/hunspell/*
qtvkb/doc/html qtvirtualkeyboard/src/virtualkeyboard/hunspell/doc/html
*.pro.user *.pro.user
*.a *.a
...@@ -17,4 +17,5 @@ qrc_*.cpp ...@@ -17,4 +17,5 @@ qrc_*.cpp
*.obj *.obj
*.rcc *.rcc
Makefile* Makefile*
*.html
*~
\ No newline at end of file
.qmake.conf 0 → 100644
load(qt_build_config)
MODULE_VERSION = 1.0
# QtVKB - Qt Virtual Keyboard Qt Virtual Keyboard
QtVKB is a virtual keyboard framework that consists of C++ backend Qt Virtual Keyboard is a virtual keyboard framework that consists of a C++
supporting custom input methods as well as UI frontend implemented in QML. backend supporting custom input methods as well as a UI frontend implemented
in QML.
The project is split into following subprojects: For more information, see the documentation.
- *demo.pro* QtVKB Demo application
- *qtvkb.pro* QtVKB C++ backend for input engine and QPlatformInputContext integration
- *styles.pro* QtVKB Style plugin that enables style decorations for keyboard
The input methods are implemented either in C++ or QML languages.
The QtVKB provides an example implementations of PlainInputMethod, MultitapInputMethod
and HunspellInputMethod. The MultitapInputMethod is implemented in QML while
the others are implemented in C++.
For more details, please refer to the documentation in qtvkb/doc/html directory.
## Build instructions
The QtVKB can be built for Linux Desktop/X11 or Boot2Qt targets. The target is
automatically detected by QMAKE and requires no special configuration parameters.
QtCreator is preferred build environment for QtVKB as you can then leverage from
shadow build and rapidly switch between build targets.
### Configuration options
- *CONFIG+=disable-xcb* Disables X11 integration
- *CONFIG+=disable-hunspell* Disables Hunspell integration
- *CONFIG+=retro-style* Enables Retro style
### Extra targets
- *docs* Generates documentation
### Hunspell integration
By default, HunspellInputMethod will not be available unless the Hunspell library and
development headers are found. For Linux/X11 target the Hunspell library can be provided
by installing libhunspell-dev package. Alternatively the Hunspell sources can be extracted into
qtvkb/hunspell directory. If Hunspell sources are used, then the dictionary
files must also be copied into qtvkb/hunspell/data directory. Furthermore,
if Hunspell sources are used, the hunspell.pro will be used for all targets.
## Deployment instructions
### Linux/X11
Add Deploy Step that executes "make install" command, then deploy using *Deploy All* command.
### Boot2Qt
Remount target file system as read-write before deployment.
adb -s <deviceid> remount
Deploy using *Deploy All* command.
TEMPLATE = subdirs
SUBDIRS += quick/enterprise/virtualkeyboard
TEMPLATE = subdirs
SUBDIRS += \
virtualkeyboard
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
****************************************************************************/ ****************************************************************************/
import QtQuick 2.0 import QtQuick 2.0
import QtVkb 1.0 import QtQuick.Enterprise.VirtualKeyboard 1.0
Item { Item {
implicitWidth: virtualKeyboard.implicitHeight implicitWidth: virtualKeyboard.implicitHeight
......
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
qputenv("QT_IM_MODULE", QByteArray("qtvkb")); qputenv("QT_IM_MODULE", QByteArray("qtvirtualkeyboard"));
QGuiApplication app(argc, argv); QGuiApplication app(argc, argv);
QQuickView view(QString("qrc:/%2").arg(MAIN_QML)); QQuickView view(QString("qrc:/%2").arg(MAIN_QML));
......
OTHER_FILES += \
$$PWD/qtvkb.qdocconf \
$$PWD/src/index.qdoc \
$$PWD/src/deployment_guide.qdoc \
$$PWD/src/technical_guide.qdoc \
$$PWD/src/examples/CustomInputMethod.qml
docs_target.target = docs
docs_target.commands = $$[QT_HOST_BINS]/qdoc $$PWD/qtvkb.qdocconf
QMAKE_EXTRA_TARGETS = docs_target
{
"Keys": [ "qtvkb" ]
}
src/src.pro 0 → 100644
TEMPLATE = subdirs
SUBDIRS += \
virtualkeyboard \
virtualkeyboard/styles
!disable-hunspell:exists(virtualkeyboard/hunspell/src/hunspell/hunspell.h) {
SUBDIRS += virtualkeyboard/hunspell
}
File moved
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment