aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.ui.dialogs.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2014-09-17 12:53:40 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2014-09-17 12:53:40 -0400
commitc44b084d2c15bf73a610c371998a8c791d298a0f (patch)
treeb74c4b573f0e5086a45fe7c06bf4b4bf90f7b5b9 /core/.ui.dialogs.luadoc
parentc19cb9243d4e2ee4dfdb425d323922aacb8c603e (diff)
More LuaDoc updates.
Diffstat (limited to 'core/.ui.dialogs.luadoc')
-rw-r--r--core/.ui.dialogs.luadoc45
1 files changed, 25 insertions, 20 deletions
diff --git a/core/.ui.dialogs.luadoc b/core/.ui.dialogs.luadoc
index 958ff55e..523c423b 100644
--- a/core/.ui.dialogs.luadoc
+++ b/core/.ui.dialogs.luadoc
@@ -104,14 +104,15 @@ function ok_msgbox(options) end
function yesno_msgbox(options) end
---
--- Prompts the user with a one-line input-box dialog defined by dialog options
--- table *options*, returning the selected button's index along with the user's
--- input text.
+-- Prompts the user with an inputbox dialog defined by dialog options table
+-- *options*, returning the selected button's index along with the user's
+-- input text (the latter as a string or table, depending on the type of
+-- *options*.`informative_text`).
-- If *options*.`string_output` is `true`, returns the selected button's label
-- along with the user's input text.
-- If the dialog timed out, returns `0` or `"timeout"`. If the user canceled the
-- dialog, returns `-1` or `"delete"`.
--- @param options Table of key-value option pairs for the input-box.
+-- @param options Table of key-value option pairs for the inputbox.
--
-- * `title`: The dialog's title text.
-- * `informative_text`: The dialog's main message text. If the value is a
@@ -141,14 +142,15 @@ function yesno_msgbox(options) end
function inputbox(options) end
---
--- Prompts the user with a one-line input-box dialog defined by dialog options
--- table *options* and with localized "Ok" and "Cancel" buttons, returning the
--- selected button's index along with the user's input text.
+-- Prompts the user with an inputbox dialog defined by dialog options table
+-- *options* and with localized "Ok" and "Cancel" buttons, returning the
+-- selected button's index along with the user's input text (the latter as a
+-- string or table, depending on the type of *options*.`informative_text`).
-- If *options*.`string_output` is `true`, returns the selected button's label
-- along with the user's input text.
-- If the dialog timed out, returns `0` or `"timeout"`. If the user canceled the
-- dialog, returns `-1` or `"delete"`.
--- @param options Table of key-value option pairs for the input-box.
+-- @param options Table of key-value option pairs for the inputbox.
--
-- * `title`: The dialog's title text.
-- * `informative_text`: The dialog's main message text. If the value is a
@@ -173,14 +175,15 @@ function inputbox(options) end
function standard_inputbox(options) end
---
--- Prompts the user with a one-line masked input-box dialog defined by dialog
--- options table *options*, returning the selected button's index along with the
--- user's input text.
+-- Prompts the user with a masked inputbox dialog defined by dialog options
+-- table *options*, returning the selected button's index along with the user's
+-- input text (the latter as a string or table, depending on the type of
+-- *options*.`informative_text`).
-- If *options*.`string_output` is `true`, returns the selected button's label
-- along with the user's input text.
-- If the dialog timed out, returns `0` or `"timeout"`. If the user canceled the
-- dialog, returns `-1` or `"delete"`.
--- @param options Table of key-value option pairs for the input-box.
+-- @param options Table of key-value option pairs for the inputbox.
--
-- * `title`: The dialog's title text.
-- * `informative_text`: The dialog's main message text. If the value is a
@@ -208,14 +211,15 @@ function standard_inputbox(options) end
function secure_inputbox(options) end
---
--- Prompts the user with a one-line masked input-box dialog defined by dialog
--- options table *options* and with localized "Ok" and "Cancel" buttons,
--- returning the selected button's index along with the user's input text.
+-- Prompts the user with a masked inputbox dialog defined by dialog options
+-- table *options* and with localized "Ok" and "Cancel" buttons, returning the
+-- selected button's index along with the user's input text (the latter as a
+-- string or table, depending on the type of *options*.`informative_text`).
-- If *options*.`string_output` is `true`, returns the selected button's label
-- along with the user's input text.
-- If the dialog timed out, returns `0` or `"timeout"`. If the user canceled the
-- dialog, returns `-1` or `"delete"`.
--- @param options Table of key-value option pairs for the input-box.
+-- @param options Table of key-value option pairs for the inputbox.
--
-- * `title`: The dialog's title text.
-- * `informative_text`: The dialog's main message text. If the value is a
@@ -440,8 +444,9 @@ function filteredlist(options) end
---
-- Prompts the user with an option selection dialog defined by dialog options
-- table *options*, returning the selected button's index along with the indices
--- of the selected options or, if *options*.`string_output` is `true`, the
--- selected button's label along with the text of the selected options.
+-- of the selected options.
+-- If *options*.`string_output` is `true`, returns the selected button's label
+-- along with the text of the selected options.
-- If the dialog timed out, returns `0` or `"timeout"`. If the user canceled the
-- dialog, returns `-1` or `"delete"`.
-- @param options Table of key-value option pairs for the option select dialog.
@@ -456,8 +461,8 @@ function filteredlist(options) end
-- to be set.
-- * `select`: The indices of initially selected options.
-- * `string_output`: Return the selected button's label or the dialog's exit
--- status along with the selected option's text instead of the button's
--- index or the dialog's exit code along with the option's index. The
+-- status along with the selected options' text instead of the button's
+-- index or the dialog's exit code along with the options' indices. The
-- default value is `false`.
-- * `width`: The dialog's pixel width.
-- * `height`: The dialog's pixel height.