className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
SViewport::OnKeyChar
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called after a character is entered while this widget has keyboard focus Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyChar ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )
[]
SViewport::IsStereoRenderingAllowed
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Whether or not this viewport supports stereo rendering
Slate
bool IsStereoRenderingAllowed() const
[]
SViewport::OnKeyDown
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called after a key is pressed when this widget has focus (this event bubbles if not handled) Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )
[]
SViewport::OnKeyUp
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called after a key is released when this widget has focus Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )
[]
SViewport::OnMapCursor
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
After OnCursorQuery has specified a cursor type the system asks each widget under the mouse to map that cursor to a widget. This event is bubbled.TOptional<TSharedRef>() if you don't have a mapping otherwise return the Widget to show.
Slate
virtual [TOptional](API\Runtime\Core\IO\TOptional)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > > OnMapCursor ( const [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) & CursorReply ) const
[]
SViewport::OnMotionDetected
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMotionDetected ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FMotionEvent](API\Runtime\SlateCore\Input\FMotionEvent) & InMotionEvent )
[]
SViewport::OnMouseButtonDoubleClick
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when a mouse button is double clicked. Override this in derived classes. Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )
[]
SViewport::OnMouseButtonDown
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SViewport::OnMouseButtonUp
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SViewport::OnMouseEnter
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.
Slate
virtual void OnMouseEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SViewport::OnMouseLeave
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.
Slate
virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SViewport::OnMouseMove
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
The system calls this method to notify the widget that a mouse moved within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SViewport::OnNavigation
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.
Slate
virtual [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) OnNavigation ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FNavigationEvent](API\Runtime\SlateCore\Input\FNavigationEvent) & InNavigationEvent )
[]
SViewport::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint. The maximum layer ID attained by this widget or any of its children.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
SViewport::OnQueryPopupMethod
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
e.g. Fullscreen games cannot summon a new window, so game SViewports will reply with EPopupMethod::UserCurrentWindow. This makes all the menu anchors within them use the current window.
Slate
virtual [FPopupMethodReply](API\Runtime\SlateCore\Input\FPopupMethodReply) OnQueryPopupMethod() const
[]
SViewport::OnQueryShowFocus
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called to determine if we should render the focus brush.
Slate
virtual [TOptional](API\Runtime\Core\IO\TOptional)< bool > OnQueryShowFocus ( const EFocusCause InFocusCause ) const
[]
SViewport::OnTouchEnded
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when a touchpad touch is ended (finger lifted)
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchEnded ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )
[]
SViewport::OnTouchFirstMove
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when a touchpad touch first moves after TouchStarted
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchFirstMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & TouchEvent )
[]
SViewport::OnTouchForceChanged
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when a touchpad touch force changes
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchForceChanged ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & TouchEvent )
[]
SViewport::OnMouseWheel
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when the mouse wheel is spun. This event is bubbled. Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SViewport::OnTouchGesture
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
TOUCH and GESTURES Called when the user performs a gesture on trackpad. This event is bubbled. Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchGesture ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & GestureEvent )
[]
SViewport::OnTouchMoved
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when a touchpad touch is moved (finger moved)
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchMoved ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )
[]
SViewport::OnTouchStarted
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Called when a touchpad touch is started (finger down)
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchStarted ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )
[]
SViewport::OnViewportActivated
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
A delegate called when the viewports top level window is activated
Slate
[FReply](API\Runtime\SlateCore\Input\FReply) OnViewportActivated ( const [FWindowActivateEvent](API\Runtime\SlateCore\Input\FWindowActivateEvent) & InActivateEvent )
[]
SViewport::OnWindowClosed
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
A delegate called when the viewports top level window is being closed
Slate
void OnWindowClosed ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > & InWindowBeingClosed )
[]
SViewport::SetActive
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Sets whether this viewport is active. While active, a persistent Active Timer is registered and a Slate tick/paint pass is guaranteed every frame.
Slate
void SetActive ( bool bActive )
[]
SViewport::SetContent
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Sets the content for this widget
Slate
void SetContent ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )
[]
SViewport::SetCustomHitTestPath
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Slate
void SetCustomHitTestPath ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ICustomHitTestPath](API\Runtime\SlateCore\Input\ICustomHitTestPath) > CustomHitTestPath )
[]
SViewport::SetIgnoreTextureAlpha
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
If true, the viewport's texture alpha is ignored when performing blending. In this case only the viewport tint opacity is used If false, the texture alpha is used during blending
Slate
void SetIgnoreTextureAlpha ( const bool bInIgnoreTextureAlpha )
[]
SViewport::OnViewportDeactivated
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
A delegate called when the viewports top level window is deactivated
Slate
void OnViewportDeactivated ( const [FWindowActivateEvent](API\Runtime\SlateCore\Input\FWindowActivateEvent) & InActivateEvent )
[]
SViewport::SetRenderDirectlyToWindow
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Sets whether this viewport can render directly to the back buffer. Advanced use only
Slate
void SetRenderDirectlyToWindow ( const bool bInRenderDirectlyToWindow )
[]
SViewport::SetViewportInterface
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Sets the interface to be used by this viewport for rendering and I/O
Slate
void SetViewportInterface ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISlateViewport](API\Runtime\SlateCore\Rendering\ISlateViewport) > InViewportInterface )
[]
SViewport::ShouldRenderDirectly
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Whether or not this viewport renders directly to the backbuffer
Slate
bool ShouldRenderDirectly() const
[]
SViewport::SupportsKeyboardFocus
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
SViewportwants keyboard focus
Slate
virtual bool SupportsKeyboardFocus() const
[]
SViewport::Tick
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.
Slate
virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )
[]
SViewport::TranslateMouseCoordinateForCustomHitTestChild
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Slate
virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FVirtualPointerPosition](API\Runtime\SlateCore\Input\FVirtualPointerPosition) > TranslateMouseCoordinateForCustomHitTestChild ( const [SWidget](API\Runtime\SlateCore\Widgets\SWidget) & ChildWidget, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate ) const
[]
SViewport::SViewport
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Default constructor.
Slate
SViewport()
[]
SViewport
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h
Slate
class SViewport : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)
[ { "type": "TWeakPtr<ISlat...", "name": "ViewportInterface", "description": "Interface to the rendering and I/O implementation of the viewport." } ]
SVirtualWindow::ComputeDesiredSize
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
The window's desired size takes into account the ratio between the slate units and the pixel size
Slate
virtual FVector2D ComputeDesiredSize ( float ) const
[]
SVirtualWindow::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\SVirtualWindow\FArguments) & InArgs )
[]
SVirtualWindow::FArguments::Size
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Slate
WidgetArgsType & Size &40; FVector2D InArg &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Slate
typedef FArguments WidgetArgsType
[]
SVirtualWindow::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Slate
FArguments&40;&41;
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< SVirtualWindow >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
SVirtualWindow::OnArrangeChildren
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.
Slate
virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const
[]
SVirtualWindow::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint. The maximum layer ID attained by this widget or any of its children.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
SVirtualWindow::OnQueryPopupMethod
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
e.g. Fullscreen games cannot summon a new window, so game SViewports will reply with EPopupMethod::UserCurrentWindow. This makes all the menu anchors within them use the current window.
Slate
virtual [FPopupMethodReply](API\Runtime\SlateCore\Input\FPopupMethodReply) OnQueryPopupMethod() const
[]
SVirtualWindow::OnVisualizeTooltip
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Called when Slate wants to visualize tooltip. If nobody handles this event, Slate will use default tooltip visualization. If you override this event, you should probably return true. true if this widget visualized the tooltip content; i.e., the event is handled.
Slate
virtual bool OnVisualizeTooltip ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & TooltipContent )
[]
SVirtualWindow::SetIsFocusable
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Slate
void SetIsFocusable ( bool bFocusable )
[]
SVirtualWindow::SetShouldResolveDeferred
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
We allow users to control the resolve policy for deferred content. When a virtual window is used in a retainer, we don't want it trying to resolve the deferred content, we instead need it to pass that content up to the non-retained window drawing the retainer. If a virtual window is used in a case like the WidgetComponent, we always want to resolve the deferred content because there won't be another opportunity since the 3D widget has no owner window that can draw it.
Slate
void SetShouldResolveDeferred ( bool bResolve )
[]
SVirtualWindow::SupportsKeyboardFocus
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Checks to see if this widget supports keyboard focus. Override this in derived classes. True if this widget can take keyboard focus
Slate
virtual bool SupportsKeyboardFocus() const
[]
SVirtualWindow
/Engine/Source/Runtime/Slate/Public/Widgets/SVirtualWindow.h
Slate
class SVirtualWindow : public [SWindow](API\Runtime\SlateCore\Widgets\SWindow)
[]
SWeakWidget::ChildWidgetIsValid
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
bool ChildWidgetIsValid() const
[]
SWeakWidget::ComputeDesiredSize
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation. The desired size.
Slate
virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const
[]
SWeakWidget::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\SWeakWidget\FArguments) & InArgs )
[]
SWeakWidget::FArguments::PossiblyNullContent
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
WidgetArgsType & PossiblyNullContent &40; TSharedPtr< SWidget > InArg &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
typedef FArguments WidgetArgsType
[]
SWeakWidget::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
FArguments&40;&41;
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< SWeakWidget >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
SWeakWidget::GetChildren
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Should be renamed to GetVisibleChildren (not ALL children will be returned in all cases).
Slate
virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()
[]
SWeakWidget::GetChildWidget
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
[TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetChildWidget() const
[]
SWeakWidget::OnArrangeChildren
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.
Slate
virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const
[]
SWeakWidget::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint. The maximum layer ID attained by this widget or any of its children.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
SWeakWidget::SetContent
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
void SetContent ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InWidget )
[]
SWeakWidget::SWeakWidget
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Slate
SWeakWidget()
[]
SWeakWidget
/Engine/Source/Runtime/Slate/Public/Widgets/SWeakWidget.h
Weak widgets encapsulate a piece of content without owning it. e.g. A tooltip is owned by the hovered widget but displayed by a floating window. That window cannot own the tooltip and must therefore use anSWeakWidget.
Slate
class SWeakWidget : public [SWidget](API\Runtime\SlateCore\Widgets\SWidget)
[]
ETextRole::Type
/Engine/Source/Runtime/Slate/Public/Widgets/Text/STextBlock.h
Slate
namespace ETextRole { enum Type { Custom, ButtonText, ComboText, } }
[]
FActiveTextEditContextMenu::Dismiss
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Called to dismiss the active context menu
Slate
void Dismiss()
[]
FActiveTextEditContextMenu::PrepareToSummon
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Called before you summon your context menu
Slate
void PrepareToSummon()
[]
FActiveTextEditContextMenu::Reset
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Called to reset the active context menu state
Slate
void Reset()
[]
FActiveTextEditContextMenu::SummonFailed
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Called if your context menu summon fails
Slate
void SummonFailed()
[]
FActiveTextEditContextMenu::SummonSucceeded
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Called when you've successfully summoned your context menu
Slate
void SummonSucceeded ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > & InMenu )
[]
FActiveTextEditContextMenu::FActiveTextEditContextMenu
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Slate
FActiveTextEditContextMenu()
[]
FActiveTextEditContextMenu::IsValid
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Check to see whether this context is valid (either pending or active)
Slate
bool IsValid() const
[]
FActiveTextEditContextMenu
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Manages the state for an active context menu
Slate
class FActiveTextEditContextMenu
[]
FCursorInfo::CreateUndo
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Create an undo for this cursor data
Slate
[FCursorInfo](API\Runtime\Slate\Widgets\Text\FCursorInfo) CreateUndo() const
[]
FCursorInfo::GetCursorAlignment
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Get the alignment of the cursor
Slate
[ECursorAlignment](API\Runtime\Slate\Widgets\Text\SlateEditableTextTypes__ECursorA-) GetCursorAlignment() const
[]
FCursorInfo::GetCursorInteractionLocation
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Get the interaction position of the cursor (where to insert, delete, etc, text from/to)
Slate
[FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) GetCursorInteractionLocation() const
[]
FCursorInfo::GetCursorLocation
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Get the literal position of the cursor (note: this may not be the correct place to insert text to, use GetCursorInteractionLocation for that)
Slate
[FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) GetCursorLocation() const
[]
FCursorInfo::GetCursorTextDirection
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Get the direction of the text under the cursor
Slate
[TextBiDi::ETextDirection](API\Runtime\Core\Internationalization\TextBiDi__ETextDirection) GetCursorTextDirection() const
[]
FCursorInfo::GetLastCursorInteractionTime
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Slate
double GetLastCursorInteractionTime() const
[]
FCursorInfo::RestoreFromUndo
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Restore this cursor data from an undo
Slate
void RestoreFromUndo ( const [FCursorInfo](API\Runtime\Slate\Widgets\Text\FCursorInfo) & UndoData )
[]
FCursorInfo::SetCursorLocationAndAlignment
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Set the literal position and alignment of the cursor
Slate
void SetCursorLocationAndAlignment ( const [FTextLayout](API\Runtime\Slate\Framework\Text\FTextLayout) & InTextLayout, const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InCursorPosition, const [ECursorAlignment](API\Runtime\Slate\Widgets\Text\SlateEditableTextTypes__ECursorA-) InCursorAlignment )
[]
FCursorInfo::SetCursorLocationAndCalculateAlignment
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Set the position of the cursor, and then work out the correct alignment based on the current text layout
Slate
void SetCursorLocationAndCalculateAlignment ( const [FTextLayout](API\Runtime\Slate\Framework\Text\FTextLayout) & InTextLayout, const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InCursorPosition )
[]
FCursorInfo::UpdateLastCursorInteractionTime
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Update the last cursor interaction time to now
Slate
void UpdateLastCursorInteractionTime()
[]
FCursorInfo::FCursorInfo
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Slate
FCursorInfo()
[]
FCursorInfo
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Store the information about the current cursor position
Slate
class FCursorInfo
[]
FCursorLineHighlighter::Create
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FCursorLineHighlighter](API\Runtime\Slate\Widgets\Text\FCursorLineHighlighter) > Create ( const [FCursorInfo](API\Runtime\Slate\Widgets\Text\FCursorInfo) * InCursorInfo )
[]
FCursorLineHighlighter::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FTextLayout::FLineView](API\Runtime\Slate\Framework\Text\FTextLayout\FLineView) & Line, const float OffsetX, const float Width, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & DefaultStyle, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
FCursorLineHighlighter::SetCursorBrush
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Slate
void SetCursorBrush ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & InCursorBrush )
[]
FCursorLineHighlighter
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Run highlighter used to draw the cursor
Slate
class FCursorLineHighlighter : public [ISlateLineHighlighter](API\Runtime\Slate\Framework\Text\ISlateLineHighlighter)
[ { "type": "TAttribute< con...", "name": "CursorBrush", "description": "Brush used to draw the cursor" }, { "type": "constFCursorIn...", "name": "CursorInfo", "description": "Cursor data that this highlighter is tracking" } ]
FCursorLineHighlighter::FCursorLineHighlighter
/Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextTypes.h
Slate
FCursorLineHighlighter ( const [FCursorInfo](API\Runtime\Slate\Widgets\Text\FCursorInfo) * InCursorInfo )
[]
FMoveCursor::Cardinal
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Creates a MoveCursor action that describes moving by a single character in any of the cardinal directions.
Slate
static [FMoveCursor](API\Runtime\Slate\Widgets\Text\FMoveCursor) Cardinal ( ECursorMoveGranularity Granularity, FIntPoint Direction, ECursorAction Action )
[]
FMoveCursor::GetAction
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
ECursorAction
Slate
ECursorAction GetAction() const
[]
FMoveCursor::GetGeometryScale
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Geometry Scale at the time of the event that caused this action
Slate
float GetGeometryScale() const
[]
FMoveCursor::GetMoveDirection
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
When using directional movement (i.e. Character or Word granularity; not screen position, which way to move.)
Slate
FIntPoint GetMoveDirection() const
[]
FMoveCursor::GetLocalPosition
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Which position in the widget where the user touched when using ScreenPosition mode.
Slate
FVector2D GetLocalPosition() const
[]
FMoveCursor::GetGranularity
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Move one character at a time, or one word?
Slate
ECursorMoveGranularity GetGranularity() const
[]
FMoveCursor::GetMoveMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
ECursorMoveMethod
Slate
ECursorMoveMethod GetMoveMethod() const
[]
FMoveCursor::IsHorizontalMovement
/Engine/Source/Runtime/Slate/Public/Widgets/Text/ISlateEditableTextWidget.h
Is the cursor moving left/right; Only valid for word and character movement methods.
Slate
bool IsHorizontalMovement() const
[]