Detailed Description

Implmentation of CYIKeyboardInputBridge which renders a keyboard using You.i Engine. Can be used on platforms which do not offer a software keyboard.

To use this class, an instance must be passed to CYIInputBridgeLocator::SetKeyboardInputBridge. If using the API which allows the caller to retain ownership, the caller must ensure that this instance is deleted before CYISceneManager is deleted during CYIApp destruction.

Warning: Not recommended for use on cloud server or mobile platforms.

#include <keyboard/YiOnScreenKeyboardInputBridge.h>

Inheritance diagram for CYIOnScreenKeyboardInputBridge:

[legend]

Public Member Functions
	CYIOnScreenKeyboardInputBridge (CYISceneManager *pSceneManager)

	CYIOnScreenKeyboardInputBridge (CYISceneManager *pSceneManager, std::unique_ptr< CYIFocusEngine > pFocusEngine)

virtual	~CYIOnScreenKeyboardInputBridge ()

Public Member Functions inherited from CYIKeyboardInputBridge
	CYIKeyboardInputBridge ()

virtual	~CYIKeyboardInputBridge ()

void	ResetKeyboard (Receiver *pSource)

virtual bool	ShowKeyboard (Receiver *pSource)

virtual bool	HideKeyboard ()

bool	IsKeyboardShowing () const

bool	IsHardwareKeyboardAvailable () const

bool	ShouldShowKeyboardForActivationEvent (CYIKeyEvent *pKeyEvent) const

void	OnTextChanged (const CYIString &text, Receiver *pSource)

void	OnCursorPositionChanged (size_t cursor, Receiver *pSource)

void	OnCursorPositionWillChange (Receiver *pSource)

Receiver *	GetCurrentReceiver ()

void	ShowSelectionMenu (bool textSelected, YI_RECT rect)

void	HideSelectionMenu ()

Protected Member Functions
virtual void	ResetKeyboardInternal () override

virtual bool	ShowKeyboardInternal (Receiver *pSource) override

virtual bool	HideKeyboardInternal () override

virtual bool	IsKeyboardShowingInternal () const override

virtual bool	IsHardwareKeyboardAvailableInternal () const override

virtual bool	ShouldShowKeyboardForActivationEventInternal (CYIKeyEvent *pKeyEvent) const override

virtual void	OnCursorPositionWillChangeInternal () override

virtual void	OnCursorPositionChangedInternal (size_t start, size_t end) override

virtual void	OnTextChangedInternal (const CYIString &text) override

virtual void	ShowSelectionMenuInternal (bool textSelected, YI_RECT rect) override

virtual void	HideSelectionMenuInternal () override

Protected Member Functions inherited from CYIKeyboardInputBridge
virtual bool	HasAccessoryImageSupport () const

virtual void	AddAccessoryImageUrl (const CYIUrl &url)

virtual void	RemoveAccessoryImageUrl (const CYIUrl &url)

virtual void	OnKeyboardShown ()

virtual void	OnKeyboardHidden ()

virtual void	SetCurrentReceiver (Receiver *pReceiver)

virtual KeyboardTextInputDirection	GetCurrentKeyboardTextInputDirection () const

Additional Inherited Members
Public Types inherited from CYIKeyboardInputBridge
enum	InputType { InputType::Text, InputType::Phone, InputType::Number, InputType::Email, InputType::URI }
	The preferred input type. More...

enum	ReturnKeyType { ReturnKeyType::Default, ReturnKeyType::Go, ReturnKeyType::Search, ReturnKeyType::Next, ReturnKeyType::Done }
	The preferred return key type. More...

enum	InputModifiers { InputModifiers::None = 0x0, InputModifiers::NoSuggestions = 0x1, InputModifiers::MaskInput = 0x2 }
	The preferred modifiers for the platform keyboard. More...

Public Attributes inherited from CYIKeyboardInputBridge
CYISignal	KeyboardShown

CYISignal	KeyboardHidden

Protected Types inherited from CYIKeyboardInputBridge
enum	KeyboardTextInputDirection { KeyboardTextInputDirection::LeftToRight, KeyboardTextInputDirection::RightToLeft, KeyboardTextInputDirection::Unknown }
	The keyboard text input direction. More...

Static Protected Member Functions inherited from CYIKeyboardInputBridge
static CYIKeyboardInputBridge::KeyboardTextInputDirection	GetDirectionFromLanguageCode (const CYIString &languageCode)

Protected Attributes inherited from CYIKeyboardInputBridge
CYISignal< KeyboardTextInputDirection >	KeyboardTextInputDirectionChanged