Navigation
API > API/Runtime > API/Runtime/Slate
Utility to wrap a single-line text widget (STextBlock or SRichTextBlock) and provide support for auto-scrolling the text if it's longer than the available space.
| Name | STextScroller |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Text/STextScroller.h |
| Include Path | #include "Widgets/Text/STextScroller.h" |
Syntax
class STextScroller : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → STextScroller
- FSlateControlledConstruction → SWidget → SCompoundWidget → STextScroller
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveState | EActiveState | Widgets/Text/STextScroller.h | ||
| ActiveTimerHandle | TSharedPtr< FActiveTimerHandle > | Widgets/Text/STextScroller.h | ||
| FontAlpha | float | Widgets/Text/STextScroller.h | ||
| ScrollOffset | float | Widgets/Text/STextScroller.h | ||
| ScrollOptions | FTextScrollerOptions | Widgets/Text/STextScroller.h | ||
| ScrollOrientation | EOrientation | Widgets/Text/STextScroller.h | ||
| TickerState | ETickerState | Widgets/Text/STextScroller.h | ||
| TimeElapsed | float | Widgets/Text/STextScroller.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Widgets/Text/STextScroller.h | ||
bool IsScrollingEnabled() |
Widgets/Text/STextScroller.h | ||
void ResetScrollState() |
Widgets/Text/STextScroller.h | ||
void StartScrolling() |
Widgets/Text/STextScroller.h | ||
void SuspendScrolling() |
Widgets/Text/STextScroller.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnArrangeChildren
(
const FGeometry& AllottedGeometry, |
Widgets/Text/STextScroller.h | ||
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Text/STextScroller.h |