Virtual keyboard widget, displays a floating keyboard widget that can be used to type into input fields. More...

Inheritance diagram for FMAR.UI.Widgets.Keyboard.Keyboard:

Public Member Functions
void	OnCharTyped (char c)
	Handles character input from the virtual keyboard.

void	OnBackspace ()
	Handles backspace input from the virtual keyboard.

override void	SetWidgetContainer (WidgetContainer widgetContainer)
	Sets the widget container and updates the keyboard visibility based on the container's scale factor.

Public Member Functions inherited from FMAR.UI.Widgets.Widget
void	SetBorderPositions (Vector2 size)
	Sets the border positions.

void	UpdateBorderTransparency ()
	Updates the border transparency based on the widget container's border transparency.

void	DetachFromContainer ()
	Detaches the widget from the widget container.

void	PlaySound (AudioClip clip)
	Plays a sound localized to the widget.

bool	TryMove ()
	Tries to move the widget out of the widget container.

void	SetBackgroundEnabled (bool enabled)
	Sets the background's enabled state.

Protected Member Functions
override void	Awake ()
	Initializes the Keyboard instance.

Protected Member Functions inherited from FMAR.UI.Widgets.Widget
virtual void	Start ()

virtual void	Update ()

void	CreateBorder (Vector2 size)
	Creates a border for the widget, around the edges.

Properties
static Keyboard	Instance `[get]`
	Gets the singleton instance of the Keyboard.

Properties inherited from FMAR.UI.Widgets.Widget
WidgetContainer	WidgetContainer `[get]`

Vector2	PreferredFloatingDisplaySize `[get]`

Color	BackgroundBaseColor `[get]`

RectTransform	Rt `[get]`

bool	Locked `[get]`

Additional Inherited Members
Public Attributes inherited from FMAR.UI.Widgets.Widget
Sprite	widgetIcon

Protected Attributes inherited from FMAR.UI.Widgets.Widget
Image	bg

RectTransform	rt

AudioSource	aud

Detailed Description

Virtual keyboard widget, displays a floating keyboard widget that can be used to type into input fields.

Member Function Documentation

◆ Awake()

override void FMAR.UI.Widgets.Keyboard.Keyboard.Awake ( )

inlineprotectedvirtual

Initializes the Keyboard instance.

Reimplemented from FMAR.UI.Widgets.Widget.

◆ OnBackspace()

void FMAR.UI.Widgets.Keyboard.Keyboard.OnBackspace ( )

inline

Handles backspace input from the virtual keyboard.

◆ OnCharTyped()

void FMAR.UI.Widgets.Keyboard.Keyboard.OnCharTyped ( char c )

inline

Handles character input from the virtual keyboard.

Parameters

c	The character typed.

◆ SetWidgetContainer()

override void FMAR.UI.Widgets.Keyboard.Keyboard.SetWidgetContainer ( WidgetContainer widgetContainer )

inlinevirtual

Sets the widget container and updates the keyboard visibility based on the container's scale factor.

Parameters

widgetContainer The widget container.

Reimplemented from FMAR.UI.Widgets.Widget.

Property Documentation

◆ Instance

Keyboard FMAR.UI.Widgets.Keyboard.Keyboard.Instance

staticget

Gets the singleton instance of the Keyboard.

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

/github/workspace/Packages/FMAR/UI/WidgetKeyboard/Runtime/Scripts/Keyboard.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members