Inheritance diagram for SCR_ComboBoxComponent:

[legend]

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

override bool	OnFocus (Widget w, int x, int y)

override bool	OnFocusLost (Widget w, int x, int y)

override bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)

void	CreateEntries ()

void	OpenList ()

void	CloseList ()

override int	AddItem (string item, bool last=false, Managed data=null)

override void	ClearAll ()

override void	RemoveItem (int item, bool last=false)

void	SetElementWidgetEnabled (int index, bool enable, bool animate=true)
	Set given element index as enabled or disabled.

int	GetElementWidgets (notnull array< Widget > elementWidgets)
	Get elementWidgets array.

bool	IsOpened ()

Public Member Functions inherited from SCR_SelectionWidgetComponent
int	AddItem (string item, bool last=false, Managed data=null)

void	ClearAll ()

void	RemoveItem (int item, bool last=false)

int	GetCurrentIndex ()

string	GetCurrentItem ()

Managed	GetCurrentItemData ()

string	GetItemName (int item)

Managed	GetItemData (int item)

int	GetNumItems ()

bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)

Public Member Functions inherited from SCR_ChangeableComponentBase
override void	HandlerAttached (Widget w)

override bool	OnFocus (Widget w, int x, int y)

override bool	OnFocusLost (Widget w, int x, int y)

override bool	OnMouseEnter (Widget w, int x, int y)

override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)

TextWidget	GetLabel ()

void	SetLabel (string label)

void	UseLabel (bool use)

bool	IsUsingLabel ()

Widget	GetLabelWidget ()
	If label is not used, label widget might not exist at all!

void	SetSizeWithLabel (float size)

void	SetSizeWithoutLabel (float size)

Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

override bool	OnMouseEnter (Widget w, int x, int y)

override bool	OnFocus (Widget w, int x, int y)

void	SetHoverSound (string soundHover)

void	SetClickedSound (string soundClicked)

string	GetHoverSound ()

string	GetClickedSound ()

void	SetEnabled (bool enabled, bool animate=true)

void	SetVisible (bool visible, bool animate=true)

bool	IsEnabled ()

void	SetMouseOverToFocus (bool mouseOverToFocus)

void	SetDisabledOpacity (float newDisabledOpacity)

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

Widget	GetRootWidget ()

bool	IsVisible ()

Static Public Member Functions
static SCR_ComboBoxComponent	GetComboBoxComponent (string name, Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.

Static Public Member Functions inherited from SCR_SelectionWidgetComponent
static SCR_SelectionWidgetComponent	GetSelectionComponent (string name, Widget parent, bool searchAllChildren=true)

Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")

Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes
float	m_fMaxListHeight

bool	m_bCreateListBelow

ResourceName	m_sListRootLayout

ResourceName	m_sElementLayout

float	m_fItemsGap

float	m_fExtraPaddingLeft

float	m_fExtraPaddingRight

ref ScriptInvoker	m_OnOpened = new ScriptInvoker()

ref ScriptInvoker	m_OnClosed = new ScriptInvoker()

Public Attributes inherited from SCR_SelectionWidgetComponent
ref array< string >	m_aElementNames

int	m_iSelectedItem

Public Attributes inherited from SCR_ChangeableComponentBase
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
bool	OnHandlerClicked ()

void	OnHandlerFocus ()

void	OnHandlerFocusLost ()

void	OnHandlerHovered ()

void	OnHandlerUnhovered ()

void	OnMenuFocusLost (ChimeraMenuBase menu)

override void	OnEnabled (bool animate)

override void	OnDisabled (bool animate)

void	UpdateName ()

void	CheckElementsInitialized ()

void	OnCreateElement (Widget elementWidget, int index)

void	OnMenuBack ()

Protected Member Functions inherited from SCR_ChangeableComponentBase
void	SetupLabel ()

void	ClearLabel ()

Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)

void	OnDisabled (bool animate)

bool	IsChildWidget (Widget parent, Widget child)

void	SetAnimationRate ()

void	PlaySound (string sound)

Protected Attributes
float	m_fArrowDefaultAngle

bool	m_bForceListWidth

float	m_fListForcedWidth

