<a href="#style-api-reference" class="anchor-heading" aria-labelledby="style-api-reference"> Style API Reference

Set(key, style)

Stores or replaces a named window header style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoWindowHeaderStyle

Returns

Struct.EchoWindowHeaderStyleFamily

Get(key)

Returns an existing named window header style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoWindowHeaderStyle|Undefined

Has(key)

Returns whether a named window header style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named window header style variant if it exists.

Arguments

key String

Returns

Struct.EchoWindowHeaderStyleFamily

ClearVariants()

Removes all named window header style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoWindowHeaderStyleFamily

EchoTextBlockStyleFamily

Creates a text block style family.

new EchoTextBlockStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default text block style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named text block style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named text block style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named text block style variant exists.
`Remove()`	Removes a named text block style variant if it exists.
`ClearVariants()`	Removes all named text block style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default text block style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoTextBlockStyle

Set(key, style)

Stores or replaces a named text block style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoTextBlockStyle

Returns

Struct.EchoTextBlockStyleFamily

Get(key)

Returns an existing named text block style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoTextBlockStyle|Undefined

Has(key)

Returns whether a named text block style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named text block style variant if it exists.

Arguments

key String

Returns

Struct.EchoTextBlockStyleFamily

ClearVariants()

Removes all named text block style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoTextBlockStyleFamily

EchoLabelStyleFamily

Creates a label style family.

new EchoLabelStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default label style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named label style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named label style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named label style variant exists.
`Remove()`	Removes a named label style variant if it exists.
`ClearVariants()`	Removes all named label style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default label style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoLabelStyle

Set(key, style)

Stores or replaces a named label style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoLabelStyle

Returns

Struct.EchoLabelStyleFamily

Get(key)

Returns an existing named label style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoLabelStyle|Undefined

Has(key)

Returns whether a named label style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named label style variant if it exists.

Arguments

key String

Returns

Struct.EchoLabelStyleFamily

ClearVariants()

Removes all named label style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoLabelStyleFamily

EchoSeparatorStyleFamily

Creates a separator style family.

new EchoSeparatorStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default separator style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named separator style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named separator style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named separator style variant exists.
`Remove()`	Removes a named separator style variant if it exists.
`ClearVariants()`	Removes all named separator style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default separator style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoSeparatorStyle

Set(key, style)

Stores or replaces a named separator style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoSeparatorStyle

Returns

Struct.EchoSeparatorStyleFamily

Get(key)

Returns an existing named separator style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoSeparatorStyle|Undefined

Has(key)

Returns whether a named separator style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named separator style variant if it exists.

Arguments

key String

Returns

Struct.EchoSeparatorStyleFamily

ClearVariants()

Removes all named separator style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoSeparatorStyleFamily

EchoButtonStyleFamily

Creates a button style family.

new EchoButtonStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default button style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named button style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named button style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named button style variant exists.
`Remove()`	Removes a named button style variant if it exists.
`ClearVariants()`	Removes all named button style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default button style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoButtonStyle

Set(key, style)

Stores or replaces a named button style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoButtonStyle

Returns

Struct.EchoButtonStyleFamily

Get(key)

Returns an existing named button style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoButtonStyle|Undefined

Has(key)

Returns whether a named button style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named button style variant if it exists.

Arguments

key String

Returns

Struct.EchoButtonStyleFamily

ClearVariants()

Removes all named button style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoButtonStyleFamily

EchoWindowChromeButtonStyleFamily

Creates a window chrome button style family.

new EchoWindowChromeButtonStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default window chrome button style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named window chrome button style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named window chrome button style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named window chrome button style variant exists.
`Remove()`	Removes a named window chrome button style variant if it exists.
`ClearVariants()`	Removes all named window chrome button style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default window chrome button style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Set(key, style)

Stores or replaces a named window chrome button style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoWindowChromeButtonStyle

Returns

Struct.EchoWindowChromeButtonStyleFamily

Get(key)

Returns an existing named window chrome button style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoWindowChromeButtonStyle|Undefined

Has(key)

Returns whether a named window chrome button style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named window chrome button style variant if it exists.

Arguments

key String

Returns

Struct.EchoWindowChromeButtonStyleFamily

ClearVariants()

Removes all named window chrome button style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoWindowChromeButtonStyleFamily

EchoColorButtonStyleFamily

Creates a color button style family.

new EchoColorButtonStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default color button style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named color button style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named color button style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named color button style variant exists.
`Remove()`	Removes a named color button style variant if it exists.
`ClearVariants()`	Removes all named color button style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default color button style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoColorButtonStyle

Set(key, style)

Stores or replaces a named color button style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoColorButtonStyle

Returns

Struct.EchoColorButtonStyleFamily

Get(key)

Returns an existing named color button style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoColorButtonStyle|Undefined

Has(key)

Returns whether a named color button style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named color button style variant if it exists.

Arguments

key String

Returns

Struct.EchoColorButtonStyleFamily

ClearVariants()

Removes all named color button style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoColorButtonStyleFamily

EchoColorPickerStyleFamily

Creates a color picker style family.

new EchoColorPickerStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default color picker style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named color picker style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named color picker style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named color picker style variant exists.
`Remove()`	Removes a named color picker style variant if it exists.
`ClearVariants()`	Removes all named color picker style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default color picker style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoColorPickerStyle

Set(key, style)

Stores or replaces a named color picker style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoColorPickerStyle

Returns

Struct.EchoColorPickerStyleFamily

Get(key)

Returns an existing named color picker style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoColorPickerStyle|Undefined

Has(key)

Returns whether a named color picker style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named color picker style variant if it exists.

Arguments

key String

Returns

Struct.EchoColorPickerStyleFamily

ClearVariants()

Removes all named color picker style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoColorPickerStyleFamily

EchoToggleStyleFamily

Creates a toggle style family.

new EchoToggleStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default toggle style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named toggle style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named toggle style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named toggle style variant exists.
`Remove()`	Removes a named toggle style variant if it exists.
`ClearVariants()`	Removes all named toggle style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default toggle style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoToggleStyle

Set(key, style)

Stores or replaces a named toggle style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoToggleStyle

Returns

Struct.EchoToggleStyleFamily

Get(key)

Returns an existing named toggle style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoToggleStyle|Undefined

Has(key)

Returns whether a named toggle style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named toggle style variant if it exists.

Arguments

key String

Returns

Struct.EchoToggleStyleFamily

ClearVariants()

Removes all named toggle style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoToggleStyleFamily

Creates a dropdown style family.

new EchoDropdownStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default dropdown style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named dropdown style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named dropdown style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named dropdown style variant exists.
`Remove()`	Removes a named dropdown style variant if it exists.
`ClearVariants()`	Removes all named dropdown style variants. This removes named variants only. It doesn't clear the default style.

EchoTextInputStyleFamily

Creates a text input style family.

new EchoTextInputStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default text input style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named text input style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named text input style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named text input style variant exists.
`Remove()`	Removes a named text input style variant if it exists.
`ClearVariants()`	Removes all named text input style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default text input style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoTextInputStyle

Set(key, style)

Stores or replaces a named text input style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoTextInputStyle

Returns

Struct.EchoTextInputStyleFamily

Get(key)

Returns an existing named text input style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoTextInputStyle|Undefined

Has(key)

Returns whether a named text input style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named text input style variant if it exists.

Arguments

key String

Returns

Struct.EchoTextInputStyleFamily

ClearVariants()

Removes all named text input style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoTextInputStyleFamily

EchoTextBoxOverlayStyleFamily

Creates a text box editor overlay style family.

new EchoTextBoxOverlayStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default text box editor overlay style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named text box editor overlay style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named text box editor overlay style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named text box editor overlay style variant exists.
`Remove()`	Removes a named text box editor overlay style variant if it exists.
`ClearVariants()`	Removes all named text box editor overlay style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default text box editor overlay style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Set(key, style)

Stores or replaces a named text box editor overlay style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoTextBoxOverlayStyle

Returns

Struct.EchoTextBoxOverlayStyleFamily

Get(key)

Returns an existing named text box editor overlay style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoTextBoxOverlayStyle|Undefined

Has(key)

Returns whether a named text box editor overlay style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named text box editor overlay style variant if it exists.

Arguments

key String

Returns

Struct.EchoTextBoxOverlayStyleFamily

ClearVariants()

Removes all named text box editor overlay style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoTextBoxOverlayStyleFamily

EchoSliderStyleFamily

Creates a slider style family.

new EchoSliderStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default slider style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named slider style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named slider style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named slider style variant exists.
`Remove()`	Removes a named slider style variant if it exists.
`ClearVariants()`	Removes all named slider style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default slider style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoSliderStyle

Set(key, style)

Stores or replaces a named slider style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoSliderStyle

Returns

Struct.EchoSliderStyleFamily

Get(key)

Returns an existing named slider style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoSliderStyle|Undefined

Has(key)

Returns whether a named slider style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named slider style variant if it exists.

Arguments

key String

Returns

Struct.EchoSliderStyleFamily

ClearVariants()

Removes all named slider style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoSliderStyleFamily

Creates a popup style family.

new EchoPopupStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default popup style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named popup style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named popup style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named popup style variant exists.
`Remove()`	Removes a named popup style variant if it exists.
`ClearVariants()`	Removes all named popup style variants. This removes named variants only. It doesn't clear the default style.

Creates a tooltip style family.

new EchoTooltipStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default tooltip style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named tooltip style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named tooltip style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named tooltip style variant exists.
`Remove()`	Removes a named tooltip style variant if it exists.
`ClearVariants()`	Removes all named tooltip style variants. This removes named variants only. It doesn't clear the default style.

EchoToastStyleFamily

Creates a toast style family.

new EchoToastStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default toast style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named toast style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named toast style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named toast style variant exists.
`Remove()`	Removes a named toast style variant if it exists.
`ClearVariants()`	Removes all named toast style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default toast style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoToastStyle

Set(key, style)

Stores or replaces a named toast style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoToastStyle

Returns

Struct.EchoToastStyleFamily

Get(key)

Returns an existing named toast style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoToastStyle|Undefined

Has(key)

Returns whether a named toast style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named toast style variant if it exists.

Arguments

key String

Returns

Struct.EchoToastStyleFamily

ClearVariants()

Removes all named toast style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoToastStyleFamily

EchoScrollbarStyleFamily

Creates a scrollbar style family.

new EchoScrollbarStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default scrollbar style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named scrollbar style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named scrollbar style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named scrollbar style variant exists.
`Remove()`	Removes a named scrollbar style variant if it exists.
`ClearVariants()`	Removes all named scrollbar style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default scrollbar style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoScrollbarStyle

Set(key, style)

Stores or replaces a named scrollbar style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoScrollbarStyle

Returns

Struct.EchoScrollbarStyleFamily

Get(key)

Returns an existing named scrollbar style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoScrollbarStyle|Undefined

Has(key)

Returns whether a named scrollbar style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named scrollbar style variant if it exists.

Arguments

key String

Returns

Struct.EchoScrollbarStyleFamily

ClearVariants()

Removes all named scrollbar style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoScrollbarStyleFamily

EchoListRowStyleFamily

Creates a list row style family.

new EchoListRowStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default list row style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named list row style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named list row style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named list row style variant exists.
`Remove()`	Removes a named list row style variant if it exists.
`ClearVariants()`	Removes all named list row style variants. This removes named variants only. It doesn't clear the default style.

Default()

Returns the live default list row style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.

Returns

Struct.EchoListRowStyle

Set(key, style)

Stores or replaces a named list row style variant. The key is the same string you pass to SetStyleKey(...), SetStyleKeyHeader(...), SetStyleKeyChromeButton(...), or another style-key setter.

Arguments

key String

style Struct.EchoListRowStyle

Returns

Struct.EchoListRowStyleFamily

Get(key)

Returns an existing named list row style variant, or undefined if it doesn't exist.

Arguments

key String

Returns

Struct.EchoListRowStyle|Undefined

Has(key)

Returns whether a named list row style variant exists.

Arguments

key String

Returns

Bool

Remove(key)

Removes a named list row style variant if it exists.

Arguments

key String

Returns

Struct.EchoListRowStyleFamily

ClearVariants()

Removes all named list row style variants. This removes named variants only. It doesn't clear the default style.

Returns

Struct.EchoListRowStyleFamily

Creates a context menu style family.

new EchoContextMenuStyleFamily()

Methods

Method	What it does
`Default()`	Returns the live default context menu style. This returns the actual default style, not a copy. If you change it, every control using the default style for that family will see the change.
`Set()`	Stores or replaces a named context menu style variant. The key is the same string you pass to `SetStyleKey(...)`, `SetStyleKeyHeader(...)`, `SetStyleKeyChromeButton(...)`, or another style-key setter.
`Get()`	Returns an existing named context menu style variant, or undefined if it doesn't exist.
`Has()`	Returns whether a named context menu style variant exists.
`Remove()`	Removes a named context menu style variant if it exists.
`ClearVariants()`	Removes all named context menu style variants. This removes named variants only. It doesn't clear the default style.

Windows and layout

EchoWindowChromeButtonStyle

Creates an optional override style for a window button. The active state is used for chrome buttons that represent an enabled window state. For example, a pinned window can use the active icon colour for its pin button.

new EchoWindowChromeButtonStyle()

Methods

Style-specific

`SetFont()`	Sets the chrome button font.
`SetActiveBgColour()`	Sets all background corner colours. Omitted corners use the top-left colour.
`SetActiveBorderColour()`	Sets all border corner colours. Omitted corners use the top-left colour.
`SetActiveTextColour()`	Sets the active text colour.
`SetActiveBgAlpha()`	Sets the active background alpha.
`SetActiveBorderAlpha()`	Sets the active border alpha.
`SetActiveTextAlpha()`	Sets the active text alpha.
`SetIconColour()`	Sets the default chrome icon colour.
`SetIconAlpha()`	Sets the default chrome icon alpha.
`SetHoverIconColour()`	Sets the hover chrome icon colour.
`SetHoverIconAlpha()`	Sets the hover chrome icon alpha.
`SetPressedIconColour()`	Sets the pressed chrome icon colour.
`SetPressedIconAlpha()`	Sets the pressed chrome icon alpha.
`SetActiveIconColour()`	Sets the active chrome icon colour.
`SetActiveIconAlpha()`	Sets the active chrome icon alpha.

Stateful box

`SetBgColour()`	Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.
`SetBorderColour()`	Sets all border corners using the shared fallback-to-top-left rule.
`SetTextColour()`	Sets the text colour.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.
`SetTextAlpha()`	Sets text opacity.
`SetHoverBgColour()`	Sets the hover background colour.
`SetHoverBorderColour()`	Sets the hover border colour.
`SetHoverTextColour()`	Sets the hover text colour.
`SetHoverBgAlpha()`	Sets the hover background alpha.
`SetHoverBorderAlpha()`	Sets the hover border alpha.
`SetHoverTextAlpha()`	Sets the hover text alpha.
`SetPressedMix()`	Sets the pressed mix.
`SetPressedBgColour()`	Sets the pressed background colour.
`SetPressedBorderColour()`	Sets the pressed border colour.
`SetPressedTextColour()`	Sets the pressed text colour.
`SetPressedBgAlpha()`	Sets the pressed background alpha.
`SetPressedBorderAlpha()`	Sets the pressed border alpha.
`SetPressedTextAlpha()`	Sets the pressed text alpha.
`SetDisabledBgColour()`	Sets the disabled background colour.
`SetDisabledBorderColour()`	Sets the disabled border colour.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledBgAlpha()`	Sets the disabled background alpha.
`SetDisabledBorderAlpha()`	Sets the disabled border alpha.
`SetDisabledTextAlpha()`	Sets disabled text opacity.
`SetShape()`	Sets the shape used to draw the box.
`SetCornerRadius()`	Sets the horizontal and vertical corner radius for rounded boxes.

SetBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all border corners using the shared fallback-to-top-left rule.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetTextColour(value)

Sets the text colour.

Arguments

value Real

Returns

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

SetTextAlpha(value)

Sets text opacity.

Arguments

value Real

Returns

SetHoverBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetHoverBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetHoverTextColour(value)

Sets the hover text colour.

Arguments

value Real

Returns

SetHoverBgAlpha(value)

Sets the hover background alpha.

Arguments

value Real

Returns

SetHoverBorderAlpha(value)

Sets the hover border alpha.

Arguments

value Real

Returns

SetHoverTextAlpha(value)

Sets the hover text alpha.

Arguments

value Real

Returns

SetPressedMix(value)

Sets the pressed mix.

Arguments

value Real

Returns

SetPressedBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetPressedBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetPressedTextColour(value)

Sets the pressed text colour.

Arguments

value Real

Returns

SetPressedBgAlpha(value)

Sets the pressed background alpha.

Arguments

value Real

Returns

SetPressedBorderAlpha(value)

Sets the pressed border alpha.

Arguments

value Real

Returns

SetPressedTextAlpha(value)

Sets the pressed text alpha.

Arguments

value Real

Returns

SetDisabledBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetDisabledBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetDisabledTextColour(value)

Sets the disabled text colour.

Arguments

value Real

Returns

SetDisabledBgAlpha(value)

Sets the disabled background alpha.

Arguments

value Real

Returns

SetDisabledBorderAlpha(value)

Sets the disabled border alpha.

Arguments

value Real

Returns

SetDisabledTextAlpha(value)

Sets disabled text opacity.

Arguments

value Real

Returns

SetShape(shape)

Sets the shape used to draw the box.

Arguments

shape Real Uses the eEchoChamberBoxShape enum.

Returns

SetCornerRadius(radius_x, [radius_y])

Sets the horizontal and vertical corner radius for rounded boxes.

Arguments

radius_x Real The non-negative horizontal corner radius.

radius_y optional Real|Undefined The vertical radius, or the horizontal radius when omitted.

Returns

SetFont(font)

Sets the chrome button font.

Arguments

font Asset.GMFont

Returns

SetActiveBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all background corner colours. Omitted corners use the top-left colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetActiveBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all border corner colours. Omitted corners use the top-left colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

SetActiveTextColour(value)

Sets the active text colour.

Arguments

value Real|Constant.Colour

Returns

SetActiveBgAlpha(value)

Sets the active background alpha.

Arguments

value Real

Returns

SetActiveBorderAlpha(value)

Sets the active border alpha.

Arguments

value Real

Returns

SetActiveTextAlpha(value)

Sets the active text alpha.

Arguments

value Real

Returns

SetIconColour(value)

Sets the default chrome icon colour.

Arguments

value Real|Constant.Colour

Returns

SetIconAlpha(value)

Sets the default chrome icon alpha.

Arguments

value Real

Returns

SetHoverIconColour(value)

Sets the hover chrome icon colour.

Arguments

value Real|Constant.Colour

Returns

SetHoverIconAlpha(value)

Sets the hover chrome icon alpha.

Arguments

value Real

Returns

SetPressedIconColour(value)

Sets the pressed chrome icon colour.

Arguments

value Real|Constant.Colour

Returns

SetPressedIconAlpha(value)

Sets the pressed chrome icon alpha.

Arguments

value Real

Returns

SetActiveIconColour(value)

Sets the active chrome icon colour.

Arguments

value Real|Constant.Colour

Returns

SetActiveIconAlpha(value)

Sets the active chrome icon alpha.

Arguments

value Real

Returns

EchoWindowStyle

Creates an optional override style for a window body. Clamp margin controls how close a draggable window is allowed to get to the canvas edge before Echo Chamber pulls it back. It's a safety margin, not visual padding.

new EchoWindowStyle()

Methods

Style-specific

`SetClampMargin()`	Sets all clamp margins to the same value.
`SetClampMarginX()`	Sets the horizontal clamp margins.
`SetClampMarginY()`	Sets the vertical clamp margins.
`SetClampMarginLeft()`	Sets the left clamp margin.
`SetClampMarginTop()`	Sets the top clamp margin.
`SetClampMarginRight()`	Sets the right clamp margin.
`SetClampMarginBottom()`	Sets the bottom clamp margin.
`SetClampMarginLTRB()`	Sets all clamp margins explicitly.
`SetTitlebarVisible()`	Sets whether the titlebar is visible.
`SetResizeGripSize()`	Sets the resize grip size.
`SetMinimizedHeight()`	Sets the minimized window height.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

SetBgColour(value)

Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetBorderColour(value)

Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoWindowStyle

SetClampMargin(value)

Sets all clamp margins to the same value.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetClampMarginX(value)

Sets the horizontal clamp margins.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetClampMarginY(value)

Sets the vertical clamp margins.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetClampMarginLeft(value)

Sets the left clamp margin.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetClampMarginTop(value)

Sets the top clamp margin.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetClampMarginRight(value)

Sets the right clamp margin.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetClampMarginBottom(value)

Sets the bottom clamp margin.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetClampMarginLTRB(left, top, right, bottom)

Sets all clamp margins explicitly.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoWindowStyle

SetTitlebarVisible(flag)

Sets whether the titlebar is visible.

Arguments

flag Bool

Returns

Struct.EchoWindowStyle

SetResizeGripSize(value)

Sets the resize grip size.

Arguments

value Real

Returns

Struct.EchoWindowStyle

SetMinimizedHeight(value)

Sets the minimized window height.

Arguments

value Real

Returns

Struct.EchoWindowStyle

EchoWindowHeaderStyle

Creates an optional override style for a window header. The SpriteSet methods expect a sprite with state subimages. Subimage 0 is the normal icon. Later subimages can provide hover, pressed, and disabled versions.

new EchoWindowHeaderStyle()

Methods

Style-specific

`SetFont()`	Sets the header font.
`SetTextColour()`	Sets the header text colour.
`SetTextAlpha()`	Sets the header text alpha.
`SetDisabledTextColour()`	Sets the disabled header text colour.
`SetDisabledTextAlpha()`	Sets the disabled header text alpha.
`SetTextAlign()`	Sets the header text alignment.
`SetHeight()`	Sets the header height.
`SetButtonGap()`	Sets the gap between header buttons.
`SetButtonSize()`	Sets the header button size.
`SetChromeIconSize()`	Sets the draw size used for chrome icons.
`SetChromeIconStrokeWidth()`	Sets the stroke width used for built-in chrome icons.
`SetChromeIconCloseSprite()`	Sets the sprite used for the close chrome icon.
`SetChromeIconMinimiseSprite()`	Sets the sprite used for the minimise chrome icon.
`SetChromeIconMaximiseSprite()`	Sets the sprite used for the maximise chrome icon.
`SetChromeIconRestoreSprite()`	Sets the sprite used for the restore chrome icon.
`SetChromeIconPinSprite()`	Sets the sprite used for the pin chrome icon.
`SetChromeIconUnpinSprite()`	Sets the sprite used for the unpin chrome icon.
`SetShowCloseButton()`	Sets whether the close chrome button is shown.
`SetShowMinimizeButton()`	Sets whether the minimize chrome button is shown.
`SetShowPinButton()`	Sets whether the pin chrome button is shown.
`SetChromeIconCloseSpriteSet()`	Sets the state sprite used for the close chrome icon.
`SetChromeIconMinimiseSpriteSet()`	Sets the state sprite used for the minimise chrome icon.
`SetChromeIconMaximiseSpriteSet()`	Sets the state sprite used for the maximise chrome icon.
`SetChromeIconRestoreSpriteSet()`	Sets the state sprite used for the restore chrome icon.
`SetChromeIconPinSpriteSet()`	Sets the state sprite used for the pin chrome icon.
`SetChromeIconUnpinSpriteSet()`	Sets the state sprite used for the unpin chrome icon.
`SetShowChromeButtons()`	Sets which chrome buttons are shown in the header.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

SetBgColour(value)

Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

SetBorderColour(value)

Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

SetFont(font)

Sets the header font.

Arguments

font Asset.GMFont

Returns

SetTextColour(value)

Sets the header text colour.

Arguments

value Real|Constant.Colour

Returns

SetTextAlpha(value)

Sets the header text alpha.

Arguments

value Real

Returns

SetDisabledTextColour(value)

Sets the disabled header text colour.

Arguments

value Real|Constant.Colour

Returns

SetDisabledTextAlpha(value)

Sets the disabled header text alpha.

Arguments

value Real

Returns

SetTextAlign(align)

Sets the header text alignment.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

SetHeight(value)

Sets the header height.

Arguments

value Real

Returns

SetButtonGap(value)

Sets the gap between header buttons.

Arguments

value Real

Returns

SetButtonSize(value)

Sets the header button size.

Arguments

value Real

Returns

SetChromeIconSize(value)

Sets the draw size used for chrome icons.

Arguments

value Real

Returns

SetChromeIconStrokeWidth(value)

Sets the stroke width used for built-in chrome icons.

Arguments

value Real

Returns

SetChromeIconCloseSprite(sprite)

Sets the sprite used for the close chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconMinimiseSprite(sprite)

Sets the sprite used for the minimise chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconMaximiseSprite(sprite)

Sets the sprite used for the maximise chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconRestoreSprite(sprite)

Sets the sprite used for the restore chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconPinSprite(sprite)

Sets the sprite used for the pin chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconUnpinSprite(sprite)

Sets the sprite used for the unpin chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetShowCloseButton(flag)

Sets whether the close chrome button is shown.

Arguments

flag Bool

Returns

SetShowMinimizeButton(flag)

Sets whether the minimize chrome button is shown.

Arguments

flag Bool

Returns

SetShowPinButton(flag)

Sets whether the pin chrome button is shown.

Arguments

flag Bool

Returns

SetChromeIconCloseSpriteSet(sprite)

Sets the state sprite used for the close chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconMinimiseSpriteSet(sprite)

Sets the state sprite used for the minimise chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconMaximiseSpriteSet(sprite)

Sets the state sprite used for the maximise chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconRestoreSpriteSet(sprite)

Sets the state sprite used for the restore chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconPinSpriteSet(sprite)

Sets the state sprite used for the pin chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetChromeIconUnpinSpriteSet(sprite)

Sets the state sprite used for the unpin chrome icon.

Arguments

sprite Asset.GMSprite

Returns

SetShowChromeButtons(show_close, show_minimize, show_pin)

Sets which chrome buttons are shown in the header.

Arguments

show_close Bool

show_minimize Bool

show_pin Bool

Returns

EchoPanelStyle

Creates an optional override style for a panel. SetGap(...) is the simple "space between controls" setting. Use SetGapX(...) and SetGapY(...) only when horizontal and vertical spacing need to differ.

new EchoPanelStyle()

Methods

Style-specific

`SetCollapseHandleSize()`	Sets the collapse handle size.
`SetCollapseHandleBgColour()`	Sets the collapse handle background colour.
`SetCollapseHandleBgAlpha()`	Sets the collapse handle background alpha.
`SetCollapseHandleHoverBgColour()`	Sets the hover collapse handle background colour.
`SetCollapseHandleHoverBgAlpha()`	Sets the hover collapse handle background alpha.
`SetCollapseHandleBorderColour()`	Sets the collapse handle border colour.
`SetCollapseHandleBorderAlpha()`	Sets the collapse handle border alpha.
`SetCollapseHandleGlyphColour()`	Sets the collapse handle glyph colour.
`SetCollapseHandleGlyphAlpha()`	Sets the collapse handle glyph alpha.
`SetSplitterHitSize()`	Sets the splitter hit size.
`SetSplitterDrawSize()`	Sets the splitter draw size.
`SetSplitterColour()`	Sets the splitter colour.
`SetSplitterAlpha()`	Sets the splitter alpha.
`SetSplitterHoverColour()`	Sets the hover splitter colour.
`SetSplitterHoverAlpha()`	Sets the hover splitter alpha.
`SetSplitterActiveColour()`	Sets the active splitter colour.
`SetSplitterActiveAlpha()`	Sets the active splitter alpha.
`SetGapX()`	Sets the horizontal panel gap.
`SetGapY()`	Sets the vertical panel gap.
`SetGap()`	Sets the horizontal and vertical panel gaps.
`SetRowHeight()`	Sets the panel row height.
`SetCollapsedSize()`	Sets the collapsed panel size.
`SetScrollGutterPad()`	Sets all scroll gutter padding edges to the same value.
`SetScrollGutterPadX()`	Sets the horizontal scroll gutter padding.
`SetScrollGutterPadY()`	Sets the vertical scroll gutter padding.
`SetScrollGutterPadLeft()`	Sets the left scroll gutter padding.
`SetScrollGutterPadTop()`	Sets the top scroll gutter padding.
`SetScrollGutterPadRight()`	Sets the right scroll gutter padding.
`SetScrollGutterPadBottom()`	Sets the bottom scroll gutter padding.
`SetScrollGutterPadLTRB()`	Sets all scroll gutter padding edges explicitly.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Margins

`SetMargin()`	Sets the margin.
`SetMarginX()`	Sets horizontal margin.
`SetMarginY()`	Sets vertical margin.
`SetMarginLeft()`	Sets the margin left.
`SetMarginTop()`	Sets the margin top.
`SetMarginRight()`	Sets the margin right.
`SetMarginBottom()`	Sets the margin bottom.
`SetMarginLTRB()`	Sets left, top, right, and bottom margin.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

SetBgColour(value)

Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetBorderColour(value)

Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoPanelStyle

SetMargin(value)

Sets the margin.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetMarginX(value)

Sets horizontal margin.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetMarginY(value)

Sets vertical margin.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetMarginLeft(value)

Sets the margin left.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetMarginTop(value)

Sets the margin top.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetMarginRight(value)

Sets the margin right.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetMarginBottom(value)

Sets the margin bottom.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetMarginLTRB(left, top, right, bottom)

Sets left, top, right, and bottom margin.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoPanelStyle

SetCollapseHandleSize(value)

Sets the collapse handle size.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetCollapseHandleBgColour(value)

Sets the collapse handle background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoPanelStyle

SetCollapseHandleBgAlpha(value)

Sets the collapse handle background alpha.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetCollapseHandleHoverBgColour(value)

Sets the hover collapse handle background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoPanelStyle

SetCollapseHandleHoverBgAlpha(value)

Sets the hover collapse handle background alpha.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetCollapseHandleBorderColour(value)

Sets the collapse handle border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoPanelStyle

SetCollapseHandleBorderAlpha(value)

Sets the collapse handle border alpha.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetCollapseHandleGlyphColour(value)

Sets the collapse handle glyph colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoPanelStyle

SetCollapseHandleGlyphAlpha(value)

Sets the collapse handle glyph alpha.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetSplitterHitSize(value)

Sets the splitter hit size.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetSplitterDrawSize(value)

Sets the splitter draw size.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetSplitterColour(value)

Sets the splitter colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoPanelStyle

SetSplitterAlpha(value)

Sets the splitter alpha.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetSplitterHoverColour(value)

Sets the hover splitter colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoPanelStyle

SetSplitterHoverAlpha(value)

Sets the hover splitter alpha.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetSplitterActiveColour(value)

Sets the active splitter colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoPanelStyle

SetSplitterActiveAlpha(value)

Sets the active splitter alpha.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetGapX(value)

Sets the horizontal panel gap.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetGapY(value)

Sets the vertical panel gap.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetGap(value)

Sets the horizontal and vertical panel gaps.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetRowHeight(value)

Sets the panel row height.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetCollapsedSize(value)

Sets the collapsed panel size.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPad(value)

Sets all scroll gutter padding edges to the same value.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPadX(value)

Sets the horizontal scroll gutter padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPadY(value)

Sets the vertical scroll gutter padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPadLeft(value)

Sets the left scroll gutter padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPadTop(value)

Sets the top scroll gutter padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPadRight(value)

Sets the right scroll gutter padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPadBottom(value)

Sets the bottom scroll gutter padding.

Arguments

value Real

Returns

Struct.EchoPanelStyle

SetScrollGutterPadLTRB(left, top, right, bottom)

Sets all scroll gutter padding edges explicitly.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoPanelStyle

Creates an optional override style for popups. Anchor gap is the distance between the control that opened the popup and the popup itself.

new EchoPopupStyle()

Methods

Style-specific

`SetHeaderBgColour()`	Sets the popup header background colour.
`SetHeaderAlpha()`	Sets the popup header alpha.
`SetAnchorGap()`	Sets the popup anchor gap.
`SetViewportMargin()`	Sets all popup viewport margins to the same value.
`SetViewportMarginX()`	Sets the left and right popup viewport margins.
`SetViewportMarginY()`	Sets the top and bottom popup viewport margins.
`SetViewportMarginLeft()`	Sets the left popup viewport margin.
`SetViewportMarginTop()`	Sets the top popup viewport margin.
`SetViewportMarginRight()`	Sets the right popup viewport margin.
`SetViewportMarginBottom()`	Sets the bottom popup viewport margin.
`SetViewportMarginLTRB()`	Sets all popup viewport margins explicitly.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

EchoScrollbarStyle

Creates an optional override style for scrollbars. The track is the full scrollbar rail. The handle is the part the user drags.

new EchoScrollbarStyle()

Methods

Style-specific

`SetTrackWidth()`	Sets the track width.
`SetHandleWidth()`	Sets the handle width.
`SetTrackBgColour()`	Sets the track background colour.
`SetTrackBgAlpha()`	Sets the track background alpha.
`SetHoverTrackBgColour()`	Sets the hover track background colour.
`SetHoverTrackBgAlpha()`	Sets the hover track background alpha.
`SetTrackBorderColour()`	Sets the track border colour.
`SetTrackBorderAlpha()`	Sets the track border alpha.
`SetHandleBgColour()`	Sets the handle background colour.
`SetHandleBgAlpha()`	Sets the handle background alpha.
`SetHoverHandleBgColour()`	Sets the hover handle background colour.
`SetHoverHandleBgAlpha()`	Sets the hover handle background alpha.
`SetPressedHandleBgColour()`	Sets the pressed handle background colour.
`SetPressedHandleBgAlpha()`	Sets the pressed handle background alpha.
`SetHandleBorderColour()`	Sets the handle border colour.
`SetHandleBorderAlpha()`	Sets the handle border alpha.

SetTrackWidth(width)

Sets the track width.

Arguments

width Real

Returns

Struct.EchoScrollbarStyle

SetHandleWidth(width)

Sets the handle width.

Arguments

width Real

Returns

Struct.EchoScrollbarStyle

SetTrackBgColour(value)

Sets the track background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoScrollbarStyle

SetTrackBgAlpha(value)

Sets the track background alpha.

Arguments

value Real

Returns

Struct.EchoScrollbarStyle

SetHoverTrackBgColour(value)

Sets the hover track background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoScrollbarStyle

SetHoverTrackBgAlpha(value)

Sets the hover track background alpha.

Arguments

value Real

Returns

Struct.EchoScrollbarStyle

SetTrackBorderColour(value)

Sets the track border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoScrollbarStyle

SetTrackBorderAlpha(value)

Sets the track border alpha.

Arguments

value Real

Returns

Struct.EchoScrollbarStyle

SetHandleBgColour(value)

Sets the handle background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoScrollbarStyle

SetHandleBgAlpha(value)

Sets the handle background alpha.

Arguments

value Real

Returns

Struct.EchoScrollbarStyle

SetHoverHandleBgColour(value)

Sets the hover handle background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoScrollbarStyle

SetHoverHandleBgAlpha(value)

Sets the hover handle background alpha.

Arguments

value Real

Returns

Struct.EchoScrollbarStyle

SetPressedHandleBgColour(value)

Sets the pressed handle background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoScrollbarStyle

SetPressedHandleBgAlpha(value)

Sets the pressed handle background alpha.

Arguments

value Real

Returns

Struct.EchoScrollbarStyle

SetHandleBorderColour(value)

Sets the handle border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoScrollbarStyle

SetHandleBorderAlpha(value)

Sets the handle border alpha.

Arguments

value Real

Returns

Struct.EchoScrollbarStyle

Text, lists, and display

EchoListRowStyle

List row style used by list and dropdown rows. List rows have more states than a simple button because a row can be normal, hovered, selected, pressed, or disabled. Selection means "this row is currently chosen", while hover means "the mouse is currently over this row".

new EchoListRowStyle()

Methods

Style-specific

`SetRowHeight()`	Sets the list row height.
`SetNormalBgColour()`	Sets the normal row background colour.
`SetHoverBgColour()`	Sets the hover row background colour.
`SetSelectedBgColour()`	Sets the selected row background colour.
`SetPressedBgColour()`	Sets the pressed row background colour.
`SetDisabledBgColour()`	Sets the disabled row background colour.
`SetNormalTextColour()`	Sets the normal row text colour.
`SetHoverTextColour()`	Sets the hover row text colour.
`SetSelectedTextColour()`	Sets the selected row text colour.
`SetPressedTextColour()`	Sets the pressed row text colour.
`SetDisabledTextColour()`	Sets the disabled row text colour.
`SetNormalBgAlpha()`	Sets the normal row background alpha.
`SetHoverBgAlpha()`	Sets the hover row background alpha.
`SetSelectedBgAlpha()`	Sets the selected row background alpha.
`SetPressedBgAlpha()`	Sets the pressed row background alpha.
`SetDisabledBgAlpha()`	Sets the disabled row background alpha.
`SetNormalTextAlpha()`	Sets the normal row text alpha.
`SetHoverTextAlpha()`	Sets the hover row text alpha.
`SetSelectedTextAlpha()`	Sets the selected row text alpha.
`SetPressedTextAlpha()`	Sets the pressed row text alpha.
`SetDisabledTextAlpha()`	Sets the disabled row text alpha.
`SetFont()`	Sets the row font.
`SetPadding()`	Sets all row padding sides.
`SetPaddingX()`	Sets horizontal row padding.
`SetPaddingY()`	Sets vertical row padding.
`SetPaddingLeft()`	Sets left row padding.
`SetPaddingTop()`	Sets top row padding.
`SetPaddingRight()`	Sets right row padding.
`SetPaddingBottom()`	Sets bottom row padding.
`SetPaddingLTRB()`	Sets explicit row padding.

SetRowHeight(value)

Sets the list row height.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetNormalBgColour(value)

Sets the normal row background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetHoverBgColour(value)

Sets the hover row background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetSelectedBgColour(value)

Sets the selected row background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetPressedBgColour(value)

Sets the pressed row background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetDisabledBgColour(value)

Sets the disabled row background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetNormalTextColour(value)

Sets the normal row text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetHoverTextColour(value)

Sets the hover row text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetSelectedTextColour(value)

Sets the selected row text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetPressedTextColour(value)

Sets the pressed row text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetDisabledTextColour(value)

Sets the disabled row text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoListRowStyle

SetNormalBgAlpha(value)

Sets the normal row background alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetHoverBgAlpha(value)

Sets the hover row background alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetSelectedBgAlpha(value)

Sets the selected row background alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPressedBgAlpha(value)

Sets the pressed row background alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetDisabledBgAlpha(value)

Sets the disabled row background alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetNormalTextAlpha(value)

Sets the normal row text alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetHoverTextAlpha(value)

Sets the hover row text alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetSelectedTextAlpha(value)

Sets the selected row text alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPressedTextAlpha(value)

Sets the pressed row text alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetDisabledTextAlpha(value)

Sets the disabled row text alpha.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetFont(font)

Sets the row font.

Arguments

font Asset.GMFont

Returns

Struct.EchoListRowStyle

SetPadding(value)

Sets all row padding sides.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPaddingX(value)

Sets horizontal row padding.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPaddingY(value)

Sets vertical row padding.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPaddingLeft(value)

Sets left row padding.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPaddingTop(value)

Sets top row padding.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPaddingRight(value)

Sets right row padding.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPaddingBottom(value)

Sets bottom row padding.

Arguments

value Real

Returns

Struct.EchoListRowStyle

SetPaddingLTRB(left, top, right, bottom)

Sets explicit row padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoListRowStyle

Creates an optional override style for context menus. The viewport margin keeps a menu away from the edge of the screen. This matters when a user right-clicks close to the edge and the menu needs room to remain visible.

new EchoContextMenuStyle()

Methods

Style-specific

`SetFont()`	Sets the context menu font.
`SetRowHeight()`	Sets the context menu row height.
`SetMinWidth()`	Sets the minimum context menu width.
`SetMaxWidth()`	Sets the maximum context menu width.
`SetViewportMargin()`	Sets the viewport edge margin used when clamping the context menu popup.
`SetItemInsetX()`	Sets the horizontal inset applied to context menu item content.
`SetItemBgInsetX()`	Sets the horizontal inset applied to context menu item background fills.
`SetItemBgColour()`	Sets the normal context menu item background colour.
`SetItemBgAlpha()`	Sets the normal context menu item background alpha.
`SetItemHoverBgColour()`	Sets the hovered context menu item background colour.
`SetItemHoverBgAlpha()`	Sets the hovered context menu item background alpha.
`SetItemDisabledBgColour()`	Sets the disabled context menu item background colour.
`SetItemDisabledBgAlpha()`	Sets the disabled context menu item background alpha.
`SetItemTextColour()`	Sets the normal context menu item text colour.
`SetItemTextAlpha()`	Sets the normal context menu item text alpha.
`SetItemHoverTextColour()`	Sets the hovered context menu item text colour.
`SetItemHoverTextAlpha()`	Sets the hovered context menu item text alpha.
`SetItemDisabledTextColour()`	Sets the disabled context menu item text colour.
`SetItemDisabledTextAlpha()`	Sets the disabled context menu item text alpha.
`SetIconSize()`	Sets the context menu icon draw size.
`SetIconGap()`	Sets the horizontal gap after context menu icons.
`SetIconColour()`	Sets the normal context menu icon colour.
`SetIconAlpha()`	Sets the normal context menu icon alpha.
`SetIconHoverColour()`	Sets the hovered context menu icon colour.
`SetIconHoverAlpha()`	Sets the hovered context menu icon alpha.
`SetIconDisabledColour()`	Sets the disabled context menu icon colour.
`SetIconDisabledAlpha()`	Sets the disabled context menu icon alpha.
`SetShortcutGap()`	Sets the horizontal gap before context menu shortcut text.
`SetShortcutTextColour()`	Sets the normal context menu shortcut text colour.
`SetShortcutTextAlpha()`	Sets the normal context menu shortcut text alpha.
`SetShortcutHoverTextColour()`	Sets the hovered context menu shortcut text colour.
`SetShortcutHoverTextAlpha()`	Sets the hovered context menu shortcut text alpha.
`SetShortcutDisabledTextColour()`	Sets the disabled context menu shortcut text colour.
`SetShortcutDisabledTextAlpha()`	Sets the disabled context menu shortcut text alpha.
`SetSeparatorHeight()`	Sets the context menu separator height.
`SetSeparatorColour()`	Sets the context menu separator colour.
`SetSeparatorAlpha()`	Sets the context menu separator alpha.
`SetSeparatorInsetX()`	Sets the horizontal inset applied to context menu separator lines.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

EchoTextBlockStyle

Text block control style. Wrapping only matters when the text is too wide for the available space. SetFillAvailableWhileWrapping(true) lets the text block use the available row width instead of measuring only its current text.

new EchoTextBlockStyle()

Methods

Style-specific

`SetTextAlign()`	Sets the text block text alignment.
`SetMaxWidth()`	Sets the max width.
`SetWrap()`	Sets the wrap.
`SetFillAvailableWhileWrapping()`	Sets the fill available while wrapping.

Text surface

`SetFont()`	Sets the font.
`SetTextColour()`	Sets the text colour.
`SetTextAlpha()`	Sets text opacity.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledTextAlpha()`	Sets disabled text opacity.

