Engine.UIComp_DrawString

Extends

UIComp_DrawComponents

Modifiers

native ( UIPrivate ) HideCategories ( Object ) editinlinenew implements ( UIStyleResolver )

This component handles rendering UIStrings for widgets. It is responsible for managing any formatting data that is specific to each widget instance (thus inappropriate for storage in UIStyles). Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.UIComponent
      |   
      +-- Engine.UIComp_DrawComponents
         |   
         +-- Engine.UIComp_DrawString

Direct Known Subclasses:

UIComp_DrawCaption, UIComp_DrawStringEditbox, UIComp_DrawStringSlider, UIComp_UTGlowString

Functions Summary
		DisableCustomAlignment ()
		DisableCustomAttributes ()
		DisableCustomAutoScaling ()
		DisableCustomClipAlignment ()
		DisableCustomClipMode ()
		DisableCustomColor ()
		DisableCustomFont ()
		DisableCustomOpacity ()
		DisableCustomPadding ()
		DisableCustomScale ()
		DisableCustomSpacingAdjust ()
		EnableAutoSizing (EUIOrientation Orientation, bool bShouldEnable=true ))
		EnableSubregion (EUIOrientation Orientation, optional bool bShouldEnable = true)
	UIStyle_Combo	GetAppliedStringStyle (optional UIState DesiredMenuState)
	bool	GetFinalStringStyle (out UICombinedStyleData FinalStyleData)
	name	GetStyleResolverTag ()
	EUIAlignment	GetSubregionAlignment (EUIOrientation Orientation ) con)
	float	GetSubregionOffset (EUIOrientation Orientation, EUIExtentEvalType OutputType=UIEXTENTEVAL_Pixels ) con)
	float	GetSubregionSize (EUIOrientation Orientation, EUIExtentEvalType OutputType=UIEXTENTEVAL_Pixels ) con)
	string	GetValue (optional bool bReturnProcessedText=true ) con)
	ETextClipMode	GetWrapMode () con)
	bool	IsAutoSizeEnabled (EUIOrientation Orientation ))
	bool	IsSubregionEnabled (EUIOrientation Orientation ) con)
	bool	NotifyResolveStyle (UISkin ActiveSkin, bool bClearExistingValue, optional UIState CurrentMenuState, const optional name StylePropertyName)
		RefreshValue ()
		SetAlignment (EUIOrientation Orientation, EUIAlignment NewAlignment)
		SetAttributes (UITextAttributes NewAttributes)
		SetAutoScaling (ETextAutoScaleMode NewAutoScaleMode, optional float NewMinScaleValue=-1.f)
		SetAutoSizeExtent (EUIOrientation Orientation, float MinValue, float MaxValue, EUIExtentEvalType MinScaleType, EUIExtentEvalType MaxScaleType)
		SetAutoSizePadding (EUIOrientation Orientation, float NearValue, float FarValue, EUIExtentEvalType NearScaleType, EUIExtentEvalType FarScaleType ))
		SetClipAlignment (EUIAlignment NewClipAlignment)
		SetColor (LinearColor NewColor)
		SetFont (Font NewFont)
		SetOpacity (float NewOpacity)
		SetPadding (float HorizontalPadding, float VerticalPadding)
		SetScale (EUIOrientation Orientation, float NewScale)
		SetSpacingAdjust (EUIOrientation Orientation, float NewSpacingAdjust)
	bool	SetStyleResolverTag (name NewResolverTag)
		SetSubregionAlignment (EUIOrientation Orientation, EUIAlignment NewValue)
		SetSubregionOffset (EUIOrientation Orientation, float NewValue, EUIExtentEvalType EvalType)
		SetSubregionSize (EUIOrientation Orientation, float NewValue, EUIExtentEvalType EvalType)
		SetValue (string NewText)
		SetWrapMode (ETextClipMode NewClipMode)

bReapplyFormatting Source code

set to indicate that this label needs to recalculate the extents for its string

StringClass Source code

the class to use for creating the ValueString

StringStyle Source code

The style to use for rendering this component's string. If the style is invalid, the component will use the owning widget's PrimaryStyle, if possible.

StyleResolverTag Source code

The tag used to fulfill the UIStyleResolver interface's GetStyleResolverTag method. Value should be set by the owning widget.

SubscriberOwner Source code

The subscriber that owns this component. If set, will be added to the refresh delegates for any data stores resolved in the string contained by this component.

ValueString Source code

The UIString that will render the text. Created at runtime when this component is initialized.

Data

bIgnoreMarkup Source code

whether the UIString should process markup

Debug

bRefreshString Source code

Used for debugging strings - causes RefreshValue to be called

Presentation

> Source code

Controls whether the owning widget will be automatically resized to display this string's value.

