Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutEditorStateRef

Represents the current state of the Layout Editor in order to visualize it properly.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • This constructor is an implementation detail. Do not use this.

    Parameters

    • ptr: number

    Returns LayoutEditorStateRef

Properties

ptr

ptr: number

Methods

buttons

  • buttons(): number

  • Returns a bitfield corresponding to which buttons are active.

    The bits are as follows:

    • 0x04 - Can remove the current component
    • 0x02 - Can move the current component up
    • 0x01 - Can move the current component down

    Returns number

componentLen

  • componentLen(): number

  • Returns the number of components in the layout.

    Returns number

componentText

  • componentText(index: number): string

  • Returns the name of the component at the specified index.

    Parameters

    • index: number

    Returns string

fieldLen

  • fieldLen(componentSettings: boolean): number

  • Returns the number of fields in the layout's settings.

    Set component_settings to true to use the selected component's settings instead.

    Parameters

    • componentSettings: boolean

    Returns number

fieldText

  • fieldText(componentSettings: boolean, index: number): string

  • Returns the name of the layout's setting at the specified index.

    Set component_settings to true to use the selected component's settings instead.

    Parameters

    • componentSettings: boolean
    • index: number

    Returns string

fieldValue

  • Returns the value of the layout's setting at the specified index.

    Set component_settings to true to use the selected component's settings instead.

    Parameters

    • componentSettings: boolean
    • index: number

    Returns SettingValueRef

selectedComponent

  • selectedComponent(): number

  • Returns the index of the currently selected component.

    Returns number

Generated using TypeDoc