UTGame.UTUIMenuList

Extends

UTSimpleList

Modifiers

native ( UI ) implements ( UIDataStoreSubscriber )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. List widget used in many of the UT menus that renders using z-ordering to simulate a 'circular' list.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- UTGame.UTUI_Widget
            |   
            +-- UTGame.UTDrawPanel
               |   
               +-- UTGame.UTSimpleList
                  |   
                  +-- UTGame.UTUIMenuList

Direct Known Subclasses:

UTUICharacterCustomizationList, UTUICharacterPartMenuList, UTUIIconMenuList

Delegates Summary
		OnSubmitSelection (UIObject Sender, optional int PlayerIndex=GetBestPlayerIndex())

Functions Summary
		ClearBoundDataStores ()
	int	FindCellFieldString (UIObject InObject, name InCellTag, string FindValue, optional bool bCaseSensitive)
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	bool	GetCellFieldString (UIObject InList, name InCellTag, int InListIndex, out string OutValue))
	bool	GetCellFieldValue (UIObject InList, name InCellTag, int InListIndex, out UIProviderFieldValue OutValue)
	int	GetCurrentItem ()))
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
		ItemChosen (int PlayerIndex))
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
		PostInitialize ()))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
		RegenerateOptions ()
		SelectItem (int NewSelection))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetIndex (int NewIndex))

bIsRotating Source code

Whether or not we are currently animating.

DataProvider Source code

the list element provider referenced by DataSource

MenuListItems Source code

Current items of the list, these index into the list dataprovider.

StartRotationTime Source code

Time we started rotating the items in this widget.

Data

DataSource Source code

The data store that this list is bound to

SelectedIndexDataSource Source code

The data source that this list will get and save its currently selected indices from.

OnSubmitSelection 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

ClearBoundDataStores Source code

Notifies this subscriber to unbind itself from all bound data stores

FindCellFieldString Source code

returns the first list index the has the specified value for the specified cell, or INDEX_NONE if it couldn't be found

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.

GetCellFieldString Source code

Gets the cell field value for a specified list and list index.
@param InList List to get the cell field value for.
@param InCellTag Tag to get the value for.
@param InListIndex Index to get the value for.
@param OutValue Storage variable for the final value.

GetCellFieldValue Source code

Gets the cell field value for a specified list and list index.
@param InList List to get the cell field value for.
@param InCellTag Tag to get the value for.
@param InListIndex Index to get the value for.
@param OutValue Storage variable for the final value.

GetCurrentItem Source code

@return Returns the currently selected item.

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:

ItemChosen Source code

Callback for when the user has picked a list item.

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.

PostInitialize Source code

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.

RegenerateOptions Source code

Regenerates the list of options for this menu list.

SelectItem Source code

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.

SetIndex Source code

Sets the currently selected item.

defaultproperties
{
   DataSource=(RequiredFieldType=DATATYPE_Collection)
   SelectedIndexDataSource=(RequiredFieldType=(INVALID))
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTSimpleList:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTSimpleList:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIMenuList"
   ObjectArchetype=UTSimpleList'UTGame.Default__UTSimpleList'
}