float	m_fListXOffset

string	m_sSoundClosed

string	m_sButton

ref Color	m_BackgroundDefault

ref Color	m_BackgroundInteracting

ref Color	m_ArrowDefault

ref Color	m_ArrowInteracting

ref Color	m_ArrowFocused

bool	m_bRotateArrow

InputManager	m_InputManager

ref array< Widget >	m_aElementWidgets = new array<Widget>()

Widget	m_wButton

ImageWidget	m_wArrowImage

TextWidget	m_wText

VerticalLayoutWidget	m_wContent

ScrollLayoutWidget	m_wScrollLayout

Widget	m_wElementsRoot

Widget	m_wContentRoot

WorkspaceWidget	m_Workspace

ref SCR_ComboModalHandler	m_ModalHandler

bool	m_bOpened

float	posX

float	posY

Widget	m_wTextBackground

Protected Attributes inherited from SCR_SelectionWidgetComponent
ref array< ref Managed >	m_aElementData = new array<ref Managed>

Protected Attributes inherited from SCR_ChangeableComponentBase
bool	m_bUseLabel

string	m_sLabel

bool	m_bForceSize

float	m_fSizeWithLabel

float	m_fSizeWithoutLabel

ResourceName	m_sLabelLayout

string	m_sSizeLayout

Widget	m_wBorder

Widget	m_wBackground

Widget	m_wLabelRoot

Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered

string	m_sSoundClicked

float	m_fAnimationTime

bool	m_bMouseOverToFocus

float	m_fDisabledOpacity

float	m_fAnimationRate

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const int	INITIALIZATION_CHECK_FREQUENCY = 10

Additional Inherited Members
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001

static const float	START_ANIMATION_PERIOD = 250

Member Function Documentation

◆ AddItem()

override int SCR_ComboBoxComponent.AddItem	(	string	item,
		bool	last = `false`,
		Managed	data = `null`
	)

Implements SCR_SelectionWidgetComponent.

Implemented in SCR_ComboBoxIconComponent.

◆ CheckElementsInitialized()

void SCR_ComboBoxComponent.CheckElementsInitialized ( )

protected

◆ ClearAll()

override void SCR_ComboBoxComponent.ClearAll ( )

Implements SCR_SelectionWidgetComponent.

Implemented in SCR_ComboBoxIconComponent.

◆ CloseList()

void SCR_ComboBoxComponent.CloseList ( )

◆ CreateEntries()

void SCR_ComboBoxComponent.CreateEntries ( )

◆ GetComboBoxComponent()

static SCR_ComboBoxComponent SCR_ComboBoxComponent.GetComboBoxComponent	(	string	name,
		Widget	parent,
		bool	searchAllChildren = `true`
	)

static

Static method to easily find component by providing name and parent.

Searching all children will go through whole hierarchy, instead of immediate chidren

◆ GetElementWidgets()

int SCR_ComboBoxComponent.GetElementWidgets ( notnull array< Widget > elementWidgets )

Get elementWidgets array.

Parameters

[out] elementWidgets array of Widgets taken from m_aElementWidgets

Returns: int count of elements in m_aElementWidgets

◆ HandlerAttached()

override void SCR_ComboBoxComponent.HandlerAttached ( Widget w )

Implements SCR_ChangeableComponentBase.

Implemented in SCR_ComboBoxIconComponent.

◆ HandlerDeattached()

override void SCR_ComboBoxComponent.HandlerDeattached ( Widget w )

◆ IsOpened()

bool SCR_ComboBoxComponent.IsOpened ( )

◆ OnCreateElement()

void SCR_ComboBoxComponent.OnCreateElement	(	Widget	elementWidget,
		int	index
	)

protected

Implemented in SCR_ComboBoxIconComponent.

◆ OnDisabled()

override void SCR_ComboBoxComponent.OnDisabled ( bool animate )

protected

Implements SCR_WLibComponentBase.

◆ OnEnabled()

override void SCR_ComboBoxComponent.OnEnabled ( bool animate )

protected

Implements SCR_WLibComponentBase.

◆ OnFocus()

override bool SCR_ComboBoxComponent.OnFocus	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ChangeableComponentBase.

◆ OnFocusLost()

override bool SCR_ComboBoxComponent.OnFocusLost	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ChangeableComponentBase.

◆ OnHandlerClicked()

bool SCR_ComboBoxComponent.OnHandlerClicked ( )

protected

◆ OnHandlerFocus()

void SCR_ComboBoxComponent.OnHandlerFocus ( )

protected

◆ OnHandlerFocusLost()

void SCR_ComboBoxComponent.OnHandlerFocusLost ( )

protected

◆ OnHandlerHovered()

void SCR_ComboBoxComponent.OnHandlerHovered ( )

protected

◆ OnHandlerUnhovered()

void SCR_ComboBoxComponent.OnHandlerUnhovered ( )

protected

◆ OnMenuBack()

void SCR_ComboBoxComponent.OnMenuBack ( )

protected

◆ OnMenuFocusLost()

void SCR_ComboBoxComponent.OnMenuFocusLost ( ChimeraMenuBase menu )

protected

◆ OpenList()

void SCR_ComboBoxComponent.OpenList ( )

◆ RemoveItem()

override void SCR_ComboBoxComponent.RemoveItem	(	int	item,
		bool	last = `false`
	)

Implements SCR_SelectionWidgetComponent.

Implemented in SCR_ComboBoxIconComponent.

◆ SetCurrentItem()

override bool SCR_ComboBoxComponent.SetCurrentItem	(	int	i,
		bool	playSound = `false`,
		bool	animate = `false`
	)

Implements SCR_SelectionWidgetComponent.

◆ SetElementWidgetEnabled()

void SCR_ComboBoxComponent.SetElementWidgetEnabled	(	int	index,
		bool	enable,
		bool	animate = `true`
	)

Set given element index as enabled or disabled.

Parameters

[in]	index	Given index of element
[in]	enable	If it should be enabled or disabled
[in]	animate	Should it animate on enabled/disabled changed?

◆ UpdateName()

void SCR_ComboBoxComponent.UpdateName ( )

protected

Implemented in SCR_ComboBoxIconComponent.

Member Data Documentation

◆ INITIALIZATION_CHECK_FREQUENCY

const int SCR_ComboBoxComponent.INITIALIZATION_CHECK_FREQUENCY = 10

staticprotected

◆ m_aElementWidgets

ref array<Widget> SCR_ComboBoxComponent.m_aElementWidgets = new array<Widget>()

protected

◆ m_ArrowDefault

ref Color SCR_ComboBoxComponent.m_ArrowDefault

protected

◆ m_ArrowFocused

ref Color SCR_ComboBoxComponent.m_ArrowFocused

protected

◆ m_ArrowInteracting

ref Color SCR_ComboBoxComponent.m_ArrowInteracting

protected

◆ m_BackgroundDefault

ref Color SCR_ComboBoxComponent.m_BackgroundDefault

protected

◆ m_BackgroundInteracting

ref Color SCR_ComboBoxComponent.m_BackgroundInteracting

protected

◆ m_bCreateListBelow

bool SCR_ComboBoxComponent.m_bCreateListBelow

◆ m_bForceListWidth

bool SCR_ComboBoxComponent.m_bForceListWidth

protected

◆ m_bOpened

bool SCR_ComboBoxComponent.m_bOpened

protected

◆ m_bRotateArrow

bool SCR_ComboBoxComponent.m_bRotateArrow

protected

◆ m_fArrowDefaultAngle

float SCR_ComboBoxComponent.m_fArrowDefaultAngle

protected

◆ m_fExtraPaddingLeft

float SCR_ComboBoxComponent.m_fExtraPaddingLeft

◆ m_fExtraPaddingRight

float SCR_ComboBoxComponent.m_fExtraPaddingRight

◆ m_fItemsGap

float SCR_ComboBoxComponent.m_fItemsGap

◆ m_fListForcedWidth

float SCR_ComboBoxComponent.m_fListForcedWidth

protected

◆ m_fListXOffset

float SCR_ComboBoxComponent.m_fListXOffset

protected

◆ m_fMaxListHeight

