CustomControlPanelComponent QML Type

Base type for user-defined property editors in the control panel. More...

• List of all members, including inherited members

Properties

• backendObject : var
• backendProperty : var
• currentZone : string
• isZoned : bool
• propertyName : string
• setterFunction : string

Methods

• setValue(value)

Detailed Description

All custom property UI components must inherit from this base type. It provides the standard interface that the simulation control panel uses to supply backend context and zone information. Subclasses can call the setValue() function to write back to the backend.

The properties backendObject, backendProperty, propertyName, setterFunction, isZoned, and currentZone are populated automatically by the control panel when the component is loaded.

Usage

import QtInterfaceFramework.ControlPanelHelper

CustomControlPanelComponent {
    id: myEditor
    // backendObject, propertyName, setterFunction, etc.
    // are set automatically by the control panel.

    Slider {
        value: myEditor.backendProperty
        onMoved: myEditor.setValue(value)
    }
}

Property Documentation

backendObject : var

This property holds a reference to the backend object that owns the property being edited.

backendProperty : var

This property holds the current value of the property being edited. Bind the editor's input control to this to reflect the backend state.

currentZone : string

This property holds the currently selected zone identifier.

isZoned : bool

This property holds whether the property belongs to a zoned interface. When true, setValue() passes currentZone as an additional argument.

propertyName : string

This property holds the name of the property being edited.

setterFunction : string

This property holds the name of the setter function on the backend object used by setValue() to write values back.

Method Documentation

setValue(value)

Writes value back to the backend by calling the function named in setterFunction. When isZoned is true, the currentZone is passed as a second argument.