Murl::Input::IKeyboardDevice Interface Reference

The IKeyboardDevice interface. More...

#include "murl_input_i_keyboard_device.h"

Inheritance diagram for Murl::Input::IKeyboardDevice:

Public Member Functions
virtual UInt32	GetNumberOfKeys () const =0
	Get the number of keys pressed in the most recent tick. More...
virtual const String &	GetKey (UInt32 index) const =0
	Get a key pressed in the most recent tick. More...
virtual const StringArray &	GetKeys () const =0
	Get all keys pressed in the most recent tick. More...
Public Member Functions inherited from Murl::Input::IDevice
virtual const String &	GetName () const =0
	Get the device name. More...
virtual UInt32	GetId () const =0
	Get the unique device identifier. More...
virtual Bool	HasUpdate () const =0
	Check if the device has received new data since the last Update(). More...
virtual void	LogicUpdate ()=0
	Is executed in the logic thread context each logic tick.
virtual void	ConfigChanged (const IAppConfiguration *appConfig)=0
	Notification of changed configuration. More...

Detailed Description

The IKeyboardDevice interface.

Member Function Documentation

GetNumberOfKeys()

virtual UInt32 Murl::Input::IKeyboardDevice::GetNumberOfKeys ( ) const

pure virtual

Get the number of keys pressed in the most recent tick.

Returns

The number of keys.

GetKey()

virtual const String& Murl::Input::IKeyboardDevice::GetKey ( UInt32  index ) const

pure virtual

Get a key pressed in the most recent tick.

A valid key buffer index is [0 .. GetNumberOfKeys() - 1].

Parameters

index

The zero-based index of the key buffer.

Returns

The UTF8 string of the key.

GetKeys()

virtual const StringArray& Murl::Input::IKeyboardDevice::GetKeys ( ) const

pure virtual

Get all keys pressed in the most recent tick.

To concat all keys to a string use String::Cat(const StringArray& stringArray).

Returns

The UTF8 string array of the keys.

---

The documentation for this interface was generated from the following file:

• murl_input_i_keyboard_device.h