MotorXP-AFM Scripting API
    Preparing search index...

    Interface ValueComboBox<T>

    Combo box with a currentValue; a d.ts-only type with no corresponding script object.

    interface ValueComboBox<T> {
        count: number;
        currentData: any;
        currentIndex: number;
        currentIndexChanged: SignalConnector<string>;
        currentText: string;
        currentValue: T;
        currentValueChanged: SignalConnector<T>;
        enabled: boolean;
        maximumHeight: number;
        maximumWidth: number;
        minimumHeight: number;
        minimumWidth: number;
        objectName: string;
        styleSheet: string;
        toolTip: string;
        visible: boolean;
        clear(): void;
        hide(): void;
        setCurrentIndex(index: number): void;
        setEnabled(enabled: boolean): void;
        setVisible(visible: boolean): void;
        show(): void;
        value(index: number): T;
    }

    Type Parameters

    • T

      Type of the list item value.

    Hierarchy (View Summary)

    Implemented by

    Index
    count currentData currentIndex currentIndexChanged currentText currentValue currentValueChanged enabled maximumHeight maximumWidth minimumHeight minimumWidth objectName styleSheet toolTip visible
    clear hide setCurrentIndex setEnabled setVisible show value
    count: number

    Number of items in the combo box.

    Read

    currentData: any

    Current item data (userData), supplied as the second argument to addItem().

    Read only

    currentIndex: number

    Sets the current index.

    Read/Write

    currentIndexChanged: SignalConnector<string>

    Signal emitted when the selected item changes. The handler receives the new item's text (the Qt 5 currentIndexChanged(QString) overload), not its index: read currentIndex for the index and currentData for the data.

    Read

    currentText: string

    Currently displayed text in the combo box.

    Read/Write

    currentValue: T

    Sets the current value.

    Read/Write

    currentValueChanged: SignalConnector<T>

    Signal emitted when the current value changes.

    Read

    enabled: boolean
    maximumHeight: number
    maximumWidth: number

    Maximum widget width in pixels.

    Read/Write

    minimumHeight: number

    Minimum widget height in pixels. Sets the lower limit of the label height.

    Read/Write

    minimumWidth: number
    objectName: string

    Unique object name used for lookup and styling.

    Read/Write

    styleSheet: string

    Widget style sheet (see QtWidgets.style*()).

    Read/Write

    toolTip: string
    visible: boolean

    • Removes all items from the combo box.

      Returns void

      Write

    • Hides the widget.

      Returns void

    • Sets the current item index.

      Parameters

      • index: number

        Item index.

      Returns void

      Write

    • Enables or disables the widget.

      Parameters

      • enabled: boolean

        True to enable; false to disable.

      Returns void

    • Sets widget visibility.

      Parameters

      • visible: boolean

        Visibility flag: true to show, false to hide.

      Returns void

    • Shows the widget.

      Returns void

    • Returns the item value at an index.

      Parameters

      • index: number

        Item index.

      Returns T

      Item value.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods