Interface: Tooltip

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.
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 Tooltip 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

Tooltip.AcceptsFocus(): boolean

No description provided.

AcceptsInput

Tooltip.AcceptsInput(): boolean

No description provided.

AddClass

Tooltip.AddClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ApplyStyles

Tooltip.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

BAscendantHasClass

Tooltip.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

CanSeeInParentScroll

Tooltip.CanSeeInParentScroll(): boolean

No description provided.

Children

Tooltip.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

Tooltip.ClearPanelEvent(event: string): void

No description provided.

Parameter

Name Type Description
event string No description provided.

ClearPropertyFromCode

Tooltip.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

Name Type Description
arg0 unknown No description provided.

CreateChildren

Tooltip.CreateChildren(elements: string): boolean

No description provided.

Parameter

Name Type Description
elements string No description provided.

CreateCopyOfCSSKeyframes

Tooltip.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

Name Type Description
animation string No description provided.

Data

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

No description provided.

Parameter

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

DeleteAsync

Tooltip.DeleteAsync(delay: number): void

No description provided.

Parameter

Name Type Description
delay number No description provided.

DeleteKeyframes

Tooltip.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

FindChild

Tooltip.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

Tooltip.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

Name Type Description
classname string No description provided.

FindChildTraverse

Tooltip.FindChildTraverse(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

GetAttributeInt

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

No description provided.

Parameters

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

GetAttributeString

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

No description provided.

Parameters

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

GetAttributeUInt32

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

No description provided.

Parameters

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

GetChild

Tooltip.GetChild(index: number): T

No description provided.

Parameter

Name Type Description
index number No description provided.

GetChildCount

Tooltip.GetChildCount(): number

No description provided.

GetChildIndex

Tooltip.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

Name Type Description
child GenericPanel No description provided.

GetFirstChild

Tooltip.GetFirstChild(): T

No description provided.

GetLastChild

Tooltip.GetLastChild(): T

No description provided.

GetLayoutFileDefine

Tooltip.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

Name Type Description
def string No description provided.

GetParent

Tooltip.GetParent(): T

No description provided.

GetPositionWithinWindow

Tooltip.GetPositionWithinWindow(): unknown

No description provided.

GetTooltipTarget

Tooltip.GetTooltipTarget(): GenericPanel

No description provided.

HasClass

Tooltip.HasClass(classname: string): boolean

No description provided.

Parameter

Name Type Description
classname string No description provided.

HasDescendantKeyFocus

Tooltip.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

Tooltip.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

Tooltip.HasKeyFocus(): boolean

No description provided.

IsDraggable

Tooltip.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

Tooltip.IsReadyForDisplay(): boolean

No description provided.

IsSelected

Tooltip.IsSelected(): boolean

No description provided.

IsSizeValid

Tooltip.IsSizeValid(): boolean

No description provided.

IsTransparent

Tooltip.IsTransparent(): boolean

No description provided.

IsValid

Tooltip.IsValid(): boolean

Check if this panel is still valid

LoadLayout

Tooltip.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

Tooltip.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

Tooltip.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

Tooltip.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

Tooltip.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

Name Type Description
snippet string No description provided.

MoveChildAfter

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

No description provided.

Parameters

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

MoveChildBefore

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

No description provided.

Parameters

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

RegisterForReadyEvents

Tooltip.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

Tooltip.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

Tooltip.RemoveClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ScrollParentToFitWhenFocused

Tooltip.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

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

ScrollToBottom

Tooltip.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

Tooltip.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

Tooltip.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

Tooltip.ScrollToRightEdge(): void

No description provided.

ScrollToTop

Tooltip.ScrollToTop(): void

No description provided.

SetAcceptsFocus

Tooltip.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetAttributeInt

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

No description provided.

Parameters

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

SetAttributeString

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

No description provided.

Parameters

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

SetAttributeUInt32

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

No description provided.

Parameters

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

SetDialogVariable

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

No description provided.

Parameters

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

SetDialogVariableFloat

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

No description provided.

Parameters

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

SetDialogVariableInt

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

No description provided.

Parameters

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

SetDialogVariableTime

Tooltip.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

Tooltip.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetDraggable

Tooltip.SetDraggable(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetFocus

Tooltip.SetFocus(focus: boolean): boolean

No description provided.

Parameter

Name Type Description
focus boolean No description provided.

SetHasClass

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

No description provided.

Parameters

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

SetInputNamespace

Tooltip.SetInputNamespace(arg0: string): void

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

SetPanelEvent

Tooltip.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

Tooltip.SetParent(parent: GenericPanel): void

No description provided.

Parameter

Name Type Description
parent GenericPanel No description provided.

SetReadyForDisplay

Tooltip.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetScrollParentToFitWhenFocused

Tooltip.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetTopOfInputContext

Tooltip.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

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

SwitchClass

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

No description provided.

Parameters

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

ToggleClass

Tooltip.ToggleClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

TriggerClass

Tooltip.TriggerClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

UpdateCurrentAnimationKeyframes

Tooltip.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

UpdateFocusInContext

Tooltip.UpdateFocusInContext(): boolean

No description provided.