Engine.UIEditBox

Extends

UIObject

Modifiers

native ( UIPrivate ) implements ( UIDataStorePublisher )

This basic widget allows the user to type text into an input field. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. @todo - auto-complete @todo - multi-line support @todo - add property to control whether change notifications are sent while the user is typing text (vs. only when the user presses enter or something).

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

Direct Known Subclasses:

UINumericEditBox, UTUIEditBox

Delegates Summary
	bool	OnSubmitText (UIEditBox Sender, int PlayerIndex)

Functions Summary
	int	CalculateCaretPositionFromCursorLocation (optional int PlayerIndex=GetBestPlayerIndex() ) con)
		ClearBoundDataStores ()
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
	string	GetValue (optional bool bReturnUserText=true ) con)
		IgnoreMarkup (bool bShouldIgnoreMarkup ))
		Initialized ()))
	bool	IsReadOnly ()))
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
		OnGetTextValue (UIAction_GetTextValue Action ))
		OnSetLabelText (UIAction_SetLabelText Action ))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
	bool	SaveSubscriberValue (out array<UIDataStore> out_BoundDataStores, optional int BindingIndex=INDEX_NONE)
		SetBackgroundImage (Surface NewImage ))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetReadOnly (bool bShouldBeReadOnly ))
		SetValue (string NewText, optional int PlayerIndex=GetBestPlayerIndex(), optional bool bSkipNotification)

Data

DataSource Source code

The name of the data source that this editbox's value will be associated with. @todo - explain this a bit more

StringRenderComponent Source code

Renders the text for this editbox

Image

BackgroundImageComponent Source code

Component for rendering the background image

Text

bPasswordMode Source code

If enabled, the * character will be rendered instead of the actual text.

bReadOnly Source code

specifies whether the text in this editbox can be changed by user input

CharacterSet Source code

InitialValue Source code

The initial value to display in the editbox's text field

MaxCharacters Source code

the maximum number of characters that can be entered into the editbox

EEditBoxCharacterSet Source code

OnSubmitText Source code

Called when the user presses enter (or any other action bound to UIKey_SubmitText) while this editbox has focus.
@param Sender the editbox that is submitting text
@param PlayerIndex the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.
@return if TRUE, the editbox will clear the existing value of its textbox.

CalculateCaretPositionFromCursorLocation Source code

Calculates the character position for the point under the mouse or joystick cursor
@param PlayerIndex the index of the player that generated the call to this method; if not specified, the value of GetBestPlayerIndex() is used instead.
@return the index into the editbox's value string for character under the mouse/joystick cursor. If the cursor is within the "client region" of the editbox but not over a character (for example, if the string is very short and the mouse is hovering towards the right side of the region), then the length of the editbox's value string is returend. Otherwise, returns INDEX_NONE,

ClearBoundDataStores Source code

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores Source code

Retrieves the list of data stores bound by this subscriber.
@param out_BoundDataStores receives the array of data stores that subscriber is bound to.

GetDataStoreBinding Source code

Retrieves the markup string corresponding to the data store that this object is bound to.
@param BindingIndex optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.
@return a datastore markup string which resolves to the datastore field that this object is bound to, in the format:

GetValue Source code

Gets the text that is currently in this editbox
@param bReturnUserText if TRUE, returns the text typed into the editbox by the user; if FALSE, returns the resolved value of this editbox's data store binding.

IgnoreMarkup Source code

Changes whether this editbox's string should process markup
@param bShouldIgnoreMarkup if TRUE, markup will not be processed by this editbox's string
@note: does not update any existing text contained by the editbox.

Initialized Source code

IsReadOnly Source code

@return TRUE if this editbox is readonly

NotifyDataStoreValueUpdated Source code

Handler for the UIDataStore.OnDataStoreValueUpdated delegate. Used by data stores to indicate that some data provided by the data has changed. Subscribers should use this function to refresh any data store values being displayed with the updated value. notify subscribers when they should refresh their values from this data store.
@param SourceDataStore the data store that generated the refresh notification; useful for subscribers with multiple data store bindings, to tell which data store sent the notification.
@param PropertyTag the tag associated with the data field that was updated; Subscribers can use this tag to determine whether there is any need to refresh their data values.
@param SourceProvider for data stores which contain nested providers, the provider that contains the data which changed.
@param ArrayIndex for collection fields, indicates which element was changed. value of INDEX_NONE indicates not an array or that the entire array was updated.

OnGetTextValue Source code

Handler for GetTextValue action.

OnSetLabelText Source code

Kismet Action Handlers

RefreshSubscriberValue Source code

Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store.
@return TRUE if this subscriber successfully resolved and applied the updated value.

SaveSubscriberValue Source code

Resolves this subscriber's data store binding and publishes this subscriber's value to the appropriate data store.
@param out_BoundDataStores contains the array of data stores that widgets have saved values to. Each widget that implements this method should add its resolved data store to this array after data values have been published. Once SaveSubscriberValue has been called on all widgets in a scene, OnCommit will be called on all data stores in this array.
@param BindingIndex optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.
@return TRUE if the value was successfully published to the data store.

SetBackgroundImage Source code

Changes the background image for this editbox.
@param NewImage the new surface to use for this UIImage

SetDataStoreBinding Source code

Sets the data store binding for this object to the text specified.
@param MarkupText a markup string which resolves to data exposed by a data store. The expected format is:
@param BindingIndex optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.

SetReadOnly Source code

Changes whether this editbox is read-only.
@param bShouldBeReadOnly TRUE if the editbox should be read-only.

SetValue Source code

Change the value of this editbox at runtime.
@param NewText the new text that should be displayed in the label
@param PlayerIndex the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents
@param bSkipNotification specify TRUE to prevent the OnValueChanged delegate from being called.

defaultproperties
{
   DataSource=
   Begin Object Class=UIComp_DrawStringEditbox Name=EditboxStringRenderer ObjName=EditboxStringRenderer Archetype=UIComp_DrawStringEditbox'Engine.Default__UIComp_DrawStringEditbox'
      StringCaret=(bDisplayCaret=True)
      bIgnoreMarkup=True
      Name="EditboxStringRenderer"
      ObjectArchetype=UIComp_DrawStringEditbox'Engine.Default__UIComp_DrawStringEditbox'
   End Object
   StringRenderComponent=EditboxStringRenderer
   Begin Object Class=UIComp_DrawImage Name=EditboxBackgroundTemplate ObjName=EditboxBackgroundTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Background Image Style"
      Name="EditboxBackgroundTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent=EditboxBackgroundTemplate
   InitialValue="Initial Editbox Value"
   PrimaryStyle=(DefaultStyleTag="DefaultEditboxStyle",RequiredStyleClass=Class'Engine.UIStyle_Combo')
   bSupportsPrimaryStyle=False
   DefaultStates(2)=Class'Engine.UIState_Focused'
   DefaultStates(3)=Class'Engine.UIState_Active'
   DefaultStates(4)=Class'Engine.UIState_Pressed'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIEditBox"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}