Class engine.ui.Dialog

A generic UI Dialog

Methods



Methods

engine.ui.Dialog:simpleWaiter (title, text, width, count, max)
Requests a simple waiter dialog

Parameters:

  • title
  • text
  • width
  • count
  • max
engine.ui.Dialog:simpleWaiterTip (title, text, tip, width, count, max)
Requests a simple waiter dialog

Parameters:

  • title
  • text
  • tip
  • width
  • count
  • max
engine.ui.Dialog:listPopup (title, text, list, w, h, fct)
Requests a simple, press any key, dialog

Parameters:

  • title
  • text
  • list
  • w
  • h
  • fct
engine.ui.Dialog:simplePopup (title, text, fct, no_leave, any_leave)
Requests a simple, press any key, dialog

Parameters:

  • title
  • text
  • fct
  • no_leave
  • any_leave
engine.ui.Dialog:simpleLongPopup (title, text, w, fct, no_leave, force_height)
Requests a simple, press any key, dialog

Parameters:

  • title
  • text
  • w
  • fct
  • no_leave
  • force_height
engine.ui.Dialog:yesnoPopup (title, text, fct, yes_text, no_text, no_leave, escape)
Requests a simple yes-no dialog

Parameters:

  • title
  • text
  • fct
  • yes_text
  • no_text
  • no_leave
  • escape
engine.ui.Dialog:yesnoLongPopup (title, text, w, fct, yes_text, no_text, no_leave, escape)
Requests a long yes-no dialog

Parameters:

  • title
  • text
  • w
  • fct
  • yes_text
  • no_text
  • no_leave
  • escape
engine.ui.Dialog:yesnocancelPopup (title, text, fct, yes_text, no_text, cancel_text, no_leave, escape)
Requests a simple yes-no dialog

Parameters:

  • title
  • text
  • fct
  • yes_text
  • no_text
  • cancel_text
  • no_leave
  • escape
engine.ui.Dialog:yesnocancelLongPopup (title, text, w, fct, yes_text, no_text, cancel_text, no_leave, escape)
Requests a simple yes-no dialog

Parameters:

  • title
  • text
  • w
  • fct
  • yes_text
  • no_text
  • cancel_text
  • no_leave
  • escape
engine.ui.Dialog:multiButtonPopup (title, text, button_list, choice_fct, w, no_leave, escape)
Requests a multiple-choice dialog, with a button for each choice

Parameters:

  • title = text at top of dialog box
  • text = message to display inside the box
  • button_list

    = ordered table of button choices {choice1=, choice2=, ....}

        each choice: {name=<button text>, fct=<optional function(choice) to run on selection>, more vars...}
    
  • choice_fct = function(choice) to handle the button pressed (if choice.fct is not defined)
  • w , h = width and height of the dialog (in pixels, optional: dialog sized to its elements by default)
  • no_leave set true to force a selection
  • escape = the default choice (number) to select if escape is pressed
engine.ui.Dialog:unload ()
This does nothing and can be changed by other classes
engine.ui.Dialog:cleanup ()
This provides required cleanups, do not touch
generated by LDoc 1.4.3