Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

SVirtualKeyboardEntry

Windows

MacOS

Linux

Inheritance Hierarchy

SLeafWidget

IVirtualKeyboardEntry

SVirtualKeyboardEntry

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Input/SVirtualKeyboardEntry.h
Include	#include "Widgets/Input/SVirtualKeyboardEntry.h"

Syntax

class SVirtualKeyboardEntry :
public SLeafWidget,
public IVirtualKeyboardEntry

Constructors

	Name	Description
	SVirtualKeyboardEntry()	Constructor

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )	Construct this widget
bool	GetIsReadOnly()
bool	HasTextChangedFromOriginal()
void	RestoreOriginalText()	Restores the text to the original state
void	SetFont ( const TAttribute< FSlateFontInfo > ... )	Sets the font used to draw the text
void	SetText ( const TAttribute< FText >& InNewTe... )	Sets the text currently being edited

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float )	Computes the desired size of this widget (SWidget)
void	OnFocusLost ( const FFocusEvent& InFocusEvent )	Called when this widget loses the keyboard focus. This event does not bubble.
FReply	OnFocusReceived ( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent )	KEY INPUT Called when focus is given to this widget. This event does not bubble.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Overwritten from SWidget.
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget. Override in derived classes, but always call the parent implementation.

Overridden from IVirtualKeyboardEntry

	Name	Description
FText	GetHintText()	Returns the hint text.
bool	GetSelection ( int& OutSelStart, int& OutSelEnd )
FText	GetText()	Returns the text.
FVirtualKeyb...	GetVirtualKeyboardOptions()
EKeyboardTyp...	GetVirtualKeyboardType()	Returns the virtual keyboard type.
bool	IsMultilineEntry()	Returns whether the entry is multi-line
void	SetSelectionFromVirtualKeyboard ( int InSelStart, int InSelEnd )
void	SetTextFromVirtualKeyboard ( const FText& InNewText, ETextEntryType TextEntryType )	Sets the text to that entered by the virtual keyboard

Classes

	Name	Description
	FArguments

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss