UCommonRichTextBlock Class Reference

Text block that supports custom scaling for mobile platforms, with option to only show icons if space is sparse. More...

Public Member Functions
Common Rich Text|Scroll Style
void	SetScrollingEnabled (bool bInIsScrollingEnabled)
Public Member Functions inherited from URichTextBlock
FText	GetText () const
	Returns widgets text.
void	SetText (FText InText)
	Directly sets the widget text. Warning: This will wipe any binding created for the Text property!
void	RefreshTextLayout ()
	Causes the text to reflow it's layout and re-evaluate any decorators.
void	SetTextStyleSet (UDataTable NewTextStyleSet)
URichTextBlockDecorator	GetDecoratorByClass (TSubclassOf< URichTextBlockDecorator > DecoratorClass)
UDataTable	GetTextStyleSet () const
const FTextBlockStyle &	GetDefaultTextStyleOverride () const
	Text style to apply by default to text in this block.
const float32 &	GetMinDesiredWidth () const
	The minimum desired size for the text.
const ETextTransformPolicy &	GetTextTransformPolicy () const
	The text transformation policy to apply to this text block.
const ETextOverflowPolicy &	GetTextOverflowPolicy () const
	Sets what happens to text that is clipped and doesn't fit within the clip rect for this widget.
void	SetDefaultTextStyleOverride (FTextBlockStyle InDefaultTextStyle)
	Text style to apply by default to text in this block.
void	SetDefaultStrikeBrush (FSlateBrush InStrikeBrush)
	Dynamically set the default strike brush for this rich text block.
void	ClearAllDefaultStyleOverrides ()
	Remove all overrides made to the default text style and return to the style specified in the style set data table.
UMaterialInstanceDynamic	GetDefaultDynamicMaterial ()
	Creates a dynamic material for the default font or returns it if it already exists.
void	SetDefaultTextStyle (FTextBlockStyle InDefaultTextStyle)
	Wholesale override of the currently established default text style.
void	SetMinDesiredWidth (float32 InMinDesiredWidth)
	Set the minimum desired width for this rich text block.
void	SetDefaultShadowOffset (FVector2D InShadowOffset)
	Sets the offset that the default text drop shadow should be drawn at.
void	SetAutoWrapText (bool InAutoTextWrap)
	Set the auto wrap for this rich text block.
void	SetDecorators (TArray< TSubclassOf< URichTextBlockDecorator > > InDecoratorClasses)
	Replaces the existing decorators with the list provided.
void	SetDefaultColorAndOpacity (FSlateColor InColorAndOpacity)
	Sets the color and opacity of the default text in this rich text block.
void	SetDefaultFont (FSlateFontInfo InFontInfo)
	Dynamically set the default font info for this rich text block.
void	SetDefaultMaterial (UMaterialInterface InMaterial)
void	SetDefaultShadowColorAndOpacity (FLinearColor InShadowColorAndOpacity)
	Sets the color and opacity of the default text drop shadow Note: if opacity is zero no shadow will be drawn.
void	SetTextTransformPolicy (ETextTransformPolicy InTransformPolicy)
	Set the text transformation policy for this text block.
void	SetTextOverflowPolicy (ETextOverflowPolicy InOverflowPolicy)
	Set the text overflow policy for this text block.
Public Member Functions inherited from UTextLayoutWidget
const ETextJustify &	GetJustification () const
	How the text should be aligned with the margin.
bool	GetAutoWrapText () const
	True if we're wrapping text automatically based on the computed horizontal space for this widget.
void	SetAutoWrapText (bool Value)
	True if we're wrapping text automatically based on the computed horizontal space for this widget.
void	SetJustification (ETextJustify InJustification)
Public Member Functions inherited from UWidget
bool	IsInViewport () const
void	RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	BroadcastFieldValueChanged (FFieldNotificationId FieldId)
void	AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	SetbOverride_Cursor (bool Value)
void	SetToolTipWidget (UWidget Widget)
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	GetbIsEnabled () const
	Sets whether this widget can be modified interactively by the user.
void	SetbIsEnabled (bool bInIsEnabled)
	Sets whether this widget can be modified interactively by the user.
const FWidgetTransform &	GetRenderTransform ()
const FText &	GetToolTipText () const
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	GetToolTipWidget () const
	Tooltip widget to show when the user hovers over the widget with the mouse.
const FVector2D &	GetRenderTransformPivot () const
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
void	GetChildWidgets (TArray< UWidget > &OutChildWidgets) const
void	SetbOverrideAccessibleDefaults (bool Value)
	Override all of the default accessibility behavior and text for this widget.
void	SetbCanChildrenBeAccessible (bool Value)
	Whether or not children of this widget can appear as distinct accessible widgets.
void	SetAccessibleText (FText Value)
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
void	SetAccessibleSummaryText (FText Value)
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
bool	GetbIsVolatile () const
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
void	SetbIsVolatile (bool Value)
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
const EMouseCursor &	GetCursor () const
	The cursor to show when the mouse is over the widget.
const FGeometry &	GetCachedGeometry () const
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
EWidgetClipping	GetClipping () const
	Gets the clipping state of this widget.
FVector2D	GetDesiredSize () const
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
FText	GetAccessibleText () const
	Gets the accessible text from the underlying Slate accessible widget.
FText	GetAccessibleSummaryText () const
	Gets the accessible summary text from the underlying Slate accessible widget.
UGameInstance	GetGameInstance () const
	Gets the game instance associated with this UI.
ULocalPlayer	GetOwningLocalPlayer () const
	Gets the local player associated with this UI.
APlayerController	GetOwningPlayer () const
	Gets the player controller associated with this UI.
const FGeometry &	GetPaintSpaceGeometry () const
UPanelWidget	GetParent () const
	Gets the parent widget.
float32	GetRenderOpacity () const
	Gets the current visibility of the widget.
bool	GetIsEnabled () const
	Gets the current enabled status of the widget.
void	ForceVolatile (bool bForce)
	Sets the forced volatility of the widget.
ESlateVisibility	GetVisibility () const
	Gets the current visibility of the widget.
bool	HasAnyUserFocus () const
	Returns true if this widget is focused by any user.
bool	HasFocusedDescendants () const
	Returns true if any descendant widget is focused by any user.
bool	HasKeyboardFocus () const
	Checks to see if this widget currently has the keyboard focus.
bool	HasMouseCapture () const
	Checks to see if this widget is the current mouse captor.
bool	HasMouseCaptureByUser (int UserIndex, int PointerIndex=- 1) const
	Checks to see if this widget is the current mouse captor.
bool	HasUserFocus (APlayerController PlayerController) const
	Returns true if this widget is focused by a specific user.
bool	HasUserFocusedDescendants (APlayerController PlayerController) const
	Returns true if any descendant widget is focused by a specific user.
void	InvalidateLayoutAndVolatility ()
	Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.
bool	IsHovered () const
	Returns true if the widget is currently being hovered by a pointer device.
void	ForceLayoutPrepass ()
	Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget. One pre-pass already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.
bool	IsRendered () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool	IsVisible () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
const FGeometry &	GetTickSpaceGeometry () const
void	SetClipping (EWidgetClipping InClipping)
	Sets the clipping state of this widget.
void	SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Custom Rule.
void	RemoveFromParent ()
	Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.
void	ResetCursor ()
	Resets the cursor to use on the widget, removing any customization for it.
void	SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
	Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.
void	SetVisibility (ESlateVisibility InVisibility)
	Sets the visibility of the widget.
void	SetCursor (EMouseCursor InCursor)
	Sets the cursor to show over the widget.
void	SetFocus ()
	Sets the focus to this widget for the owning user.
void	SetIsEnabled (bool bInIsEnabled)
	Sets the current enabled status of the widget.
void	SetKeyboardFocus ()
	Sets the focus to this widget.
void	SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
void	SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for non Explicit, non Custom and non CustomBoundary Rules.
void	SetUserFocus (APlayerController PlayerController)
	Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()).
void	SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for CustomBoundary Rule.
void	SetNavigationRuleExplicit (EUINavigation Direction, UWidget InWidget)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Explicit Rule.
void	SetRenderOpacity (float32 InOpacity)
	Sets the visibility of the widget.
void	SetToolTip (UWidget Widget)
	Sets a custom widget as the tooltip of the widget.
void	SetToolTipText (FText InToolTipText)
	Sets the tooltip text for the widget.
void	SetRenderTransformAngle (float32 Angle)
void	SetRenderTransformPivot (FVector2D Pivot)
float32	GetRenderTransformAngle () const
void	SetRenderTransform (FWidgetTransform InTransform)
void	SetRenderShear (FVector2D Shear)
void	SetRenderScale (FVector2D Scale)
void	SetRenderTranslation (FVector2D Translation)
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from URichTextBlock
static UClass	StaticClass ()
Static Public Member Functions inherited from UTextLayoutWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UVisual
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Appearance
TSubclassOf< UCommonTextScrollStyle >	ScrollStyle
	References the scroll style asset to use, no reference disables scrolling.
TSubclassOf< UCommonTextStyle >	DefaultTextStyleOverrideClass
bool	bAutoCollapseWithEmptyText
	True to automatically collapse this rich text block when set to display an empty string. Conversely, will be SelfHitTestInvisible when showing a non-empty string.
