Ui module for gaining basic input event (i.e. keyboard) support on non-Android devices. More...

Inheritance diagram for InputArea:

Public Types
enum	Key_X { Key_Button_B = 0x01030000 }
	Defines an additional set of key codes to extend `Qt::Key`. More...

Public Member Functions
	InputArea (QQuickItem *parent=0)
	Constructs an InputArea. More...

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent)

QQuickWindow *	window () const

QQuickItem *	parentItem () const

void	setParentItem (QQuickItem *parent)

void	stackBefore (const QQuickItem *sibling)

void	stackAfter (const QQuickItem *sibling)

QRectF	childrenRect ()

QList< QQuickItem * >	childItems () const

bool	clip () const

void	setClip (bool)

QString	state () const

void	setState (const QString &)

qreal	baselineOffset () const

void	setBaselineOffset (qreal)

qreal	x () const

qreal	y () const

void	setX (qreal)

void	setY (qreal)

qreal	width () const

void	setWidth (qreal)

void	resetWidth ()

void	setImplicitWidth (qreal)

qreal	implicitWidth () const

qreal	height () const

void	setHeight (qreal)

void	resetHeight ()

void	setImplicitHeight (qreal)

qreal	implicitHeight () const

TransformOrigin	transformOrigin () const

void	setTransformOrigin (TransformOrigin)

qreal	z () const

void	setZ (qreal)

qreal	rotation () const

void	setRotation (qreal)

qreal	scale () const

void	setScale (qreal)

qreal	opacity () const

void	setOpacity (qreal)

bool	isVisible () const

void	setVisible (bool)

bool	isEnabled () const

void	setEnabled (bool)

bool	smooth () const

void	setSmooth (bool)

bool	activeFocusOnTab () const

void	setActiveFocusOnTab (bool)

bool	antialiasing () const

void	setAntialiasing (bool)

void	resetAntialiasing ()

Flags	flags () const

void	setFlag (Flag flag, bool enabled)

void	setFlags (QFlags< QQuickItem::Flag > flags)

bool	hasActiveFocus () const

bool	hasFocus () const

void	setFocus (bool)

void	setFocus (bool focus, Qt::FocusReason reason)

bool	isFocusScope () const

QQuickItem *	scopedFocusItem () const

Qt::MouseButtons	acceptedMouseButtons () const

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)

bool	acceptHoverEvents () const

void	setAcceptHoverEvents (bool enabled)

QCursor	cursor () const

void	setCursor (const QCursor &cursor)

void	unsetCursor ()

void	grabMouse ()

void	ungrabMouse ()

bool	keepMouseGrab () const

void	setKeepMouseGrab (bool keep)

bool	filtersChildMouseEvents () const

void	setFiltersChildMouseEvents (bool filter)

void	grabTouchPoints (const QVector< int > &ids)

void	ungrabTouchPoints ()

bool	keepTouchGrab () const

void	setKeepTouchGrab (bool keep)

virtual bool	contains (const QPointF &point) const

QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const

QPointF	mapToScene (const QPointF &point) const

QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const

QRectF	mapRectToScene (const QRectF &rect) const

QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const

QPointF	mapFromScene (const QPointF &point) const

QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const

QRectF	mapRectFromScene (const QRectF &rect) const

void	polish ()

void	forceActiveFocus ()

void	forceActiveFocus (Qt::FocusReason reason)

QQuickItem *	nextItemInFocusChain (bool forward)

QQuickItem *	childAt (qreal x, qreal y) const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

virtual bool	isTextureProvider () const

virtual QSGTextureProvider *	textureProvider () const

void	update ()

void	windowChanged (QQuickWindow *window)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual bool	eventFilter (QObject watched, QEvent event)

virtual const QMetaObject *	metaObject () const

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const

bool	blockSignals (bool block)

QThread *	thread () const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

bool	inherits (const char *className) const

void	deleteLater ()

Public Member Functions inherited from QQmlParserStatus
virtual void	classBegin ()=0

virtual void	componentComplete ()=0

Static Public Member Functions
static KeyCode	convertQtKeyCode (int qtKeyCode)
	Returns the KeyCode that corresponds `Qt::Key` code. More...

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Protected Member Functions
virtual void	keyPressEvent (QKeyEvent *event) override
	Intercept QKeyEvent press and process the event. More...

virtual void	keyReleaseEvent (QKeyEvent *event) override
	Intercept QKeyEvent release and process the event. More...

Protected Member Functions inherited from QQuickItem
virtual bool	event (QEvent *ev)

bool	isComponentComplete () const

virtual void	itemChange (ItemChange change, const ItemChangeData &value)

void	updateInputMethod (Qt::InputMethodQueries queries)

bool	widthValid () const

bool	heightValid () const

virtual void	classBegin ()

virtual void	componentComplete ()

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseUngrabEvent ()

virtual void	touchUngrabEvent ()

virtual void	wheelEvent (QWheelEvent *event)

virtual void	touchEvent (QTouchEvent *event)

virtual void	hoverEnterEvent (QHoverEvent *event)

virtual void	hoverMoveEvent (QHoverEvent *event)

virtual void	hoverLeaveEvent (QHoverEvent *event)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual bool	childMouseEventFilter (QQuickItem item, QEvent event)

virtual void	geometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry)

virtual QSGNode *	updatePaintNode (QSGNode oldNode, UpdatePaintNodeData updatePaintNodeData)

virtual void	releaseResources ()

virtual void	updatePolish ()

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Additional Inherited Members
Public Attributes inherited from QQuickItem
typedef	Flags

Properties inherited from QQuickItem
	parent

	x

	y

	z

	width

	height

	opacity

	enabled

	visible

	state

	childrenRect

	baselineOffset

	clip

	focus

	activeFocus

	activeFocusOnTab

	rotation

	scale

	transformOrigin

	smooth

	antialiasing

	implicitWidth

	implicitHeight

Properties inherited from QObject
	objectName

Detailed Description

Ui module for gaining basic input event (i.e. keyboard) support on non-Android devices.

On non-Android devices, this item, when given focus or along a focused path in the Qml item tree, intercepts QKeyEvents, converts them into their associated ControllerEvents, and passes them to the KeyboardManager for handling.

Note: InputArea must ignore QKeyEvents on Android, and instead handle them separately in AndroidActivity. The problem is Qt translates sequences of Android MotionEvents occasionally into QKeyEvents that are difficult to correlate due to lack of device Id on QEvents. As a result, even though a gamepad-related controller was spawned for the Android MotionEvents in AndroidActivity, we would end up spawning a second keyboard-related controller for the Qt system's translated QKeyEvent if we did not ignore the QKeyEvents on Android. Thus, the full solution adopted here and in AndroidActivity is, on Android, to not let InputArea spawn controllers (i.e. route events to ControllerManagers). Instead, AndroidActivity captures all input events (both KeyEvents and MotionEvents), translating and routing them appropriately. However, we leave the InputArea code to do translation for other non-Android platforms.

Member Enumeration Documentation

enum InputArea::Key_X

Defines an additional set of key codes to extend Qt::Key.

Note: At the time of writing this class, the highest Qt::Key enum value is currently Qt::Key_Cancel (0x01020001), which Key_X gives plenty of buffer room between.

Enumerator
Key_Button_B	Represents a gamepad "B" button.

Constructor & Destructor Documentation

InputArea::InputArea ( QQuickItem * parent = 0 )

explicit

Constructs an InputArea.

Parameters

parent Parent item

Member Function Documentation

static KeyCode InputArea::convertQtKeyCode ( int qtKeyCode )

static

Returns the KeyCode that corresponds Qt::Key code.

Parameters

qtKeyCode Qt::Key code to convert

virtual void InputArea::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

Intercept QKeyEvent press and process the event.

If the converted ControllerEvent is not handled by the KeyboardManager, then event is allowed to continue propagation; otherwise, event is accepted.

Parameters

event Key press event to handle

Reimplemented from QQuickItem.

virtual void InputArea::keyReleaseEvent ( QKeyEvent * event )

overrideprotectedvirtual

Intercept QKeyEvent release and process the event.

If the converted ControllerEvent is not handled by the KeyboardManager, then event is allowed to continue propagation; otherwise, event is accepted.

Parameters

event Key release event to handle

Reimplemented from QQuickItem.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation