#include <ISlateEditableTextWidget.h>

Inheritance diagram for ISlateEditableTextWidget:

Public Member Functions
virtual bool	IsTextReadOnly () const =0

virtual bool	IsTextPassword () const =0

virtual bool	IsMultiLineTextEdit () const =0

virtual bool	ShouldJumpCursorToEndWhenFocused () const =0

virtual bool	ShouldSelectAllTextWhenFocused () const =0

virtual bool	ShouldClearTextSelectionOnFocusLoss () const =0

virtual bool	ShouldRevertTextOnEscape () const =0

virtual bool	ShouldClearKeyboardFocusOnCommit () const =0

virtual bool	ShouldSelectAllTextOnCommit () const =0

virtual bool	ShouldSelectWordOnMouseDoubleClick () const =0

virtual bool	CanInsertCarriageReturn () const =0

virtual bool	CanTypeCharacter (const TCHAR InChar) const =0

virtual bool	IsIntegratedKeyboardEnabled () const =0

virtual void	EnsureActiveTick ()=0

virtual EKeyboardType	GetVirtualKeyboardType () const =0

virtual FVirtualKeyboardOptions	GetVirtualKeyboardOptions () const =0

virtual EVirtualKeyboardTrigger	GetVirtualKeyboardTrigger () const =0

virtual EVirtualKeyboardDismissAction	GetVirtualKeyboardDismissAction () const =0

virtual TSharedRef< SWidget >	GetSlateWidget ()=0

virtual TSharedPtr< SWidget >	GetSlateWidgetPtr ()=0

virtual TSharedPtr< SWidget >	BuildContextMenuContent () const =0

virtual void	OnBeginTextEdit (const FText &InText)=0

virtual void	OnTextChanged (const FText &InText)=0

virtual void	OnTextCommitted (const FText &InText, const ETextCommit::Type InTextAction)=0

virtual void	OnCursorMoved (const FTextLocation &InLocation)=0

virtual float	UpdateAndClampHorizontalScrollBar (const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverride)=0

virtual float	UpdateAndClampVerticalScrollBar (const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverride)=0

Detailed Description

Interface to allow FSlateEditableTextLayout to notify its parent SEditableText/SMultiLineEditableText of changes, as well as query some widget specific state

Member Function Documentation

◆ BuildContextMenuContent()

virtual TSharedPtr< SWidget > ISlateEditableTextWidget::BuildContextMenuContent ( ) const

pure virtual

Build the context menu content to use for this widget (if any)

Implemented in SEditableText.

◆ CanInsertCarriageReturn()

virtual bool ISlateEditableTextWidget::CanInsertCarriageReturn ( ) const

pure virtual

Are we currently able to insert a carriage return? (some widgets have modifier keys that need to be pressed)

Implemented in SEditableText.

◆ CanTypeCharacter()

virtual bool ISlateEditableTextWidget::CanTypeCharacter ( const TCHAR InChar ) const

pure virtual

Are we able to insert the given character into our text?

Implemented in SEditableText.

◆ EnsureActiveTick()

virtual void ISlateEditableTextWidget::EnsureActiveTick ( )

pure virtual

Ensure that we will get a Tick() soon (either due to having active focus, or something having changed progmatically and requiring an update) Does nothing if the active tick timer is already enabled

Implemented in SEditableText.

◆ GetSlateWidget()

virtual TSharedRef< SWidget > ISlateEditableTextWidget::GetSlateWidget ( )

pure virtual

Get the Slate widget this interface is representing (may not be called during destruction)

Implemented in SEditableText.

◆ GetSlateWidgetPtr()

virtual TSharedPtr< SWidget > ISlateEditableTextWidget::GetSlateWidgetPtr ( )

pure virtual

Get the Slate widget this interface is representing (may be null during destruction)

Implemented in SEditableText.

◆ GetVirtualKeyboardDismissAction()

virtual EVirtualKeyboardDismissAction ISlateEditableTextWidget::GetVirtualKeyboardDismissAction ( ) const

pure virtual

Get the message action to take when the virtual keyboard is dismissed by the user

Implemented in SEditableText.

◆ GetVirtualKeyboardOptions()

virtual FVirtualKeyboardOptions ISlateEditableTextWidget::GetVirtualKeyboardOptions ( ) const

pure virtual

Get the options for the virtual keyboard used for this widget

Implemented in SEditableText.

◆ GetVirtualKeyboardTrigger()

virtual EVirtualKeyboardTrigger ISlateEditableTextWidget::GetVirtualKeyboardTrigger ( ) const

pure virtual

Get the type of event that will trigger the display of the virtual keyboard

Implemented in SEditableText.

◆ GetVirtualKeyboardType()

virtual EKeyboardType ISlateEditableTextWidget::GetVirtualKeyboardType ( ) const

pure virtual

Get the type of virtual keyboard to use for this widget

Implemented in SEditableText.

◆ IsIntegratedKeyboardEnabled()

virtual bool ISlateEditableTextWidget::IsIntegratedKeyboardEnabled ( ) const

pure virtual

Is the widget currently has IntegratedKeyboard enabled?

Implemented in SEditableText.

◆ IsMultiLineTextEdit()

