#include <SScrollBox.h>

Inheritance diagram for SScrollBox:

Classes
class	FSlot

Public Types
using	FScopedWidgetSlotArguments = TPanelChildren< FSlot >::FScopedWidgetSlotArguments

Public Member Functions
	SLATE_BEGIN_ARGS (SScrollBox)

	SLATE_ARGUMENT (EAllowOverscroll, AllowOverscroll)

	SLATE_ARGUMENT (bool, BackPadScrolling)

	SLATE_ARGUMENT (bool, FrontPadScrolling)

	SLATE_ARGUMENT (bool, AnimateWheelScrolling)

	SLATE_ARGUMENT (float, ScrollAnimationInterpSpeed)

	SLATE_ARGUMENT (float, WheelScrollMultiplier)

	SLATE_ARGUMENT (bool, EnableTouchScrolling)

	SLATE_ARGUMENT (bool, ConsumePointerInput)

	SLATE_ARGUMENT (EDescendantScrollDestination, NavigationDestination)

	SLATE_ARGUMENT (float, NavigationScrollPadding)

	SLATE_ARGUMENT (EScrollWhenFocusChanges, ScrollWhenFocusChanges)

	SLATE_ARGUMENT (EConsumeMouseWheel, ConsumeMouseWheel)

	SLATE_ARGUMENT (bool, AllowContentToShrink)

SLATE_API	SScrollBox ()

virtual SLATE_API	~SScrollBox ()

SLATE_API void	Construct (const FArguments &InArgs)

SLATE_API FScopedWidgetSlotArguments	AddSlot ()

SLATE_API FScopedWidgetSlotArguments	InsertSlot (int32 Index)

SLATE_API const FSlot &	GetSlot (int32 SlotIndex) const

SLATE_API FSlot &	GetSlot (int32 SlotIndex)

SLATE_API void	RemoveSlot (const TSharedRef< SWidget > &WidgetToRemove)

SLATE_API int32	NumSlots () const

SLATE_API void	ClearChildren ()

SLATE_API bool	IsRightClickScrolling () const

SLATE_API EAllowOverscroll	GetAllowOverscroll () const

SLATE_API void	SetAllowOverscroll (EAllowOverscroll NewAllowOverscroll)

SLATE_API void	SetAnimateWheelScrolling (bool bInAnimateWheelScrolling)

SLATE_API void	SetScrollingAnimationInterpolationSpeed (float NewScrollingAnimationInterpolationSpeed)

SLATE_API void	SetWheelScrollMultiplier (float NewWheelScrollMultiplier)

SLATE_API void	SetIsTouchScrollingEnabled (const bool bInEnableTouchScrolling)

void	SetConsumePointerInput (bool bInConsumePointerInput)

SLATE_API void	SetScrollWhenFocusChanges (EScrollWhenFocusChanges NewScrollWhenFocusChanges)

SLATE_API float	GetScrollOffset () const

SLATE_API UE::Slate::FDeprecateVector2DResult	GetScrollPanelContentSize () const

SLATE_API float	GetOverscrollOffset () const

SLATE_API float	GetOverscrollPercentage () const

SLATE_API float	GetViewFraction () const

SLATE_API float	GetViewOffsetFraction () const

SLATE_API float	GetScrollOffsetOfEnd () const

bool	GetIsScrolling () const

SLATE_API void	SetScrollOffset (float NewScrollOffset)

SLATE_API void	ScrollToStart ()

SLATE_API void	ScrollToEnd ()

SLATE_API void	EndInertialScrolling ()

SLATE_API void	ScrollDescendantIntoView (const TSharedPtr< SWidget > &WidgetToFind, bool InAnimateScroll=true, EDescendantScrollDestination InDestination=EDescendantScrollDestination::IntoView, float Padding=0)

SLATE_API EOrientation	GetOrientation ()

SLATE_API void	SetNavigationDestination (const EDescendantScrollDestination NewNavigationDestination)

SLATE_API void	SetConsumeMouseWheel (EConsumeMouseWheel NewConsumeMouseWheel)

SLATE_API void	SetAnalogMouseWheelKey (FKey InAnalogKey)

SLATE_API void	SetIsFocusable (bool bInIsFocusable)

SLATE_API void	SetOrientation (EOrientation InOrientation)

SLATE_API void	SetScrollBarVisibility (EVisibility InVisibility)

SLATE_API void	SetScrollBarAlwaysVisible (bool InAlwaysVisible)

SLATE_API void	SetScrollBarTrackAlwaysVisible (bool InAlwaysVisible)

SLATE_API void	SetScrollBarThickness (UE::Slate::FDeprecateVector2DParameter InThickness)

SLATE_API void	SetScrollBarPadding (const FMargin &InPadding)

SLATE_API void	SetScrollBarRightClickDragAllowed (bool bIsAllowed)

SLATE_API void	SetStyle (const FScrollBoxStyle *InStyle)

SLATE_API void	SetScrollBarStyle (const FScrollBarStyle *InBarStyle)

SLATE_API void	InvalidateStyle ()

SLATE_API void	InvalidateScrollBarStyle ()

virtual SLATE_API void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override

virtual SLATE_API bool	ComputeVolatility () const override

virtual SLATE_API FReply	OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API void	OnMouseLeave (const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent) override

