Interface: TextEntry
An interactive text input.
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. |
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 | TextEntry | 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. |
text | string | No description provided. |
visible | boolean | No description provided. |
Functions
AcceptsFocus
TextEntry.AcceptsFocus(): boolean
No description provided.
AcceptsInput
TextEntry.AcceptsInput(): boolean
No description provided.
AddClass
TextEntry.AddClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ApplyStyles
TextEntry.ApplyStyles(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
BAscendantHasClass
TextEntry.BAscendantHasClass(arg0: string): boolean
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
CanSeeInParentScroll
TextEntry.CanSeeInParentScroll(): boolean
No description provided.
Children
TextEntry.Children(): GenericPanel[]
No description provided.
ClearPanelEvent
TextEntry.ClearPanelEvent(event: string): void
No description provided.
Parameter
| Name | Type | Description |
event | string | No description provided. |
ClearPropertyFromCode
TextEntry.ClearPropertyFromCode(arg0: unknown): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | unknown | No description provided. |
ClearSelection
TextEntry.ClearSelection(): void
No description provided.
CreateChildren
TextEntry.CreateChildren(elements: string): boolean
No description provided.
Parameter
| Name | Type | Description |
elements | string | No description provided. |
CreateCopyOfCSSKeyframes
TextEntry.CreateCopyOfCSSKeyframes(animation: string): unknown
No description provided.
Parameter
| Name | Type | Description |
animation | string | No description provided. |
Data
TextEntry.Data(...args: any[]): void
No description provided.
Parameter
| Name | Type | Description |
...args | any[] | No description provided. |
DeleteAsync
TextEntry.DeleteAsync(delay: number): void
No description provided.
Parameter
| Name | Type | Description |
delay | number | No description provided. |
DeleteKeyframes
TextEntry.DeleteKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
FindChild
TextEntry.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
TextEntry.FindChildInLayoutFile(id: string): T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
FindChildrenWithClassTraverse
TextEntry.FindChildrenWithClassTraverse(classname: string): T[]
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
FindChildTraverse
TextEntry.FindChildTraverse(id: string): T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
GetAttributeInt
TextEntry.GetAttributeInt(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetAttributeString
TextEntry.GetAttributeString(attribute: string, fallback: string): string
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | string | No description provided. |
GetAttributeUInt32
TextEntry.GetAttributeUInt32(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetChild
TextEntry.GetChild(index: number): T
No description provided.
Parameter
| Name | Type | Description |
index | number | No description provided. |
GetChildCount
TextEntry.GetChildCount(): number
No description provided.
GetChildIndex
TextEntry.GetChildIndex(child: GenericPanel): number
No description provided.
Parameter
| Name | Type | Description |
child | GenericPanel | No description provided. |
GetCursorOffset
TextEntry.GetCursorOffset(): number
No description provided.
GetFirstChild
TextEntry.GetFirstChild(): T
No description provided.
GetLastChild
TextEntry.GetLastChild(): T
No description provided.
GetLayoutFileDefine
TextEntry.GetLayoutFileDefine(def: string): unknown
No description provided.
Parameter
| Name | Type | Description |
def | string | No description provided. |
GetMaxCharCount
TextEntry.GetMaxCharCount(): number
No description provided.
GetParent
TextEntry.GetParent(): T
No description provided.
GetPositionWithinWindow
TextEntry.GetPositionWithinWindow(): unknown
No description provided.
HasClass
TextEntry.HasClass(classname: string): boolean
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
HasDescendantKeyFocus
TextEntry.HasDescendantKeyFocus(): boolean
No description provided.
HasHoverStyle
TextEntry.HasHoverStyle(): boolean
No description provided.
HasKeyFocus
TextEntry.HasKeyFocus(): boolean
No description provided.
IsDraggable
TextEntry.IsDraggable(): boolean
No description provided.
IsReadyForDisplay
TextEntry.IsReadyForDisplay(): boolean
No description provided.
IsSelected
TextEntry.IsSelected(): boolean
No description provided.
IsSizeValid
TextEntry.IsSizeValid(): boolean
No description provided.
IsTransparent
TextEntry.IsTransparent(): boolean
No description provided.
IsValid
TextEntry.IsValid(): boolean
Check if this panel is still valid
LoadLayout
TextEntry.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
TextEntry.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
TextEntry.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
TextEntry.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
TextEntry.LoadLayoutSnippet(snippet: string): boolean
No description provided.
Parameter
| Name | Type | Description |
snippet | string | No description provided. |
MoveChildAfter
TextEntry.MoveChildAfter(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
MoveChildBefore
TextEntry.MoveChildBefore(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
RaiseChangeEvents
TextEntry.RaiseChangeEvents(enable: boolean): void
Sets the TextEntryChanged event will be raised by this TextEntry.
This is expensive, so defaults to disabled and has to be manually enabled.
Parameter
| Name | Type | Description |
enable | boolean | No description provided. |
RegisterForReadyEvents
TextEntry.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
TextEntry.RemoveAndDeleteChildren(): void
No description provided.
RemoveClass
TextEntry.RemoveClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ScrollParentToFitWhenFocused
TextEntry.ScrollParentToFitWhenFocused(): boolean
No description provided.
ScrollParentToMakePanelFit
TextEntry.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | number | No description provided. |
arg1 | boolean | No description provided. |
ScrollToBottom
TextEntry.ScrollToBottom(): void
No description provided.
ScrollToFitRegion
TextEntry.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
TextEntry.ScrollToLeftEdge(): void
No description provided.
ScrollToRightEdge
TextEntry.ScrollToRightEdge(): void
No description provided.
ScrollToTop
TextEntry.ScrollToTop(): void
No description provided.
SelectAll
TextEntry.SelectAll(): void
No description provided.
SetAcceptsFocus
TextEntry.SetAcceptsFocus(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetAttributeInt
TextEntry.SetAttributeInt(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetAttributeString
TextEntry.SetAttributeString(attribute: string, value: string): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | string | No description provided. |
SetAttributeUInt32
TextEntry.SetAttributeUInt32(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetCursorOffset
TextEntry.SetCursorOffset(offset: number): void
No description provided.
Parameter
| Name | Type | Description |
offset | number | No description provided. |
SetDialogVariable
TextEntry.SetDialogVariable(arg0: string, arg1: string): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | string | No description provided. |
SetDialogVariableFloat
TextEntry.SetDialogVariableFloat(arg0: string, arg1: number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | number | No description provided. |
SetDialogVariableInt
TextEntry.SetDialogVariableInt(arg0: string, arg1: number): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | string | No description provided. |
arg1 | number | No description provided. |
SetDialogVariableTime
TextEntry.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
TextEntry.SetDisableFocusOnMouseDown(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetDraggable
TextEntry.SetDraggable(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetFocus
TextEntry.SetFocus(focus: boolean): boolean
No description provided.
Parameter
| Name | Type | Description |
focus | boolean | No description provided. |
SetHasClass
TextEntry.SetHasClass(classname: string, hasclass: boolean): void
No description provided.
Parameters
| Name | Type | Description |
classname | string | No description provided. |
hasclass | boolean | No description provided. |
SetInputNamespace
TextEntry.SetInputNamespace(arg0: string): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
SetMaxChars
TextEntry.SetMaxChars(max: number): void
No description provided.
Parameter
| Name | Type | Description |
max | number | No description provided. |
SetPanelEvent
TextEntry.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
TextEntry.SetParent(parent: GenericPanel): void
No description provided.
Parameter
| Name | Type | Description |
parent | GenericPanel | No description provided. |
SetReadyForDisplay
TextEntry.SetReadyForDisplay(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetScrollParentToFitWhenFocused
TextEntry.SetScrollParentToFitWhenFocused(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetTopOfInputContext
TextEntry.SetTopOfInputContext(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SortChildrenOnAttribute
TextEntry.SortChildrenOnAttribute(attribute: string, ascending: boolean): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
ascending | boolean | No description provided. |
Submit
TextEntry.Submit(): boolean
No description provided.
SwitchClass
TextEntry.SwitchClass(oldclass: string, newclass: string): void
No description provided.
Parameters
| Name | Type | Description |
oldclass | string | No description provided. |
newclass | string | No description provided. |
ToggleClass
TextEntry.ToggleClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
TriggerClass
TextEntry.TriggerClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
UpdateCurrentAnimationKeyframes
TextEntry.UpdateCurrentAnimationKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
UpdateFocusInContext
TextEntry.UpdateFocusInContext(): boolean
No description provided.