FMAR.UI.Widgets.Keyboard.Key Class Reference

Represents a key on the virtual keyboard. More...

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

Public Member Functions
Key	Init (char key, char shiftKey)
	Initializes the key with the specified characters.

Protected Member Functions
virtual void	SetLabels ()
	Sets the labels on the key.
virtual void	OnDown ()
	Handles the button's pointer down event and sends the character to the keyboard.

Protected Attributes
char	key
	The character displayed on the key.
char	shiftKey
	The character displayed on the key when shift is pressed.
TextMeshProUGUI	primaryLabel
TextMeshProUGUI	shiftLabel
UpDownButton	button
LayoutElement	layoutElement

Detailed Description

Represents a key on the virtual keyboard.

Member Function Documentation

Init()

Key FMAR.UI.Widgets.Keyboard.Key.Init ( char key, char shiftKey )

inline

Initializes the key with the specified characters.

Parameters

key	The character displayed on the key.
shiftKey	The character displayed on the key when shift is pressed.

Returns

The initialized key.

OnDown()

virtual void FMAR.UI.Widgets.Keyboard.Key.OnDown ( )

inlineprotectedvirtual

Handles the button's pointer down event and sends the character to the keyboard.

Reimplemented in FMAR.UI.Widgets.Keyboard.SpecialKey.

SetLabels()

virtual void FMAR.UI.Widgets.Keyboard.Key.SetLabels ( )

inlineprotectedvirtual

Sets the labels on the key.

Reimplemented in FMAR.UI.Widgets.Keyboard.SpecialKey.

Member Data Documentation

button

UpDownButton FMAR.UI.Widgets.Keyboard.Key.button

protected

key

char FMAR.UI.Widgets.Keyboard.Key.key

protected

The character displayed on the key.

layoutElement

LayoutElement FMAR.UI.Widgets.Keyboard.Key.layoutElement

protected

primaryLabel

TextMeshProUGUI FMAR.UI.Widgets.Keyboard.Key.primaryLabel

protected

shiftKey

char FMAR.UI.Widgets.Keyboard.Key.shiftKey

protected

The character displayed on the key when shift is pressed.

shiftLabel

TextMeshProUGUI FMAR.UI.Widgets.Keyboard.Key.shiftLabel

protected

---

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

• /github/workspace/Packages/FMAR/UI/WidgetKeyboard/Runtime/Scripts/Key.cs