Class: oProgressDialog

$. oProgressDialog

An simple progress dialog to display the progress of a task. To react to the user clicking the cancel button, connect a function to $.oProgressDialog.canceled() signal. When $.batchmode is true, the progress will be outputed as a "Progress : value/range" string to the Harmony stdout.

new $.oProgressDialog(labelText, range, title, show)

openHarmony/openHarmony_dialog.js, line 405
The $.oProgressDialog constructor.
Name Type Default Description
labelText string optional The text displayed above the progress bar.
range string 100 optional The maximum value that represents a full progress bar.
title string optional The title of the dialog
show bool false optional Whether to immediately show the dialog.
Properties:
Name Type Description
wasCanceled bool Whether the progress bar was cancelled.
canceled $.oSignal A Signal emited when the dialog is canceled. Can be connected to a callback.

Members

cancelled

Whether the Progress Dialog was cancelled by the user.
Deprecated
  • use $.oProgressDialog.wasCanceled to get the cancel status, or connect a function to the "canceled" signal.

    labelstring

    The text displayed by the window.

    rangeint

    The maximum value that can be displayed by the progress dialog (equivalent to "finished")

    valueint

    The current value of the progress bar. Setting this to the value of 'range' will close the dialog.

    Methods

    close()

    openHarmony/openHarmony_dialog.js, line 536
    Closes the dialog.

    show()

    openHarmony/openHarmony_dialog.js, line 524
    Shows the dialog.