SScrubWidget

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

KismetWidgets

Header

/Engine/Source/Editor/KismetWidgets/Public/SScrubWidget.h

Include

#include "SScrubWidget.h"

Syntax

class SScrubWidget : public SCompoundWidget

Functions

Name Description

Protected function

void

 

CommitValue

(
    float NewValue,
    bool bSliderClamp,
    bool bCommittedFromText
)

Call this method when the user's interaction has changed the value

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Construct the widget

Public function Static

int32

 

GetDivider

(
    float InputMinX,
    float InputMaxX,
    FVector2D WidgetSize,
    float SequenceLength,
    int32 NumFrames
)

This function is used by a few random widgets and is mostly arbitrary. It could be moved anywhere.

Overridden from SWidget

Name Description

Public function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float LayoutScaleMultiplier
)

Compute the ideal size necessary to display this widget.

Public function Virtual Const

FCursorReply

 

OnCursorQuery

(
    const FGeometry& MyGeometry,
    const FPointerEvent& CursorEvent
)

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

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

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

FReply

 

OnMouseWheel

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

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

Public function Virtual Const

int32

 

OnPaint

(
    const FPaintArgs& Args,
    const FGeometry& AllottedGeometry,
    const FSlateRect& MyCullingRect,
    FSlateWindowElementList& OutDrawEl...,
    int32 LayerId,
    const FWidgetStyle& InWidgetStyle,
    bool bParentEnabled
)

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

Name

Description

Public struct

FArguments
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss