Engine.UIComboBox

Extends

UIObject

Modifiers

native ( UIPrivate ) placeable implements ( UIDataStorePublisher )

A complex widget which contains a list, a button for toggling the visibility of the list, and an editbox for displaying the currently selected item when the list is not visible. Also supports rendering a caption to left, right, above, or below the editbox. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved

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

Direct Known Subclasses:

UTUIComboBox

Delegates Summary
	UIToggleButton	CreateCustomComboButton (UIComboBox ButtonOwner)
	UIEditBox	CreateCustomComboEditbox (UIComboBox EditboxOwner)
	UIList	CreateCustomComboList (UIComboBox ListOwner)

Functions Summary
		ButtonPressed (UIScreenObject EventObject, int PlayerIndex ))
		ClearBoundDataStores ()
		EditboxPressed (UIScreenObject EventObject, int PlayerIndex ))
		EditboxTextChanged (UIObject Sender, int PlayerIndex ))
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
		HideList (optional int PlayerIndex=GetBestPlayerIndex() ))
	bool	IsListDockedToButton ()))
		ListItemSelected (UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ))
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
		OnGetTextValue (UIAction_GetTextValue Action ))
		PostInitialize ()))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
	bool	SaveSubscriberValue (out array<UIDataStore> out_BoundDataStores, optional int BindingIndex=INDEX_NONE)
		SelectedItemChanged (UIObject Sender, int PlayerIndex ))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetEditboxText (string NewText, int PlayerIndex, optional bool bListItemsOnly, optional bool bSkipNotification ))
		SetListDocking (bool bDockToButton ))
		SetVisibility (bool bIsVisible ))
		ShowList (optional int PlayerIndex=GetBestPlayerIndex() ))
	bool	ShowListClickHandler (UIScreenObject EventObject, int PlayerIndex ))

INDEX_CHANGED_NOTIFY_MASK Source code

TEXT_CHANGED_NOTIFY_MASK Source code

ComboButtonClass Source code

The class to use for creating the combo box's button. If more control of the creation is necessary, or to use an existing button, subscribe to the CreateCustomComboButton delegate instead.

ComboEditboxClass Source code

The class to use for creating the combo box's editbox. If more control of the creation is necessary, or to use an existing editbox, subscribe to the CreateCustomComboEditbox delegate instead.

ComboListClass Source code

The class to use for creating the combo box's list. If more control of the creation is necessary, or to use an existing list, subscribe to the CreateCustomComboList delegate instead.

Data

CaptionDataSource Source code

The data source this this combo box's caption will link to, if applicable.

Presentation

BackgroundRenderComponent Source code

Optional component for rendering a background image for this combo box. No value given by default.

bDockListToButtonSource code

Controls whether the list is docked to the combobox itself or the inside face of the button.

CaptionRenderComponent Source code

Optional component for rendering a caption next to the editbox. No value given by default.

thelistwillbethesamewidthastheeditbox.Ifdisabled Source code

Controls whether the list is docked to the combobox itself or the inside face of the button.

thelistwillbethesamewidthastheentirecombobox(defaultbehavior).> Source code

Controls whether the list is docked to the combobox itself or the inside face of the button.

Sound

DecrementCue Source code

This sound is played when the combo's list is hidden It will be played at the same time as the combobox button's clicked sound, so it's recommended to clear any sound cues assign to the combo box button's ClickedCue.

OpenList Source code

This sound is played when the list is made visible. It will be played at the same time as the combobox button's clicked sound, so it's recommended to clear any sound cues assign to the combo box button's ClickedCue.

UIComboBox

bLockSelectedItem Source code

Indicates whether the list's selected item can be modified. The editbox has its own property for controlling whether the user is allowed to type into the editbox.

ComboButton Source code

Used to toggle the visibility of the list @todo - need script accessors for safely replacing the button with a new type, since the var is const

ComboEditbox Source code

Used to display the currently selected value @todo - need script accessors for safely replacing the editbox with a new type, since the var is const

ComboList Source code

Contains the collection of available choices for this combo box @todo - need script accessors for safely replacing the list with a new type, since the var is const

CreateCustomComboButton Source code

CreateCustomComboEditbox Source code

Provides a convenient way to override the creation of the combo's components. Called when this UIComboBox is first initialized.
@return if a custom component is desired, a pointer to a fully configured instance of the desired component class. You must use UIScreenObject.CreateWidget to create the widget instances. The returned instance will be inserted into the combo box's Children array and initialized.

CreateCustomComboList Source code

ButtonPressed Source code

Handler for the button's OnPressed delegate
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

ClearBoundDataStores Source code

Notifies this subscriber to unbind itself from all bound data stores

EditboxPressed Source code

Handler for the editbox's OnPress delegate.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

EditboxTextChanged Source code

Handler for the editbox's OnValueChanged delegate. Called when the user types text into the editbox.
@param Sender the UIObject whose value changed
@param PlayerIndex the index of the player that generated the call to this method; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.

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 indicates which data store binding should be modified. Valid values and their meanings are: 0: list data source 1: caption data source
@return a datastore markup string which resolves to the datastore field that this object is bound to, in the format:

HideList Source code

IsListDockedToButton Source code

Retrieves the value of bDockListToButton.

ListItemSelected Source code

Called when the user presses Enter (or any other action bound to UIKey_SubmitListSelection) while this list has focus.
@param Sender the list that is submitting the selection

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.

PostInitialize Source code

Propagate the enabled state of this widget.

RefreshSubscriberValue Source code

Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store.
@param BindingIndex indicates which data store binding should be modified. Valid values and their meanings are: -1: all data sources 0: list data source 1: caption data source
@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 indicates which data store binding should be modified. Valid values and their meanings are: -1: all data sources 0: list data source 1: caption data source
@return TRUE if the value was successfully published to the data store.

SelectedItemChanged Source code

Handler for the list's OnValueChanged delegate. Called when the list's index changes.
@param Sender the UIObject whose value changed
@param PlayerIndex the index of the player that generated the call to this method; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.

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 indicates which data store binding should be modified. Valid values and their meanings are: 0: list data source 1: caption data source

SetEditboxText Source code

Changes the editbox's text to the string specified.
@param NewText the text to apply to the editbox
@param PlayerIndex Player that performed the action that issued the event.
@param bListItemsOnly if TRUE, will only apply the specified text if matches an existing element in the list
@param bSkipNotification specify TRUE to prevent the OnValueChanged delegate from being called.

SetListDocking Source code

Changes the value of bDockListToButton to the specified value.

SetVisibility Source code

Changes whether this widget is visible or not. Should be overridden in child classes to perform additional logic or abort the visibility change.
@param bIsVisible TRUE if the widget should be visible; false if not.

ShowList Source code

ShowListClickHandler Source code

Handler for the button and editbox's OnClicked delegate; Used to show the combobox list.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.
@return return TRUE to prevent the kismet OnClick event from firing.

defaultproperties
{
   ComboEditboxClass=Class'Engine.UIEditBox'
   ComboButtonClass=Class'Engine.UIToggleButton'
   ComboListClass=Class'Engine.UIList'
   CaptionDataSource=
   PrivateFlags=1024
   bSupportsPrimaryStyle=False
   Position=(Value[2]=256.000000,Value[3]=32.000000,ScaleType[2]=EVALPOS_PixelOwner,ScaleType[3]=EVALPOS_PixelOwner)
   DefaultStates(2)=Class'Engine.UIState_Active'
   DefaultStates(3)=Class'Engine.UIState_Focused'
   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__UIComboBox"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}