bool	bIsScrollingEnabled
	If scrolling is enabled/disabled initially, this can be updated in blueprint.
InlineIcon
bool	bTintInlineIcon
	Toggle it on if the text color should also tint the inline icons.
ERichTextInlineIconDisplayMode	InlineIconDisplayMode
Mobile
float32	MobileTextBlockScale
	Mobile font size multiplier. Activated by default on mobile. See CVar Mobile_PreviewFontSize.
Public Attributes inherited from URichTextBlock
ETextOverflowPolicy	TextOverflowPolicy
	Sets what happens to text that is clipped and doesn't fit within the clip rect for this widget.
FText	Text
	The text to display.
UDataTable	TextStyleSet
bool	bOverrideDefaultStyle
	True to specify the default text style for this rich text inline, overriding any default provided in the style set table.
const UMaterialInstanceDynamic	DefaultDynamicMaterial
	Creates a dynamic material for the default font or returns it if it already exists.
TArray< TSubclassOf< URichTextBlockDecorator > >	DecoratorClasses
FTextBlockStyle	DefaultTextStyleOverride
	Text style to apply by default to text in this block.
float32	MinDesiredWidth
	The minimum desired size for the text.
ETextTransformPolicy	TextTransformPolicy
	The text transformation policy to apply to this text block.
Public Attributes inherited from UTextLayoutWidget
ETextJustify	Justification
	How the text should be aligned with the margin.
bool	ApplyLineHeightToBottomLine
	Whether to leave extra space below the last line due to line height.
FMargin	Margin
	The amount of blank space left around the edges of text area.
float32	LineHeightPercentage
	The amount to scale each lines height by.
FShapedTextOptions	ShapedTextOptions
	Controls how the text within this widget should be shaped.
float32	WrapTextAt
	Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.
bool	AutoWrapText
	True if we're wrapping text automatically based on the computed horizontal space for this widget.
ETextWrappingPolicy	WrappingPolicy
	The wrapping policy to use.
Public Attributes inherited from UWidget
FText	AccessibleSummaryText
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
FText	AccessibleText
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
ESlateAccessibleBehavior	AccessibleBehavior
	Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
ESlateAccessibleBehavior	AccessibleSummaryBehavior
	How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
EMouseCursor	Cursor
	The cursor to show when the mouse is over the widget.
FText	ToolTipText
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	ToolTipWidget
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	bIsEnabled
	Sets whether this widget can be modified interactively by the user.
ESlateVisibility	Visibility
	The visibility of the widget.
UPanelSlot	Slot
	The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
EFlowDirectionPreference	FlowDirectionPreference
	Allows you to set a new flow direction.
UWidgetNavigation	Navigation
	The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
bool	bIsVolatile
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
FVector2D	RenderTransformPivot
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
FWidgetTransform	RenderTransform
	The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
EWidgetPixelSnapping	PixelSnapping
	If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.
EWidgetClipping	Clipping
	Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.
float32	RenderOpacity
	The opacity of the widget.
const FGeometry	CachedGeometry
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
const FGeometry	PaintSpaceGeometry
const UGameInstance	GameInstance
	Gets the game instance associated with this UI.
const UPanelWidget	Parent
	Gets the parent widget.
const FVector2D	DesiredSize
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
const FGeometry	TickSpaceGeometry
bool	IsEnabled
	Gets the current enabled status of the widget.
const ULocalPlayer	OwningLocalPlayer
	Gets the local player associated with this UI.
const APlayerController	OwningPlayer
	Gets the player controller associated with this UI.
float32	RenderTransformAngle
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

Text block that supports custom scaling for mobile platforms, with option to only show icons if space is sparse.

Member Function Documentation

SetScrollingEnabled()

void SetScrollingEnabled

(

bool

bInIsScrollingEnabled

)

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

bAutoCollapseWithEmptyText

bool bAutoCollapseWithEmptyText

True to automatically collapse this rich text block when set to display an empty string. Conversely, will be SelfHitTestInvisible when showing a non-empty string.

bIsScrollingEnabled

bool bIsScrollingEnabled

If scrolling is enabled/disabled initially, this can be updated in blueprint.

bTintInlineIcon

bool bTintInlineIcon

Toggle it on if the text color should also tint the inline icons.

DefaultTextStyleOverrideClass

TSubclassOf<UCommonTextStyle> DefaultTextStyleOverrideClass

InlineIconDisplayMode

ERichTextInlineIconDisplayMode InlineIconDisplayMode

MobileTextBlockScale

float32 MobileTextBlockScale

Mobile font size multiplier. Activated by default on mobile. See CVar Mobile_PreviewFontSize.

ScrollStyle

TSubclassOf<UCommonTextScrollStyle> ScrollStyle

References the scroll style asset to use, no reference disables scrolling.