UTGame.UTUIOptionList

Extends

UTDrawPanel

Modifiers

placeable native ( UIFrontEnd ) implements ( UIDataStoreSubscriber )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Options tab page, autocreates a set of options widgets using the datasource provided.

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

Direct Known Subclasses:

UTUIDynamicOptionList, UTUIKeyBindingList

Delegates Summary
		OnAcceptOptions (UIScreenObject InObject, int PlayerIndex)
		OnOptionChanged (UIScreenObject InObject, name OptionName, int PlayerIndex)
		OnOptionFocused (UIScreenObject InObject, UIDataProvider OptionProvider)

Functions Summary
		CheckAndUpdateDragging ()))
		CheckArrowInput (const SubscribedInputEventParameters EventParms))
		ClearBoundDataStores ()
		ClickedScrollZone (UIScrollbar Sender, float PositionPerc, int PlayerIndex ))
	bool	CursorCheck (float X1, float Y1, float X2, float Y2))
		DrawPanel ()))
		DrawSpecial (float x, float y, float w, float h, float u, float v, float ul, float vl, color DrawColor, bool bOver, bool bPressed))
	bool	EnableItem (int PlayerIndex, UIObject ChosenObj, bool bShouldEnable=true ))
	bool	EnableItemAtIndex (int PlayerIndex, int OptionIdx, bool bShouldEnable=true ))
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	UIObject	GetCurrentlySelectedOption ()))
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
	Vector	GetMousePosition ()))
	int	GetObjectInfoIndexFromName (name ProviderName))
	int	GetObjectInfoIndexFromObject (UIObject Sender))
		GetSupportedUIActionKeyNames (out array out_KeyNames ))
		InitializeComboboxWidgets ()
		InitializeScrollbars ()
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
		OnOption_NotifyActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
		OnValueChanged (UIObject Sender, int PlayerIndex ))
		PostInitialize ()))
	bool	ProcessInputAxis (const out SubscribedInputEventParameters EventParms ))
	bool	ProcessInputKey (const out SubscribedInputEventParameters EventParms ))
		RefreshAllOptions ()))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
		RegenerateOptions ()
		RepositionOptions ()
	bool	ScrollVertical (UIScrollbar Sender, float PositionChange, optional bool bPositionMaxed=false ))
	bool	SelectItem (int OptionIdx, optional int PlayerIndex=GetBestPlayerIndex(), optional bool bClampValue=true ))
	bool	SelectNextItem (optional bool bWrap=false, optional int PlayerIndex=GetBestPlayerIndex()))
	bool	SelectPreviousItem (optional bool bWrap=false, optional int PlayerIndex=GetBestPlayerIndex()))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetSelectedOptionIndex (int OptionIdx)
		SetupOptionBindings ()))

ArrowColor Source code

ArrowImage Source code

bAnimatingBGPrefab Source code

Whether or not we are currently animating the background prefab.

bDownArrowPressed Source code

bDragging Source code

BGPrefabInstance Source code

Instance of the background prefab.

bRegenOptions Source code

Flag to let the optionlist know that it should regenerate its options on next tick.

bUpArrowPressed Source code

CurrentIndex Source code

Current option index.

DataProvider Source code

the list element provider referenced by DataSource

DownArrowBounds[4] Source code

DragClickPosition Source code

Last time we changed the current selection due to dragging.

DragDeadZone Source code

Current state of the arrows.

GeneratedObjects Source code

List of auto-generated objects, anything in this array will be removed from the children's array before presave.

LastDragSelection Source code

Speed to increase or decrease the currently selected element when dragging, in seconds.

MaxVisibleItems Source code

Maximum number of visible items.

PreviousIndex Source code

Previously selected option index.

ScrollArrowWidth Source code

Properties for the scroll arrows.

SelectionImage Source code

SelectionSpeed Source code

StartMovementTime Source code

Start time for animating option switches.

UpArrowBounds[4] Source code

VerticalScrollbar Source code

Scrollbar to let PC users scroll up and down the list freely.

Data

DataSource Source code

The data store that this list is bound to

UTUIOptionList

BGPrefab Source code

Background prefab for the currently selected item.

DefaultOptionHeight Source code

Properties for individual option spacing

DefaultOptionPadding Source code

DefaultOptionRightMargin Source code

DefaultOptionTopMargin Source code

