m5::unit::UnitKeyboard Class Reference

Base class of the Keyboard Unit. More...

#include <unit_Keyboard.hpp>

Inheritance diagram for m5::unit::UnitKeyboard:

Public Member Functions
	UnitKeyboard (const uint8_t addr=DEFAULT_ADDRESS)
virtual bool	begin () override
virtual void	update (const bool force=false) override
virtual char	getchar () const
	Gets the input character.
virtual uint8_t	released () const
	Gets the released key character code if updated.

Detailed Description

Base class of the Keyboard Unit.

Member Function Documentation

begin()

bool m5::unit::UnitKeyboard::begin ( )

overridevirtual

Reimplemented in m5::unit::UnitCardKB2, m5::unit::UnitCardKB2UART, m5::unit::UnitCardKB, and m5::unit::UnitFacesQWERTY.

getchar()

virtual char m5::unit::UnitKeyboard::getchar ( ) const

inlinevirtual

Gets the input character.

Return values

!=	0 Character
==	0 Not input or invalid character

Note

Whether the input is a released or pressed key depends on the derived class

Reimplemented in m5::unit::UnitCardKB2, and m5::unit::UnitKeyboardBitwise.

released()

virtual uint8_t m5::unit::UnitKeyboard::released ( ) const

inlinevirtual

Gets the released key character code if updated.

Return values

!=	0 Released character code
==	0 There is no released key

Reimplemented in m5::unit::UnitFacesQWERTY, and m5::unit::UnitKeyboardBitwise.

update()

void m5::unit::UnitKeyboard::update ( const bool force = false )

overridevirtual

Reimplemented in m5::unit::UnitCardKB2, m5::unit::UnitCardKB2UART, m5::unit::UnitCardKB, m5::unit::UnitFacesQWERTY, and m5::unit::UnitKeyboardBitwise.