QVirtualKeyboardInputEngine Class

This enum specifies the input mode for the input method.

This enum specifies the input mode for the input method.

flags QVirtualKeyboardInputEngine::ReselectFlags

This enum specifies the rules for word reselection.

The ReselectFlags type is a typedef for QFlags<ReselectFlag>. It stores an OR combination of ReselectFlag values.

This enum specifies the text case for the input method.

This property holds the active key.

Currently pressed key.

Access functions:

• activeKey() const

Notifier signal:

• void activeKeyChanged( key)

This property holds the active input method.

Use this property to set active the input method, or to monitor when the active input method changes.

Access functions:

• *inputMethod() const

• void setInputMethod( *inputMethod)

Notifier signal:

• void inputMethodChanged()

This property holds the current input mode.

Use this property to get or set the current input mode. The InputEngine::inputModes provides list of valid input modes for current input method and locale.

Access functions:

• inputMode() const

• void setInputMode( inputMode)

Notifier signal:

• void inputModeChanged()

This property holds the available input modes for active input method.

The list of available input modes is dependent on the input method and locale. This property is updated when either of the dependencies changes.

Access functions:

• <int> inputModes() const

Notifier signal:

• void inputModesChanged()

This property holds the list of available pattern recognition modes.

The list of available pattern recognition modes.

This property was introduced in QtQuick.VirtualKeyboard 2.0.

Access functions:

• <int> patternRecognitionModes() const

Notifier signal:

• void patternRecognitionModesChanged()

This property holds the previous active key.

Previously pressed key.

Access functions:

• previousKey() const

Notifier signal:

• void previousKeyChanged( key)

list model for the word candidate list.

Use this property to access the list model for the word candidate list.

Access functions:

• *wordCandidateListModel() const

Notifier signal:

• void wordCandidateListModelChanged()

visible hint for the word candidate list.

Use this property to check if the word candidate list should be visible in the UI.

Access functions:

• bool wordCandidateListVisibleHint() const

Notifier signal:

• void wordCandidateListVisibleHintChanged()

Returns the currently active key, or Qt::Key_unknown if no key is active.

Indicates that the active key has changed.

Returns the InputContext instance associated with the input engine.

Returns the active input method.

See Also▲

Indicates that the input method has changed.

Emitted when the input method needs to be reset.

Indicates that the input mode has changed.

Returns the list of available input modes.

Indicates that the available input modes have changed.

Returns list of supported pattern recognition modes.

Indicates that the available pattern recognition modes have changed.

This function was introduced in QtQuick.VirtualKeyboard 2.0.

Returns the previously active key, or Qt::Key_unknown if no key has been active.

Indicates that the previous key has changed.

This function attempts to reselect a word located at the cursorPosition. The reselectFlags define the rules for how the word should be selected in relation to the cursor position.

The function returns true if the word was successfully reselected.

This function was introduced in QtQuick.VirtualKeyboard 2.0.

Sets inputMethod as the active input method.

See Also▲

Starts a trace interaction with the input engine.

The trace is uniquely identified by the traceId. The input engine will assign the id to the QVirtualKeyboardTrace object if the input method accepts the event.

The patternRecognitionMode specifies the recognition mode used for the pattern.

If the current input method accepts the event it returns a QVirtualKeyboardTrace object associated with this interaction. If the input method discards the event, it returns a NULL value.

The traceCaptureDeviceInfo provides information about the source device and the traceScreenInfo provides information about the screen context.

By definition, the QVirtualKeyboardTrace object remains valid until the traceEnd() method is called.

The trace interaction is ended by calling the traceEnd() method.

This function was introduced in QtQuick.VirtualKeyboard 2.0.

Ends the trace interaction with the input engine.

The trace object may be discarded at any point after calling this function.

The function returns true if the trace interaction was accepted (i.e. the touch events should not be used for anything else).

Reverts the active key state without emitting the key event. This method is useful when the user discards the current key and the key state needs to be restored.

Emits a key click event for the given key, text and modifiers. Returns true if the key event was accepted by the input engine.

Indicates that the virtual key was clicked with the given text and modifiers. The isAutoRepeat indicates if the event is automatically repeated while the key is being pressed. This signal is emitted after the input method has processed the key event.

Called by the keyboard layer to indicate that key was pressed, with the given text and modifiers.

The key is set as an active key (down key). The actual key event is triggered when the key is released by the virtualKeyRelease() method. The key press event can be discarded by calling virtualKeyCancel().

The key press also initiates the key repeat timer if repeat is true.

Returns true if the key was accepted by this input engine.

See Also▲

Releases the key at key. The method emits a key event for the input method if the event has not been generated by a repeating timer. The text and modifiers are passed to the input method.

Returns true if the key was accepted by the input engine.