ClampRegion[EUIOrientation.UIORIENT_MAX] Source code

Specifies how much of the available bounding region should be available for rendering the string in.

StyleOverride

TextStyleCustomization Source code

Contains values for customizing and overriding rendering and formatting values designated by this component's style.

DisableCustomAlignment Source code

Disables text alignment customization allowing the string to use the values from the applied style.

DisableCustomAttributes Source code

Disables text attribute customization allowing the string to use the values from the applied style.

DisableCustomAutoScaling Source code

Disables text autoscale mode customization, allowing the string to use the values from the applied style.

DisableCustomClipAlignment Source code

Disables clip alignment customization allowing the string to use the values from the applied style.

DisableCustomClipMode Source code

Disables text clip mode customization allowing the string to use the values from the applied style.

DisableCustomColor Source code

Disables font color customization allowing the string to use the values from the applied style.

DisableCustomFont Source code

Disables font customization allowing the string to use the values from the applied style.

DisableCustomOpacity Source code

Disables the custom opacity level for this comp

DisableCustomPadding Source code

Disables the custom padding for this component.

DisableCustomScale Source code

Disables text scale customization allowing the string to use the values from the applied style.

DisableCustomSpacingAdjust Source code

Disables customization of spacing adjustment between characters and lines of text from the applied style.

EnableAutoSizing Source code

Changes the value of bAutoSizeEnabled for the specified orientation.
@param Orientation the orientation to enable/disable
@param bShouldEnable whether autosizing should be enabled

EnableSubregion Source code

Changes the value of bSubregionEnabled for the specified orientation.
@param Orientation the orientation to enable/disable
@param bShouldEnable whether specifying a subregion should be allowed

GetAppliedStringStyle Source code

Returns the combo style data being used by this string rendering component. If the component's StringStyle is not set, the style data will be pulled from the owning widget's PrimaryStyle, if possible.
@param DesiredMenuState the menu state for the style data to retrieve; if not specified, uses the owning widget's current menu state.
@return the combo style data used to render this component's string for the specified menu state.
@note: noexport because we the native version is also handles optionally resolving the string style data from the active skin, so it takes a few more parameters.

GetFinalStringStyle Source code

Gets the style data that will be used when rendering this component's string, including all style overrides or customizations enabled for this instance.
@param FinalStyleData will be filled in with the style and formatting values that will be applied to this component's string
@return TRUE if the input value was filled in; FALSE if the component's style is still invalid or couldn't set the output value for any reason.

GetStyleResolverTag Source code

Returns the tag assigned to this UIStyleResolver by the owning widget

GetSubregionAlignment Source code

Returns the alignment of the clamped subregion for a single orientation.
@param Orientation the orientation to retrieve the subregion alignment for
@return the alignment of the clamp subregion for the specified orientation.

GetSubregionOffset Source code

Returns the offset of the clamped subregion for a single orientation.
@param Orientation the orientation to retrieve the subregion offset for
@param OutputType indicates how the result should be formatted.
@return the offset of the clamp subregion for the specified orientation, relative to the widget's bounding region and formatted according to the value of OutputType.

GetSubregionSize Source code

Returns the size of the clamped subregion for a single orientation.
@param Orientation the orientation to retrieve the subregion size for
@param OutputType indicates how the result should be formatted.
@return the size of the clamp subregion for the specified orientation, formatted according to the value of OutputType.

GetValue Source code

Retrieve the value of the string.
@param bReturnProcessedText Determines whether the processed or raw version of the value string is returned. The raw value will contain any markup; the processed string will be text only. Any image tokens are converted to their text counterpart.
@return the complete text value contained by the UIString, in either the processed or unprocessed state.

GetWrapMode Source code

Wrapper for quickly grabbing the current wrap mode for this component.

IsAutoSizeEnabled Source code

Returns TRUE if autosizing is enabled for the specified orientation.
@param Orientation the orientation to check
@return TRUE if auto-sizing is enabled for the specified orientation

IsSubregionEnabled Source code

Returns TRUE if a subregion clamp is enabled for the specified orientation.
@param Orientation the orientation to check
@return TRUE if a subregion is enabled for the specified orientation

NotifyResolveStyle Source code

Resolves the combo style for this string rendering component.
@param ActiveSkin the skin the use for resolving the style reference.
@param bClearExistingValue if TRUE, style references will be invalidated first.
@param CurrentMenuState the menu state to use for resolving the style data; if not specified, uses the current menu state of the owning widget.
@param StyleProperty if specified, only the style reference corresponding to the specified property will be resolved; otherwise, all style references will be resolved.

RefreshValue Source code

Clears and regenerates all nodes in the string by reparsing the source string.

SetAlignment Source code

Enables text alignment customization and sets the component's custom alignment value to the value specified.
@param Orientation indicates which orientation to modify
@param NewAlignment the new alignment to use for rendering this component's text

