|
Module |
|
|
Header |
/Engine/Source/Runtime/SlateCore/Public/Widgets/SWidget.h |
|
Include |
#include "Widgets/SWidget.h" |
class SWidget :
public FSlateControlledConstruction,
public TSharedFromThis< SWidget >
Abstract base class for Slate widgets.
DO NOT INHERIT DIRECTLY FROM WIDGET!
Inheritance: Widget is not meant to be directly inherited. Instead consider inheriting from LeafWidget or Panel, which represent intended use cases and provide a succinct set of methods which to override.
SWidget is the base class for all interactive Slate entities. SWidget's public interface describes everything that a Widget can do and is fairly complex as a result.
Events: Events in Slate are implemented as virtual functions that the Slate system will call on a Widget in order to notify the Widget about an important occurrence (e.g. a key press) or querying the Widget regarding some information (e.g. what mouse cursor should be displayed).
Widget provides a default implementation for most events; the default implementation does nothing and does not handle the event.
Some events are able to reply to the system by returning an FReply, FCursorReply, or similar object.
| Name | Description | ||
|---|---|---|---|
|
|
AccessibleBehavior |
||
|
|
AccessibleSummaryBehavior |
||
|
|
uint8: 1 |
bCanChildrenBeAccessible |
All variables surrounding how this widget is exposed to the platform's accessibility API. |
|
|
uint8: 1 |
bCanHaveChildren |
Can the widget ever support children? This will be false on SLeafWidgets, rather than setting this directly, you should probably inherit from SLeafWidget. |
|
|
uint8: 1 |
bCanSupportFocus |
Can the widget ever support keyboard focus |
|
|
uint8: 1 |
bClippingProxy |
Some widgets might be a complex hierarchy of child widgets you never see. |
|
|
uint8: 1 |
bHasCustomPrepass |
|
|
|
uint8: 1 |
bHasRelativeLayoutScale |
|
|
|
uint8: 1 |
bIsHovered |
Is this widget hovered? |
|
|
uint8: 1 |
bVolatilityAlwaysInvalidatesPrepass |
If this widget should always invalidate the prepass step when volatile |
|
|
Clipping |
Set to true if all content of the widget should clip to the bounds of this widget. |
|
|
|
CullingBoundsExtension |
Can be used to enlarge the culling bounds of this widget (pre-intersection), this can be useful if you've got children that you know are using rendering transforms to render outside their standard bounds, if that happens it's possible the parent might be culled before the descendant widget is entirely off screen. |
|
|
|
TAttribute< boo... |
EnabledState |
Whether or not this widget is enabled |
|
|
TOptional< floa... |
PrepassLayoutScaleMultiplier |
|
|
|
float |
RenderOpacity |
The opacity of the widget. Automatically applied during rendering. |
|
|
TAttribute< TOp... |
RenderTransform |
Render transform of this widget. |
|
|
TAttribute< FVe... |
RenderTransformPivot |
Render transform pivot of this widget (in normalized local space) |
|
|
TAttribute< EVi... |
Visibility |
Is this widget visible, hidden or collapsed |
| Name | Description | |
|---|---|---|
|
|
SWidget() |
Hidden default constructor. Use SNew(WidgetClassName) to instantiate new widgets. |
| Name | Description | |
|---|---|---|
|
|
~SWidget() |
Dtor ensures that active timer handles are UnRegistered with the SlateApplication. |
| Name | Description | ||
|---|---|---|---|
|
|
const TAttri... |
AccessWidgetVisibilityAttribute ( |
Protected static helper to allow widgets to access the visibility attribute of other widgets directly |
|
|
AddMetadata ( |
Add metadata to this widget. |
|
|
|
const FSlate... |
Advanced_AsInvalidationRoot() |
|
|
|
FORCEINLINET... |
Advanced_GetPaintParentWidget() |
|
|
|
FORCEINLINEb... |
Advanced_InvalidateVolatility() |
Recalculates and caches volatility and returns 'true' if the volatility changed. |
|
|
Advanced_IsInvalidationRoot() |
||
|
|
Advanced_IsWindow() |
Is this widget derivative of SWindow |
|
|
|
ArrangeChildren ( |
Non-virtual entry point for arrange children. |
|
|
|
AssignParentWidget ( |
||
|
|
CacheDesiredSize ( |
The system calls this method. |
|
|
|
FORCEINLINEv... |
CacheVolatility() |
Recalculates volatility of the widget and caches the result. |
|
|
CalculateCullingAndClippingRules ( |
Calculates what if any clipping state changes need to happen when drawing this widget. |
|
|
|
CanChildrenBeAccessible() |
Checks whether this widget allows its children to be accessible or not. |
|
|
|
ComputeDesiredSize ( |
Compute the ideal size necessary to display this widget. |
|
|
|
EFlowDirecti... |
ComputeFlowDirection() |
Establishes a new flow direction potentially, if this widget has a particular preference for it and all its children. |
|
|
ComputeVolatility() |
Recomputes the volatility of the widget. |
|
|
|
ConditionallyDetatchParentWidget ( |
||
|
|
TSharedRef< ... |
CreateAccessibleWidget() |
|
|
|
CustomPrepass ( |
||
|
|
Debug_GetLastPaintFrame() |
||
|
|
EnableToolTipForceField ( |
Sets whether this widget is a "tool tip force field". |
|
|
|
FindChildGeometries ( |
Find the geometry of a descendant widget. |
|
|
|
FindChildGeometries_Helper ( |
Actual implementation of FindChildGeometries. |
|
|
|
FindChildGeometry ( |
Find the geometry of a descendant widget. |
|
|
|
FindChildUnderMouse ( |
||
|
|
FindChildUnderPosition ( |
||
|
|
FORCEINLINEv... |
ForceVolatile ( |
Should this widget always appear as volatile for any layout caching host widget. |
|
|
EAccessibleB... |
GetAccessibleBehavior ( |
Get the behavior describing how the accessible text of this widget should be retrieved. |
|
|
GetAccessibleSummary() |
Traverse all child widgets and concat their results of GetAccessibleText(Summary). |
|
|
|
GetAccessibleText ( |
Get the text that should be reported to the user when attempting to access this widget. |
|
|
|
FChildren &#... |
GetAllChildren() |
|
|
|
GetAllMetaData() |
Get all metadata of the type provided. |
|
|
|
GetCanTick() |
||
|
|
FChildren &#... |
GetChildren() |
Every widget that has children must implement this method. |
|
|
FORCEINLINEE... |
GetClipping() |
|
|
|
GetCreatedInLocation() |
||
|
|
FORCEINLINEF... |
GetCullingBoundsExtension() |
|
|
|
const TOptio... |
GetCurrentClippingState() |
Returns the clipping state to clip this widget against its parent |
|
|
GetCursor() |
The cursor to show when the mouse is hovering over this widget. |
|
|
|
GetDefaultAccessibleText ( |
Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom. |
|
|
|
GetDesiredSize() |
||
|
|
EFlowDirecti... |
GetFlowDirectionPreference() |
Gets the desired flow direction for the layout. |
|
|
const FSlate... |
GetFocusBrush() |
|
|
|
GetForegroundColor() |
||
|
|
GetId() |
||
|
|
TSharedPtr< ... |
GetMetaData() |
Get the metadata of the type provided. |
|
|
const FGeome... |
GetPaintSpaceGeometry() |
Gets the last geometry used to Tick the widget. |
|
|
FORCEINLINET... |
GetParentWidget() |
|
|
|
const FSlate... |
GetPersistentState() |
|
|
|
float |
GetPrepassLayoutScaleMultiplier() |
|
|
|
const FWidge... |
GetProxyHandle() |
|
|
|
GetReadableLocation() |
||
|
|
float |
GetRelativeLayoutScale ( |
What is the Child's scale relative to this widget. |
|
|
FORCEINLINE ... |
GetRenderOpacity() |
|
|
|
FORCEINLINE ... |
GetRenderTransform() |
|
|
|
FORCEINLINEF... |
GetRenderTransformPivot() |
|
|
|
FORCEINLINEF... |
GetRenderTransformPivotWithRespectToFlowDirection() |
|
|
|
FORCEINLINET... |
GetRenderTransformWithRespectToFlowDirection() |
|
|
|
FORCEINLINET... |
GetStatID() |
|
|
|
GetTag() |
||
|
|
const FGeome... |
GetTickSpaceGeometry() |
Gets the last geometry used to Tick the widget. |
|
|
TSharedPtr< ... |
GetToolTip() |
|
|
|
GetType() |
||
|
|
GetTypeAsString() |
||
|
|
FORCEINLINEE... |
GetVisibility() |
This widget can be visible but if a parent is hidden or collapsed, it would not show on screen. |
|
|
EWindowZone:... |
GetWindowZoneOverride() |
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. |
|
|
HasActiveTimers() |
Does this widget have any active timers? |
|
|
|
HasAnyUpdateFlags ( |
||
|
|
HasAnyUserFocus() |
Gets whether or not any users have this widget focused, and if so the type of focus (first one found). |
|
|
|
HasAnyUserFocusOrFocusedDescendants() |
||
|
|
HasFocusedDescendants() |
||
|
|
HasKeyboardFocus() |
Checks to see if this widget currently has the keyboard focus |
|
|
|
HasMouseCapture() |
Checks to see if this widget is the current mouse captor |
|
|
|
HasMouseCaptureByUser |
Checks to see if this widget has mouse capture from the provided user. |
|
|
|
HasToolTipForceField() |
||
|
|
HasUserFocus ( |
Gets whether or not the specified users has this widget focused, and if so the type of focus. |
|
|
|
HasUserFocusedDescendants ( |
Gets whether or not the specified users has this widget or any descendant focused. |
|
|
|
Invalidate ( |
Invalidates the widget from the view of a layout caching widget that may own this widget. |
|
|
|
InvalidateChildRemovedFromTree ( |
Called when a child is removed from the tree parent's widget tree either by removing it from a slot. |
|
|
|
InvalidatePrepass() |
||
|
|
IsAccessible() |
Whether this widget is considered accessible or not. |
|
|
|
FORCEINLINEb... |
IsChildWidgetCulled ( |
|
|
|
IsChildWidgetCulled ( |
Tests if an arranged widget should be culled. |
|
|
|
IsDirectlyHovered() |
||
|
|
FORCEINLINEb... |
IsEnabled() |
|
|
|
IsFastPathVisible() |
||
|
|
IsHovered() |
||
|
|
IsInteractable() |
||
|
|
FORCEINLINEb... |
IsParentValid() |
|
|
|
FORCEINLINEb... |
IsVolatile() |
Whether or not a widget is volatile and will update every frame without being invalidated |
|
|
FORCEINLINEb... |
IsVolatileIndirectly() |
This widget is volatile because its parent or some ancestor is volatile @note only valid if the widget is contained by an InvalidationRoot (the proxy is valid). |
|
|
NeedsPrepass() |
LAYOUT |
|
|
|
OnAnalogValueChanged ( |
Called when an analog value changes on a button that supports analog |
|
|
|
OnClippingChanged() |
Called when clipping is changed. |
|
|
|
OnCursorQuery ( |
The system asks each widget under the mouse to provide a cursor. This event is bubbled. |
|
|
|
OnDragDetected ( |
Called when Slate detects that a widget started to be dragged. |
|
|
|
OnDragEnter ( |
DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget. |
|
|
|
OnDragLeave ( |
Called during drag and drop when the drag leaves a widget. |
|
|
|
OnDragOver ( |
Called during drag and drop when the the mouse is being dragged over a widget. |
|
|
|
OnDrop ( |
Called when the user is dropping something onto a widget; terminates drag and drop. |
|
|
|
OnFinishedKeyInput() |
All the key (keyboard, gamepay, joystick, etc.) input from this frame has been routed. |
|
|
|
OnFinishedPointerInput() |
All the pointer (mouse, touch, stylus, etc.) events from this frame have been routed. |
|
|
|
OnFocusChanging ( |
Called whenever a focus path is changing on all the widgets within the old and new focus paths |
|
|
|
OnFocusLost ( |
Called when this widget loses focus. This event does not bubble. |
|
|
|
OnFocusReceived ( |
KEY INPUT Called when focus is given to this widget. This event does not bubble. |
|
|
|
OnKeyChar ( |
Called after a character is entered while this widget has keyboard focus |
|
|
|
OnKeyDown |
Called after a key is pressed when this widget has focus (this event bubbles if not handled) |
|
|
|
OnKeyUp |
Called after a key is released when this widget has focus |
|
|
|
OnMapCursor ( |
After OnCursorQuery has specified a cursor type the system asks each widget under the mouse to map that cursor to a widget. |
|
|
|
OnMotionDetected ( |
Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller. |
|
|
|
OnMouseButtonDoubleClick ( |
Called when a mouse button is double clicked. Override this in derived classes. |
|
|
|
OnMouseButtonDown ( |
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. |
|
|
|
OnMouseButtonUp ( |
The system calls this method to notify the widget that a mouse button was release within it. |
|
|
|
OnMouseCaptureLost ( |
Called when this widget had captured the mouse, but that capture has been revoked for some reason. |
|
|
|
OnMouseEnter ( |
The system will use this event to notify a widget that the cursor has entered it. |
|
|
|
OnMouseLeave ( |
The system will use this event to notify a widget that the cursor has left it. |
|
|
|
OnMouseMove ( |
The system calls this method to notify the widget that a mouse moved within it. |
|
|
|
OnMouseWheel ( |
Called when the mouse wheel is spun. This event is bubbled. |
|
|
|
FNavigationR... |
OnNavigation ( |
Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events. |
|
|
OnPreviewKeyDown |
Called after a key is pressed when this widget or a child of this widget has focus If a widget handles this event, OnKeyDown will not be passed to the focused widget. |
|
|
|
OnPreviewMouseButtonDown ( |
Just like OnMouseButtonDown, but tunnels instead of bubbling. |
|
|
|
FPopupMethod... |
OnQueryPopupMethod() |
Popups can manifest in a NEW OS WINDOW or via an OVERLAY in an existing window. |
|
|
OnQueryShowFocus ( |
Called to determine if we should render the focus brush. |
|
|
|
OnToolTipClosing() |
Called when a tooltip displayed from this widget is being closed |
|
|
|
OnTouchEnded ( |
Called when a touchpad touch is ended (finger lifted) |
|
|
|
OnTouchFirstMove ( |
Called when a touchpad touch first moves after TouchStarted |
|
|
|
OnTouchForceChanged ( |
Called when a touchpad touch force changes |
|
|
|
OnTouchGesture ( |
TOUCH and GESTURES Called when the user performs a gesture on trackpad. This event is bubbled. |
|
|
|
OnTouchMoved ( |
Called when a touchpad touch is moved (finger moved) |
|
|
|
OnTouchStarted ( |
Called when a touchpad touch is started (finger down) |
|
|
|
TSharedPtr< ... |
OnVisualizePopup ( |
Visualize a new pop-up if possible. |
|
|
OnVisualizeTooltip ( |
Called when Slate wants to visualize tooltip. |
|
|
|
Paint ( |
GENERAL EVENTS Called to tell a widget to paint itself (and it's children). |
|
|
|
Prepass_ChildLoop ( |
||
|
|
TSharedRef< ... |
RegisterActiveTimer ( |
Registers an "active timer" delegate that will execute at some regular interval. |
|
|
RemoveMetaData ( |
Remove metadata to this widget. |
|
|
|
SetAccessibleBehavior ( |
Set a new accessible behavior, and if the behavior is custom, new accessible text to go along with it. |
|
|
|
SetAttribute ( |
Performs the attribute assignment and invalidates the widget minimally based on what actually changed. |
|
|
|
SetCanChildrenBeAccessible ( |
Sets whether children are allowed to be accessible or not. |
|
|
|
SetCanTick ( |
||
|
|
FORCEINLINEv... |
SetClipping ( |
Sets the clipping to bounds rules for this widget. |
|
|
FORCEINLINEv... |
SetCullingBoundsExtension ( |
Sets an additional culling padding that is added to a widget to give more leeway when culling widgets. |
|
|
SetCursor ( |
Set the cursor that should appear when this widget is hovered |
|
|
|
SetDebugInfo |
Used by Slate to set the runtime debug info about this widget. |
|
|
|
SetEnabled ( |
Sets the enabled state of this widget |
|
|
|
SetFlowDirectionPreference ( |
Sets how content should flow in this panel, based on the current culture. |
|
|
|
SetOnMouseButtonDown ( |
See OnMouseButtonDown event |
|
|
|
SetOnMouseButtonUp ( |
See OnMouseButtonUp event |
|
|
|
SetOnMouseDoubleClick ( |
See OnMouseDoubleClick event |
|
|
|
SetOnMouseEnter ( |
See OnMouseEnter event |
|
|
|
SetOnMouseLeave |
See OnMouseLeave event |
|
|
|
SetOnMouseMove ( |
See OnMouseMove event |
|
|
|
FORCEINLINEv... |
SetRenderOpacity ( |
|
|
|
FORCEINLINEv... |
SetRenderTransform ( |
|
|
|
FORCEINLINEv... |
SetRenderTransformPivot ( |
|
|
|
FORCEINLINEv... |
SetTag ( |
|
|
|
SetToolTip ( |
Set the tool tip that should appear when this widget is hovered. |
|
|
|
SetToolTipText ( |
Set the tool tip that should appear when this widget is hovered. |
|
|
|
SetToolTipText ( |
Set the tool tip that should appear when this widget is hovered. |
|
|
|
SetVisibility ( |
||
|
|
ShouldBeEnabled ( |
Determines if this widget should be enabled. |
|
|
|
FORCEINLINEb... |
ShouldInvalidatePrepassDueToVolatility() |
|
|
|
SlatePrepass ( |
Descends to leaf-most widgets in the hierarchy and gathers desired sizes on the way up. |
|
|
|
SupportsKeyboardFocus() |
Checks to see if this widget supports keyboard focus. Override this in derived classes. |
|
|
|
SWidgetConstruct ( |
Construct a SWidget based on initial parameters. |
|
|
|
Tick ( |
Ticks this widget with Geometry. |
|
|
|
ToString() |
||
|
|
TSharedPtr< ... |
TranslateMouseCoordinateForCustomHitTestChild ( |
|
|
|
UnRegisterActiveTimer ( |
Unregisters an active timer handle. |
|
|
|
ValidatePathToChild ( |
| Name | Description | ||
|---|---|---|---|
|
|
Construct ( |
SWidget::Construct should not be called directly. Use SNew or SAssignNew to create a SWidget |
|
|
|
const FGeome... |
GetCachedGeometry() |
GetCachedGeometry has been deprecated, use GetTickSpaceGeometry instead |
|
|
float |
GetRelativeLayoutScale ( |
GetRelativeLayoutScale(int32 ChildIndex, float LayoutScaleMultiplier), your widget will also need to set bHasRelativeLayoutScale in their Construct/ctor. |
|
|
OnFocusChanging ( |
Please use the newer version of OnFocusChanging that takes a FocusEvent |
|
|
|
OnMouseCaptureLost() |
Please use OnMouseCaptureLost(const FCaptureLostEvent& CaptureLostEvent) |
|
|
|
SlatePrepass() |
SlatePrepass requires a layout scale to be accurate. |
|
|
|
SWidgetConstruct ( |
SWidget::SWidgetConstruct should not be called directly. Use SNew or SAssignNew to create a SWidget |
|
|
|
TSharedPtr< ... |
TranslateMouseCoordinateFor3DChild ( |
Renaming to TranslateMouseCoordinateForCustomHitTestChild |