UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IVirtualKeyboardEntry Class Referenceabstract

#include <IVirtualKeyboardEntry.h>

+ Inheritance diagram for IVirtualKeyboardEntry:

Public Member Functions

virtual ~IVirtualKeyboardEntry ()
 
virtual void SetTextFromVirtualKeyboard (const FText &InNewText, ETextEntryType TextEntryType)=0
 
virtual void SetSelectionFromVirtualKeyboard (int InSelStart, int SelEnd)=0
 
virtual FText GetText () const =0
 
virtual bool GetSelection (int &OutSelStart, int &OutSelEnd)=0
 
virtual FText GetHintText () const =0
 
virtual EKeyboardType GetVirtualKeyboardType () const =0
 
virtual FVirtualKeyboardOptions GetVirtualKeyboardOptions () const =0
 
virtual bool IsMultilineEntry () const =0
 
virtual bool IsIntegratedKeyboardEnabled () const
 

Public Attributes

FOnSelectionChangedDelegateVK OnSelectionChanged
 

Constructor & Destructor Documentation

◆ ~IVirtualKeyboardEntry()

virtual IVirtualKeyboardEntry::~IVirtualKeyboardEntry ( )
inlinevirtual

Member Function Documentation

◆ GetHintText()

virtual FText IVirtualKeyboardEntry::GetHintText ( ) const
pure virtual

Returns the hint text.

Returns
HintText

Implemented in SVirtualKeyboardEntry.

◆ GetSelection()

virtual bool IVirtualKeyboardEntry::GetSelection ( int &  OutSelStart,
int &  OutSelEnd 
)
pure virtual

Implemented in SVirtualKeyboardEntry.

◆ GetText()

virtual FText IVirtualKeyboardEntry::GetText ( ) const
pure virtual

Returns the text.

Returns
Text

Implemented in SVirtualKeyboardEntry.

◆ GetVirtualKeyboardOptions()

virtual FVirtualKeyboardOptions IVirtualKeyboardEntry::GetVirtualKeyboardOptions ( ) const
pure virtual
Returns
Returns additional virtual keyboard options

Implemented in SVirtualKeyboardEntry.

◆ GetVirtualKeyboardType()

virtual EKeyboardType IVirtualKeyboardEntry::GetVirtualKeyboardType ( ) const
pure virtual

Returns the virtual keyboard type.

Returns
VirtualKeyboardType

Implemented in SVirtualKeyboardEntry.

◆ IsIntegratedKeyboardEnabled()

virtual bool IVirtualKeyboardEntry::IsIntegratedKeyboardEnabled ( ) const
inlinevirtual

Returns whether the entry is using IntegratedKeyboard

Returns
Whether the entry is using IntegratedKeyboard

Reimplemented in SVirtualKeyboardEntry.

◆ IsMultilineEntry()

virtual bool IVirtualKeyboardEntry::IsMultilineEntry ( ) const
pure virtual

Returns whether the entry is multi-line

Returns
Whether the entry is multi-line

Implemented in SVirtualKeyboardEntry.

◆ SetSelectionFromVirtualKeyboard()

virtual void IVirtualKeyboardEntry::SetSelectionFromVirtualKeyboard ( int  InSelStart,
int  SelEnd 
)
pure virtual

Implemented in SVirtualKeyboardEntry.

◆ SetTextFromVirtualKeyboard()

virtual void IVirtualKeyboardEntry::SetTextFromVirtualKeyboard ( const FText InNewText,
ETextEntryType  TextEntryType 
)
pure virtual

Sets the text to that entered by the virtual keyboard

Parameters
InNewTextThe new text
TextEntryTypeWhat type of text update is being provided
CommitTypeIf we are sending a TextCommitted event, what commit type is it

Implemented in SVirtualKeyboardEntry.

Member Data Documentation

◆ OnSelectionChanged

FOnSelectionChangedDelegateVK IVirtualKeyboardEntry::OnSelectionChanged

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