finalcut::FKeyboard Class Reference

Public Types
using	keybuffer = CharRingBuffer< FIFO_BUF_SIZE >

Public Member Functions
	FKeyboard (const FKeyboard &)=delete
	FKeyboard (FKeyboard &&) noexcept=delete
auto	operator= (const FKeyboard &) -> FKeyboard &=delete
auto	operator= (FKeyboard &&) noexcept -> FKeyboard &=delete
auto	getClassName () const -> FString
auto	getKey () const noexcept -> FKey
auto	getKeyName (const FKey) const -> FString
auto	getKeyBuffer () &noexcept -> keybuffer &
auto	getKeyPressedTime () const noexcept -> TimeValue
template<typename T >
void	setTermcapMap (const T &)
void	setTermcapMap ()
auto	setNonBlockingInput (bool=true) -> bool
auto	unsetNonBlockingInput () noexcept -> bool
void	enableUTF8 () noexcept
void	disableUTF8 () noexcept
void	enableMouseSequences () noexcept
void	disableMouseSequences () noexcept
void	setPressCommand (const FKeyboardCommand &)
void	setReleaseCommand (const FKeyboardCommand &)
void	setEscPressedCommand (const FKeyboardCommand &)
void	setMouseTrackingCommand (const FKeyboardCommand &)
auto	hasPendingInput () const noexcept -> bool
auto	hasDataInQueue () const -> bool
auto	hasUnprocessedInput () const noexcept -> bool
auto	isKeyPressed (uInt64=read_blocking_time) -> bool
void	clearKeyBuffer () noexcept
void	clearKeyBufferOnTimeout ()
void	fetchKeyCode ()
void	escapeKeyHandling ()
void	processQueuedInput ()

Static Public Member Functions
static auto	getInstance () -> FKeyboard &
static auto	getKeypressTimeout () noexcept -> uInt64
static auto	getReadBlockingTime () noexcept -> uInt64
static void	setKeypressTimeout (const uInt64) noexcept
static void	setReadBlockingTime (const uInt64) noexcept
static void	setNonBlockingInputSupport (bool=true) noexcept

Static Public Attributes
static constexpr std::size_t	FIFO_BUF_SIZE {512}

---

The documentation for this class was generated from the following files:

• final/input/fkeyboard.h
• final/input/fkeyboard.cpp