1. Epic GamesDeveloper
  3. SScrollBar

SScrollBar

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Layout

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScrollBar.h
Include #include "Widgets/Layout/SScrollBar.h"

Syntax

class SScrollBar : public SBorder

Variables

  Type Name Description
Protected variable const FSlateBrush * BackgroundBrush Background brush
Protected variable bool bAlwaysShowScrollbar  
Protected variable bool bAlwaysShowScrollbarTrack  
Protected variable bool bDraggingThumb  
Protected variable bool bHideWhenNotInUse  
Protected variable bool bIsScrolling  
Protected variable const FSlateBrush * BottomBrush Bottom brush
Protected variable TSharedPtr< SImage > BottomImage  
Protected variable bool bPreventThrottling Holds whether or not to prevent throttling during mouse capture When true, the viewport will be updated with every single change to the value during dragging
Protected variable EFocusCause DragFocusCause  
Protected variable const FSlateBrush * DraggedThumbImage Image to use when the scrollbar thumb is in its dragged state
Protected variable float DragGrabOffset  
Protected variable TSharedPtr< SBorder > DragThumb  
Protected variable const FSlateBrush * HoveredThumbImage Image to use when the scrollbar thumb is in its hovered state
Protected variable double LastInteractionTime  
Protected variable const FSlateBrush * NormalThumbImage Image to use when the scrollbar thumb is in its normal state
Protected variable FOnUserScrolled OnUserScrolled  
Protected variable EOrientation Orientation  
Protected variable TSharedPtr< SSpacer > ThicknessSpacer  
Protected variable const FSlateBrush * TopBrush Top brush
Protected variable TSharedPtr< SImage > TopImage  
Protected variable TSharedPtr< SScrollBarTrack > Track  
Protected variable TAttribute< EVisibility > UserVisibility The scrollbar's visibility as specified by the user.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool Returns True when the scrollbar should always be shown, else False
Public function Virtual void Allows external scrolling panels to notify the scrollbar when scrolling begins.
Public function void

Construct ( const FArguments& InArgs
)

 Construct this widget
Public function Const float  
Public function Const float  
Public function Virtual void Allows external scrolling panels to notify the scrollbar when scrolling ends.
Protected function void

ExecuteOnUserScrolled ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Execute the on user scrolled delegate
Protected function Const const FSlateBrush *  
Public function Const EOrientation  
Protected function Const FLinearColor We always show a subtle scroll thumb, but highlight it extra when dragging
Protected function Const FSlateColor We fade the scroll track unless it is being hovered
Public function void Invalidate the style
Public function Const bool  
Public function Const bool  
Public function void

SetDragFocusCause ( EFocusCause InDragFocusCause
)

 Set DragFocusCause attribute
Public function void

SetOnUserScrolled ( const FOnUserScrolled& InHandler
)

 Set the handler to be invoked when the user scrolls.
Public function void

SetScrollBarAlwaysVisible ( bool InAlwaysVisible
)

 Set ScrollBarAlwaysVisible attribute
Public function void

SetScrollBarTrackAlwaysVisible ( bool InAlwaysVisible
)

 Set ScrollBarTrackAlwaysVisible attribute
Public function Virtual void

SetState ( float InOffsetFraction,
float InThumbSizeFraction,
bool bCallOnUserScrolled
)

 Set the offset and size of the track's thumb.
Public function void

SetStyle ( const FScrollBarStyle* InStyle
)

 Set argument Style
Public function void

SetThickness ( TAttribute< FVector2D > InThickness
)

 Set Thickness attribute
Public function void

SetUserVisibility ( TAttribute< EVisibility > InUserVisibility
)

 Set UserVisibility attribute
Public function Const EVisibility  
Public function Const float  

Overridden from SWidget

  Type Name Description
Public function Virtual FReply

OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Public function Virtual FReply

OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was release within it.
Public function Virtual void

OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has entered it.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.
Public function Virtual FReply

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual void

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

 SWidget.

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page