virtual SLATE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const override

virtual SLATE_API int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override

virtual SLATE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override

virtual SLATE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override

virtual SLATE_API FNavigationReply	OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent) override

virtual SLATE_API void	OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent) override

virtual SLATE_API FReply	OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent) override

virtual SLATE_API void	OnFocusLost (const FFocusEvent &InFocusEvent) override

virtual bool	SupportsKeyboardFocus () const override

Public Member Functions inherited from SCompoundWidget
const FVector2D	GetContentScale () const

void	SetContentScale (TAttribute< FVector2D > InContentScale)

FLinearColor	GetColorAndOpacity () const

void	SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)

void	SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)

virtual SLATECORE_API FChildren *	GetChildren () override

virtual SLATECORE_API void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual SLATECORE_API FSlateColor	GetForegroundColor () const override

virtual SLATECORE_API void	SetVisibility (TAttribute< EVisibility > InVisibility) override final

Public Member Functions inherited from SWidget
SLATECORE_API int32	Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATECORE_API FReply	OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)

virtual SLATECORE_API FReply	OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API TOptional< TSharedRef< SWidget > >	OnMapCursor (const FCursorReply &CursorReply) const

virtual SLATECORE_API FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)

virtual SLATECORE_API bool	OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)

virtual SLATECORE_API FReply	OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API void	OnDragLeave (const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)

virtual SLATECORE_API FReply	OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)

virtual SLATECORE_API TOptional< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API FPopupMethodReply	OnQueryPopupMethod () const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const

virtual SLATECORE_API void	OnFinishedPointerInput ()

virtual SLATECORE_API void	OnFinishedKeyInput ()

virtual SLATECORE_API EWindowZone::Type	GetWindowZoneOverride () const

bool	NeedsPrepass () const

SLATECORE_API void	SlatePrepass ()

SLATECORE_API void	SlatePrepass (float InLayoutScaleMultiplier)

void	SetCanTick (bool bInCanTick)

bool	GetCanTick () const

bool	HasRegisteredSlateAttribute () const

bool	IsAttributesUpdatesEnabled () const

const FSlateWidgetPersistentState &	GetPersistentState () const

const FWidgetProxyHandle	GetProxyHandle () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSize () const

SLATECORE_API void	AssignParentWidget (TSharedPtr< SWidget > InParent)

SLATECORE_API bool	ConditionallyDetatchParentWidget (SWidget *InExpectedParent)

virtual bool	ValidatePathToChild (SWidget *InChild)

bool	IsParentValid () const

TSharedPtr< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_GetPaintParentWidget () const

SLATECORE_API FSlateRect	CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const

bool	HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const

TStatId	GetStatID (bool bForDeferredUse=false) const

virtual SLATECORE_API float	GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const

SLATECORE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const

virtual FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () const

SLATECORE_API bool	HasUserFocusedDescendants (int32 UserIndex) const

SLATECORE_API bool	HasFocusedDescendants () const

SLATECORE_API bool	HasAnyUserFocusOrFocusedDescendants () const

SLATECORE_API bool	HasMouseCapture () const

SLATECORE_API bool	HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const

void	SetEnabled (TAttribute< bool > InEnabledState)

bool	IsEnabled () const

virtual bool	IsInteractable () const

virtual SLATECORE_API TSharedPtr< IToolTip >	GetToolTip ()

virtual SLATECORE_API void	OnToolTipClosing ()

SLATECORE_API void	EnableToolTipForceField (const bool bEnableForceField)

bool	HasToolTipForceField () const

bool	IsHovered () const

SLATECORE_API bool	IsDirectlyHovered () const

EVisibility	GetVisibility () const

bool	IsVolatile () const

bool	IsVolatileIndirectly () const

void	ForceVolatile (bool bForce)

bool	ShouldInvalidatePrepassDueToVolatility ()

SLATECORE_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)

void	CacheVolatility ()

void	MarkPrepassAsDirty ()

float	GetRenderOpacity () const

void	SetRenderOpacity (float InRenderOpacity)

void	SetTag (FName InTag)

const TOptional< FSlateRenderTransform > &	GetRenderTransform () const

TOptional< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () const

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivotWithRespectToFlowDirection () const

void	SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivot () const

void	SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)

SLATECORE_API void	SetClipping (EWidgetClipping InClipping)

EWidgetClipping	GetClipping () const

SLATECORE_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)

EWidgetPixelSnapping	GetPixelSnapping () const

void	SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)

FMargin	GetCullingBoundsExtension () const

void	SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)

EFlowDirectionPreference	GetFlowDirectionPreference () const

SLATECORE_API void	SetToolTipText (const TAttribute< FText > &ToolTipText)

SLATECORE_API void	SetToolTipText (const FText &InToolTipText)

SLATECORE_API void	SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)

SLATECORE_API void	SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)

template<typename MetaDataType >
TSharedPtr< MetaDataType >	GetMetaData () const

template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > >	GetAllMetaData () const

template<typename MetaDataType >
void	AddMetadata (const TSharedRef< MetaDataType > &AddMe)

template<typename MetaDataType >
int32	RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)

SLATECORE_API void	SetOnMouseButtonDown (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseButtonUp (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseMove (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseDoubleClick (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)

virtual SLATECORE_API FString	ToString () const

SLATECORE_API FString	GetTypeAsString () const

SLATECORE_API FName	GetType () const

virtual SLATECORE_API FString	GetReadableLocation () const

SLATECORE_API FName	GetCreatedInLocation () const

virtual SLATECORE_API FName	GetTag () const

virtual SLATECORE_API FSlateColor	GetDisabledForegroundColor () const

SLATECORE_API const FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)

SLATECORE_API void	UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)

bool	HasActiveTimers () const

Public Member Functions inherited from FSlateControlledConstruction
	FSlateControlledConstruction ()=default

virtual	~FSlateControlledConstruction ()=default

virtual const FSlateWidgetClassData &	GetWidgetClass () const =0

void	operator delete (void *mem)

Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode >	AsShared ()

TSharedRef< SWidget const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< SWidget, Mode >	AsWeak ()

TWeakPtr< SWidget const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static SLATE_API FSlot::FSlotArguments	Slot ()

Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Protected Member Functions
SLATE_API void	OnClippingChanged ()

SLATE_API bool	InternalScrollDescendantIntoView (const FGeometry &MyGeometry, const TSharedPtr< SWidget > &WidgetToFind, bool InAnimateScroll=true, EDescendantScrollDestination InDestination=EDescendantScrollDestination::IntoView, float Padding=0)

SLATE_API TSharedPtr< SWidget >	GetKeyboardFocusableWidget (TSharedPtr< SWidget > InWidget)

Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D	ComputeDesiredSize (float) const override

TSlateAttributeRef< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () const

SLATECORE_API	SCompoundWidget ()

virtual SLATECORE_API	~SCompoundWidget ()

Protected Member Functions inherited from SWidget
void	SetVolatilePrepass (bool bVolatile)

virtual bool	CustomPrepass (float LayoutScaleMultiplier)

virtual SLATECORE_API void	CacheDesiredSize (float InLayoutScaleMultiplier)

void	SetHover (TAttribute< bool > InHovered)

bool	IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const

SLATECORE_API void	InvalidateChildRemovedFromTree (SWidget &Child)

bool	Advanced_InvalidateVolatility ()

EFlowDirection	ComputeFlowDirection () const

SLATECORE_API void	SetDebugInfo (const ANSICHAR InType, const ANSICHAR InFile, int32 OnLine, size_t InAllocSize)

virtual SLATECORE_API TOptional< EMouseCursor::Type >	GetCursor () const

SLATECORE_API	SWidget ()

SLATECORE_API void	SWidgetConstruct (const FSlateBaseNamedArgs &Args)

bool	IsConstructed () const

SLATECORE_API bool	FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API void	FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API FGeometry	FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const

bool	ShouldBeEnabled (bool InParentEnabled) const

virtual SLATECORE_API const FSlateBrush *	GetFocusBrush () const

float	GetPrepassLayoutScaleMultiplier () const

SLATECORE_API void	Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)

template<typename TargetValueType , typename SourceValueType >
bool	SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)

TSlateAttributeRef< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Protected Attributes
TSharedPtr< class SScrollPanel >	ScrollPanel

TSharedPtr< SScrollBar >	ScrollBar

float	TickScrollDelta

TOptional< int32 >	bFingerOwningTouchInteraction

float	AmountScrolledWhileRightMouseDown

float	PendingScrollTriggerAmount

FInertialScrollManager	InertialScrollManager

FOverscroll	Overscroll

EAllowOverscroll	AllowOverscroll

bool	BackPadScrolling

bool	FrontPadScrolling

float	NavigationScrollPadding

EDescendantScrollDestination	NavigationDestination

EScrollWhenFocusChanges	ScrollWhenFocusChanges

FVector2f	SoftwareCursorPosition

FOnUserScrolled	OnUserScrolled

FOnScrollBarVisibilityChanged	OnScrollBarVisibilityChanged

FOnScrollBoxFocusReceived	OnScrollBoxFocusReceived

FOnScrollBoxFocusLost	OnScrollBoxFocusLost

EOrientation	Orientation

const FScrollBoxStyle *	Style

const FScrollBarStyle *	ScrollBarStyle

EConsumeMouseWheel	ConsumeMouseWheel

FKey	AnalogMouseWheelKey

FGeometry	CachedGeometry

TFunction< void(FGeometry)>	ScrollIntoViewRequest

TSharedPtr< FActiveTimerHandle >	UpdateInertialScrollHandle

double	LastScrollTime

float	WheelScrollMultiplier = 1.f

bool	bEnableTouchScrolling = true

bool	bConsumePointerInput = true

float	ScrollingAnimationInterpolationSpeed = 15.f

bool	bAnimateWheelScrolling: 1

bool	bShowSoftwareCursor: 1

bool	bScrollBarIsExternal: 1

bool	bIsScrolling: 1

bool	bAnimateScroll: 1

bool	bScrollToEnd: 1

bool	bIsScrollingActiveTimerRegistered: 1

bool	bAllowsRightClickDragScrolling: 1

bool	bTouchPanningCapture: 1

bool	bIsFocusable: 1

bool	bAllowContentToShrink = false

Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot	ChildSlot

Protected Attributes inherited from SWidget
uint8	bCanSupportFocus: 1

