UE3:UTUIComboBox (UDK): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
No edit summary
 
m 1 revision: class descriptions for UDK January update (part 8)
 
Line 1: Line 1:
{{infobox class
{{UE3:UTUIComboBox (UT3)}}
| package = UTGame
| parent1 = UIComboBox
| parent2 = UIObject
| parent3 = UIScreenObject
| parent4 = UIRoot
| parent5 = Object
| interface1 = UIDataStorePublisher
}}
{{autogenerated}}
Extended version of combo box for UT3.
 
==Properties==
====EditboxBGStyleName====
'''Type:''' [[name]]
 
<!-- enter variable description -->
 
'''Default value:''' 'DefaultEditboxImageStyle'
 
====ListBackgroundStyleName====
'''Type:''' [[name]]
 
<!-- enter variable description -->
 
'''Default value:''' 'ComboListBackgroundStyle'
 
====ToggleButtonCheckedStyleName====
'''Type:''' [[name]]
 
<!-- enter variable description -->
 
'''Default value:''' 'ComboBoxDown'
 
====ToggleButtonStyleName====
'''Type:''' [[name]]
 
<!-- enter variable description -->
 
'''Default value:''' 'ComboBoxUp'
 
===Default values===
{| class="list defaults"
! Property
! Value
|-
| {{tl|ComboListClass||UIComboBox}}
| [[Types#Class|Class]]'{{cl|UTUIList|UTGame}}'
|}
 
===Subobjects===
====WidgetEventComponent====
'''Class:''' {{cl|UIComp_Event|Engine}}
 
'''Inherits from:''' {{tl|WidgetEventComponent|UIComboBox}}
 
''No new values.''
 
==Functions==
===Native functions===
====SetupChildStyles====
{{code|native function '''SetupChildStyles''' ()}}
 
Initializes styles for child widgets.
 
===Events===
====AddedChild====
{{code|event '''AddedChild''' ({{cl|UIScreenObject}}&nbsp;'''WidgetOwner''', {{cl|UIObject}}&nbsp;'''NewChild''')}}
 
'''Overrides:''' {{tl|AddedChild|UIScreenObject}}
 
Called immediately after a child has been added to this screen object.
 
'''Parameters:'''
* ''WidgetOwner'' - the screen object that the NewChild was added as a child for
* ''NewChild'' - the widget that was added
 
====Initialized====
{{code|event '''Initialized''' ()}}
 
'''Overrides:''' {{tl|Initialized|UIScreenObject}}
 
Called once this screen object has been completely initialized, before it has activated its InitialState or called
Initialize on its children.  This event is only called the first time a widget is initialized.  If reparented, for
example, the widget would already be initialized so the Initialized event would not be called.
 
===Other instance functions===
====GetSelectionIndex====
{{code|function [[int]]&nbsp;'''GetSelectionIndex''' ()}}
 
'''Returns:'''
:the Selection Index of the currently selected list item
 
====SetSelectedItem====
{{code|function '''SetSelectedItem''' ([[int]]&nbsp;'''ItemIndex''')}}
 
Sets the currently selected item.
 
'''Parameters:'''
* ''ItemIndex'' - Not the list index but the index of the item which is a value of the Items array.
 
====SetSelectionIndex====
{{code|function '''SetSelectionIndex''' ([[int]]&nbsp;'''NewIndex''')}}
 
Sets the current index for the list.
 
'''Parameters:'''
* ''NewIndex'' - The new index to select

Latest revision as of 06:02, 17 January 2010

UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UIComboBox >> UTUIComboBox
Package:
UTGame
Implemented interfaces:
UIDataStorePublisher
This class in other games:
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Extended version of combo box for UT3.

Properties

EditboxBGStyleName

Type: name


Default value: 'DefaultEditboxImageStyle'

ListBackgroundStyleName

Type: name


Default value: 'ComboListBackgroundStyle'

ToggleButtonCheckedStyleName

Type: name


Default value: 'ComboBoxDown'

ToggleButtonStyleName

Type: name


Default value: 'ComboBoxUp'

Default values

Property Value
ComboListClass Class'UTGame.UTUIList'

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIComboBox.WidgetEventComponent

No new values.

Functions

Native functions

SetupChildStyles

native function SetupChildStyles ()

Initializes styles for child widgets.

Events

AddedChild

event AddedChild (UIScreenObject WidgetOwner, UIObject NewChild)

Overrides: UIScreenObject.AddedChild

Called immediately after a child has been added to this screen object.

Parameters:

  • WidgetOwner - the screen object that the NewChild was added as a child for
  • NewChild - the widget that was added

Initialized

event Initialized ()

Overrides: UIScreenObject.Initialized

Called after initialization.

Other instance functions

GetSelectionIndex

function int GetSelectionIndex ()

Returns:

the Selection Index of the currently selected list item

SetSelectedItem

function SetSelectedItem (int ItemIndex)

Sets the currently selected item.

Parameters:

  • ItemIndex - Not the list index but the index of the item which is a value of the Items array.

SetSelectionIndex

function SetSelectionIndex (int NewIndex)

Sets the current index for the list.

Parameters:

  • NewIndex - The new index to select
Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:UTUIComboBox_(UDK)&oldid=42186"