GeneratedObjectInfo Source code

Info about an option we have generated.

OnAcceptOptions Source code

Accept button was pressed on the option list.

OnOptionChanged Source code

Delegate for when the user changes one of the options in this option list.

OnOptionFocused Source code

Delegate called when an option gains focus.

CheckAndUpdateDragging Source code

If we are dragging, this function will increment the current selection based on the location of the mouse cursor.

CheckArrowInput Source code

Checks to see if the user has clicked on the scroll arrows.

ClearBoundDataStores Source code

Notifies this subscriber to unbind itself from all bound data stores

ClickedScrollZone Source code

Handler for the vertical scrollbar's OnClickedScrollZone delegate. Scrolls the list by a full page (MaxVisibleItems).
@param Sender the scrollbar that was clicked.
@param PositionPerc a value from 0.0 - 1.0, representing the location of the click within the region between the increment and decrement buttons. Values closer to 0.0 means that the user clicked near the decrement button; values closer to 1.0 are nearer the increment button.
@param PlayerIndex Player that performed the action that issued the event.

CursorCheck Source code

All are in pixels @Param X1 Left @Param Y1 Top @Param X2 Right @Param Y2 Bottom @Returns true if the mouse is within the bounds given

DrawPanel Source code

Render's the list's selection elements.

DrawSpecial Source code

EnableItem Source code

Enables / disables an item in the list. If the item is the currently selected item, selects the next item in the list, if possible.
@param OptionIdx the index for the option that should be updated
@param bShouldEnable TRUE to enable the item; FALSE to disable.
@return TRUE if the item's state was successfully changed; FALSE if it couldn't be changed or OptionIdx was invalid.

EnableItemAtIndex Source code

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.

GetCurrentlySelectedOption Source code

Returns the currently selected option object

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:

GetMousePosition Source code

@Returns the mouse position in widget space

GetObjectInfoIndexFromName Source code

@return Returns the object info struct index given a provider namename.

GetObjectInfoIndexFromObject Source code

@return Returns the object info struct given a sender object.

GetSupportedUIActionKeyNames Source code

InitializeComboboxWidgets Source code

Initializes combobox widgets.

InitializeScrollbars Source code

Initializes the scrollbar widget for the option list.

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.

OnOption_NotifyActiveStateChanged Source code

Callback for when the object's active state changes.

OnValueChanged Source code

Callback for all of the options we generated.

PostInitialize Source code

Post initialize, binds callbacks for all of the generated options.

ProcessInputAxis Source code

Enable hottracking if we are dragging

ProcessInputKey Source code

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

RefreshAllOptions Source code

Refreshes the value of all of the options by having them pull their options from the datastore again.

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

Generates widgets for all of the options.

RepositionOptions Source code

Repositions all of the visible options.

ScrollVertical Source code

Handler for vertical scrolling activity PositionChange should be a number of nudge values by which the slider was moved
@param Sender the scrollbar that generated the event.
@param PositionChange indicates how many items to scroll the list by
@param bPositionMaxed indicates that the scrollbar's marker has reached its farthest available position, unused in this function

SelectItem Source code

Selects the specified option item.

SelectNextItem Source code

Selects the next item in the list.

SelectPreviousItem Source code

Selects the previous item in the list.

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.

SetSelectedOptionIndex Source code

Sets the currently selected option index.

SetupOptionBindings Source code

Sets up the option bindings.

defaultproperties
{
   DataSource=(RequiredFieldType=DATATYPE_Collection)
   BGPrefab=UIPrefab'UI_Scenes_FrontEnd.Prefabs.OptionBG'
   ScrollArrowWidth=0.040000
   ArrowColor=(B=1,G=0,R=128,A=255)
   SelectionImage=Texture2D'UI_HUD.HUD.UI_HUD_BaseD'
   ArrowImage=Texture2D'UI_HUD.HUD.UI_HUD_BaseC'
   DefaultOptionHeight=32.000000
   DefaultOptionPadding=12.000000
   DefaultOptionTopMargin=-3.000000
   DefaultOptionRightMargin=10.000000
   bRequiresTick=True
   DefaultStates(3)=Class'Engine.UIState_Active'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTDrawPanel:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTDrawPanel:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIOptionList"
   ObjectArchetype=UTDrawPanel'UTGame.Default__UTDrawPanel'
}