uint8	bCanHaveChildren: 1

uint8	bClippingProxy: 1

uint8	bHasCustomPrepass: 1

uint8	bHasRelativeLayoutScale: 1

uint8	bVolatilityAlwaysInvalidatesPrepass: 1

EWidgetClipping	Clipping

EWidgetPixelSnapping	PixelSnappingMethod

FMargin	CullingBoundsExtension

float	RenderOpacity

Additional Inherited Members
Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32	FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)

static SLATECORE_API int32	FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)

static TAttribute< EVisibility >	AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)

Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

SScrollBox can scroll through an arbitrary number of widgets.

Member Typedef Documentation

◆ FScopedWidgetSlotArguments

using SScrollBox::FScopedWidgetSlotArguments = TPanelChildren<FSlot>::FScopedWidgetSlotArguments

Constructor & Destructor Documentation

◆ SScrollBox()

SScrollBox::SScrollBox ( )

◆ ~SScrollBox()

SScrollBox::~SScrollBox ( )

virtualdefault

Member Function Documentation

◆ AddSlot()

SScrollBox::FScopedWidgetSlotArguments SScrollBox::AddSlot ( )

Adds a slot to SScrollBox

◆ ClearChildren()

void SScrollBox::ClearChildren ( )

Removes all children from the box

◆ ComputeVolatility()

bool SScrollBox::ComputeVolatility ( ) const

overridevirtual

Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.

Reimplemented from SWidget.

◆ Construct()

void SScrollBox::Construct ( const FArguments & InArgs )

◆ EndInertialScrolling()

void SScrollBox::EndInertialScrolling ( )

◆ GetAllowOverscroll()

EAllowOverscroll SScrollBox::GetAllowOverscroll ( ) const

◆ GetIsScrolling()

bool SScrollBox::GetIsScrolling ( ) const

inline

◆ GetKeyboardFocusableWidget()

TSharedPtr< SWidget > SScrollBox::GetKeyboardFocusableWidget ( TSharedPtr< SWidget > InWidget )

protected

returns widget that can receive keyboard focus or nullptr

◆ GetOrientation()

EOrientation SScrollBox::GetOrientation ( )

Get the current orientation of the scrollbox.

◆ GetOverscrollOffset()

float SScrollBox::GetOverscrollOffset ( ) const

◆ GetOverscrollPercentage()

float SScrollBox::GetOverscrollPercentage ( ) const

◆ GetScrollOffset()

float SScrollBox::GetScrollOffset ( ) const

◆ GetScrollOffsetOfEnd()

float SScrollBox::GetScrollOffsetOfEnd ( ) const

Gets the scroll offset of the bottom of the ScrollBox in Slate Units.

◆ GetScrollPanelContentSize()

UE::Slate::FDeprecateVector2DResult SScrollBox::GetScrollPanelContentSize ( ) const

◆ GetSlot() [1/2]

SScrollBox::FSlot & SScrollBox::GetSlot ( int32 SlotIndex )

◆ GetSlot() [2/2]

const SScrollBox::FSlot & SScrollBox::GetSlot ( int32 SlotIndex ) const

Returns the slot at the given index.

◆ GetViewFraction()

float SScrollBox::GetViewFraction ( ) const

◆ GetViewOffsetFraction()

float SScrollBox::GetViewOffsetFraction ( ) const

◆ InsertSlot()

SScrollBox::FScopedWidgetSlotArguments SScrollBox::InsertSlot ( int32 Index )

Insert a slot at a given position.

◆ InternalScrollDescendantIntoView()

bool SScrollBox::InternalScrollDescendantIntoView	(	const FGeometry &	MyGeometry,
		const TSharedPtr< SWidget > &	WidgetToFind,
		bool	InAnimateScroll = `true`,
		EDescendantScrollDestination	InDestination = `EDescendantScrollDestination::IntoView`,
		float	Padding = `0`
	)

protected

Scrolls or begins scrolling a widget into view, only valid to call when we have layout geometry.

◆ InvalidateScrollBarStyle()

void SScrollBox::InvalidateScrollBarStyle ( )

◆ InvalidateStyle()

void SScrollBox::InvalidateStyle ( )

◆ IsRightClickScrolling()

bool SScrollBox::IsRightClickScrolling ( ) const

Returns: Returns true if the user is currently interactively scrolling the view by holding the right mouse button and dragging.

◆ NumSlots()

int32 SScrollBox::NumSlots ( ) const

Returns: the number of slots.

◆ OnAnalogValueChanged()

FReply SScrollBox::OnAnalogValueChanged	(	const FGeometry &	MyGeometry,
		const FAnalogInputEvent &	InAnalogInputEvent
	)

overridevirtual

Called when an analog value changes on a button that supports analog

Parameters

MyGeometry	The Geometry of the widget receiving the event
InAnalogInputEvent	Analog input event

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnClippingChanged()

void SScrollBox::OnClippingChanged ( )

protectedvirtual

Called when clipping is changed. Should be used to forward clipping states onto potentially hidden children that actually are responsible for clipping the content.

Reimplemented from SWidget.

◆ OnCursorQuery()

FCursorReply SScrollBox::OnCursorQuery	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	CursorEvent
	)		const

overridevirtual

