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

Public function

SVirtualKeyboardEntry()

Constructor

Functions

Name Description

Public function

void

 

Construct

(
    const FArguments & InArgs
)

Construct this widget

Public function Const

bool

 

GetIsReadOnly()

Public function Const

bool

 

HasTextChangedFromOriginal()

Public function

void

 

RestoreOriginalText()

Restores the text to the original state

Public function

void

 

SetFont

(
    const TAttribute < FSlateFontInfo > ...
)

Sets the font used to draw the text

Public function

void

 

SetText

(
    const TAttribute < FText >& InNewTe...
)

Sets the text currently being edited

Overridden from SWidget

Name Description

Protected function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float
)

Computes the desired size of this widget (SWidget )

Protected function Virtual

void

 

OnFocusLost

(
    const FFocusEvent & InFocusEvent
)

Called when this widget loses the keyboard focus. This event does not bubble.

Protected function Virtual

FReply

 

OnFocusReceived

(
    const FGeometry & MyGeometry,
    const FFocusEvent & InFocusEvent
)

KEY INPUT Called when focus is given to this widget. This event does not bubble.

Protected function Virtual Const

int32

 

OnPaint

(
    const FPaintArgs & Args,
    const FGeometry & AllottedGeometry,
    const FSlateRect & MyCullingRect,
    FSlateWindowElementList & OutDrawEl...,
    int32 LayerId,
    const FWidgetStyle & InWidgetStyle,
    bool bParentEnabled
)

Overwritten from SWidget .

Protected function Virtual Const

bool

 

SupportsKeyboardFocus()

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Protected function Virtual

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

Public function Virtual Const

FText

 

GetHintText()

Returns the hint text.

Public function Virtual

bool

 

GetSelection

(
    int& OutSelStart,
    int& OutSelEnd
)

Public function Virtual Const

FText

 

GetText()

Returns the text.

Public function Virtual Const

FVirtualKeyb ...

 

GetVirtualKeyboardOptions()

Public function Virtual Const

EKeyboardTyp ...

 

GetVirtualKeyboardType()

Returns the virtual keyboard type.

Public function Virtual Const

bool

 

IsMultilineEntry()

Returns whether the entry is multi-line

Public function Virtual

void

 

SetSelectionFromVirtualKeyboard

(
    int InSelStart,
    int InSelEnd
)

Public function Virtual

void

 

SetTextFromVirtualKeyboard

(
    const FText & InNewText,
    ETextEntryType TextEntryType
)

Sets the text to that entered by the virtual keyboard

Classes

Name

Description

Public struct

FArguments

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback