Interface: SettingsEnumDropDown

Interface describing base panel properties that all other panels extend.

Properties

Name Type Description
activationenabled boolean No description provided.
actuallayoutheight number No description provided.
actuallayoutwidth number No description provided.
actualuiscale_x number No description provided.
actualuiscale_y number No description provided.
actualxoffset number No description provided.
actualyoffset number No description provided.
checked boolean No description provided.
contentheight number No description provided.
contentwidth number No description provided.
convar string No description provided.
defaultfocus string No description provided.
desiredlayoutheight number No description provided.
desiredlayoutwidth number No description provided.
enabled boolean No description provided.
hittest boolean No description provided.
hittestchildren boolean No description provided.
id string No description provided.
inputnamespace string No description provided.
layoutfile string No description provided.
paneltype SettingsEnumDropDown No description provided.
rememberchildfocus boolean No description provided.
scrolloffset_x number No description provided.
scrolloffset_y number No description provided.
selectionpos_x number No description provided.
selectionpos_y number No description provided.
style Style No description provided.
tabindex number No description provided.
visible boolean No description provided.

Functions

AcceptsFocus

SettingsEnumDropDown.AcceptsFocus(): boolean

No description provided.

AcceptsInput

SettingsEnumDropDown.AcceptsInput(): boolean

No description provided.

AddClass

SettingsEnumDropDown.AddClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ApplyStyles

SettingsEnumDropDown.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

BAscendantHasClass

SettingsEnumDropDown.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

CanSeeInParentScroll

SettingsEnumDropDown.CanSeeInParentScroll(): boolean

No description provided.

Children

SettingsEnumDropDown.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

SettingsEnumDropDown.ClearPanelEvent(event: string): void

No description provided.

Parameter

Name Type Description
event string No description provided.

ClearPropertyFromCode

SettingsEnumDropDown.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

Name Type Description
arg0 unknown No description provided.

CreateChildren

SettingsEnumDropDown.CreateChildren(elements: string): boolean

No description provided.

Parameter

Name Type Description
elements string No description provided.

CreateCopyOfCSSKeyframes

SettingsEnumDropDown.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

Name Type Description
animation string No description provided.

Data

SettingsEnumDropDown.Data(...args: any[]): void

No description provided.

Parameter

Name Type Description
...args any[] No description provided.

DeleteAsync

SettingsEnumDropDown.DeleteAsync(delay: number): void

No description provided.

Parameter

Name Type Description
delay number No description provided.

DeleteKeyframes

SettingsEnumDropDown.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

FindChild

SettingsEnumDropDown.FindChild(id: string): T

Searches this element's direct children and returns a child with the specified id.

Parameter

Name Type Description
id string No description provided.

FindChildInLayoutFile

SettingsEnumDropDown.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

FindChildrenWithClassTraverse

SettingsEnumDropDown.FindChildrenWithClassTraverse(classname: string): T[]

No description provided.

Parameter

Name Type Description
classname string No description provided.

FindChildTraverse