The system asks each widget under the mouse to provide a cursor. This event is bubbled.

Returns: FCursorReply::Unhandled() if the event is not handled; return FCursorReply::Cursor() otherwise.

Reimplemented from SWidget.

◆ OnFocusChanging()

void SScrollBox::OnFocusChanging	(	const FWeakWidgetPath &	PreviousFocusPath,
		const FWidgetPath &	NewWidgetPath,
		const FFocusEvent &	InFocusEvent
	)

overridevirtual

Called whenever a focus path is changing on all the widgets within the old and new focus paths

Reimplemented from SWidget.

◆ OnFocusLost()

void SScrollBox::OnFocusLost ( const FFocusEvent & InFocusEvent )

overridevirtual

Called when this widget loses focus. This event does not bubble.

Parameters

InFocusEvent The FocusEvent

Reimplemented from SWidget.

◆ OnFocusReceived()

FReply SScrollBox::OnFocusReceived	(	const FGeometry &	MyGeometry,
		const FFocusEvent &	InFocusEvent
	)

overridevirtual

Called when focus is given to this widget. This event does not bubble.

Parameters

MyGeometry	The Geometry of the widget receiving the event
InFocusEvent	The FocusEvent

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnMouseButtonDown()

FReply SScrollBox::OnMouseButtonDown	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseButtonUp()

FReply SScrollBox::OnMouseButtonUp	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseCaptureLost()

void SScrollBox::OnMouseCaptureLost ( const FCaptureLostEvent & CaptureLostEvent )

overridevirtual

Called when this widget had captured the mouse, but that capture has been revoked for some reason.

Reimplemented from SWidget.

◆ OnMouseEnter()

void SScrollBox::OnMouseEnter	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Reimplemented from SWidget.

◆ OnMouseLeave()

void SScrollBox::OnMouseLeave ( const FPointerEvent & MouseEvent )

overridevirtual

The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

Parameters

MouseEvent Information about the input event

Reimplemented from SWidget.

◆ OnMouseMove()

FReply SScrollBox::OnMouseMove	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseWheel()

FReply SScrollBox::OnMouseWheel	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

Called when the mouse wheel is spun. This event is bubbled.

Parameters

MouseEvent Mouse event

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnNavigation()

FNavigationReply SScrollBox::OnNavigation	(	const FGeometry &	MyGeometry,
		const FNavigationEvent &	InNavigationEvent
	)

overridevirtual

Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.

Parameters

InNavigationEvent The navigation event generated

Reimplemented from SWidget.

◆ OnPaint()

int32 SScrollBox::OnPaint	(	const FPaintArgs &	Args,
		const FGeometry &	AllottedGeometry,
		const FSlateRect &	MyCullingRect,
		FSlateWindowElementList &	OutDrawElements,
		int32	LayerId,
		const FWidgetStyle &	InWidgetStyle,
		bool	bParentEnabled
	)		const

overridevirtual

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.

Parameters

