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
|
|---|---|---|---|---|---|
SWidget::GetRelativeLayoutScale | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Deprecated* GetRelativeLayoutScale(int32 ChildIndex, float LayoutScaleMultiplier), your widget will also need to set bHasRelativeLayoutScale in their Construct/ctor. | SlateCore | virtual float GetRelativeLayoutScale ( const [FSlotBase](API\Runtime\SlateCore\FSlotBase) & Child, float LayoutScaleMultiplier ) const | [] |
SWidget::GetRelativeLayoutScale | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | What is the Child's scale relative to this widget. | SlateCore | virtual float GetRelativeLayoutScale ( const int32 ChildIndex, float LayoutScaleMultiplier ) const | [] |
SWidget::GetRenderOpacity | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | the render opacity of the widget. | SlateCore | FORCEINLINE float GetRenderOpacity() const | [] |
SWidget::GetRenderTransformWithRespectToFlowDirection | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | FORCEINLINE[TOptional](API\Runtime\Core\IO\TOptional)< FSlateRenderTransform > GetRenderTransformWithRespectToFlowDirection() const | [] |
|
SWidget::GetRenderTransform | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | the render transform of the widget. | SlateCore | FORCEINLINE const [TOptional](API\Runtime\Core\IO\TOptional)< FSlateRenderTransform > & GetRenderTransform() const | [] |
SWidget::GetRenderTransformPivotWithRespectToFlowDirection | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | FORCEINLINE[UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) GetRenderTransformPivotWithRespectToFlowDirection() const | [] |
|
SWidget::GetRenderTransformAttribute | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | an attribute reference of RenderTransformAttribute | SlateCore | [TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< [TOptional](API\Runtime\Core\IO\TOptional)< FSlateRenderTransform > > GetRenderTransformAttribute() const | [] |
SWidget::GetProxyHandle | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | const [FWidgetProxyHandle](API\Runtime\SlateCore\FastUpdate\FWidgetProxyHandle) GetProxyHandle() const | [] |
|
SWidget::GetRenderTransformPivot | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | the pivot point of the render transform. | SlateCore | FORCEINLINE[UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) GetRenderTransformPivot() const | [] |
SWidget::GetRenderTransformPivotAttribute | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | an attribute reference of RenderTransformPivotAttribute | SlateCore | [TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< FVector2D > GetRenderTransformPivotAttribute() const | [] |
SWidget::GetStatID | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | FORCEINLINE[TStatId](API\Runtime\Core\Stats\TStatId) GetStatID() const | [] |
|
SWidget::GetTag | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | The name this widget was tagged with | SlateCore | virtual [FName](API\Runtime\Core\UObject\FName) GetTag() const | [] |
SWidget::GetTickSpaceGeometry | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | We recommend not to use this data unless there's no other way to solve your problem. Normally in Slate we try and handle these issues by making a dependent widget part of the hierarchy, as to avoid frame behind or what are referred to as hysteresis problems, both caused by depending on geometry from the previous frame being used to advise how to layout a dependent object the current frame. | SlateCore | const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & GetTickSpaceGeometry() const | [] |
SWidget::GetToolTip | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | The tool tip associated with this widget; Invalid reference if there is not one | SlateCore | virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IToolTip](API\Runtime\SlateCore\Widgets\IToolTip) > GetToolTip() | [] |
SWidget::GetType | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | The widget's type as anFNameID | SlateCore | [FName](API\Runtime\Core\UObject\FName) GetType() const | [] |
SWidget::GetTypeAsString | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | A String of the widget's type | SlateCore | [FString](API\Runtime\Core\Containers\FString) GetTypeAsString() const | [] |
SWidget::GetVisibility | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | This widget can be visible but if a parent is hidden or collapsed, it would not show on screen.
is this widget visible, hidden or collapsed. | SlateCore | FORCEINLINE[EVisibility](API\Runtime\SlateCore\Layout\EVisibility) GetVisibility() const | [] |
SWidget::GetVisibilityAttribute | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | an attribute reference of VisibilityAttribute | SlateCore | [TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) > GetVisibilityAttribute() const | [] |
SWidget::GetWindowZoneOverride | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when the mouse is moved over the widget's window, to determine if we should report whether OS-specific features should be active at this location (such as a title bar grip, system menu, etc.) Usually you should not need to override this function.
The window "zone" the cursor is over, orEWindowZone::Unspecifiedif no special behavior is needed | SlateCore | virtual [EWindowZone::Type](API\Runtime\ApplicationCore\GenericPlatform\EWindowZone__Type) GetWindowZoneOverride() const | [] |
SWidget::HasActiveTimers | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Does this widget have any active timers? | SlateCore | bool HasActiveTimers() const | [] |
SWidget::HasAnyUpdateFlags | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | bool HasAnyUpdateFlags ( EWidgetUpdateFlags FlagsToCheck ) const | [] |
|
SWidget::HasAnyUserFocus | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Gets whether or not any users have this widget focused, and if so the type of focus (first one found).
The optional will be set with the focus cause, if unset this widget doesn't have focus. | SlateCore | [TOptional](API\Runtime\Core\IO\TOptional)< EFocusCause > HasAnyUserFocus() const | [] |
SWidget::HasAnyUserFocusOrFocusedDescendants | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | whether or not any users have this widget focused, or any descendant focused. | SlateCore | bool HasAnyUserFocusOrFocusedDescendants() const | [] |
SWidget::HasFocusedDescendants | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Whether this widget has any descendants with keyboard focus | SlateCore | bool HasFocusedDescendants() const | [] |
SWidget::HasKeyboardFocus | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Checks to see if this widget currently has the keyboard focus
True if this widget has keyboard focus | SlateCore | virtual bool HasKeyboardFocus() const | [] |
SWidget::HasMouseCapture | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Checks to see if this widget is the current mouse captor
True if this widget has captured the mouse | SlateCore | bool HasMouseCapture() const | [] |
SWidget::HasMouseCaptureByUser | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Checks to see if this widget has mouse capture from the provided user.
True if this widget has captured the mouse | SlateCore | bool HasMouseCaptureByUser ( int32 UserIndex, [TOptional](API\Runtime\Core\IO\TOptional)< int32 > PointerIndex ) const | [] |
SWidget::HasRegisteredSlateAttribute | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | true if the widgets has any bound slate attribute. | SlateCore | bool HasRegisteredSlateAttribute() const | [] |
SWidget::HasToolTipForceField | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | True if a tool tip force field is active on this widget | SlateCore | bool HasToolTipForceField() const | [] |
SWidget::HasUserFocus | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Gets whether or not the specified users has this widget focused, and if so the type of focus.
The optional will be set with the focus cause, if unset this widget doesn't have focus. | SlateCore | [TOptional](API\Runtime\Core\IO\TOptional)< EFocusCause > HasUserFocus ( int32 UserIndex ) const | [] |
SWidget::HasUserFocusedDescendants | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Gets whether or not the specified users has this widget or any descendant focused.
The optional will be set with the focus cause, if unset this widget doesn't have focus. | SlateCore | bool HasUserFocusedDescendants ( int32 UserIndex ) const | [] |
SWidget::InvalidateChildRemovedFromTree | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when a child is removed from the tree parent's widget tree either by removing it from a slot. This can also be called manually if you've got some non-slot based what of no longer reporting children An example of a widget that needs manual calling isSWidgetSwitcher. It keeps all its children but only arranges and paints a single "active" one. Once a child becomes inactive, its cached data should be removed. | SlateCore | void InvalidateChildRemovedFromTree ( [SWidget](API\Runtime\SlateCore\Widgets\SWidget) & Child ) | [] |
SWidget::Invalidate | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass. | SlateCore | void Invalidate ( EInvalidateWidgetReason InvalidateReason ) | [] |
SWidget::IsAccessible | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Whether this widget is considered accessible or not. A widget is accessible if its behavior is set to something other than NotAccessible, and all of its parent widgets support accessible children.
true if an accessible widget should be created for this widget. | SlateCore | bool IsAccessible() const | [] |
SWidget::InvalidatePrepass | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Deprecated* InvalidatePrepass is deprecated. Use the Invalidate(EInvalidateWidgetReason::Prepass) or useMarkPrepassAsDirty() | SlateCore | void InvalidatePrepass() | [] |
SWidget::IsAttributesUpdatesEnabled | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | true if the widgets will update its registered slate attributes automatically or they need to be updated manually. | SlateCore | bool IsAttributesUpdatesEnabled() const | [] |
SWidget::IsChildWidgetCulled | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Tests if an arranged widget should be culled. | SlateCore | bool IsChildWidgetCulled ( const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, const [FArrangedWidget](API\Runtime\SlateCore\Layout\FArrangedWidget) & ArrangedChild ) const | [] |
SWidget::IsChildWidgetCulled | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | FORCEINLINEbool IsChildWidgetCulled ( const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) &, const [FArrangedWidget](API\Runtime\SlateCore\Layout\FArrangedWidget) & ) const | [] |
|
SWidget::IsConstructed | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Is the widget construction completed (did we called and returned from theConstruct()function) | SlateCore | bool IsConstructed() const | [] |
SWidget::IsDirectlyHovered | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | True if this widget is directly hovered | SlateCore | bool IsDirectlyHovered() const | [] |
SWidget::IsEnabled | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Whether or not this widget is enabled | SlateCore | FORCEINLINEbool IsEnabled() const | [] |
SWidget::IsFastPathVisible | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Only valid if the widget is contained by an InvalidationRoot (the proxy is valid).
is the widget visible and its parents also visible. | SlateCore | bool IsFastPathVisible() const | [] |
SWidget::IsHovered | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | IsHovered used to be virtual. Use SetHover to assign an attribute if you need to override the default behavior.
True if this widget hovered | SlateCore | bool IsHovered() const | [] |
SWidget::IsInteractable | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Is this widget interactive or not? Defaults to false | SlateCore | virtual bool IsInteractable() const | [] |
SWidget::IsParentValid | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | FORCEINLINEbool IsParentValid() const | [] |
|
SWidget::IsVolatile | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Whether or not a widget is volatile and will update every frame without being invalidated | SlateCore | FORCEINLINEbool IsVolatile() const | [] |
SWidget::IsVolatileIndirectly | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | only valid if the widget is contained by an InvalidationRoot (the proxy is valid). | SlateCore | FORCEINLINEbool IsVolatileIndirectly() const | [] |
SWidget::MarkPrepassAsDirty | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | In fast path, if the widget is mark, do a full Prepass on its next update to calculate it's desired size. This does not invalidate the widget. | SlateCore | void MarkPrepassAsDirty() | [] |
SWidget::NeedsPrepass | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | LAYOUT | SlateCore | bool NeedsPrepass() const | [] |
SWidget::OnAnalogValueChanged | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when an analog value changes on a button that supports analog
Returns whether the event was handled, along with other possible actions | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnAnalogValueChanged ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FAnalogInputEvent](API\Runtime\SlateCore\Input\FAnalogInputEvent) & InAnalogInputEvent ) | [] |
SWidget::OnClippingChanged | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when clipping is changed. Should be used to forward clipping states onto potentially hidden children that actually are responsible for clipping the content. | SlateCore | virtual void OnClippingChanged() | [] |
SWidget::OnArrangeChildren | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | void OnArrangeChildren &40; const FGeometry & AllottedGeometry, FArrangedChildren & ArrangedChildren &41; const | [] |
SWidget::OnCursorQuery | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | The system asks each widget under the mouse to provide a cursor. This event is bubbled.FCursorReply::Unhandled()if the event is not handled; returnFCursorReply::Cursor()otherwise. | SlateCore | virtual [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) OnCursorQuery ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & CursorEvent ) const | [] |
SWidget::OnDragDetected | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when Slate detects that a widget started to be dragged. Usage: A widget can ask Slate to detect a drag. OnMouseDown() reply withFReply::Handled().DetectDrag( SharedThis(this) ). Slate will either send anOnDragDetected()event or do nothing. If the user releases a mouse button or leaves the widget before a drag is triggered (maybe user started at the very edge) then no event will be sent. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragDetected ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnDragEnter | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | The concession is to return a can_handled/cannot_handle boolean rather than a fullFReply.
A reply that indicated whether the contents of the DragDropEvent can potentially be processed by this widget. | SlateCore | virtual void OnDragEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SWidget::OnDragLeave | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called during drag and drop when the drag leaves a widget. | SlateCore | virtual void OnDragLeave ( const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SWidget::OnDragOver | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called during drag and drop when the the mouse is being dragged over a widget.
A reply that indicated whether this event was handled. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragOver ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SWidget::OnDrop | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when the user is dropping something onto a widget; terminates drag and drop.
A reply that indicated whether this event was handled. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDrop ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent ) | [] |
SWidget::OnFinishedKeyInput | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | All the key (keyboard, gamepay, joystick, etc.) input from this frame has been routed. This is a widget's chance to act on any accumulated data. | SlateCore | virtual void OnFinishedKeyInput() | [] |
SWidget::OnFinishedPointerInput | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | All the pointer (mouse, touch, stylus, etc.) events from this frame have been routed. This is a widget's chance to act on any accumulated data. | SlateCore | virtual void OnFinishedPointerInput() | [] |
SWidget::OnFocusChanging | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called whenever a focus path is changing on all the widgets within the old and new focus paths | SlateCore | virtual void OnFocusChanging ( const [FWeakWidgetPath](API\Runtime\SlateCore\Layout\FWeakWidgetPath) & PreviousFocusPath, const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & NewWidgetPath, const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent ) | [] |
SWidget::OnFocusLost | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when this widget loses focus. This event does not bubble. | SlateCore | virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent ) | [] |
SWidget::OnFocusReceived | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | KEY INPUT Called when focus is given to this widget. This event does not bubble.
Returns whether the event was handled, along with other possible actions | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnFocusReceived ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent ) | [] |
SWidget::OnKeyChar | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called after a character is entered while this widget has keyboard focus
Returns whether the event was handled, along with other possible actions | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyChar ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent ) | [] |
SWidget::OnKeyDown | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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 | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent ) | [] |
SWidget::OnKeyUp | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called after a key is released when this widget has focus
Returns whether the event was handled, along with other possible actions | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent ) | [] |
SWidget::OnMapCursor | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | 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 | [] |
SWidget::OnMotionDetected | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMotionDetected ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FMotionEvent](API\Runtime\SlateCore\Input\FMotionEvent) & InMotionEvent ) | [] |
SWidget::OnMouseButtonDoubleClick | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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 | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent ) | [] |
SWidget::OnMouseButtonUp | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnMouseCaptureLost | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when this widget had captured the mouse, but that capture has been revoked for some reason. | SlateCore | void OnMouseCaptureLost() | [] |
SWidget::OnMouseCaptureLost | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when this widget had captured the mouse, but that capture has been revoked for some reason. | SlateCore | virtual void OnMouseCaptureLost ( const [FCaptureLostEvent](API\Runtime\SlateCore\Input\FCaptureLostEvent) & CaptureLostEvent ) | [] |
SWidget::OnMouseEnter | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | virtual void OnMouseEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnMouseLeave | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnMouseMove | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnMouseWheel | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when the mouse wheel is spun. This event is bubbled.
Returns whether the event was handled, along with other possible actions | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnNavigation | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events. | SlateCore | virtual [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) OnNavigation ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FNavigationEvent](API\Runtime\SlateCore\Input\FNavigationEvent) & InNavigationEvent ) | [] |
SWidget::OnMouseButtonDown | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnPaint | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | 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 | [] |
SWidget::OnPreviewKeyDown | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | This event is primarily to allow parent widgets to consume an event before a child widget processes it and it should be used only when there is no better design alternative.
Returns whether the event was handled, along with other possible actions | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnPreviewKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent ) | [] |
SWidget::OnPreviewMouseButtonDown | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Use this event sparingly as preview events generally make UIs more difficult to reason about. | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnPreviewMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) | [] |
SWidget::OnQueryPopupMethod | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | virtual [FPopupMethodReply](API\Runtime\SlateCore\Input\FPopupMethodReply) OnQueryPopupMethod() const | [] |
SWidget::OnQueryShowFocus | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called to determine if we should render the focus brush. | SlateCore | virtual [TOptional](API\Runtime\Core\IO\TOptional)< bool > OnQueryShowFocus ( const EFocusCause InFocusCause ) const | [] |
SWidget::OnToolTipClosing | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when a tooltip displayed from this widget is being closed | SlateCore | virtual void OnToolTipClosing() | [] |
SWidget::OnTouchEnded | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when a touchpad touch is ended (finger lifted) | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchEnded ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent ) | [] |
SWidget::OnTouchFirstMove | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when a touchpad touch first moves after TouchStarted | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchFirstMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & TouchEvent ) | [] |
SWidget::OnTouchForceChanged | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when a touchpad touch force changes | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchForceChanged ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & TouchEvent ) | [] |
SWidget::OnTouchGesture | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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 | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchGesture ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & GestureEvent ) | [] |
SWidget::OnTouchMoved | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when a touchpad touch is moved (finger moved) | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchMoved ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent ) | [] |
SWidget::OnTouchStarted | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Called when a touchpad touch is started (finger down) | SlateCore | virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchStarted ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent ) | [] |
SWidget::OnVisualizePopup | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Visualize a new pop-up if possible. If it's not possible for this widget to host the pop-up content you'll get back an invalid pointer to the layer. The returnedFPopupLayerallows you to remove the pop-up when you're done with it
a validFPopupLayerif this widget supported hosting it. You can call Remove() on this to destroy the pop-up. | SlateCore | virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPopupLayer](API\Runtime\SlateCore\Widgets\FPopupLayer) > OnVisualizePopup ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & PopupContent ) | [] |
SWidget::OnVisualizeTooltip | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.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. | SlateCore | virtual bool OnVisualizeTooltip ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & TooltipContent ) | [] |
SWidget::Paint | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
The maximum layer ID attained by this widget or any of its children. | SlateCore | int32 Paint ( 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 | [] |
SWidget::Prepass_ChildLoop | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | void Prepass_ChildLoop ( float InLayoutScaleMultiplier, [FChildren](API\Runtime\SlateCore\Layout\FChildren) * MyChildren ) | [] |
|
SWidget::RegisterActiveTimer | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Slate may go to sleep when there is no user interaction for some time to save power. However, some UI elements may need to "drive" the UI even when the user is not providing any input (ie, animations, viewport rendering, async polling, etc). A widget notifies Slate of this by registering an "Active Timer" that is executed at a specified frequency to drive the UI. In this way, slate can go to sleep when there is no input and no active timer needs to fire. When any active timer needs to fire, all of Slate will do a Tick and Paint pass.
An active timer handle that can be used to UnRegister later. | SlateCore | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FActiveTimerHandle > RegisterActiveTimer ( float TickPeriod, FWidgetActiveTimerDelegate TickFunction ) | [] |
SWidget::RemoveMetaData | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | SlateCore | template<typename MetaDataType> bool RemoveMetaData() | [] |
|
SWidget::RemoveMetaData | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Remove metadata to this widget.
Number of removed elements. | SlateCore | template<typename MetaDataType> int32 RemoveMetaData ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< MetaDataType > & RemoveMe ) | [] |
SWidget::SetAttribute | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Performs the attribute assignment and invalidates the widget minimally based on what actually changed. So if the boundness of the attribute didn't change volatility won't need to be recalculated. Returns true if the value changed. | SlateCore | template<typename TargetValueType, typename SourceValueType> bool SetAttribute ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< TargetValueType > & TargetValue, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< SourceValueType > & SourceValue, EInvalidateWidgetReason BaseInvalidationReason ) | [] |
SWidget::SetAccessibleBehavior | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Set a new accessible behavior, and if the behavior is custom, new accessible text to go along with it. | SlateCore | void SetAccessibleBehavior ( EAccessibleBehavior InBehavior, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InText, EAccessibleType AccessibleType ) | [] |
SWidget::SetCanChildrenBeAccessible | /Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h | Sets whether children are allowed to be accessible or not. Warning: Calling this function after accessibility is enabled will cause the accessibility tree to become unsynced. | SlateCore | void SetCanChildrenBeAccessible ( bool InCanChildrenBeAccessible ) | [] |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.