ScriptDialog

QML Item for writing visual scripts. More...

import Script

Properties

	Name
var	data
bool	interactive
int	stepCount

Methods

	Name
	firstStep(string firstStep)
	nextStep(string title)
	runSteps(function generator)
	setStepCount(int stepCount)

Signals

	Name
	onAccepted()
	onClicked(string name)
	onRejected()

Detailed Description

The ScriptDialog allows creating a script dialog based on a ui file. It requires creating a ui file with the same name as the qml script.

Inside the dialog, all widget's main property is mapped to a property inside the data property, using the same name as the objectName. For example, the text of a QLineEdit with objectName set to lineEdit will be mapped to data.lineEdit.

Buttons (QPushButton or QToolButton) clicked signal is available through the onClikced signal handler, with the button objectName as parameter.

QDialogButtonBox accepted or rejected signals are automatically connected and available through the onAccepted and onRejected signal handlers.

import Script

ScriptDialog {
    property string text1: data.lineEdit
    property string text2: data.comboBox
    property int number: data.spinBox
    property int number2: data.doubleSpinBox
    property bool check: data.checkBox
    property bool check2: data.radioButton
    onClicked: (name) => {
        if (name == "pushButton" || name == "toolButton")
            console.log(name)
    }
    onAccepted: {
        console.log("Accepted")
    }
    onRejected: {
        console.log("Rejected")
    }
}

Property Documentation

var data

This read-only property contains all properties mapping the widgets.

Use data.objectName to access the main property of a widget (the text for a QLineEdit for example).

bool interactive

If set to false, runSteps will not ask for user input, the entire script will be run at once. This is especially useful for testing.

int stepCount

Number of steps to display in the progress bar.

Method Documentation

firstStep(string firstStep)

Starts a progress bar with the given firstStep title.

The number of following nextStep calls (or yield calls if using runSteps) should be one less than the number of steps set here.

nextStep(string title)

Changes the progression to a new progress step.

This will update the progress bar and the title of the progress dialog. Make sure that the number of steps is set correctly before calling this method.

runSteps(function generator)

Runs a script in multiple (interactive) steps.

The argument to this function must be a JavaScript generator object (See this documentation on JS Generators).

The generator should yield a string with the next step title, whenever the user should be able to pause the script and inspect the changes. This will behave the same as calling nextStep, but pauses the script, until the user continues or aborts the script.

You can also mix and match between yield and nextStep calls.

For the best experience, we recommend to use setStepCount, firstStep and yield to indicate the remaining progress.

Example:

function *conversionSteps() {
   setStepCount(2)            // <--- Initialize the number of steps
   firstStep("Adding member") // <--- Start the first step
   document.addMember("test", "int", CppDocument.Public)

   yield "Inserting include"  // <--- The user can check that the member was inserted correctly
   document.insertInclude("<iostream>")
}

function convert() {
   runSteps(conversionSteps())
}

setStepCount(int stepCount)

Sets the number of steps to show in the progress bar.

By default the value is 0, meaning there are no steps set. This will show an indeterminate progress bar. You can use the stepCount property to set the number of steps too.

Signal Documentation

onAccepted()

This handler is called when a button with an accept role from a QDialogButtonBox is pressed (usually the OK button).

onClicked(string name)

This handler is called when a button is cliked, the name is the name of the button.

onRejected()

This handler is called when a button with a reject role from a QDialogButtonBox is pressed (usually the Cancel button).