SetFont(font)

Sets the font.

Arguments

font Asset.GMFont

Returns

Struct.EchoTextBlockStyle

SetTextColour(value)

Sets the text colour.

Arguments

value Real

Returns

Struct.EchoTextBlockStyle

SetTextAlpha(value)

Sets text opacity.

Arguments

value Real

Returns

Struct.EchoTextBlockStyle

SetDisabledTextColour(value)

Sets the disabled text colour.

Arguments

value Real

Returns

Struct.EchoTextBlockStyle

SetDisabledTextAlpha(value)

Sets disabled text opacity.

Arguments

value Real

Returns

Struct.EchoTextBlockStyle

SetTextAlign(align)

Sets the text block text alignment.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

Struct.EchoTextBlockStyle

SetMaxWidth(value)

Sets the max width.

Arguments

value Real

Returns

Struct.EchoTextBlockStyle

SetWrap(flag)

Sets the wrap.

Arguments

flag Bool

Returns

Struct.EchoTextBlockStyle

SetFillAvailableWhileWrapping(flag)

Sets the fill available while wrapping.

Arguments

flag Bool

Returns

Struct.EchoTextBlockStyle

EchoLabelStyle

Label style used by controls and panels. Labels can be automatic. In that mode, Echo Chamber decides whether a label should sit to the left of a control, above the control, or be hidden for that layout. This is why the label style includes minimum width, maximum width, and maximum ratio settings.

new EchoLabelStyle()

Methods

Style-specific

`SetGap()`	Sets the gap.
`SetWidth()`	Sets the width.
`SetMinWidth()`	Sets the min width.
`SetMaxWidth()`	Sets the max width.
`SetMaxRatio()`	Sets the max ratio.
`SetPlacement()`	Sets the placement.
`SetAutoMinControlWidth()`	Sets the auto min control width.
`SetLeadingAlign()`	Sets the leading label alignment.
`SetAboveAlign()`	Sets the above label alignment.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Text surface

`SetFont()`	Sets the font.
`SetTextColour()`	Sets the text colour.
`SetTextAlpha()`	Sets text opacity.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledTextAlpha()`	Sets disabled text opacity.

SetFont(font)

Sets the font.

Arguments

font Asset.GMFont

Returns

Struct.EchoLabelStyle

SetTextColour(value)

Sets the text colour.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetTextAlpha(value)

Sets text opacity.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetDisabledTextColour(value)

Sets the disabled text colour.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetDisabledTextAlpha(value)

Sets disabled text opacity.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoLabelStyle

SetGap(value)

Sets the gap.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetWidth(value)

Sets the width.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetMinWidth(value)

Sets the min width.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetMaxWidth(value)

Sets the max width.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetMaxRatio(value)

Sets the max ratio.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetPlacement(placement)

Sets the placement.

Arguments

placement Real

Returns

Struct.EchoLabelStyle

SetAutoMinControlWidth(value)

Sets the auto min control width.

Arguments

value Real

Returns

Struct.EchoLabelStyle

SetLeadingAlign(align)

Sets the leading label alignment.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

Struct.EchoLabelStyle

SetAboveAlign(align)

Sets the above label alignment.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

Struct.EchoLabelStyle

Creates an optional override style for tooltips. Viewport margin keeps the tooltip away from the canvas edge so it doesn't get clipped offscreen.

new EchoTooltipStyle()

Methods

Style-specific

`SetFont()`	Sets the tooltip font.
`SetTextColour()`	Sets the tooltip text colour.
`SetTextAlpha()`	Sets the tooltip text alpha.
`SetMaxWidth()`	Sets the tooltip max width.
`SetAnchorOffsetX()`	Sets the tooltip anchor X offset.
`SetAnchorOffsetY()`	Sets the tooltip anchor Y offset.
`SetViewportMargin()`	Sets all tooltip viewport margins to the same value.
`SetViewportMarginX()`	Sets the left and right tooltip viewport margins.
`SetViewportMarginY()`	Sets the top and bottom tooltip viewport margins.
`SetViewportMarginLeft()`	Sets the left tooltip viewport margin.
`SetViewportMarginTop()`	Sets the top tooltip viewport margin.
`SetViewportMarginRight()`	Sets the right tooltip viewport margin.
`SetViewportMarginBottom()`	Sets the bottom tooltip viewport margin.
`SetViewportMarginLTRB()`	Sets all tooltip viewport margins explicitly.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

EchoToastStyle

Creates an optional override style for toasts. Toasts are short-lived messages shown by the Echo Chamber root. They are useful for "saved", "copied", or "layout restored" style feedback.

new EchoToastStyle()

Methods

Style-specific

`SetFont()`	Sets the toast font.
`SetTextColour()`	Sets the toast text colour.
`SetTextAlpha()`	Sets the toast text alpha.
`SetMaxWidth()`	Sets the toast max width.
`SetViewportMargin()`	Sets all toast viewport margins to the same value.
`SetViewportMarginX()`	Sets the left and right toast viewport margins.
`SetViewportMarginY()`	Sets the top and bottom toast viewport margins.
`SetViewportMarginLeft()`	Sets the left toast viewport margin.
`SetViewportMarginTop()`	Sets the top toast viewport margin.
`SetViewportMarginRight()`	Sets the right toast viewport margin.
`SetViewportMarginBottom()`	Sets the bottom toast viewport margin.
`SetViewportMarginLTRB()`	Sets all toast viewport margins explicitly.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

SetBgColour(value)

Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetBorderColour(value)

Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoToastStyle

SetFont(font)

Sets the toast font.

Arguments

font Asset.GMFont

Returns

Struct.EchoToastStyle

SetTextColour(value)

Sets the toast text colour.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetTextAlpha(value)

Sets the toast text alpha.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetMaxWidth(value)

Sets the toast max width.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMargin(value)

Sets all toast viewport margins to the same value.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMarginX(value)

Sets the left and right toast viewport margins.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMarginY(value)

Sets the top and bottom toast viewport margins.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMarginLeft(value)

Sets the left toast viewport margin.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMarginTop(value)

Sets the top toast viewport margin.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMarginRight(value)

Sets the right toast viewport margin.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMarginBottom(value)

Sets the bottom toast viewport margin.

Arguments

value Real

Returns

Struct.EchoToastStyle

SetViewportMarginLTRB(left, top, right, bottom)

Sets all toast viewport margins explicitly.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoToastStyle

EchoSeparatorStyle

Separator control style. A separator doesn't behave like a button. It's mostly a visual divider, so its style is intentionally small.

new EchoSeparatorStyle()

Methods

Style-specific

`SetLineColour()`	Sets the separator line colour.
`SetLineAlpha()`	Sets the separator line alpha.
`SetDisabledLineColour()`	Sets the disabled separator line colour.
`SetDisabledLineAlpha()`	Sets the disabled separator line alpha.
`SetThickness()`	Sets the separator thickness.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoSeparatorStyle

SetLineColour(value)

Sets the separator line colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoSeparatorStyle

SetLineAlpha(value)

Sets the separator line alpha.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetDisabledLineColour(value)

Sets the disabled separator line colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoSeparatorStyle

SetDisabledLineAlpha(value)

Sets the disabled separator line alpha.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

SetThickness(value)

Sets the separator thickness.

Arguments

value Real

Returns

Struct.EchoSeparatorStyle

Interactive controls

EchoButtonStyle

Button control style.

new EchoButtonStyle()

Methods

Style-specific

`SetFont()`	Sets the button font.
`SetIconGap()`	Sets the gap between button icon and text. This setting matters when the button draws an icon alongside its text.
`SetIconScale()`	Sets the icon scale multiplier. This setting matters when the button draws an icon alongside its text.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Stateful box

`SetBgColour()`	Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.
`SetBorderColour()`	Sets all border corners using the shared fallback-to-top-left rule.
`SetTextColour()`	Sets the text colour.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.
`SetTextAlpha()`	Sets text opacity.
`SetHoverBgColour()`	Sets the hover background colour.
`SetHoverBorderColour()`	Sets the hover border colour.
`SetHoverTextColour()`	Sets the hover text colour.
`SetHoverBgAlpha()`	Sets the hover background alpha.
`SetHoverBorderAlpha()`	Sets the hover border alpha.
`SetHoverTextAlpha()`	Sets the hover text alpha.
`SetPressedMix()`	Sets the pressed mix.
`SetPressedBgColour()`	Sets the pressed background colour.
`SetPressedBorderColour()`	Sets the pressed border colour.
`SetPressedTextColour()`	Sets the pressed text colour.
`SetPressedBgAlpha()`	Sets the pressed background alpha.
`SetPressedBorderAlpha()`	Sets the pressed border alpha.
`SetPressedTextAlpha()`	Sets the pressed text alpha.
`SetDisabledBgColour()`	Sets the disabled background colour.
`SetDisabledBorderColour()`	Sets the disabled border colour.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledBgAlpha()`	Sets the disabled background alpha.
`SetDisabledBorderAlpha()`	Sets the disabled border alpha.
`SetDisabledTextAlpha()`	Sets disabled text opacity.
`SetShape()`	Sets the shape used to draw the box.
`SetCornerRadius()`	Sets the horizontal and vertical corner radius for rounded boxes.

Alignment

`SetTextAlign()`	Sets the text align.
`SetVerticalAlign()`	Sets the vertical align.

SetBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all border corners using the shared fallback-to-top-left rule.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetTextColour(value)

Sets the text colour.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetTextAlpha(value)

Sets text opacity.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetHoverBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetHoverBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetHoverTextColour(value)

Sets the hover text colour.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetHoverBgAlpha(value)

Sets the hover background alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetHoverBorderAlpha(value)

Sets the hover border alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetHoverTextAlpha(value)

Sets the hover text alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPressedMix(value)

Sets the pressed mix.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPressedBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetPressedBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetPressedTextColour(value)

Sets the pressed text colour.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPressedBgAlpha(value)

Sets the pressed background alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPressedBorderAlpha(value)

Sets the pressed border alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPressedTextAlpha(value)

Sets the pressed text alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetDisabledBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetDisabledBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoButtonStyle

SetDisabledTextColour(value)

Sets the disabled text colour.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetDisabledBgAlpha(value)

Sets the disabled background alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetDisabledBorderAlpha(value)

Sets the disabled border alpha.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetDisabledTextAlpha(value)

Sets disabled text opacity.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetShape(shape)

Sets the shape used to draw the box.

Arguments

shape Real Uses the eEchoChamberBoxShape enum.

Returns

Struct.EchoButtonStyle

SetCornerRadius(radius_x, [radius_y])

Sets the horizontal and vertical corner radius for rounded boxes.

Arguments

radius_x Real The non-negative horizontal corner radius.

radius_y optional Real|Undefined The vertical radius, or the horizontal radius when omitted.

Returns

Struct.EchoButtonStyle

SetTextAlign(align)

Sets the text align.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

Struct.EchoButtonStyle

SetVerticalAlign(align)

Sets the vertical align.

Arguments

align Real Takes eEchoChamberAlignVer enum.

Returns

Struct.EchoButtonStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoButtonStyle

SetFont(font)

Sets the button font.

Arguments

font Asset.GMFont

Returns

Struct.EchoButtonStyle

SetIconGap(value)

Sets the gap between button icon and text. This setting matters when the button draws an icon alongside its text.

Arguments

value Real

Returns

Struct.EchoButtonStyle

SetIconScale(value)

Sets the icon scale multiplier. This setting matters when the button draws an icon alongside its text.

Arguments

value Real

Returns

Struct.EchoButtonStyle

EchoColorButtonStyle

Color button control style. The swatch is the little colour preview box shown on the button. Value text is the optional written value, such as an RGB readout.

new EchoColorButtonStyle()

Methods

Style-specific

`SetFont()`	Sets the color-button font.
`SetIconGap()`	Sets the gap between icon and text.
`SetIconScale()`	Sets the icon scale multiplier.
`SetSwatchSize()`	Sets the swatch size.
`SetSwatchGap()`	Sets the gap after the swatch.
`SetValueGap()`	Sets the gap between label and value text.
`SetSwatchBorderColour()`	Sets the swatch border colour.
`SetValueTextColour()`	Sets the value text colour.
`SetValueTextAlpha()`	Sets the value text alpha.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Stateful box

`SetBgColour()`	Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.
`SetBorderColour()`	Sets all border corners using the shared fallback-to-top-left rule.
`SetTextColour()`	Sets the text colour.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.
`SetTextAlpha()`	Sets text opacity.
`SetHoverBgColour()`	Sets the hover background colour.
`SetHoverBorderColour()`	Sets the hover border colour.
`SetHoverTextColour()`	Sets the hover text colour.
`SetHoverBgAlpha()`	Sets the hover background alpha.
`SetHoverBorderAlpha()`	Sets the hover border alpha.
`SetHoverTextAlpha()`	Sets the hover text alpha.
`SetPressedMix()`	Sets the pressed mix.
`SetPressedBgColour()`	Sets the pressed background colour.
`SetPressedBorderColour()`	Sets the pressed border colour.
`SetPressedTextColour()`	Sets the pressed text colour.
`SetPressedBgAlpha()`	Sets the pressed background alpha.
`SetPressedBorderAlpha()`	Sets the pressed border alpha.
`SetPressedTextAlpha()`	Sets the pressed text alpha.
`SetDisabledBgColour()`	Sets the disabled background colour.
`SetDisabledBorderColour()`	Sets the disabled border colour.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledBgAlpha()`	Sets the disabled background alpha.
`SetDisabledBorderAlpha()`	Sets the disabled border alpha.
`SetDisabledTextAlpha()`	Sets disabled text opacity.
`SetShape()`	Sets the shape used to draw the box.
`SetCornerRadius()`	Sets the horizontal and vertical corner radius for rounded boxes.

Alignment

`SetTextAlign()`	Sets the text align.
`SetVerticalAlign()`	Sets the vertical align.

SetBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all border corners using the shared fallback-to-top-left rule.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetTextColour(value)

Sets the text colour.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetTextAlpha(value)

Sets text opacity.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetHoverBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetHoverBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetHoverTextColour(value)

Sets the hover text colour.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetHoverBgAlpha(value)

Sets the hover background alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetHoverBorderAlpha(value)

Sets the hover border alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetHoverTextAlpha(value)

Sets the hover text alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPressedMix(value)

Sets the pressed mix.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPressedBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetPressedBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetPressedTextColour(value)

Sets the pressed text colour.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPressedBgAlpha(value)

Sets the pressed background alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPressedBorderAlpha(value)

Sets the pressed border alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPressedTextAlpha(value)

Sets the pressed text alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetDisabledBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetDisabledBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoColorButtonStyle

SetDisabledTextColour(value)

Sets the disabled text colour.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetDisabledBgAlpha(value)

Sets the disabled background alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetDisabledBorderAlpha(value)

Sets the disabled border alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetDisabledTextAlpha(value)

Sets disabled text opacity.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetShape(shape)

Sets the shape used to draw the box.

Arguments

shape Real Uses the eEchoChamberBoxShape enum.

Returns

Struct.EchoColorButtonStyle

SetCornerRadius(radius_x, [radius_y])

Sets the horizontal and vertical corner radius for rounded boxes.

Arguments

radius_x Real The non-negative horizontal corner radius.

radius_y optional Real|Undefined The vertical radius, or the horizontal radius when omitted.

Returns

Struct.EchoColorButtonStyle

SetTextAlign(align)

Sets the text align.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

Struct.EchoColorButtonStyle

SetVerticalAlign(align)

Sets the vertical align.

Arguments

align Real Takes eEchoChamberAlignVer enum.

Returns

Struct.EchoColorButtonStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoColorButtonStyle

SetFont(font)

Sets the color-button font.

Arguments

font Asset.GMFont

Returns

Struct.EchoColorButtonStyle

SetIconGap(value)

Sets the gap between icon and text.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetIconScale(value)

Sets the icon scale multiplier.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetSwatchSize(value)

Sets the swatch size.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetSwatchGap(value)

Sets the gap after the swatch.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetValueGap(value)

Sets the gap between label and value text.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

SetSwatchBorderColour(value)

Sets the swatch border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoColorButtonStyle

SetValueTextColour(value)

Sets the value text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoColorButtonStyle

SetValueTextAlpha(value)

Sets the value text alpha.

Arguments

value Real

Returns

Struct.EchoColorButtonStyle

EchoToggleStyle

Toggles control style. The "on" colour is used when the toggle value is true. The "off" colour is used when the toggle value is false.

new EchoToggleStyle()

Methods

Style-specific

`SetFont()`	Sets the toggle font.
`SetTextAlign()`	Sets the toggle horizontal text alignment.
`SetVerticalAlign()`	Sets the toggle vertical content alignment.
`SetBoxSize()`	Sets the checkbox square size.
`SetBoxGap()`	Sets the gap between checkbox and text.
`SetBoxOnColour()`	Sets the on-box fill colour.
`SetBoxOffColour()`	Sets the off-box fill colour.
`SetBoxBorderColour()`	Sets the box border colour.
`SetBoxOnAlpha()`	Sets the on-box alpha.
`SetBoxOffAlpha()`	Sets the off-box alpha.
`SetBoxBorderAlpha()`	Sets the box border alpha.
`SetHoverBoxBorderColour()`	Sets the hover box border colour.
`SetHoverBoxBorderAlpha()`	Sets the hover box border alpha.
`SetPressedBoxBorderColour()`	Sets the pressed box border colour.
`SetPressedBoxBorderAlpha()`	Sets the pressed box border alpha.
`SetHoverBoxOnColour()`	Sets the hover on-box colour.
`SetHoverBoxOnAlpha()`	Sets the hover on-box alpha.
`SetPressedBoxOnColour()`	Sets the pressed on-box colour.
`SetPressedBoxOnAlpha()`	Sets the pressed on-box alpha.
`SetHoverBoxOffColour()`	Sets the hover off-box colour.
`SetHoverBoxOffAlpha()`	Sets the hover off-box alpha.
`SetPressedBoxOffColour()`	Sets the pressed off-box colour.
`SetPressedBoxOffAlpha()`	Sets the pressed off-box alpha.
`SetDisabledBoxOnColour()`	Sets the disabled on-box colour.
`SetDisabledBoxOnAlpha()`	Sets the disabled on-box alpha.
`SetDisabledBoxOffColour()`	Sets the disabled off-box colour.
`SetDisabledBoxOffAlpha()`	Sets the disabled off-box alpha.
`SetDisabledBoxBorderColour()`	Sets the disabled box border colour.
`SetDisabledBoxBorderAlpha()`	Sets the disabled box border alpha.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Stateful box

`SetBgColour()`	Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.
`SetBorderColour()`	Sets all border corners using the shared fallback-to-top-left rule.
`SetTextColour()`	Sets the text colour.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.
`SetTextAlpha()`	Sets text opacity.
`SetHoverBgColour()`	Sets the hover background colour.
`SetHoverBorderColour()`	Sets the hover border colour.
`SetHoverTextColour()`	Sets the hover text colour.
`SetHoverBgAlpha()`	Sets the hover background alpha.
`SetHoverBorderAlpha()`	Sets the hover border alpha.
`SetHoverTextAlpha()`	Sets the hover text alpha.
`SetPressedMix()`	Sets the pressed mix.
`SetPressedBgColour()`	Sets the pressed background colour.
`SetPressedBorderColour()`	Sets the pressed border colour.
`SetPressedTextColour()`	Sets the pressed text colour.
`SetPressedBgAlpha()`	Sets the pressed background alpha.
`SetPressedBorderAlpha()`	Sets the pressed border alpha.
`SetPressedTextAlpha()`	Sets the pressed text alpha.
`SetDisabledBgColour()`	Sets the disabled background colour.
`SetDisabledBorderColour()`	Sets the disabled border colour.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledBgAlpha()`	Sets the disabled background alpha.
`SetDisabledBorderAlpha()`	Sets the disabled border alpha.
`SetDisabledTextAlpha()`	Sets disabled text opacity.
`SetShape()`	Sets the shape used to draw the box.
`SetCornerRadius()`	Sets the horizontal and vertical corner radius for rounded boxes.

SetBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all border corners using the shared fallback-to-top-left rule.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetTextColour(value)

Sets the text colour.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetTextAlpha(value)

Sets text opacity.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetHoverBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetHoverBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetHoverTextColour(value)

Sets the hover text colour.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetHoverBgAlpha(value)

Sets the hover background alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetHoverBorderAlpha(value)

Sets the hover border alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetHoverTextAlpha(value)

Sets the hover text alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedMix(value)

Sets the pressed mix.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetPressedBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetPressedTextColour(value)

Sets the pressed text colour.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedBgAlpha(value)

Sets the pressed background alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedBorderAlpha(value)

Sets the pressed border alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedTextAlpha(value)

Sets the pressed text alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetDisabledBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetDisabledBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoToggleStyle

SetDisabledTextColour(value)

Sets the disabled text colour.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetDisabledBgAlpha(value)

Sets the disabled background alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetDisabledBorderAlpha(value)

Sets the disabled border alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetDisabledTextAlpha(value)

Sets disabled text opacity.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetShape(shape)

Sets the shape used to draw the box.

Arguments

shape Real Uses the eEchoChamberBoxShape enum.

Returns

Struct.EchoToggleStyle

SetCornerRadius(radius_x, [radius_y])

Sets the horizontal and vertical corner radius for rounded boxes.

Arguments

radius_x Real The non-negative horizontal corner radius.

radius_y optional Real|Undefined The vertical radius, or the horizontal radius when omitted.

Returns

Struct.EchoToggleStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoToggleStyle

SetFont(font)

Sets the toggle font.

Arguments

font Asset.GMFont

Returns

Struct.EchoToggleStyle

SetTextAlign(align)

Sets the toggle horizontal text alignment.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

Struct.EchoToggleStyle

SetVerticalAlign(align)

Sets the toggle vertical content alignment.

Arguments

align Real Takes eEchoChamberAlignVer enum.

Returns

Struct.EchoToggleStyle

SetBoxSize(value)

Sets the checkbox square size.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetBoxGap(value)

Sets the gap between checkbox and text.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetBoxOnColour(value)

Sets the on-box fill colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetBoxOffColour(value)

Sets the off-box fill colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetBoxBorderColour(value)

Sets the box border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetBoxOnAlpha(value)

Sets the on-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetBoxOffAlpha(value)

Sets the off-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetBoxBorderAlpha(value)

Sets the box border alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetHoverBoxBorderColour(value)

Sets the hover box border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetHoverBoxBorderAlpha(value)

Sets the hover box border alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedBoxBorderColour(value)

Sets the pressed box border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetPressedBoxBorderAlpha(value)

Sets the pressed box border alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetHoverBoxOnColour(value)

Sets the hover on-box colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetHoverBoxOnAlpha(value)

Sets the hover on-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedBoxOnColour(value)

Sets the pressed on-box colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetPressedBoxOnAlpha(value)

Sets the pressed on-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetHoverBoxOffColour(value)

Sets the hover off-box colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetHoverBoxOffAlpha(value)

Sets the hover off-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetPressedBoxOffColour(value)

Sets the pressed off-box colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetPressedBoxOffAlpha(value)

Sets the pressed off-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetDisabledBoxOnColour(value)

Sets the disabled on-box colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetDisabledBoxOnAlpha(value)

Sets the disabled on-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetDisabledBoxOffColour(value)

Sets the disabled off-box colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetDisabledBoxOffAlpha(value)

Sets the disabled off-box alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

SetDisabledBoxBorderColour(value)

Sets the disabled box border colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoToggleStyle

SetDisabledBoxBorderAlpha(value)

Sets the disabled box border alpha.

Arguments

value Real

Returns

Struct.EchoToggleStyle

Creates an optional override style for dropdowns. The overlay is the floating options list that appears when the dropdown opens. Search styles only matter when the dropdown is configured with a searchable overlay.

new EchoDropdownStyle()

Methods

Style-specific

`SetOpenMix()`	Sets the open state blend amount.
`SetFont()`	Sets the dropdown font.
`SetOverlayMaxHeight()`	Sets the maximum overlay height before scrolling.
`SetOverlayBgColour()`	Sets the overlay background colour.
`SetOverlayBorderColour()`	Sets the overlay border colour.
`SetOverlayBgAlpha()`	Sets the overlay background alpha.
`SetOverlayBorderAlpha()`	Sets the overlay border alpha.
`SetOverlayRowBgColour()`	Sets the overlay row background colour.
`SetOverlayRowHoverColour()`	Sets the overlay row hover colour.
`SetOverlayRowSelectedColour()`	Sets the overlay row selected colour.
`SetOverlayRowPressedColour()`	Sets the overlay row pressed colour.
`SetOverlayRowBgAlpha()`	Sets the overlay row background alpha.
`SetOverlayRowHoverAlpha()`	Sets the overlay row hover alpha.
`SetOverlayRowSelectedAlpha()`	Sets the overlay row selected alpha.
`SetOverlayRowPressedAlpha()`	Sets the overlay row pressed alpha.
`SetOverlayTextColour()`	Sets the overlay text colour.
`SetOverlayHoverTextColour()`	Sets the overlay hover text colour.
`SetOverlaySelectedTextColour()`	Sets the overlay selected text colour.
`SetOverlayPressedTextColour()`	Sets the overlay pressed text colour.
`SetOverlayTextAlpha()`	Sets the overlay text alpha.
`SetOverlayHoverTextAlpha()`	Sets the overlay hover text alpha.
`SetOverlaySelectedTextAlpha()`	Sets the overlay selected text alpha.
`SetOverlayPressedTextAlpha()`	Sets the overlay pressed text alpha.
`SetOverlaySearchBgColour()`	Sets the overlay search background colour.
`SetOverlaySearchHoverBgColour()`	Sets the overlay search hover background colour.
`SetOverlaySearchBorderColour()`	Sets the overlay search border colour.
`SetOverlaySearchBgAlpha()`	Sets the overlay search background alpha.
`SetOverlaySearchHoverBgAlpha()`	Sets the overlay search hover background alpha.
`SetOverlaySearchBorderAlpha()`	Sets the overlay search border alpha.
`SetOverlaySearchTextColour()`	Sets the overlay search text colour.
`SetOverlaySearchPlaceholderColour()`	Sets the overlay search placeholder colour.
`SetOverlaySearchTextAlpha()`	Sets the overlay search text alpha.
`SetOverlaySearchPlaceholderAlpha()`	Sets the overlay search placeholder alpha.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Stateful box

`SetBgColour()`	Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.
`SetBorderColour()`	Sets all border corners using the shared fallback-to-top-left rule.
`SetTextColour()`	Sets the text colour.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.
`SetTextAlpha()`	Sets text opacity.
`SetHoverBgColour()`	Sets the hover background colour.
`SetHoverBorderColour()`	Sets the hover border colour.
`SetHoverTextColour()`	Sets the hover text colour.
`SetHoverBgAlpha()`	Sets the hover background alpha.
`SetHoverBorderAlpha()`	Sets the hover border alpha.
`SetHoverTextAlpha()`	Sets the hover text alpha.
`SetPressedMix()`	Sets the pressed mix.
`SetPressedBgColour()`	Sets the pressed background colour.
`SetPressedBorderColour()`	Sets the pressed border colour.
`SetPressedTextColour()`	Sets the pressed text colour.
`SetPressedBgAlpha()`	Sets the pressed background alpha.
`SetPressedBorderAlpha()`	Sets the pressed border alpha.
`SetPressedTextAlpha()`	Sets the pressed text alpha.
`SetDisabledBgColour()`	Sets the disabled background colour.
`SetDisabledBorderColour()`	Sets the disabled border colour.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledBgAlpha()`	Sets the disabled background alpha.
`SetDisabledBorderAlpha()`	Sets the disabled border alpha.
`SetDisabledTextAlpha()`	Sets disabled text opacity.
`SetShape()`	Sets the shape used to draw the box.
`SetCornerRadius()`	Sets the horizontal and vertical corner radius for rounded boxes.

Alignment

`SetTextAlign()`	Sets the text align.
`SetVerticalAlign()`	Sets the vertical align.

SetOverlayTextColour(value)

Sets the overlay text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoDropdownStyle

SetOverlayTextAlpha(value)

Sets the overlay text alpha.

Arguments

value Real

Returns

Struct.EchoDropdownStyle

EchoTextInputStyle

Creates an optional override style for text inputs. Active means the input currently has keyboard focus. Readonly means the user can see the value but can't edit it. Invalid is used when validation reports a problem.

new EchoTextInputStyle()

Methods

Style-specific

`SetActiveBgColour()`	Sets the active background colour.
`SetActiveBorderColour()`	Sets the active border colour.
`SetActiveTextColour()`	Sets the active text colour.
`SetActiveBgAlpha()`	Sets the active background alpha.
`SetActiveBorderAlpha()`	Sets the active border alpha.
`SetActiveTextAlpha()`	Sets the active text alpha.
`SetReadonlyBgColour()`	Sets the readonly background colour.
`SetReadonlyBorderColour()`	Sets the readonly border colour.
`SetReadonlyTextColour()`	Sets the readonly text colour.
`SetReadonlyBgAlpha()`	Sets the readonly background alpha.
`SetReadonlyBorderAlpha()`	Sets the readonly border alpha.
`SetReadonlyTextAlpha()`	Sets the readonly text alpha.
`SetInvalidBgColour()`	Sets the invalid background colour.
`SetInvalidBorderColour()`	Sets the invalid border colour.
`SetInvalidTextColour()`	Sets the invalid text colour.
`SetInvalidBgAlpha()`	Sets the invalid background alpha.
`SetInvalidBorderAlpha()`	Sets the invalid border alpha.
`SetInvalidTextAlpha()`	Sets the invalid text alpha.
`SetSelectionBgColour()`	Sets the selection background colour.
`SetSelectionTextColour()`	Sets the selection text colour.
`SetInactiveSelectionBgColour()`	Sets the inactive selection background colour.
`SetInactiveSelectionTextColour()`	Sets the inactive selection text colour.
`SetSelectionBgAlpha()`	Sets the selection background alpha.
`SetSelectionTextAlpha()`	Sets the selection text alpha.
`SetInactiveSelectionBgAlpha()`	Sets the inactive selection background alpha.
`SetInactiveSelectionTextAlpha()`	Sets the inactive selection text alpha.
`SetCaretColour()`	Sets the caret colour.
`SetCaretAlpha()`	Sets the caret alpha.
`SetCaretChar()`	Sets the caret character.
`SetCaretBlinkMs()`	Sets the caret blink time in milliseconds.
`SetCaretWidth()`	Sets the caret width.
`SetCaretHeight()`	Sets the caret height.
`SetCaretInsetX()`	Sets the horizontal caret inset.
`SetCaretInsetY()`	Sets the vertical caret inset.
`SetPlaceholderColour()`	Sets the placeholder colour.
`SetPlaceholderAlpha()`	Sets the placeholder alpha.
`SetValidationGap()`	Sets the validation message gap.
`SetValidationAlpha()`	Sets the validation alpha.
`SetValidationErrorColour()`	Sets the validation error colour.
`SetValidationWarnColour()`	Sets the validation warning colour.
`SetValidationInfoColour()`	Sets the validation info colour.
`SetValidationFont()`	Sets the validation font.
`SetTextBoxExpandSprite()`	Sets the text box expand-button sprite.
`SetTextBoxGripSprite()`	Sets the text box resize-grip sprite.
`SetTextBoxGripSize()`	Sets the text box resize-grip size.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Stateful box

`SetFont()`	Sets the font.
`SetBgColour()`	Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.
`SetBorderColour()`	Sets all border corners using the shared fallback-to-top-left rule.
`SetTextColour()`	Sets the text colour.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.
`SetTextAlpha()`	Sets text opacity.
`SetHoverBgColour()`	Sets the hover background colour.
`SetHoverBorderColour()`	Sets the hover border colour.
`SetHoverTextColour()`	Sets the hover text colour.
`SetHoverBgAlpha()`	Sets the hover background alpha.
`SetHoverBorderAlpha()`	Sets the hover border alpha.
`SetHoverTextAlpha()`	Sets the hover text alpha.
`SetPressedMix()`	Sets the pressed mix.
`SetPressedBgColour()`	Sets the pressed background colour.
`SetPressedBorderColour()`	Sets the pressed border colour.
`SetPressedTextColour()`	Sets the pressed text colour.
`SetPressedBgAlpha()`	Sets the pressed background alpha.
`SetPressedBorderAlpha()`	Sets the pressed border alpha.
`SetPressedTextAlpha()`	Sets the pressed text alpha.
`SetDisabledBgColour()`	Sets the disabled background colour.
`SetDisabledBorderColour()`	Sets the disabled border colour.
`SetDisabledTextColour()`	Sets the disabled text colour.
`SetDisabledBgAlpha()`	Sets the disabled background alpha.
`SetDisabledBorderAlpha()`	Sets the disabled border alpha.
`SetDisabledTextAlpha()`	Sets disabled text opacity.
`SetShape()`	Sets the shape used to draw the box.
`SetCornerRadius()`	Sets the horizontal and vertical corner radius for rounded boxes.

Alignment

`SetTextAlign()`	Sets the text align.
`SetVerticalAlign()`	Sets the vertical align.

SetFont(font)

Sets the font.

Arguments

font Asset.GMFont

Returns

Struct.EchoTextInputStyle

SetBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all background corners. Every omitted corner uses _top_left, and every call overwrites all four stored corners.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets all border corners using the shared fallback-to-top-left rule.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetTextColour(value)

Sets the text colour.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetTextAlpha(value)

Sets text opacity.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetHoverBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetHoverBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the hover border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetHoverTextColour(value)

Sets the hover text colour.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetHoverBgAlpha(value)

Sets the hover background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetHoverBorderAlpha(value)

Sets the hover border alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetHoverTextAlpha(value)

Sets the hover text alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPressedMix(value)

Sets the pressed mix.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPressedBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetPressedBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the pressed border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetPressedTextColour(value)

Sets the pressed text colour.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPressedBgAlpha(value)

Sets the pressed background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPressedBorderAlpha(value)

Sets the pressed border alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPressedTextAlpha(value)

Sets the pressed text alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetDisabledBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetDisabledBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the disabled border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetDisabledTextColour(value)

Sets the disabled text colour.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetDisabledBgAlpha(value)

Sets the disabled background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetDisabledBorderAlpha(value)

Sets the disabled border alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetDisabledTextAlpha(value)

Sets disabled text opacity.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetShape(shape)

Sets the shape used to draw the box.

Arguments

shape Real Uses the eEchoChamberBoxShape enum.

Returns

Struct.EchoTextInputStyle

SetCornerRadius(radius_x, [radius_y])

Sets the horizontal and vertical corner radius for rounded boxes.

Arguments

radius_x Real The non-negative horizontal corner radius.

radius_y optional Real|Undefined The vertical radius, or the horizontal radius when omitted.

Returns

Struct.EchoTextInputStyle

SetTextAlign(align)

Sets the text align.

Arguments

align Real Takes eEchoChamberAlignHor enum.

Returns

Struct.EchoTextInputStyle

SetVerticalAlign(align)

Sets the vertical align.

Arguments

align Real Takes eEchoChamberAlignVer enum.

Returns

Struct.EchoTextInputStyle

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

Struct.EchoTextInputStyle

SetActiveBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the active background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetActiveBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the active border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetActiveTextColour(value)

Sets the active text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetActiveBgAlpha(value)

Sets the active background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetActiveBorderAlpha(value)

Sets the active border alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetActiveTextAlpha(value)

Sets the active text alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetReadonlyBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the readonly background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetReadonlyBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the readonly border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetReadonlyTextColour(value)

Sets the readonly text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetReadonlyBgAlpha(value)

Sets the readonly background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetReadonlyBorderAlpha(value)

Sets the readonly border alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetReadonlyTextAlpha(value)

Sets the readonly text alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetInvalidBgColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the invalid background colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetInvalidBorderColour(top_left, [top_right], [bottom_right], [bottom_left])

Sets the invalid border colour.

Arguments

top_left Colour The top-left colour and fallback for omitted corners.

top_right optional Colour|Undefined The optional top-right colour.

bottom_right optional Colour|Undefined The optional bottom-right colour.

bottom_left optional Colour|Undefined The optional bottom-left colour.

Returns

Struct.EchoTextInputStyle

SetInvalidTextColour(value)

Sets the invalid text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetInvalidBgAlpha(value)

Sets the invalid background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetInvalidBorderAlpha(value)

Sets the invalid border alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetInvalidTextAlpha(value)

Sets the invalid text alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetSelectionBgColour(value)

Sets the selection background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetSelectionTextColour(value)

Sets the selection text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetInactiveSelectionBgColour(value)

Sets the inactive selection background colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetInactiveSelectionTextColour(value)

Sets the inactive selection text colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetSelectionBgAlpha(value)

Sets the selection background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetSelectionTextAlpha(value)

Sets the selection text alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetInactiveSelectionBgAlpha(value)

Sets the inactive selection background alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetInactiveSelectionTextAlpha(value)

Sets the inactive selection text alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetCaretColour(value)

Sets the caret colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetCaretAlpha(value)

Sets the caret alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetCaretChar(value)

Sets the caret character.

Arguments

value String

Returns

Struct.EchoTextInputStyle

SetCaretBlinkMs(value)

Sets the caret blink time in milliseconds.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetCaretWidth(value)

Sets the caret width.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetCaretHeight(value)

Sets the caret height.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetCaretInsetX(value)

Sets the horizontal caret inset.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetCaretInsetY(value)

Sets the vertical caret inset.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetPlaceholderColour(value)

Sets the placeholder colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetPlaceholderAlpha(value)

Sets the placeholder alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetValidationGap(value)

Sets the validation message gap.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetValidationAlpha(value)

Sets the validation alpha.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

SetValidationErrorColour(value)

Sets the validation error colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetValidationWarnColour(value)

Sets the validation warning colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetValidationInfoColour(value)

Sets the validation info colour.

Arguments

value Real|Constant.Colour

Returns

Struct.EchoTextInputStyle

SetValidationFont(font)

Sets the validation font.

Arguments

font Asset.GMFont

Returns

Struct.EchoTextInputStyle

SetTextBoxExpandSprite(sprite)

Sets the text box expand-button sprite.

Arguments

sprite Real

Returns

Struct.EchoTextInputStyle

SetTextBoxGripSprite(sprite)

Sets the text box resize-grip sprite.

Arguments

sprite Real

Returns

Struct.EchoTextInputStyle

SetTextBoxGripSize(value)

Sets the text box resize-grip size.

Arguments

value Real

Returns

Struct.EchoTextInputStyle

EchoTextBoxOverlayStyle

Creates an optional override style for the text box editor overlay. The dim colour is drawn behind the editor overlay. It helps the editor feel separate from the rest of the debug UI while the user is editing a longer text value.

new EchoTextBoxOverlayStyle()

Methods

Style-specific

`SetDimColour()`	Sets the dim backdrop colour.
`SetDimAlpha()`	Sets the dim backdrop alpha.
`SetViewportMargin()`	Sets the viewport edge margin used when sizing and clamping the editor overlay.
`SetMinWidth()`	Sets the minimum editor overlay width.
`SetMaxWidth()`	Sets the maximum editor overlay width.
`SetMinHeight()`	Sets the minimum editor overlay height.
`SetMaxHeight()`	Sets the maximum editor overlay height.
`SetGap()`	Sets the gap between editor overlay sections.
`SetRowMinHeight()`	Sets the minimum top and bottom row height.
`SetButtonWidth()`	Sets the editor overlay button width.
`SetButtonBgColour()`	Sets the editor overlay button background colour.
`SetButtonHoverBgColour()`	Sets the editor overlay button hover background colour.
`SetButtonBorderColour()`	Sets the editor overlay button border colour.
`SetButtonBgAlpha()`	Sets the editor overlay button background alpha.
`SetButtonBorderAlpha()`	Sets the editor overlay button border alpha.
`SetButtonTextColour()`	Sets the editor overlay button text colour.
`SetButtonTextAlpha()`	Sets the editor overlay button text alpha.
`SetButtonCancelInsetX()`	Sets the cancel button text inset.
`SetButtonDoneInsetX()`	Sets the done button text inset.
`SetTitleFont()`	Sets the editor overlay title font.
`SetTitleTextColour()`	Sets the editor overlay title text colour.
`SetTitleTextAlpha()`	Sets the editor overlay title text alpha.
`SetEditorBgColour()`	Sets the editor panel background colour.
`SetEditorBorderColour()`	Sets the editor panel border colour.
`SetEditorBgAlpha()`	Sets the editor panel background alpha.
`SetEditorBorderAlpha()`	Sets the editor panel border alpha.
`SetEditorInnerPadding()`	Sets the editor panel inner padding.
`SetEditorScrollbarExtraWidth()`	Sets the extra width reserved beside the editor viewport for scrollbar spacing.

Padding

`SetPadding()`	Sets the padding.
`SetPaddingX()`	Sets horizontal padding.
`SetPaddingY()`	Sets vertical padding.
`SetPaddingLeft()`	Sets the padding left.
`SetPaddingTop()`	Sets the padding top.
`SetPaddingRight()`	Sets the padding right.
`SetPaddingBottom()`	Sets the padding bottom.
`SetPaddingLTRB()`	Sets left, top, right, and bottom padding.

Frame

`SetBgColour()`	Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBorderColour()`	Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.
`SetBgAlpha()`	Sets background opacity.
`SetBorderAlpha()`	Sets border opacity.

SetBgColour(value)

Sets the background colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

SetBorderColour(value)

Sets the border colour. Frame styles use one colour for the entire surface, unlike stateful box styles which support four corner colours.

Arguments

value Real

Returns

SetBgAlpha(value)

Sets background opacity.

Arguments

value Real

Returns

SetBorderAlpha(value)

Sets border opacity.

Arguments

value Real

Returns

SetPadding(value)

Sets the padding.

Arguments

value Real

Returns

SetPaddingX(value)

Sets horizontal padding.

Arguments

value Real

Returns

SetPaddingY(value)

Sets vertical padding.

Arguments

value Real

Returns

SetPaddingLeft(value)

Sets the padding left.

Arguments

value Real

Returns

SetPaddingTop(value)

Sets the padding top.

Arguments

value Real

Returns

SetPaddingRight(value)

Sets the padding right.

Arguments

value Real

Returns

SetPaddingBottom(value)

Sets the padding bottom.

Arguments

value Real

Returns

SetPaddingLTRB(left, top, right, bottom)

Sets left, top, right, and bottom padding.

Arguments

left Real

top Real

right Real

bottom Real

Returns

SetDimColour(value)

Sets the dim backdrop colour.

Arguments

value Real|Constant.Colour

Returns

SetDimAlpha(value)

Sets the dim backdrop alpha.

Arguments

value Real

Returns

SetViewportMargin(value)

Sets the viewport edge margin used when sizing and clamping the editor overlay.

Arguments

value Real

Returns

SetMinWidth(value)

Sets the minimum editor overlay width.

Arguments

value Real

Returns

SetMaxWidth(value)

Sets the maximum editor overlay width.

Arguments

value Real

Returns

SetMinHeight(value)

Sets the minimum editor overlay height.

Arguments

value Real

Returns

SetMaxHeight(value)

Sets the maximum editor overlay height.

Arguments

value Real

Returns

SetGap(value)

Sets the gap between editor overlay sections.

Arguments

value Real

Returns

SetRowMinHeight(value)

Sets the minimum top and bottom row height.

Arguments

value Real

Returns

SetButtonWidth(value)

Sets the editor overlay button width.

Arguments

value Real

Returns

SetButtonBgColour(value)

Sets the editor overlay button background colour.

Arguments

value Real|Constant.Colour

Returns

SetButtonHoverBgColour(value)

Sets the editor overlay button hover background colour.

Arguments

value Real|Constant.Colour

Returns

SetButtonBorderColour(value)

Sets the editor overlay button border colour.

Arguments

value Real|Constant.Colour

Returns

SetButtonBgAlpha(value)

Sets the editor overlay button background alpha.

Arguments

value Real

Returns

SetButtonBorderAlpha(value)

Sets the editor overlay button border alpha.

Arguments

value Real

Returns

SetButtonTextColour(value)

Sets the editor overlay button text colour.

Arguments

value Real|Constant.Colour

Returns

SetButtonTextAlpha(value)

Sets the editor overlay button text alpha.

Arguments

value Real

Returns

SetButtonCancelInsetX(value)

Sets the cancel button text inset.

Arguments

value Real

Returns

SetButtonDoneInsetX(value)

Sets the done button text inset.

Arguments

value Real

Returns

SetTitleFont(font)

Sets the editor overlay title font.

Arguments

font Asset.GMFont

Returns

SetTitleTextColour(value)

Sets the editor overlay title text colour.

Arguments

value Real|Constant.Colour

Returns

SetTitleTextAlpha(value)

Sets the editor overlay title text alpha.

Arguments

value Real

Returns

SetEditorBgColour(value)

Sets the editor panel background colour.

Arguments

value Real|Constant.Colour

Returns

SetEditorBorderColour(value)

Sets the editor panel border colour.

Arguments

value Real|Constant.Colour

Returns

SetEditorBgAlpha(value)

Sets the editor panel background alpha.

Arguments

value Real

Returns

SetEditorBorderAlpha(value)

Sets the editor panel border alpha.

Arguments

value Real

Returns

SetEditorInnerPadding(value)

Sets the editor panel inner padding.

Arguments

value Real

Returns

SetEditorScrollbarExtraWidth(value)

Sets the extra width reserved beside the editor viewport for scrollbar spacing.

Arguments

value Real

Returns