float SCR_ComboBoxComponent.m_fMaxListHeight

◆ m_InputManager

InputManager SCR_ComboBoxComponent.m_InputManager

protected

◆ m_ModalHandler

ref SCR_ComboModalHandler SCR_ComboBoxComponent.m_ModalHandler

protected

◆ m_OnClosed

ref ScriptInvoker SCR_ComboBoxComponent.m_OnClosed = new ScriptInvoker()

◆ m_OnOpened

ref ScriptInvoker SCR_ComboBoxComponent.m_OnOpened = new ScriptInvoker()

◆ m_sButton

string SCR_ComboBoxComponent.m_sButton

protected

◆ m_sElementLayout

ResourceName SCR_ComboBoxComponent.m_sElementLayout

◆ m_sListRootLayout

ResourceName SCR_ComboBoxComponent.m_sListRootLayout

◆ m_sSoundClosed

string SCR_ComboBoxComponent.m_sSoundClosed

protected

◆ m_wArrowImage

ImageWidget SCR_ComboBoxComponent.m_wArrowImage

protected

◆ m_wButton

Widget SCR_ComboBoxComponent.m_wButton

protected

◆ m_wContent

VerticalLayoutWidget SCR_ComboBoxComponent.m_wContent

protected

◆ m_wContentRoot

Widget SCR_ComboBoxComponent.m_wContentRoot

protected

◆ m_wElementsRoot

Widget SCR_ComboBoxComponent.m_wElementsRoot

protected

◆ m_Workspace

WorkspaceWidget SCR_ComboBoxComponent.m_Workspace

protected

◆ m_wScrollLayout

ScrollLayoutWidget SCR_ComboBoxComponent.m_wScrollLayout

protected

◆ m_wText

TextWidget SCR_ComboBoxComponent.m_wText

protected

◆ m_wTextBackground

Widget SCR_ComboBoxComponent.m_wTextBackground

protected

◆ posX

float SCR_ComboBoxComponent.posX

protected

◆ posY

float SCR_ComboBoxComponent.posY

protected

The documentation for this interface was generated from the following file:

Game/UI/Components/WidgetLibrary/SCR_ComboBox/SCR_ComboBoxComponent.c

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AddItem()

◆ CheckElementsInitialized()

◆ ClearAll()

◆ CloseList()

◆ CreateEntries()

◆ GetComboBoxComponent()

◆ GetElementWidgets()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ IsOpened()

◆ OnCreateElement()

◆ OnDisabled()

◆ OnEnabled()

◆ OnFocus()

◆ OnFocusLost()

◆ OnHandlerClicked()

◆ OnHandlerFocus()

◆ OnHandlerFocusLost()

◆ OnHandlerHovered()

◆ OnHandlerUnhovered()

◆ OnMenuBack()

◆ OnMenuFocusLost()

◆ OpenList()

◆ RemoveItem()

◆ SetCurrentItem()

◆ SetElementWidgetEnabled()

◆ UpdateName()

Member Data Documentation

◆ INITIALIZATION_CHECK_FREQUENCY

◆ m_aElementWidgets

◆ m_ArrowDefault

◆ m_ArrowFocused

◆ m_ArrowInteracting

◆ m_BackgroundDefault

◆ m_BackgroundInteracting

◆ m_bCreateListBelow

◆ m_bForceListWidth

◆ m_bOpened

◆ m_bRotateArrow

◆ m_fArrowDefaultAngle

◆ m_fExtraPaddingLeft

◆ m_fExtraPaddingRight

◆ m_fItemsGap

◆ m_fListForcedWidth

◆ m_fListXOffset

◆ m_fMaxListHeight

◆ m_InputManager

◆ m_ModalHandler

◆ m_OnClosed

◆ m_OnOpened

◆ m_sButton

◆ m_sElementLayout

◆ m_sListRootLayout

◆ m_sSoundClosed

◆ m_wArrowImage

◆ m_wButton

◆ m_wContent

◆ m_wContentRoot

◆ m_wElementsRoot

◆ m_Workspace

◆ m_wScrollLayout

◆ m_wText

◆ m_wTextBackground

◆ posX

◆ posY