SettingsEnumDropDown.FindChildTraverse(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

GetAttributeInt

SettingsEnumDropDown.GetAttributeInt(attribute: string, fallback: number): number

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback number No description provided.

GetAttributeString

SettingsEnumDropDown.GetAttributeString(attribute: string, fallback: string): string

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback string No description provided.

GetAttributeUInt32

SettingsEnumDropDown.GetAttributeUInt32(attribute: string, fallback: number): number

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback number No description provided.

GetChild

SettingsEnumDropDown.GetChild(index: number): T

No description provided.

Parameter

Name Type Description
index number No description provided.

GetChildCount

SettingsEnumDropDown.GetChildCount(): number

No description provided.

GetChildIndex

SettingsEnumDropDown.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

Name Type Description
child GenericPanel No description provided.

GetFirstChild

SettingsEnumDropDown.GetFirstChild(): T

No description provided.

GetLastChild

SettingsEnumDropDown.GetLastChild(): T

No description provided.

GetLayoutFileDefine

SettingsEnumDropDown.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

Name Type Description
def string No description provided.

GetParent

SettingsEnumDropDown.GetParent(): T

No description provided.

GetPositionWithinWindow

SettingsEnumDropDown.GetPositionWithinWindow(): unknown

No description provided.

HasClass

SettingsEnumDropDown.HasClass(classname: string): boolean

No description provided.

Parameter

Name Type Description
classname string No description provided.

HasDescendantKeyFocus

SettingsEnumDropDown.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

SettingsEnumDropDown.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

SettingsEnumDropDown.HasKeyFocus(): boolean

No description provided.

IsDraggable

SettingsEnumDropDown.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

SettingsEnumDropDown.IsReadyForDisplay(): boolean

No description provided.

IsSelected

SettingsEnumDropDown.IsSelected(): boolean

No description provided.

IsSizeValid

SettingsEnumDropDown.IsSizeValid(): boolean

No description provided.

IsTransparent

SettingsEnumDropDown.IsTransparent(): boolean

No description provided.

IsValid

SettingsEnumDropDown.IsValid(): boolean

Check if this panel is still valid

LoadLayout

SettingsEnumDropDown.LoadLayout(url: string, override: boolean, partial: boolean): boolean

No description provided.

Parameters

Name Type Description
url string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutAsync

SettingsEnumDropDown.LoadLayoutAsync(url: string, override: boolean, partial: boolean): void

No description provided.

Parameters

Name Type Description
url string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutFromString

SettingsEnumDropDown.LoadLayoutFromString(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

Name Type Description
layout string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutFromStringAsync

SettingsEnumDropDown.LoadLayoutFromStringAsync(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

Name Type Description
layout string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutSnippet

SettingsEnumDropDown.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

Name Type Description
snippet string No description provided.

MoveChildAfter

SettingsEnumDropDown.MoveChildAfter(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

Name Type Description
arg0 unknown No description provided.
arg1 unknown No description provided.

MoveChildBefore

SettingsEnumDropDown.MoveChildBefore(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

Name Type Description
arg0 unknown No description provided.
arg1 unknown No description provided.

OnShow

SettingsEnumDropDown.OnShow(): void

No description provided.

RefreshDisplay

SettingsEnumDropDown.RefreshDisplay(): void

No description provided.

RegisterForReadyEvents

SettingsEnumDropDown.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

Name Type Description
enable boolean Should this panel receive ready/unready events?

RemoveAndDeleteChildren

SettingsEnumDropDown.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

SettingsEnumDropDown.RemoveClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

RestoreCVarDefault

SettingsEnumDropDown.RestoreCVarDefault(): void

Set the cvar back to default

ScrollParentToFitWhenFocused

SettingsEnumDropDown.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

SettingsEnumDropDown.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void

No description provided.

Parameters

Name Type Description
arg0 number No description provided.
arg1 boolean No description provided.

ScrollToBottom

SettingsEnumDropDown.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

SettingsEnumDropDown.ScrollToFitRegion(arg0: number, arg1: number, arg2: number, arg3: number, arg4: unknown, arg5: boolean, arg6: boolean): void

No description provided.

Parameters

Name Type Description
arg0 number No description provided.
arg1 number No description provided.
arg2 number No description provided.
arg3 number No description provided.
arg4 unknown No description provided.
arg5 boolean No description provided.
arg6 boolean No description provided.

ScrollToLeftEdge

SettingsEnumDropDown.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

SettingsEnumDropDown.ScrollToRightEdge(): void

No description provided.

ScrollToTop

SettingsEnumDropDown.ScrollToTop(): void

No description provided.

SetAcceptsFocus

SettingsEnumDropDown.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetAttributeInt

SettingsEnumDropDown.SetAttributeInt(attribute: string, value: number): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value number No description provided.

SetAttributeString

SettingsEnumDropDown.SetAttributeString(attribute: string, value: string): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value string No description provided.

SetAttributeUInt32

SettingsEnumDropDown.SetAttributeUInt32(attribute: string, value: number): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value number No description provided.

SetDialogVariable

SettingsEnumDropDown.SetDialogVariable(arg0: string, arg1: string): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 string No description provided.

SetDialogVariableFloat

SettingsEnumDropDown.SetDialogVariableFloat(arg0: string, arg1: number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 number No description provided.

SetDialogVariableInt

SettingsEnumDropDown.SetDialogVariableInt(arg0: string, arg1: number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 number No description provided.

SetDialogVariableTime

SettingsEnumDropDown.SetDialogVariableTime(arg0: string, arg1: string | number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 string | number No description provided.

SetDisableFocusOnMouseDown

SettingsEnumDropDown.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetDraggable

SettingsEnumDropDown.SetDraggable(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetFocus

SettingsEnumDropDown.SetFocus(focus: boolean): boolean

No description provided.

Parameter

Name Type Description
focus boolean No description provided.

SetHasClass

SettingsEnumDropDown.SetHasClass(classname: string, hasclass: boolean): void

No description provided.

Parameters

Name Type Description
classname string No description provided.
hasclass boolean No description provided.

SetInputNamespace

SettingsEnumDropDown.SetInputNamespace(arg0: string): void

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

SetPanelEvent

SettingsEnumDropDown.SetPanelEvent(event: string, callback: Func<any[], void>): void

Sets an event trigger for this panel.

Example

latestUpdateImage.SetPanelEvent('onactivate', () => SteamOverlayAPI.OpenURLModal(item.link));

Parameters

Name Type Description
event string No description provided.
callback Func<any[], void> No description provided.

See also

SetParent

SettingsEnumDropDown.SetParent(parent: GenericPanel): void

No description provided.

Parameter

Name Type Description
parent GenericPanel No description provided.

SetReadyForDisplay

SettingsEnumDropDown.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetScrollParentToFitWhenFocused

SettingsEnumDropDown.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetTopOfInputContext

SettingsEnumDropDown.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SortChildrenOnAttribute

SettingsEnumDropDown.SortChildrenOnAttribute(attribute: string, ascending: boolean): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
ascending boolean No description provided.

SwitchClass

SettingsEnumDropDown.SwitchClass(oldclass: string, newclass: string): void

No description provided.

Parameters

Name Type Description
oldclass string No description provided.
newclass string No description provided.

ToggleClass

SettingsEnumDropDown.ToggleClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

TriggerClass

SettingsEnumDropDown.TriggerClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

UpdateCurrentAnimationKeyframes

SettingsEnumDropDown.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

UpdateFocusInContext

SettingsEnumDropDown.UpdateFocusInContext(): boolean

No description provided.