The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:UINumericEditBox (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UIEditBox >> UINumericEditBox
Package: 
Engine
Implemented interfaces
UIDataStorePublisher
Direct subclass:
UTUINumericEditBox
This class in other games:
UDK

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[edit]

Property group 'Buttons'[edit]

DecButton_Position[edit]

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[edit]

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'[edit]

DecrementStyle[edit]

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[edit]

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'[edit]

DecimalPlaces[edit]

Type: int

The number of digits after the decimal point.

Default value: 4

NumericValue[edit]

Type: UIRoot.UIRangeData

The value and range parameters for this numeric editbox.

Default value:

Member Value
MaxValue 100.0
NudgeValue 1.0

Internal variables[edit]

DecrementButton[edit]

Type: UINumericEditBoxButton

Modifiers: private


IncrementButton[edit]

Type: UINumericEditBoxButton

Modifiers: private

Buttons that can be used to increment and decrement the value stored in the input field.

Default values[edit]

Property Value
CharacterSet CHARSET_NumericOnly
DataSource
Member Value
MarkupString "Numeric Editbox Text"
RequiredFieldType DATATYPE_RangeProperty
PrivateFlags 1024

Subobjects[edit]

EditboxBackgroundTemplate[edit]

Class: Engine.UIComp_DrawImage

Inherits from: UIEditBox.EditboxBackgroundTemplate

No new values.

EditboxStringRenderer[edit]

Class: Engine.UIComp_DrawStringEditbox

Inherits from: UIEditBox.EditboxStringRenderer

No new values.

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UIEditBox.WidgetEventComponent

No new values.

Functions[edit]

Native functions[edit]

DecrementValue[edit]

native final function DecrementValue (UIScreenObject Sender, int PlayerIndex)

Decrements the numeric editbox's value.

Parameters:

  • EventObject - Object that issued the event.
  • PlayerIndex - Player that performed the action that issued the event.

GetNumericValue[edit]

native final function float GetNumericValue () const

Gets the current value of this numeric editbox.

IncrementValue[edit]

native final function IncrementValue (UIScreenObject Sender, int PlayerIndex)

Increments the numeric editbox's value.

Parameters:

  • EventObject - Object that issued the event.
  • PlayerIndex - Player that performed the action that issued the event.

SetNumericValue[edit]

native final function bool SetNumericValue (float NewValue, optional bool bForceRefreshString)

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[edit]

Initialized[edit]

event 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[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Propagate the enabled state of this widget.