virtual bool ISlateEditableTextWidget::IsMultiLineTextEdit ( ) const

pure virtual

Is the text edit multi-line aware?

Implemented in SEditableText.

◆ IsTextPassword()

virtual bool ISlateEditableTextWidget::IsTextPassword ( ) const

pure virtual

Is the text displaying a password and should be obscured?

Implemented in SEditableText.

◆ IsTextReadOnly()

virtual bool ISlateEditableTextWidget::IsTextReadOnly ( ) const

pure virtual

Is the text currently read-only?

Implemented in SEditableText.

◆ OnBeginTextEdit()

virtual void ISlateEditableTextWidget::OnBeginTextEdit ( const FText & InText )

pure virtual

Called when the text starts to be edited

Implemented in SEditableText.

◆ OnCursorMoved()

virtual void ISlateEditableTextWidget::OnCursorMoved ( const FTextLocation & InLocation )

pure virtual

Called when the cursor is moved within the text area

Implemented in SEditableText.

◆ OnTextChanged()

virtual void ISlateEditableTextWidget::OnTextChanged ( const FText & InText )

pure virtual

Called when the text has been changed by an edit operation

Implemented in SEditableText.

◆ OnTextCommitted()

virtual void ISlateEditableTextWidget::OnTextCommitted	(	const FText &	InText,
		const ETextCommit::Type	InTextAction
	)

pure virtual

Called when the text control has committed its current edit changes

Implemented in SEditableText.

◆ ShouldClearKeyboardFocusOnCommit()

virtual bool ISlateEditableTextWidget::ShouldClearKeyboardFocusOnCommit ( ) const

pure virtual

Should we clear the keyboard focus when the user commits text to this widget?

Implemented in SEditableText.

◆ ShouldClearTextSelectionOnFocusLoss()

virtual bool ISlateEditableTextWidget::ShouldClearTextSelectionOnFocusLoss ( ) const

pure virtual

Should the text clear its selection the widget loses focus?

Implemented in SEditableText.

◆ ShouldJumpCursorToEndWhenFocused()

virtual bool ISlateEditableTextWidget::ShouldJumpCursorToEndWhenFocused ( ) const

pure virtual

Should the cursor be jumped to the end of the document when the widget gains focus?

Implemented in SEditableText.

◆ ShouldRevertTextOnEscape()

virtual bool ISlateEditableTextWidget::ShouldRevertTextOnEscape ( ) const

pure virtual

Should we revert the text back to its original state when the user presses escape?

Implemented in SEditableText.

◆ ShouldSelectAllTextOnCommit()

virtual bool ISlateEditableTextWidget::ShouldSelectAllTextOnCommit ( ) const

pure virtual

Should we select all text when the user commits text to this widget?

Implemented in SEditableText.

◆ ShouldSelectAllTextWhenFocused()

virtual bool ISlateEditableTextWidget::ShouldSelectAllTextWhenFocused ( ) const

pure virtual

Should the text be selected when the widget gains focus?

Implemented in SEditableText.

◆ ShouldSelectWordOnMouseDoubleClick()

virtual bool ISlateEditableTextWidget::ShouldSelectWordOnMouseDoubleClick ( ) const

pure virtual

Should we select word on mouse double click?

Implemented in SEditableText.

◆ UpdateAndClampHorizontalScrollBar()

virtual float ISlateEditableTextWidget::UpdateAndClampHorizontalScrollBar	(	const float	InViewOffset,
		const float	InViewFraction,
		const EVisibility	InVisiblityOverride
	)

pure virtual

Called when the fraction and offset of the horizontal scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped horizontal scroll value

Implemented in SEditableText.

◆ UpdateAndClampVerticalScrollBar()

virtual float ISlateEditableTextWidget::UpdateAndClampVerticalScrollBar	(	const float	InViewOffset,
		const float	InViewFraction,
		const EVisibility	InVisiblityOverride
	)

pure virtual

Called when the fraction and offset of the vertical scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped vertical scroll value

Implemented in SEditableText.

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

Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ BuildContextMenuContent()

◆ CanInsertCarriageReturn()

◆ CanTypeCharacter()

◆ EnsureActiveTick()

◆ GetSlateWidget()

◆ GetSlateWidgetPtr()

◆ GetVirtualKeyboardDismissAction()

◆ GetVirtualKeyboardOptions()

◆ GetVirtualKeyboardTrigger()

◆ GetVirtualKeyboardType()

◆ IsIntegratedKeyboardEnabled()

◆ IsMultiLineTextEdit()

◆ IsTextPassword()

◆ IsTextReadOnly()

◆ OnBeginTextEdit()

◆ OnCursorMoved()

◆ OnTextChanged()

◆ OnTextCommitted()

◆ ShouldClearKeyboardFocusOnCommit()

◆ ShouldClearTextSelectionOnFocusLoss()

◆ ShouldJumpCursorToEndWhenFocused()

◆ ShouldRevertTextOnEscape()

◆ ShouldSelectAllTextOnCommit()

◆ ShouldSelectAllTextWhenFocused()

◆ ShouldSelectWordOnMouseDoubleClick()

◆ UpdateAndClampHorizontalScrollBar()

◆ UpdateAndClampVerticalScrollBar()