Navigation
API > API/Runtime > API/Runtime/Slate
| Name | SVirtualKeyboardEntry |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SVirtualKeyboardEntry.h |
| Include Path | #include "Widgets/Input/SVirtualKeyboardEntry.h" |
Syntax
class SVirtualKeyboardEntry :
public SLeafWidget ,
public IVirtualKeyboardEntry
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SLeafWidget → SVirtualKeyboardEntry
- FSlateControlledConstruction → SWidget → SLeafWidget → SVirtualKeyboardEntry
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SVirtualKeyboardEntry() |
Constructor | Widgets/Input/SVirtualKeyboardEntry.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnableIntegratedKeyboard | TAttribute< bool > | Whether to enable integrated keyboard | Widgets/Input/SVirtualKeyboardEntry.h | |
| bIsChangingText | bool | True if we're currently (potentially) changing the text string | Widgets/Input/SVirtualKeyboardEntry.h | |
| bNeedsUpdate | bool | Widgets/Input/SVirtualKeyboardEntry.h | ||
| bWasFocusedByLastMouseDown | bool | True if the last mouse down caused us to receive keyboard focus | Widgets/Input/SVirtualKeyboardEntry.h | |
| ClearKeyboardFocusOnCommit | TAttribute< bool > | Whether to clear keyboard focus when pressing enter to commit changes | Widgets/Input/SVirtualKeyboardEntry.h | |
| ColorAndOpacity | TAttribute< FSlateColor > | Text color and opacity | Widgets/Input/SVirtualKeyboardEntry.h | |
| EditedText | FText | Text string currently being edited | Widgets/Input/SVirtualKeyboardEntry.h | |
| Font | TAttribute< FSlateFontInfo > | The font used to draw the text | Widgets/Input/SVirtualKeyboardEntry.h | |
| HintText | TAttribute< FText > | Widgets/Input/SVirtualKeyboardEntry.h | ||
| IsReadOnly | TAttribute< bool > | Sets whether this text box can actually be modified interactively by the user | Widgets/Input/SVirtualKeyboardEntry.h | |
| KeyboardType | TAttribute< EKeyboardType > | Widgets/Input/SVirtualKeyboardEntry.h | ||
| MinDesiredWidth | TAttribute< float > | Prevents the editabletext from being smaller than desired in certain cases (e.g. when it is empty) | Widgets/Input/SVirtualKeyboardEntry.h | |
| OnTextChanged | FOnTextChanged | Called whenever the text is changed programmatically or interactively by the user | Widgets/Input/SVirtualKeyboardEntry.h | |
| OnTextCommitted | FOnTextCommitted | Called whenever the text is committed. | Widgets/Input/SVirtualKeyboardEntry.h | |
| OriginalText | FText | Original text prior to user edits. | Widgets/Input/SVirtualKeyboardEntry.h | |
| ScrollHelper | FScrollHelper | Current scrolled position | Widgets/Input/SVirtualKeyboardEntry.h | |
| Text | TAttribute< FText > | The text content for this editable text widget | Widgets/Input/SVirtualKeyboardEntry.h | |
| VirtualKeyboardOptions | FVirtualKeyboardOptions | Widgets/Input/SVirtualKeyboardEntry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct this widget | Widgets/Input/SVirtualKeyboardEntry.h | |
bool GetIsReadOnly() |
Widgets/Input/SVirtualKeyboardEntry.h | ||
bool HasTextChangedFromOriginal() |
Widgets/Input/SVirtualKeyboardEntry.h | ||
void RestoreOriginalText() |
Restores the text to the original state | Widgets/Input/SVirtualKeyboardEntry.h | |
void SetFont
(
const TAttribute< FSlateFontInfo >& InNewFont |
Sets the font used to draw the text | Widgets/Input/SVirtualKeyboardEntry.h | |
void SetText
(
const TAttribute< FText >& InNewText |
Sets the text currently being edited | Widgets/Input/SVirtualKeyboardEntry.h |
Overridden from IVirtualKeyboardEntry
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FText GetHintText() |
Returns the hint text. | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual bool GetSelection
(
int& OutSelStart, |
Widgets/Input/SVirtualKeyboardEntry.h | ||
virtual FText GetText() |
Returns the text. | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual FVirtualKeyboardOptions GetVirtualKeyboardOptions() |
Widgets/Input/SVirtualKeyboardEntry.h | ||
virtual EKeyboardType GetVirtualKeyboardType() |
Returns the virtual keyboard type. | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual bool IsIntegratedKeyboardEnabled() |
Returns whether the entry is using IntegratedKeyboard | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual bool IsMultilineEntry() |
Returns whether the entry is multi-line | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual void SetSelectionFromVirtualKeyboard
(
int InSelStart, |
Widgets/Input/SVirtualKeyboardEntry.h | ||
virtual void SetTextFromVirtualKeyboard
(
const FText& InNewText, |
Sets the text to that entered by the virtual keyboard | Widgets/Input/SVirtualKeyboardEntry.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Input/SVirtualKeyboardEntry.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Computes the desired size of this widget (SWidget) | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual void OnFocusLost
(
const FFocusEvent& InFocusEvent |
Called when this widget loses the keyboard focus. This event does not bubble. | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual FReply OnFocusReceived
(
const FGeometry& MyGeometry, |
Widgets/Input/SVirtualKeyboardEntry.h | ||
virtual bool SupportsKeyboardFocus() |
Checks to see if this widget supports keyboard focus. Override this in derived classes. | Widgets/Input/SVirtualKeyboardEntry.h | |
virtual void Tick
(
const FGeometry& AllottedGeometry, |
Ticks this widget. Override in derived classes, but always call the parent implementation. | Widgets/Input/SVirtualKeyboardEntry.h |