Options
All
  • Public
  • Public/Protected
  • All
V1.7
  • V1.6
  • V1.7
Menu

Class EclipseToggleParams

Eclipse toggle parameters for creating sliders

Hierarchy

  • EclipseToggleParams

Index

Constructors

Properties

Constructors

constructor

Properties

absoluteIconPath

absoluteIconPath: boolean

If the icon path is an absolute path (default false).

height

height: number

Height of the Eclipse toggle, (default 0 = default toggle height).

iconPath

iconPath: string

Eclipse toggle icon path used in kRadialWithIcon.

iconScale

iconScale: number

Icon scale (default 1.0f).

iconType

iconType: SystemIcon

The type of SystemIcon to be used for the eclipse toggle

iconTypeOffState

iconTypeOffState: SystemIcon

Optional SystemIcon to be displayed in the toggle off state

l10nKey

l10nKey: string

The localization key for the element label.

l10nParams

l10nParams: {}

The optional localization parameters for the element label.

Type declaration

labelDisplayMode

labelDisplayMode: LabelDisplayMode

The display mode of the label, used in kIcon.

labelSide

labelSide: Side

What side the label text sits on, used in kIcon.

labelText

labelText: string

The toggle label text

showBackground

showBackground: boolean

Whether to show the toggle background (OFF outline or solid ON states)

statusText1

statusText1: string

The left status label of the kSwitchWithLabel ("OFF")

statusText2

statusText2: string

The right status label of the kSwitchWithLabel ("ON")

type

type: EclipseToggleType

Type of eclipse toggle.

Generated using TypeDoc