Args	All the arguments necessary to paint this widget (
AllottedGeometry	The FGeometry that describes an area in which the widget should appear.
MyCullingRect	The rectangle representing the bounds currently being used to completely cull widgets. Unless IsChildWidgetCulled(...) returns true, you should paint the widget.
OutDrawElements	A list of FDrawElements to populate with the output.
LayerId	The Layer onto which this widget should be rendered.
InColorAndOpacity	Color and Opacity to be applied to all the descendants of the widget being painted
bParentEnabled	True if the parent of this widget is enabled.

Returns: The maximum layer ID attained by this widget or any of its children.

Reimplemented from SCompoundWidget.

◆ OnPreviewMouseButtonDown()

FReply SScrollBox::OnPreviewMouseButtonDown	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

Just like OnMouseButtonDown, but tunnels instead of bubbling. If this event is handled, OnMouseButtonDown will not be sent.

Use this event sparingly as preview events generally make UIs more difficult to reason about.

Reimplemented from SWidget.

◆ OnTouchEnded()

FReply SScrollBox::OnTouchEnded	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

overridevirtual

Called when a touchpad touch is ended (finger lifted)

Parameters

InTouchEvent The touch event generated

Reimplemented from SWidget.

◆ RemoveSlot()

void SScrollBox::RemoveSlot ( const TSharedRef< SWidget > & WidgetToRemove )

Removes the corresponding widget from the set of slots if it exists.

◆ ScrollDescendantIntoView()

void SScrollBox::ScrollDescendantIntoView	(	const TSharedPtr< SWidget > &	WidgetToFind,
		bool	InAnimateScroll = `true`,
		EDescendantScrollDestination	InDestination = `EDescendantScrollDestination::IntoView`,
		float	Padding = `0`
	)

Attempt to scroll a widget into view, will safely handle non-descendant widgets

Parameters

WidgetToFind	The widget whose geometry we wish to discover.
InAnimateScroll	Whether or not to animate the scroll
InDestination	Where we want the child widget to stop.

◆ ScrollToEnd()

void SScrollBox::ScrollToEnd ( )

◆ ScrollToStart()

void SScrollBox::ScrollToStart ( )

◆ SetAllowOverscroll()

void SScrollBox::SetAllowOverscroll ( EAllowOverscroll NewAllowOverscroll )

◆ SetAnalogMouseWheelKey()

void SScrollBox::SetAnalogMouseWheelKey ( FKey InAnalogKey )

◆ SetAnimateWheelScrolling()

void SScrollBox::SetAnimateWheelScrolling ( bool bInAnimateWheelScrolling )

◆ SetConsumeMouseWheel()

void SScrollBox::SetConsumeMouseWheel ( EConsumeMouseWheel NewConsumeMouseWheel )

◆ SetConsumePointerInput()

void SScrollBox::SetConsumePointerInput ( bool bInConsumePointerInput )

inline

◆ SetIsFocusable()

void SScrollBox::SetIsFocusable ( bool bInIsFocusable )

◆ SetIsTouchScrollingEnabled()

void SScrollBox::SetIsTouchScrollingEnabled ( const bool bInEnableTouchScrolling )

Enables/disables being able to scroll using touch input.

◆ SetNavigationDestination()

void SScrollBox::SetNavigationDestination ( const EDescendantScrollDestination NewNavigationDestination )

◆ SetOrientation()

void SScrollBox::SetOrientation ( EOrientation InOrientation )

Sets the current orientation of the scrollbox and updates the layout

◆ SetScrollBarAlwaysVisible()

void SScrollBox::SetScrollBarAlwaysVisible ( bool InAlwaysVisible )

◆ SetScrollBarPadding()

void SScrollBox::SetScrollBarPadding ( const FMargin & InPadding )

◆ SetScrollBarRightClickDragAllowed()

void SScrollBox::SetScrollBarRightClickDragAllowed ( bool bIsAllowed )

◆ SetScrollBarStyle()

void SScrollBox::SetScrollBarStyle ( const FScrollBarStyle * InBarStyle )

◆ SetScrollBarThickness()

void SScrollBox::SetScrollBarThickness ( UE::Slate::FDeprecateVector2DParameter InThickness )

◆ SetScrollBarTrackAlwaysVisible()

void SScrollBox::SetScrollBarTrackAlwaysVisible ( bool InAlwaysVisible )

◆ SetScrollBarVisibility()

void SScrollBox::SetScrollBarVisibility ( EVisibility InVisibility )

◆ SetScrollingAnimationInterpolationSpeed()

void SScrollBox::SetScrollingAnimationInterpolationSpeed ( float NewScrollingAnimationInterpolationSpeed )

◆ SetScrollOffset()

void SScrollBox::SetScrollOffset ( float NewScrollOffset )

◆ SetScrollWhenFocusChanges()

void SScrollBox::SetScrollWhenFocusChanges ( EScrollWhenFocusChanges NewScrollWhenFocusChanges )

◆ SetStyle()

void SScrollBox::SetStyle ( const FScrollBoxStyle * InStyle )

◆ SetWheelScrollMultiplier()

void SScrollBox::SetWheelScrollMultiplier ( float NewWheelScrollMultiplier )

◆ SLATE_ARGUMENT() [1/13]

SScrollBox::SLATE_ARGUMENT	(	bool	,
		AllowContentToShrink
	)

If enabled, content in the underlying panel will be allowed to shrink with the overall size of the ScrollBox instead of always taking up maximum space

◆ SLATE_ARGUMENT() [2/13]

SScrollBox::SLATE_ARGUMENT	(	bool	,
		AnimateWheelScrolling
	)

◆ SLATE_ARGUMENT() [3/13]

SScrollBox::SLATE_ARGUMENT	(	bool	,
		BackPadScrolling
	)

◆ SLATE_ARGUMENT() [4/13]

SScrollBox::SLATE_ARGUMENT	(	bool	,
		ConsumePointerInput
	)

◆ SLATE_ARGUMENT() [5/13]

SScrollBox::SLATE_ARGUMENT	(	bool	,
		EnableTouchScrolling
	)

◆ SLATE_ARGUMENT() [6/13]

SScrollBox::SLATE_ARGUMENT	(	bool	,
		FrontPadScrolling
	)

◆ SLATE_ARGUMENT() [7/13]

SScrollBox::SLATE_ARGUMENT	(	EAllowOverscroll	,
		AllowOverscroll
	)

Style used to draw this scrollbox Style used to draw this scrollbox's scrollbar Custom scroll bar The direction that children will be stacked, and also the direction the box will scroll. This accounts for total internal scroll bar padding; default 2.0f padding from the scroll bar itself is removed

◆ SLATE_ARGUMENT() [8/13]

SScrollBox::SLATE_ARGUMENT	(	EConsumeMouseWheel	,
		ConsumeMouseWheel
	)

Called when the button is clicked Fired when scroll bar visibility changed If bIsFocusable is enabled, Called when the scrollbox focus is received If bIsFocusable is enabled, Called when the scrollbox focus is lost

◆ SLATE_ARGUMENT() [9/13]

SScrollBox::SLATE_ARGUMENT	(	EDescendantScrollDestination	,
		NavigationDestination
	)

◆ SLATE_ARGUMENT() [10/13]

SScrollBox::SLATE_ARGUMENT	(	EScrollWhenFocusChanges	,
		ScrollWhenFocusChanges
	)

◆ SLATE_ARGUMENT() [11/13]

SScrollBox::SLATE_ARGUMENT	(	float	,
		NavigationScrollPadding
	)

The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. Use this if you want to ensure there's a preview of the next item the user could scroll to.

◆ SLATE_ARGUMENT() [12/13]

SScrollBox::SLATE_ARGUMENT	(	float	,
		ScrollAnimationInterpSpeed
	)

◆ SLATE_ARGUMENT() [13/13]

SScrollBox::SLATE_ARGUMENT	(	float	,
		WheelScrollMultiplier
	)

◆ SLATE_BEGIN_ARGS()

SScrollBox::SLATE_BEGIN_ARGS ( SScrollBox )

inline

◆ Slot()

SScrollBox::FSlot::FSlotArguments SScrollBox::Slot ( )

static

Returns: a new slot. Slots contain children for SScrollBox

◆ SupportsKeyboardFocus()

virtual bool SScrollBox::SupportsKeyboardFocus ( ) const

inlineoverridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns: True if this widget can take keyboard focus

Reimplemented from SWidget.

◆ Tick()

void SScrollBox::Tick	(	const FGeometry &	AllottedGeometry,
		const double	InCurrentTime,
		const float	InDeltaTime
	)

overridevirtual

Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

Parameters

AllottedGeometry	The space allotted for this widget
InCurrentTime	Current absolute real time
InDeltaTime	Real time passed since last tick

Reimplemented from SWidget.

Member Data Documentation

◆ AllowOverscroll

EAllowOverscroll SScrollBox::AllowOverscroll

protected

Whether to permit overscroll on this scroll box

◆ AmountScrolledWhileRightMouseDown

float SScrollBox::AmountScrolledWhileRightMouseDown

protected

How much we scrolled while the rmb has been held

◆ AnalogMouseWheelKey

FKey SScrollBox::AnalogMouseWheelKey

protected

Gamepad key used for scrolling. Will adhere to ConsumeMouseWheel

◆ BackPadScrolling

bool SScrollBox::BackPadScrolling

protected

Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible

◆ bAllowContentToShrink

bool SScrollBox::bAllowContentToShrink = false

protected

Whether content in the underlying panel will be allowed to shrink with the overall size of the ScrollBox instead of always taking up maximum space

◆ bAllowsRightClickDragScrolling

bool SScrollBox::bAllowsRightClickDragScrolling

protected

◆ bAnimateScroll

bool SScrollBox::bAnimateScroll

protected

Should the current scrolling be animated or immediately jump to the desired scroll offer

◆ bAnimateWheelScrolling

bool SScrollBox::bAnimateWheelScrolling

protected

Whether to animate wheel scrolling

◆ bConsumePointerInput

bool SScrollBox::bConsumePointerInput = true

protected

If true, touch input events will pass through to widgets under the ScrollBox, while still being handled by the ScrollBox.

◆ bEnableTouchScrolling

bool SScrollBox::bEnableTouchScrolling = true

protected

True to allow scrolling by using touch input.

◆ bFingerOwningTouchInteraction

TOptional<int32> SScrollBox::bFingerOwningTouchInteraction

protected

Did the user start an interaction in this list?

◆ bIsFocusable

bool SScrollBox::bIsFocusable

protected

◆ bIsScrolling

bool SScrollBox::bIsScrolling

protected

Are we actively scrolling right now

◆ bIsScrollingActiveTimerRegistered

bool SScrollBox::bIsScrollingActiveTimerRegistered

protected

Whether the active timer to update the inertial scroll is registered

◆ bScrollBarIsExternal

bool SScrollBox::bScrollBarIsExternal

protected

Whether or not the user supplied an external scrollbar to control scrolling.

◆ bScrollToEnd

bool SScrollBox::bScrollToEnd

protected

If true, will scroll to the end next Tick

◆ bShowSoftwareCursor

bool SScrollBox::bShowSoftwareCursor

protected

Whether the software cursor should be drawn in the viewport

◆ bTouchPanningCapture

bool SScrollBox::bTouchPanningCapture

protected

◆ CachedGeometry

FGeometry SScrollBox::CachedGeometry

protected

Cached geometry for use with the active timer

◆ ConsumeMouseWheel

EConsumeMouseWheel SScrollBox::ConsumeMouseWheel

protected

How we should handle scrolling with the mouse wheel

◆ FrontPadScrolling

bool SScrollBox::FrontPadScrolling

protected

Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible

◆ HorizontalScrollBarSlot

SVerticalBox::FSlot* SScrollBox::HorizontalScrollBarSlot

◆ InertialScrollManager

FInertialScrollManager SScrollBox::InertialScrollManager

protected

Helper object to manage inertial scrolling

◆ LastScrollTime

double SScrollBox::LastScrollTime

protected

◆ NavigationDestination

EDescendantScrollDestination SScrollBox::NavigationDestination

protected

Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled

◆ NavigationScrollPadding

float SScrollBox::NavigationScrollPadding

protected

The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. Use this if you want to ensure there's a preview of the next item the user could scroll to.

◆ OnScrollBarVisibilityChanged

FOnScrollBarVisibilityChanged SScrollBox::OnScrollBarVisibilityChanged

protected

Fired when scroll bar visibility changed

◆ OnScrollBoxFocusLost

FOnScrollBoxFocusLost SScrollBox::OnScrollBoxFocusLost

protected

If bIsFocusable is enabled, Called when the scrollbox focus is lost

◆ OnScrollBoxFocusReceived

FOnScrollBoxFocusReceived SScrollBox::OnScrollBoxFocusReceived

protected

If bIsFocusable is enabled, Called when the scrollbox focus is received

◆ OnUserScrolled

FOnUserScrolled SScrollBox::OnUserScrolled

protected

Fired when the user scrolls the scrollbox

◆ Orientation

EOrientation SScrollBox::Orientation

protected

The scrolling and stacking orientation.

◆ Overscroll

FOverscroll SScrollBox::Overscroll

protected

The overscroll state management structure.

◆ PendingScrollTriggerAmount

float SScrollBox::PendingScrollTriggerAmount

protected

The current deviation we've accumulated on scrol, once it passes the trigger amount, we're going to begin scrolling.

◆ ScrollBar

TSharedPtr<SScrollBar> SScrollBox::ScrollBar

protected

The scrollbar which controls scrolling for the scrollbox.

◆ ScrollBarStyle

const FScrollBarStyle* SScrollBox::ScrollBarStyle

protected

Style resource for the scrollbar

◆ ScrollingAnimationInterpolationSpeed

float SScrollBox::ScrollingAnimationInterpolationSpeed = 15.f

protected

The speed of interpolation for the scrolling animation

◆ ScrollIntoViewRequest

TFunction<void(FGeometry)> SScrollBox::ScrollIntoViewRequest

protected

Scroll into view request.

◆ ScrollPanel

TSharedPtr<class SScrollPanel> SScrollBox::ScrollPanel

protected

The panel which stacks the child slots

◆ ScrollWhenFocusChanges

EScrollWhenFocusChanges SScrollBox::ScrollWhenFocusChanges

protected

Scroll behavior when user focus is given to a child widget

◆ SoftwareCursorPosition

FVector2f SScrollBox::SoftwareCursorPosition

protected

The current position of the software cursor

◆ Style

const FScrollBoxStyle* SScrollBox::Style

protected

Style resource for the scrollbox

◆ TickScrollDelta

float SScrollBox::TickScrollDelta

protected

The amount we have scrolled this tick cycle

◆ UpdateInertialScrollHandle

TSharedPtr<FActiveTimerHandle> SScrollBox::UpdateInertialScrollHandle

protected

◆ VerticalScrollBarSlot

SHorizontalBox::FSlot* SScrollBox::VerticalScrollBarSlot

◆ WheelScrollMultiplier

float SScrollBox::WheelScrollMultiplier = 1.f

protected

Multiplier applied to each click of the scroll wheel (applied alongside the global scroll amount)

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

Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScrollBox.h
Engine/Source/Runtime/Slate/Private/Widgets/Layout/SScrollBox.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FScopedWidgetSlotArguments

Constructor & Destructor Documentation

◆ SScrollBox()

◆ ~SScrollBox()

Member Function Documentation

◆ AddSlot()

◆ ClearChildren()

◆ ComputeVolatility()

◆ Construct()

◆ EndInertialScrolling()

◆ GetAllowOverscroll()

◆ GetIsScrolling()

◆ GetKeyboardFocusableWidget()

◆ GetOrientation()

◆ GetOverscrollOffset()

◆ GetOverscrollPercentage()

◆ GetScrollOffset()

◆ GetScrollOffsetOfEnd()

◆ GetScrollPanelContentSize()

◆ GetSlot() [1/2]

◆ GetSlot() [2/2]

◆ GetViewFraction()

◆ GetViewOffsetFraction()

◆ InsertSlot()

◆ InternalScrollDescendantIntoView()

◆ InvalidateScrollBarStyle()

◆ InvalidateStyle()

◆ IsRightClickScrolling()

◆ NumSlots()

◆ OnAnalogValueChanged()

◆ OnClippingChanged()

◆ OnCursorQuery()

◆ OnFocusChanging()

◆ OnFocusLost()

◆ OnFocusReceived()

◆ OnMouseButtonDown()

◆ OnMouseButtonUp()

◆ OnMouseCaptureLost()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ OnMouseMove()

◆ OnMouseWheel()

◆ OnNavigation()

◆ OnPaint()

◆ OnPreviewMouseButtonDown()

◆ OnTouchEnded()

◆ RemoveSlot()

◆ ScrollDescendantIntoView()

◆ ScrollToEnd()

◆ ScrollToStart()

◆ SetAllowOverscroll()

◆ SetAnalogMouseWheelKey()

◆ SetAnimateWheelScrolling()

◆ SetConsumeMouseWheel()

◆ SetConsumePointerInput()

◆ SetIsFocusable()

◆ SetIsTouchScrollingEnabled()

◆ SetNavigationDestination()

◆ SetOrientation()

◆ SetScrollBarAlwaysVisible()

◆ SetScrollBarPadding()

◆ SetScrollBarRightClickDragAllowed()

◆ SetScrollBarStyle()

◆ SetScrollBarThickness()

◆ SetScrollBarTrackAlwaysVisible()

◆ SetScrollBarVisibility()

◆ SetScrollingAnimationInterpolationSpeed()

◆ SetScrollOffset()

◆ SetScrollWhenFocusChanges()

◆ SetStyle()

◆ SetWheelScrollMultiplier()