You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
0be426b07e
UE-1496 - Slate: Implement PageUp PageDown support for multiline editable text This will move the multi-line text by a "page" (based on the number of visible lines), and then scroll the document to try and keep the cursor at the same relative location in the view. This also fixes some issues with scrolling when dealing with a scaled multi-line editable text, as the scroll offset is now always considered to be unscaled until it is given to the text layout. This prevents issues where we could over or under scroll when using a scale other than 1. #codereview Justin.Sargent [CL 2485106 by Jamie Dale in Main branch]
464 lines
15 KiB
C++
464 lines
15 KiB
C++
// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "SlatePrivatePCH.h"
|
|
#include "TextEditHelper.h"
|
|
|
|
/**
|
|
* Ensure that text transactions are always completed.
|
|
* i.e. never forget to call FinishChangingText();
|
|
*/
|
|
struct FScopedTextTransaction
|
|
{
|
|
explicit FScopedTextTransaction( const TSharedRef< ITextEditorWidget >& InTextEditor )
|
|
: TextEditor( InTextEditor )
|
|
{
|
|
TextEditor->StartChangingText();
|
|
}
|
|
|
|
~FScopedTextTransaction()
|
|
{
|
|
TextEditor->FinishChangingText();
|
|
}
|
|
|
|
const TSharedRef< ITextEditorWidget > TextEditor;
|
|
};
|
|
|
|
FReply FTextEditHelper::OnKeyChar( const FCharacterEvent& InCharacterEvent, const TSharedRef< ITextEditorWidget >& TextEditor )
|
|
{
|
|
FReply Reply = FReply::Unhandled();
|
|
|
|
// Check for special characters
|
|
const TCHAR Character = InCharacterEvent.GetCharacter();
|
|
|
|
switch( Character )
|
|
{
|
|
// Backspace
|
|
case TCHAR( 8 ):
|
|
{
|
|
if( !TextEditor->GetIsReadOnly() )
|
|
{
|
|
FScopedTextTransaction TextTransaction(TextEditor);
|
|
|
|
TextEditor->BackspaceChar();
|
|
|
|
Reply = FReply::Handled();
|
|
}
|
|
}
|
|
break;
|
|
|
|
|
|
// Tab
|
|
case TCHAR( '\t' ):
|
|
{
|
|
Reply = FReply::Handled();
|
|
}
|
|
break;
|
|
|
|
|
|
// Newline (Ctrl+Enter), we handle adding new lines via SMultiLineEditableText::OnEnter rather than processing \n characters
|
|
case TCHAR( '\n' ):
|
|
{
|
|
Reply = FReply::Handled();
|
|
}
|
|
break;
|
|
|
|
|
|
// Swallow OnKeyChar keys that we don't want to be entered into the buffer
|
|
case 1: // Swallow Ctrl+A, we handle that through OnKeyDown
|
|
case 3: // Swallow Ctrl+C, we handle that through OnKeyDown
|
|
case 13: // Swallow Enter, we handle that through OnKeyDown
|
|
case 22: // Swallow Ctrl+V, we handle that through OnKeyDown
|
|
case 24: // Swallow Ctrl+X, we handle that through OnKeyDown
|
|
case 25: // Swallow Ctrl+Y, we handle that through OnKeyDown
|
|
case 26: // Swallow Ctrl+Z, we handle that through OnKeyDown
|
|
case 27: // Swallow ESC, we handle that through OnKeyDown
|
|
case 127: // Swallow CTRL+Backspace, we handle that through OnKeyDown
|
|
Reply = FReply::Handled();
|
|
break;
|
|
|
|
|
|
// Any other character!
|
|
default:
|
|
{
|
|
// Type the character, but only if it is allowed.
|
|
if (!TextEditor->GetIsReadOnly() && TextEditor->CanTypeCharacter(Character))
|
|
{
|
|
FScopedTextTransaction TextTransaction(TextEditor);
|
|
TextEditor->TypeChar( Character );
|
|
Reply = FReply::Handled();
|
|
}
|
|
else
|
|
{
|
|
Reply = FReply::Unhandled();
|
|
}
|
|
}
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
return Reply;
|
|
}
|
|
|
|
FReply FTextEditHelper::OnKeyDown( const FKeyEvent& InKeyEvent, const TSharedRef< ITextEditorWidget >& TextEditor )
|
|
{
|
|
const FKey Key = InKeyEvent.GetKey();
|
|
|
|
if( Key == EKeys::Left )
|
|
{
|
|
return TextEditor->MoveCursor( FMoveCursor::Cardinal(
|
|
// Ctrl moves a whole word instead of one character.
|
|
InKeyEvent.IsControlDown( ) ? ECursorMoveGranularity::Word : ECursorMoveGranularity::Character,
|
|
// Move left
|
|
FIntPoint( -1, 0 ),
|
|
// Shift selects text.
|
|
InKeyEvent.IsShiftDown() ? ECursorAction::SelectText : ECursorAction::MoveCursor
|
|
));
|
|
}
|
|
else if( Key == EKeys::Right )
|
|
{
|
|
return TextEditor->MoveCursor( FMoveCursor::Cardinal(
|
|
// Ctrl moves a whole word instead of one character.
|
|
InKeyEvent.IsControlDown( ) ? ECursorMoveGranularity::Word : ECursorMoveGranularity::Character,
|
|
// Move right
|
|
FIntPoint( +1, 0 ),
|
|
// Shift selects text.
|
|
InKeyEvent.IsShiftDown() ? ECursorAction::SelectText : ECursorAction::MoveCursor
|
|
));
|
|
}
|
|
else if ( Key == EKeys::Up )
|
|
{
|
|
return TextEditor->MoveCursor( FMoveCursor::Cardinal(
|
|
InKeyEvent.IsControlDown( ) ? ECursorMoveGranularity::Word : ECursorMoveGranularity::Character,
|
|
// Move up
|
|
FIntPoint( 0, -1 ),
|
|
// Shift selects text.
|
|
InKeyEvent.IsShiftDown() ? ECursorAction::SelectText : ECursorAction::MoveCursor
|
|
));
|
|
}
|
|
else if ( Key == EKeys::Down )
|
|
{
|
|
return TextEditor->MoveCursor( FMoveCursor::Cardinal(
|
|
InKeyEvent.IsControlDown( ) ? ECursorMoveGranularity::Word : ECursorMoveGranularity::Character,
|
|
// Move down
|
|
FIntPoint( 0, +1 ),
|
|
// Shift selects text.
|
|
InKeyEvent.IsShiftDown() ? ECursorAction::SelectText : ECursorAction::MoveCursor
|
|
));
|
|
}
|
|
else if( Key == EKeys::Home )
|
|
{
|
|
// Go to the beginning of the document; select text if Shift is down.
|
|
TextEditor->JumpTo(
|
|
(InKeyEvent.IsControlDown() ) ? ETextLocation::BeginningOfDocument : ETextLocation::BeginningOfLine,
|
|
(InKeyEvent.IsShiftDown()) ? ECursorAction::SelectText : ECursorAction::MoveCursor );
|
|
|
|
return FReply::Handled();
|
|
}
|
|
else if ( Key == EKeys::End )
|
|
{
|
|
// Go to the end of the document; select text if Shift is down.
|
|
TextEditor->JumpTo(
|
|
(InKeyEvent.IsControlDown() ) ? ETextLocation::EndOfDocument : ETextLocation::EndOfLine,
|
|
(InKeyEvent.IsShiftDown()) ? ECursorAction::SelectText : ECursorAction::MoveCursor );
|
|
|
|
return FReply::Handled();
|
|
}
|
|
else if( Key == EKeys::PageUp )
|
|
{
|
|
// Go to the previous page of the document document; select text if Shift is down.
|
|
TextEditor->JumpTo(
|
|
ETextLocation::PreviousPage,
|
|
(InKeyEvent.IsShiftDown()) ? ECursorAction::SelectText : ECursorAction::MoveCursor );
|
|
|
|
return FReply::Handled();
|
|
}
|
|
else if ( Key == EKeys::PageDown )
|
|
{
|
|
// Go to the next page of the document document; select text if Shift is down.
|
|
TextEditor->JumpTo(
|
|
ETextLocation::NextPage,
|
|
(InKeyEvent.IsShiftDown()) ? ECursorAction::SelectText : ECursorAction::MoveCursor );
|
|
|
|
return FReply::Handled();
|
|
}
|
|
else if( Key == EKeys::Enter && !TextEditor->GetIsReadOnly() )
|
|
{
|
|
FScopedTextTransaction TextTransaction(TextEditor);
|
|
|
|
TextEditor->OnEnter();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
else if( Key == EKeys::Delete && !TextEditor->GetIsReadOnly() )
|
|
{
|
|
// @Todo: Slate keybindings support more than one set of keys.
|
|
// Delete to next word boundary (Ctrl+Delete)
|
|
if (InKeyEvent.IsControlDown() && !InKeyEvent.IsAltDown() && !InKeyEvent.IsShiftDown())
|
|
{
|
|
TextEditor->MoveCursor( FMoveCursor::Cardinal(
|
|
ECursorMoveGranularity::Word,
|
|
// Move right
|
|
FIntPoint(+1, 0),
|
|
// selects text.
|
|
ECursorAction::SelectText
|
|
));
|
|
}
|
|
|
|
FScopedTextTransaction TextTransaction(TextEditor);
|
|
|
|
// Delete selected text
|
|
TextEditor->DeleteChar();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
else if( Key == EKeys::Escape )
|
|
{
|
|
return TextEditor->OnEscape();
|
|
}
|
|
|
|
// @Todo: Slate keybindings support more than one set of keys.
|
|
//Alternate key for cut (Shift+Delete)
|
|
else if( Key == EKeys::Delete && InKeyEvent.IsShiftDown() && TextEditor->CanExecuteCut() )
|
|
{
|
|
// Cut text to clipboard
|
|
TextEditor->CutSelectedTextToClipboard();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
// @Todo: Slate keybindings support more than one set of keys.
|
|
// Alternate key for copy (Ctrl+Insert)
|
|
else if( Key == EKeys::Insert && InKeyEvent.IsControlDown() && TextEditor->CanExecuteCopy() )
|
|
{
|
|
// Copy text to clipboard
|
|
TextEditor->CopySelectedTextToClipboard();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
|
|
// @Todo: Slate keybindings support more than one set of keys.
|
|
// Alternate key for paste (Shift+Insert)
|
|
else if( Key == EKeys::Insert && InKeyEvent.IsShiftDown() && TextEditor->CanExecutePaste() )
|
|
{
|
|
// Paste text from clipboard
|
|
TextEditor->PasteTextFromClipboard();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
// @Todo: Slate keybindings support more than one set of keys.
|
|
//Alternate key for undo (Alt+Backspace)
|
|
else if( Key == EKeys::BackSpace && InKeyEvent.IsAltDown() && !InKeyEvent.IsShiftDown() && TextEditor->CanExecuteUndo() )
|
|
{
|
|
// Undo
|
|
TextEditor->Undo();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
// @Todo: Slate keybindings support more than one set of keys.
|
|
// Delete to previous word boundary (Ctrl+Backspace)
|
|
else if( Key == EKeys::BackSpace && InKeyEvent.IsControlDown() && !InKeyEvent.IsAltDown() && !InKeyEvent.IsShiftDown() && !TextEditor->GetIsReadOnly() )
|
|
{
|
|
FScopedTextTransaction TextTransaction(TextEditor);
|
|
|
|
TextEditor->MoveCursor( FMoveCursor::Cardinal(
|
|
ECursorMoveGranularity::Word,
|
|
// Move left
|
|
FIntPoint(-1, 0),
|
|
ECursorAction::SelectText
|
|
));
|
|
TextEditor->BackspaceChar();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
|
|
|
|
// Ctrl+Y (or Ctrl+Shift+Z, or Alt+Shift+Backspace) to redo
|
|
else if( !TextEditor->GetIsReadOnly() && ( ( Key == EKeys::Y && InKeyEvent.IsControlDown() ) ||
|
|
( Key == EKeys::Z && InKeyEvent.IsControlDown() && InKeyEvent.IsShiftDown() ) ||
|
|
( Key == EKeys::BackSpace && InKeyEvent.IsAltDown() && InKeyEvent.IsShiftDown() ) ) )
|
|
{
|
|
// Redo
|
|
TextEditor->Redo();
|
|
|
|
return FReply::Handled();
|
|
}
|
|
else if( !InKeyEvent.IsAltDown() && !InKeyEvent.IsControlDown() && InKeyEvent.GetKey() != EKeys::Tab && InKeyEvent.GetCharacter() != 0 )
|
|
{
|
|
// Shift and a character was pressed or a single character was pressed. We will type something in an upcoming OnKeyChar event.
|
|
// Absorb this event so it is not bubbled and handled by other widgets that could have something bound to the key press.
|
|
|
|
//Note: Tab can generate a character code but not result in a typed character in this box so we ignore it.
|
|
return FReply::Handled();
|
|
}
|
|
else
|
|
{
|
|
return FReply::Unhandled();
|
|
}
|
|
}
|
|
FReply FTextEditHelper::OnMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& InMouseEvent, const TSharedRef< ITextEditorWidget >& TextEditor )
|
|
{
|
|
FReply Reply = FReply::Unhandled();
|
|
|
|
// If the mouse is already captured, then don't allow a new action to be taken
|
|
if( !TextEditor->GetWidget()->HasMouseCapture() )
|
|
{
|
|
if( InMouseEvent.GetEffectingButton() == EKeys::LeftMouseButton ||
|
|
InMouseEvent.GetEffectingButton() == EKeys::RightMouseButton )
|
|
{
|
|
// Am I getting focus right now?
|
|
const bool bIsGettingFocus = !TextEditor->GetWidget()->HasKeyboardFocus();
|
|
if( bIsGettingFocus )
|
|
{
|
|
// We might be receiving keyboard focus due to this event. Because the keyboard focus received callback
|
|
// won't fire until after this function exits, we need to make sure our widget's state is in order early
|
|
|
|
// Assume we'll be given keyboard focus, so load text for editing
|
|
TextEditor->LoadText();
|
|
|
|
// Reset 'mouse has moved' state. We'll use this in OnMouseMove to determine whether we
|
|
// should reset the selection range to the caret's position.
|
|
TextEditor->SetWasFocusedByLastMouseDown( true );
|
|
}
|
|
|
|
if( InMouseEvent.GetEffectingButton() == EKeys::LeftMouseButton )
|
|
{
|
|
if( InMouseEvent.IsShiftDown() )
|
|
{
|
|
TextEditor->MoveCursor( FMoveCursor::ViaScreenPointer( MyGeometry.AbsoluteToLocal( InMouseEvent.GetScreenSpacePosition( ) ), MyGeometry.Scale, ECursorAction::SelectText ) );
|
|
}
|
|
else
|
|
{
|
|
// Deselect any text that was selected
|
|
TextEditor->ClearSelection();
|
|
TextEditor->MoveCursor( FMoveCursor::ViaScreenPointer( MyGeometry.AbsoluteToLocal( InMouseEvent.GetScreenSpacePosition( ) ), MyGeometry.Scale, ECursorAction::MoveCursor ) );
|
|
}
|
|
|
|
// Start drag selection
|
|
TextEditor->BeginDragSelection();
|
|
}
|
|
else if( InMouseEvent.GetEffectingButton() == EKeys::RightMouseButton )
|
|
{
|
|
// If the user right clicked on a character that wasn't already selected, we'll clear
|
|
// the selection
|
|
if ( TextEditor->AnyTextSelected( ) && !TextEditor->IsTextSelectedAt( MyGeometry, InMouseEvent.GetScreenSpacePosition() ) )
|
|
{
|
|
// Deselect any text that was selected
|
|
TextEditor->ClearSelection();
|
|
}
|
|
}
|
|
|
|
// Right clicking to summon context menu, but we'll do that on mouse-up.
|
|
Reply = FReply::Handled();
|
|
Reply.CaptureMouse( TextEditor->GetWidget() );
|
|
Reply.SetUserFocus(TextEditor->GetWidget(), EFocusCause::Mouse);
|
|
}
|
|
}
|
|
|
|
return Reply;
|
|
}
|
|
|
|
FReply FTextEditHelper::OnMouseMove( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent, const TSharedRef< ITextEditorWidget >& TextEditor )
|
|
{
|
|
FReply Reply = FReply::Unhandled();
|
|
|
|
if( TextEditor->IsDragSelecting() && TextEditor->GetWidget()->HasMouseCapture() && InMouseEvent.GetCursorDelta() != FVector2D::ZeroVector )
|
|
{
|
|
TextEditor->MoveCursor( FMoveCursor::ViaScreenPointer( InMyGeometry.AbsoluteToLocal( InMouseEvent.GetScreenSpacePosition( ) ), InMyGeometry.Scale, ECursorAction::SelectText ) );
|
|
TextEditor->SetHasDragSelectedSinceFocused( true );
|
|
Reply = FReply::Handled();
|
|
}
|
|
|
|
return Reply;
|
|
}
|
|
|
|
FReply FTextEditHelper::OnMouseButtonUp( const FGeometry& MyGeometry, const FPointerEvent& InMouseEvent, const TSharedRef< ITextEditorWidget >& TextEditor )
|
|
{
|
|
FReply Reply = FReply::Unhandled();
|
|
|
|
// The mouse must have been captured by either left or right button down before we'll process mouse ups
|
|
if( TextEditor->GetWidget()->HasMouseCapture() )
|
|
{
|
|
if( InMouseEvent.GetEffectingButton() == EKeys::LeftMouseButton &&
|
|
TextEditor->IsDragSelecting() )
|
|
{
|
|
// No longer drag-selecting
|
|
TextEditor->EndDragSelection();
|
|
|
|
// If we received keyboard focus on this click, then we'll want to select all of the text
|
|
// when the user releases the mouse button, unless the user actually dragged the mouse
|
|
// while holding the button down, in which case they've already selected some text and
|
|
// we'll leave things alone!
|
|
if( TextEditor->WasFocusedByLastMouseDown() )
|
|
{
|
|
if( !TextEditor->HasDragSelectedSinceFocused() )
|
|
{
|
|
if( TextEditor->SelectAllTextWhenFocused() )
|
|
{
|
|
// Move the cursor to the end of the string
|
|
TextEditor->JumpTo(ETextLocation::EndOfDocument, ECursorAction::MoveCursor);
|
|
|
|
// User wasn't dragging the mouse, so go ahead and select all of the text now
|
|
// that we've become focused
|
|
TextEditor->SelectAllText();
|
|
|
|
// @todo Slate: In this state, the caret should actually stay hidden (until the user interacts again), and we should not move the caret
|
|
}
|
|
}
|
|
|
|
TextEditor->SetWasFocusedByLastMouseDown( false );
|
|
}
|
|
|
|
// Release mouse capture
|
|
Reply = FReply::Handled();
|
|
Reply.ReleaseMouseCapture();
|
|
}
|
|
else if( InMouseEvent.GetEffectingButton() == EKeys::RightMouseButton )
|
|
{
|
|
if ( MyGeometry.IsUnderLocation( InMouseEvent.GetScreenSpacePosition() ) )
|
|
{
|
|
// Right clicked, so summon a context menu if the cursor is within the widget
|
|
TextEditor->SummonContextMenu( InMouseEvent.GetScreenSpacePosition() );
|
|
}
|
|
|
|
// Release mouse capture
|
|
Reply = FReply::Handled();
|
|
Reply.ReleaseMouseCapture();
|
|
}
|
|
}
|
|
|
|
return Reply;
|
|
}
|
|
|
|
FReply FTextEditHelper::OnMouseButtonDoubleClick(const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent, const TSharedRef< ITextEditorWidget >& TextEditor)
|
|
{
|
|
FReply Reply = FReply::Unhandled();
|
|
|
|
if (InMouseEvent.GetEffectingButton() == EKeys::LeftMouseButton)
|
|
{
|
|
TextEditor->SelectWordAt(InMyGeometry, InMouseEvent.GetScreenSpacePosition());
|
|
|
|
Reply = FReply::Handled();
|
|
}
|
|
|
|
return Reply;
|
|
}
|
|
|
|
float FTextEditHelper::GetFontHeight(const FSlateFontInfo& FontInfo)
|
|
{
|
|
const TSharedRef< FSlateFontMeasure > FontMeasure = FSlateApplication::Get().GetRenderer()->GetFontMeasureService();
|
|
return FontMeasure->GetMaxCharacterHeight(FontInfo);
|
|
}
|
|
|
|
float FTextEditHelper::CalculateCaretWidth(const float FontMaxCharHeight)
|
|
{
|
|
// We adjust the width of the cursor because on smaller fonts the cursor would overlap too much of the characters it is next too.
|
|
// Other programs get around this by inverting the colors under the cursor. This causes a single character to be rendered as two characters.
|
|
|
|
// The caret with should be at least one pixel. For very small fonts the width could be < 1 which makes it not visible
|
|
return FMath::Max(1.0f, EditableTextDefs::CaretWidthPercent * FontMaxCharHeight);
|
|
}
|