Module Dialog

Module in charge of general purpose GUI dialogs.

Functions

showDialog (params, callbackFunction) Shows a dialog.
showErrorDialog (params, callbackFunction) Shows an error dialog.


Functions

showDialog (params, callbackFunction)
Shows a dialog.

Remarks:

    The callback function is not called if user pressed the Cancel button.

Parameters:

  • params tab

    Table of parameters tha can contain the following slots.

    • visibilityHandler - function that is called with true when dialog is shown and with false when it is hidden, can be used to disable other components while the dialog is shown
    • dialogType - one of the following
      • Dialog.YES_NO_CANCEL_TYPE
      • Dialog.OK_CANCEL_TYPE
    • title - title of the dialog
    • message - title of the dialog
    • x, y - position where to show the dialog
    • buttonNames - mapping of any of YES, NO, OK and CANCEL to alternate names that should be used instead
  • callbackFunction func Function that gets called after the dialog concludes.
showErrorDialog (params, callbackFunction)
Shows an error dialog.

Parameters:

  • params tab

    Table of parameters tha can contain the following slots.

    • visibilityHandler - function that is called with true when dialog is shown and with false when it is hidden, can be used to disable other components while the dialog is shown
    • title - title of the dialog
    • message - title of the dialog
    • x, y - position where to show the dialog
    • buttonNames - mapping of any of OK to alternate name that should be used instead
  • callbackFunction func Function that gets called after the dialog concludes.
generated by LDoc 1.4.3 Last updated 2017-06-01 23:07:48