Editor Scripting API
    Preparing search index...

    Class Dialog

    Modal or modeless dialog window.

        const root = new Widget(parent);
        const layout = new BoxLayout();
        layout.setDirection(Direction.TopToBottom);
        layout.spacing = 8;
        root.layout = layout;

        const status = new Label(root);
        status.text = 'Dialog result: (none)';
        status.fontRole = FontRole.Title;
        layout.addWidget(status);

        // Button that opens a dialog
        const openBtn = new PushButton(root);
        openBtn.text = 'Open Dialog';
        openBtn.primary = true;
        layout.addWidget(openBtn);

        const gui = this.pluginSystem.findInterface(Ui.IGui) as Ui.IGui;

        this.connections.push(
          openBtn.onClick.connect(() => {
            const dialog = gui.createDialog();
            dialog.setModal(true);
            dialog.resize(300, 150);

            const dlgLayout = new BoxLayout();
            dlgLayout.setDirection(Direction.TopToBottom);
            dlgLayout.spacing = 8;
            dialog.layout = dlgLayout;

            const msg = new Label(dialog);
            msg.text = 'Are you sure you want to proceed?';
            msg.wordWrap = true;
            dlgLayout.addWidget(msg);

            const btnRow = new Widget(dialog);
            const btnLayout = new BoxLayout();
            btnLayout.setDirection(Direction.LeftToRight);
            btnRow.layout = btnLayout;

            const okBtn = new PushButton(btnRow);
            okBtn.text = 'OK';
            okBtn.primary = true;
            btnLayout.addWidget(okBtn);

            const cancelBtn = new PushButton(btnRow);
            cancelBtn.text = 'Cancel';
            btnLayout.addWidget(cancelBtn);

            dlgLayout.addWidget(btnRow);

            okBtn.onClick.connect(() => dialog.accept());
            cancelBtn.onClick.connect(() => dialog.reject());

            dialog.onFinish.connect((code: number) => {
              status.text = `Dialog result: ${code === 1 ? 'Accepted' : 'Rejected'}`;
            });

            dialog.open();
          })
        );

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    autoFillBackground backgroundRole className contextMenuPolicy devicePixelRatio enabled fontRole foregroundRole hasFocus height hidden isNull isTransparentForMouseEvents layout objectName onClose onFinish onFocusIn onFocusOut onHide onKeyPress onMouseDoubleClick onMouseMove onMousePress onMouseRelease onResize onShow toolTip visible width windowTitle

    Methods

    accept activateWindow adjustSize blockSignals close deleteLater done exec findChild getProperty getTypeName grab isOfType isSame move open raise reject resize setContentsMargins setCursor setCursorPixmap setFixedHeight setFixedWidth setFocus setMaximumHeight setMaximumWidth setMinimumHeight setMinimumWidth setModal setProperty setSizePolicy setUndoable setUndoableRecursive show unsetCursor

    Constructors

    Properties

    autoFillBackground: boolean

    Whether the widget automatically fills its background before painting.

    backgroundRole: ColorRole

    The color role used for the widget's background.

    className: string
    contextMenuPolicy: ContextMenuPolicy

    Controls how the widget handles context menu requests.

    devicePixelRatio: number

    The ratio between physical and logical pixels for the widget's display.

    enabled: boolean

    Whether the widget is interactive and accepts user input.

    fontRole: FontRole

    The font role applied to the widget's text rendering.

    foregroundRole: ColorRole

    The color role used for the widget's foreground elements.

    hasFocus: boolean
    height: number

    Current height of the widget in pixels.

    hidden: boolean

    Whether the widget is hidden from view.

    isNull: boolean

    True if the underlying native widget object has been destroyed.

    isTransparentForMouseEvents: boolean
    layout: Layout

    The layout manager assigned to arrange child widgets.

    objectName: string
    onClose: signal1<CloseEvent, void>

    Signal emitted when the widget is closed.

    onFinish: signal1<number, void>

    Signal emitted when the dialog closes.

    onFocusIn: signal0<void>
    onFocusOut: signal0<void>
    onHide: signal0<void>

    Signal emitted when the widget becomes hidden.

    onKeyPress: signal1<number, void>

    Signal emitted when a key is pressed while the widget has focus.

    onMouseDoubleClick: signal1<MouseEvent, void>

    Signal emitted when the user double-clicks on the widget.

    onMouseMove: signal1<MouseEvent, void>

    Signal emitted when the mouse moves over the widget.

    onMousePress: signal1<MouseEvent, void>

    Signal emitted when a mouse button is pressed on the widget.

    onMouseRelease: signal1<MouseEvent, void>

    Signal emitted when a mouse button is released on the widget.

    onResize: signal2<number, number, void>

    Signal emitted when the widget is resized.

    onShow: signal0<void>

    Signal emitted when the widget becomes visible.

    toolTip: string

    Text displayed in a tooltip when the user hovers over the widget.

    visible: boolean

    Whether the widget is currently visible.

    width: number

    Current width of the widget in pixels.

    windowTitle: string

    Title text displayed in the widget's title bar when shown as a window.

    Methods

    • Close the dialog with accepted status.

      Returns void

    • Brings the widget's top-level window to the foreground and gives it focus.

      Returns void

    • Resizes the widget to fit its contents based on the size hint.

      Returns void

    • Blocks or unblocks signal emission from the widget.

      Parameters

      • blocked: boolean

      Returns void

    • Closes the widget, hiding it and emitting the onClose signal.

      Returns void

    • Schedules the widget for deletion after the current event loop iteration.

      Returns void

    • Close the dialog with a specific result code.

      Parameters

      • code: number

      Returns void

    • Run the dialog modally and return the result code.

      Returns number

    • Parameters

      • name: string

      Returns any

    • Returns the name of this object's type.

      Returns string

    • Captures the widget's current rendered content as a Pixmap.

      Returns Pixmap

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object refers to the same instance as the given object.

      Parameters

      Returns boolean

    • Moves the widget to the specified position.

      Parameters

      • ax: number
      • ay: number

      Returns void

    • Display the dialog non-modally.

      Returns void

    • Raises the widget to the top of the parent widget's stack.

      Returns void

    • Close the dialog with rejected status.

      Returns void

    • Resizes the widget to the specified width and height.

      Parameters

      • width: number
      • height: number

      Returns void

    • Sets the margins around the widget's contents.

      Parameters

      • left: number
      • top: number
      • right: number
      • bottom: number

      Returns void

    • Sets a custom pixmap as the cursor when the mouse is over the widget.

      Parameters

      Returns void

    • Locks the widget's height to the given value, preventing resizing.

      Parameters

      • height: number

      Returns void

    • Locks the widget's width to the given value, preventing resizing.

      Parameters

      • width: number

      Returns void

    • Gives keyboard input focus to the widget.

      Returns void

    • Sets the maximum height the widget can be resized to.

      Parameters

      • height: number

      Returns void

    • Sets the maximum width the widget can be resized to.

      Parameters

      • width: number

      Returns void

    • Sets the minimum height the widget must maintain.

      Parameters

      • height: number

      Returns void

    • Sets the minimum width the widget must maintain.

      Parameters

      • width: number

      Returns void

    • Set whether the dialog blocks interaction with other windows.

      Parameters

      • modal: boolean

      Returns void

    • Parameters

      • name: string
      • value: any

      Returns boolean

    • Marks property changes on this widget as undoable via the undo stack.

      Parameters

      • undoable: boolean

      Returns void

    • Marks property changes on this widget and all its children as undoable.

      Parameters

      • undoable: boolean

      Returns void

    • Makes the widget visible.

      Returns void

    • Resets the cursor to the parent widget's cursor.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods