Message

LuaFAR for Editor

Message


result = far2_message.Message (Text, Title, Buttons, Flags, HelpTopic, Id)

Parameters:
  Text       : Text elements to display inside the dialog frame.
               Either a string or a table, depending on flag 'c'.
               Sequences '\n', '\r\n' and '\r' are treated as line separators.
  Title      : Title string; optional.
  Buttons    : Buttons string; ';' and '\n' serve as button separators; optional.
               Buttons automatically wrap on multiple lines if don't fit on one
               line. Separator '\n' forces new line for the next button.
  Flags      : Concatenation of 0 or more character flags; optional.
               'l' - left-align text lines (default: center lines on the dialog).
               'w' - use "warning" color set for the dialog and its elements.
               'R' - don't wrap long text lines (default: wrap).
               'c' - "color"-mode, that changes treating the aText argument. With
                  this flag set, aText should be an array of individual elements,
                  each of which is either a string or a table.
                  A table elements may have the following fields:
                     "text" (string)
                     "color" (number; optional)
                     "separator" (1 = single line, 2 = double line; optional)
                  Each element's begins at the position next to the previous
                  element's end. Separators are always put on separate lines.
  HelpTopic  : Help topic string; optional.
  Id         : Dialog Id; binary GUID string; optional.

Returns:
  result     : negative number when dialog was canceled, button number otherwise
               (1 is the first button).