I love the smell of UnrealEd crashing in the morning. – tarquin
UE3:UINumericEditBox (UT3)
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIEditBox >> UINumericEditBox |
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- Direct subclass:
- UTUINumericEditBox
- This class in other games:
- UDK
| 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 widget allows the user to type numeric text into an input field. The value of the text in the input field can be incremented and decremented through the buttons associated with this widget.
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved
Todo: selection highlight support
Properties
Property group 'Buttons'
DecButton_Position
Type: UIRoot.UIScreenValue_Bounds
The position of the faces of the Decrement button.
Default value:
| Member | Value |
|---|---|
| ScaleType[0] | EVALPOS_PercentageOwner |
| ScaleType[1] | EVALPOS_PercentageOwner |
| ScaleType[2] | EVALPOS_PercentageOwner |
| ScaleType[3] | EVALPOS_PercentageOwner |
| Value[2] | 1.0 |
| Value[3] | 1.0 |
IncButton_Position
Type: UIRoot.UIScreenValue_Bounds
The position of the faces of the increment button.
Default value:
| Member | Value |
|---|---|
| ScaleType[0] | EVALPOS_PercentageOwner |
| ScaleType[1] | EVALPOS_PercentageOwner |
| ScaleType[2] | EVALPOS_PercentageOwner |
| ScaleType[3] | EVALPOS_PercentageOwner |
| Value[2] | 1.0 |
| Value[3] | 1.0 |
Property group 'Style'
DecrementStyle
Type: UIRoot.UIStyleReference
the style to use for the editbox's decrement button
Default value:
| Member | Value |
|---|---|
| DefaultStyleTag | 'ButtonBackground' |
| RequiredStyleClass | Class'Engine.UIStyle_Image' |
IncrementStyle
Type: UIRoot.UIStyleReference
the style to use for the editbox's increment button
Default value:
| Member | Value |
|---|---|
| DefaultStyleTag | 'ButtonBackground' |
| RequiredStyleClass | Class'Engine.UIStyle_Image' |
Property group 'Text'
DecimalPlaces
Type: int
The number of digits after the decimal point.
Default value: 4
NumericValue
Type: UIRoot.UIRangeData
The value and range parameters for this numeric editbox.
Default value:
| Member | Value |
|---|---|
| MaxValue | 100.0 |
| NudgeValue | 1.0 |
Internal variables
DecrementButton
Type: UINumericEditBoxButton
Modifiers: private
IncrementButton
Type: UINumericEditBoxButton
Modifiers: private
Buttons that can be used to increment and decrement the value stored in the input field.
Default values
| Property | Value | ||||||
|---|---|---|---|---|---|---|---|
| CharacterSet | CHARSET_NumericOnly | ||||||
| DataSource |
|
||||||
| PrivateFlags | 1024 |
Subobjects
EditboxBackgroundTemplate
Class: Engine.UIComp_DrawImage
Inherits from: UIEditBox.EditboxBackgroundTemplate
No new values.
EditboxStringRenderer
Class: Engine.UIComp_DrawStringEditbox
Inherits from: UIEditBox.EditboxStringRenderer
No new values.
WidgetEventComponent
Class: Engine.UIComp_Event
Inherits from: UIEditBox.WidgetEventComponent
No new values.
Functions
Native functions
DecrementValue
Decrements the numeric editbox's value.
Parameters:
- EventObject - Object that issued the event.
- PlayerIndex - Player that performed the action that issued the event.
GetNumericValue
Gets the current value of this numeric editbox.
IncrementValue
Increments the numeric editbox's value.
Parameters:
- EventObject - Object that issued the event.
- PlayerIndex - Player that performed the action that issued the event.
SetNumericValue
Change the value of this numeric editbox at runtime. Takes care of conversion from float to internal value string.
Parameters:
- NewValue - the new value for the editbox.
- bForceRefreshString - Forces a refresh of the string component, normally the string is only refreshed when the value is different from the current value.
Returns:
- TRUE if the editbox's value was changed
Events
Initialized
Overrides: UIEditBox.Initialized
Initializes the clicked delegates in the increment and decrement buttons to use the editbox's increment and decrement functions.
Todo: this is a fix for the issue where delegates don't seem to be getting set properly in defaultproperties blocks.
PostInitialize
Overrides: UIScreenObject.PostInitialize
Propagate the enabled state of this widget.
