Engine.UINumericEditBox

Extends

UIEditBox

Modifiers

native ( inherit )

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-2008 Epic Games, Inc. All Rights Reserved. @todo - selection highlight support

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIEditBox
            |   
            +-- Engine.UINumericEditBox

Direct Known Subclasses:

UTUINumericEditBox

Functions Summary
		DecrementValue (UIScreenObject Sender, int PlayerIndex)
	float	GetNumericValue () con)
		IncrementValue (UIScreenObject Sender, int PlayerIndex)
		Initialized ()))
		PostInitialize ()))
	bool	SetNumericValue (float NewValue, optional bool bForceRefreshString=false)

DecrementButton Source code

IncrementButton Source code

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

Buttons

DecButton_Position Source code

The position of the faces of the Decrement button.

IncButton_Position Source code

The position of the faces of the increment button.

Style

DecrementStyle Source code

the style to use for the editbox's decrement button

IncrementStyle Source code

the style to use for the editbox's increment button

Text

DecimalPlaces Source code

The number of digits after the decimal point.

NumericValue Source code

The value and range parameters for this numeric editbox.

DecrementValue Source code

Decrements the numeric editbox's value.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

GetNumericValue Source code

Gets the current value of this numeric editbox.

IncrementValue Source code

Increments the numeric editbox's value.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

Initialized Source code

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 Source code

Propagate the enabled state of this widget.

SetNumericValue Source code

Change the value of this numeric editbox at runtime. Takes care of conversion from float to internal value string.
@param NewValue the new value for the editbox.
@param bForceRefreshString Forces a refresh of the string component, normally the string is only refreshed when the value is different from the current value.
@return TRUE if the editbox's value was changed

defaultproperties
{
   IncrementStyle=(DefaultStyleTag="ButtonBackground",RequiredStyleClass=Class'Engine.UIStyle_Image')
   DecrementStyle=(DefaultStyleTag="ButtonBackground",RequiredStyleClass=Class'Engine.UIStyle_Image')
   NumericValue=(MaxValue=100.000000,NudgeValue=1.000000)
   DecimalPlaces=4
   IncButton_Position=(Value[2]=1.000000,Value[3]=1.000000,ScaleType[0]=EVALPOS_PercentageOwner,ScaleType[1]=EVALPOS_PercentageOwner,ScaleType[2]=EVALPOS_PercentageOwner,ScaleType[3]=EVALPOS_PercentageOwner)
   DecButton_Position=(Value[2]=1.000000,Value[3]=1.000000,ScaleType[0]=EVALPOS_PercentageOwner,ScaleType[1]=EVALPOS_PercentageOwner,ScaleType[2]=EVALPOS_PercentageOwner,ScaleType[3]=EVALPOS_PercentageOwner)
   DataSource=(RequiredFieldType=DATATYPE_RangeProperty,MarkupString="Numeric Editbox Text")
   Begin Object Class=UIComp_DrawStringEditbox Name=EditboxStringRenderer ObjName=EditboxStringRenderer Archetype=UIComp_DrawStringEditbox'Engine.Default__UIEditBox:EditboxStringRenderer'
      ObjectArchetype=UIComp_DrawStringEditbox'Engine.Default__UIEditBox:EditboxStringRenderer'
   End Object
   StringRenderComponent=EditboxStringRenderer
   Begin Object Class=UIComp_DrawImage Name=EditboxBackgroundTemplate ObjName=EditboxBackgroundTemplate Archetype=UIComp_DrawImage'Engine.Default__UIEditBox:EditboxBackgroundTemplate'
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIEditBox:EditboxBackgroundTemplate'
   End Object
   BackgroundImageComponent=EditboxBackgroundTemplate
   CharacterSet=CHARSET_NumericOnly
   PrivateFlags=1024
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIEditBox:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIEditBox:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UINumericEditBox"
   ObjectArchetype=UIEditBox'Engine.Default__UIEditBox'
}