SetAttributes Source code

Enables text attribute customization and changes the component's override attributes to the value specified.
@param NewAttributes the attributes to use for rendering this component's text

SetAutoScaling Source code

Enables autoscale customization and changes the component's override autoscalemode to the value specified.
@param NewAutoScaleMode the autoscale mode to use for formatting this component's text
@param NewMinScaleValue the minimum scaling value to apply to the text. if not specified (or a negative value is specified), the min scaling value will not be changed.

SetAutoSizeExtent Source code

Changes the minimum and maximum auto-size values for this string.
@param Orientation the orientation to enable/disable
@param MinValue the minimum size that auto-sizing should resize to (specify 0 to disable)
@param MaxValue the maximum size that auto-sizing should resize to (specify 0 to disable)
@param MinScaleType the scale type for the minimum value
@param MaxScaleType the scale type for the maximum value

SetAutoSizePadding Source code

SetClipAlignment Source code

Enables clip alignment customization and sets the component's custom clip alignment value to the value specified.
@param NewClipAlignment the new clip alignment to use mode for this string.

SetColor Source code

Enables font color customization and changes the component's override color to the value specified.
@param NewColor the color to use for rendering this component's string

SetFont Source code

Enables font customization and changes the component's override font to the value specified.
@param NewFont the font to use for rendering this component's text

SetOpacity Source code

Enables a custom opacity and changes the component's override opacity to the value specified.
@param NewOpacity the alpha to use for rendering this component's string

SetPadding Source code

Enables custom padding and changes the component's override padding to the value specified.
@param HorizontalPadding new horizontal padding value to use (assuming a screen height of DEFAULT_SIZE_Y); will be scaled based on actual resolution. Specify -1 to indicate that HorizontalPadding should not be changed (useful when changing only the vertical padding)
@param HorizontalPadding new vertical padding value to use (assuming a screen height of DEFAULT_SIZE_Y); will be scaled based on actual resolution. Specify -1 to indicate that VerticalPadding should not be changed (useful when changing only the horizontal padding)

SetScale Source code

Enables text scale customization and sets the component's custom scale value to the value specified.
@param Orientation indicates which orientation to modify
@param NewScale the new scale to use for rendering this component's text

SetSpacingAdjust Source code

Enables customization of the spacing adjustment between characters and lines of text
@param Orientation indicates which orientation to modify
@param NewSpacingAdjust the new spacing adjust (in pixels) for rendering this component's text

SetStyleResolverTag Source code

Changes the tag assigned to the UIStyleResolver to the specified value.
@return TRUE if the name was changed successfully; FALSE otherwise.

SetSubregionAlignment Source code

Changes the alignment of the clamped subregion for the specified orientation.
@param Orientation the orientation to update
@param NewValue the new alignment to use

SetSubregionOffset Source code

Changes the offset of the clamped subregion for the specified orientation.
@param Orientation the orientation to update
@param NewValue the new offset to use
@param EvalType indicates how NewValue should be intepreted

SetSubregionSize Source code

Changes the size of the clamped subregion for the specified orientation.
@param Orientation the orientation to update
@param NewValue the new size for the subregion.
@param EvalType indicates how NewValue should be intepreted

SetValue Source code

Changes the value of the text at runtime.
@param NewText the new text that should be displayed

SetWrapMode Source code

Enables clip mode customization and sets the component's custom clip mode value to the value specified.
@param NewClipMode the new wrapping mode for this string.

defaultproperties
{
   StyleResolverTag="String Style"
   ClampRegion(0)=(ClampRegionSize=(Value=1.000000,ScaleType=UIEXTENTEVAL_PercentSelf),ClampRegionOffset=(ScaleType=UIEXTENTEVAL_PercentSelf),ClampRegionAlignment=UIALIGN_Default)
   ClampRegion(1)=(ClampRegionSize=(Value=1.000000,ScaleType=UIEXTENTEVAL_PercentSelf,Orientation=UIORIENT_Vertical),ClampRegionOffset=(ScaleType=UIEXTENTEVAL_PercentSelf,Orientation=UIORIENT_Vertical),ClampRegionAlignment=UIALIGN_Default)
   TextStyleCustomization=(AutoScaling=(MinScale=0.600000),DrawScale[0]=1.000000,DrawScale[1]=1.000000,DrawColor=(R=1.000000,G=1.000000,B=1.000000,A=1.000000),Opacity=1.000000)
   StringStyle=(DefaultStyleTag="DefaultComboStyle",RequiredStyleClass=Class'Engine.UIStyle_Combo')
   Name="Default__UIComp_DrawString"
   ObjectArchetype=UIComp_DrawComponents'Engine.Default__UIComp_DrawComponents'
}