The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
UE3:UIComp_DrawString (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
| Object >> Component >> UIComponent >> UIComp_DrawComponents >> UIComp_DrawString |
Contents |
- Package:
- Engine
- Within class:
- UIObject
- Implemented interfaces:
- UIStyleResolver
- Direct subclasses:
- UIComp_DrawCaption, UIComp_DrawStringEditbox, UIComp_DrawStringSlider, UIComp_UTGlowString
- This class in other games:
- UDK
| This is an auto-generated page and may need human attention. Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
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-2007 Epic Games, Inc. All Rights Reserved.
[edit] Properties
[edit] Property group 'Data'
[edit] bIgnoreMarkup
Type: bool
whether the UIString should process markup
[edit] Property group 'Debug'
[edit] bRefreshString
Type: bool
Modifiers: transient
Used for debugging strings - causes RefreshValue to be called
[edit] Property group 'Presentation'
[edit] AutoSizeParameters
Type: UIRoot.AutoSizeData
Array size: 2 (EUIOrientation.UIORIENT_MAX)
Controls whether the owning widget will be automatically resized to display this string's value.
[edit] ClampRegion
Type: UIRoot.UIRenderingSubregion
Array size: 2 (EUIOrientation.UIORIENT_MAX)
Modifiers: private
Specifies how much of the available bounding region should be available for rendering the string in.
Default value, index 0:
| Member | Value | ||||||
|---|---|---|---|---|---|---|---|
| ClampRegionAlignment | UIALIGN_Default | ||||||
| ClampRegionOffset |
|
||||||
| ClampRegionSize |
|
Default value, index 1:
| Member | Value | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| ClampRegionAlignment | UIALIGN_Default | ||||||||
| ClampRegionOffset |
|
||||||||
| ClampRegionSize |
|
[edit] Property group 'StyleOverride'
[edit] TextStyleCustomization
Type: UIRoot.UITextStyleOverride
Contains values for customizing and overriding rendering and formatting values designated by this component's style.
Default value:
| Member | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AutoScaling |
|
||||||||||
| DrawColor |
|
||||||||||
| DrawScale[0] | 1.0 | ||||||||||
| DrawScale[1] | 1.0 | ||||||||||
| Opacity | 1.0 |
[edit] Internal variables
[edit] bReapplyFormatting
Type: bool
Modifiers: transient
set to indicate that this label needs to recalculate the extents for its string
[edit] StringClass
Modifiers: const, transient
the class to use for creating the ValueString
[edit] StringStyle
Type: UIRoot.UIStyleReference
Modifiers: private
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.
Default value:
| Member | Value |
|---|---|
| DefaultStyleTag | 'DefaultComboStyle' |
| RequiredStyleClass | Class'Engine.UIStyle_Combo' |
[edit] StyleResolverTag
Type: name
The tag used to fulfill the UIStyleResolver interface's GetStyleResolverTag method. Value should be set by the owning widget.
Default value: 'String Style'
[edit] SubscriberOwner
Type: UIDataStoreSubscriber
Modifiers: transient
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.
[edit] ValueString
Type: UIString
Modifiers: private, transient
The UIString that will render the text. Created at runtime when this component is initialized.
[edit] Functions
[edit] Native functions
See UIComp_DrawString native functions.
[edit] Events
[edit] EnableAutoSizing
Changes the value of bAutoSizeEnabled for the specified orientation.
Parameters:
- Orientation - the orientation to enable/disable
- bShouldEnable - whether autosizing should be enabled
[edit] SetAutoSizePadding
[edit] Other instance functions
[edit] IsAutoSizeEnabled
Returns TRUE if autosizing is enabled for the specified orientation.
Parameters:
- Orientation - the orientation to check
Returns:
- TRUE if auto-sizing is enabled for the specified orientation
