UE3:UIComp_DrawString (UDK)
|
Object >> Component >> UIComponent >> UIComp_DrawComponents >> UIComp_DrawString |
- Package:
- Engine
- Within class:
- UIObject
- Implemented interfaces:
- UIStyleResolver
- Direct subclasses:
- UIComp_DrawCaption, UIComp_DrawStringEditbox, UIComp_DrawStringSlider, UIComp_UTGlowString
- This class in other games:
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} 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).
Properties
Property group 'Appearance'
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.
bAllowBoundsAdjustment
Type: bool
Modifiers: private
Displayed as: Affects Widget Bounds
Controls whether docking is taken into account when determining the boundaries of the string, and whether the widget's position and size could potentially be modified by this component. If the widget only has one string component which takes up the entire widget (such as a label
Default value: True
bDropShadow
Type: bool
true to draw an automatic dropshadow under the text
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 |
|
DropShadowColor
Type: Object.LinearColor
Color of the dropshadow
Default value:
| Member | Value |
|---|---|
| A | 1.0 |
| B | 0.0 |
| G | 0.0 |
| R | 0.0 |
DropShadowOffset
Type: Object.Vector2D
Offset to draw the dropshadow
Default value:
| Member | Value |
|---|---|
| X | 2.0 |
| Y | 2.0 |
Property group 'Data'
bIgnoreMarkup
Type: bool
whether the UIString should process markup
Property group 'StyleOverride'
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 |
Property group 'ZDebug'
bRefreshString
Type: bool
Modifiers: transient
Used for debugging strings - causes RefreshValue to be called
Internal variables
bReapplyFormatting
Type: bool
Modifiers: transient
set to indicate that this label needs to recalculate the extents for its string
StringClass
Modifiers: const, transient
the class to use for creating the ValueString
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' |
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'
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.
ValueString
Type: UIString
Modifiers: private, transient
The UIString that will render the text. Created at runtime when this component is initialized.
Functions
Native functions
See UIComp_DrawString native functions.
Events
EnableAutoSizing
Changes the value of bAutoSizeEnabled for the specified orientation.
Parameters:
- Orientation - the orientation to enable/disable
- bShouldEnable - whether autosizing should be enabled
SetAutoSizePadding
Other instance functions
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
