aboutsummaryrefslogtreecommitdiff
path: root/core/.ui.dialogs.luadoc
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2017-06-20 23:58:43 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2017-06-20 23:58:43 -0400
commit45c18f1229294e96a3603116aed8ffec2be7420b (patch)
tree0fc8d4bf617450d6d197b4c2498b6f4f1f67b999 /core/.ui.dialogs.luadoc
parent93d418c3fae83a32a48edbb43a71ba892401acaf (diff)
downloadtextadept-45c18f1229294e96a3603116aed8ffec2be7420b.tar.gz
textadept-45c18f1229294e96a3603116aed8ffec2be7420b.zip
Added support and documentation for new ui dialogs.
This requires gtdialog r108 (changeset 8465c20432e1).
Diffstat (limited to 'core/.ui.dialogs.luadoc')
-rw-r--r--core/.ui.dialogs.luadoc20
1 files changed, 20 insertions, 0 deletions
diff --git a/core/.ui.dialogs.luadoc b/core/.ui.dialogs.luadoc
index ebc2a167..eaa03a6c 100644
--- a/core/.ui.dialogs.luadoc
+++ b/core/.ui.dialogs.luadoc
@@ -498,3 +498,23 @@ function optionselect(options) end
-- @usage ui.dialogs.colorselect{title = 'Foreground color', color = 0x000000,
-- palette = {'#000000', 0x0000FF, '#00FF00', 0xFF0000}}
function colorselect(options) end
+
+---
+-- Prompts the user with a font selection dialog defined by dialog options
+-- table *options*, returning the font selected (including style and size).
+-- If the user canceled the dialog, returns `nil`.
+-- @param options Table of key-value option pairs for the option select dialog.
+--
+-- * `title`: The dialog's title text.
+-- * `text`: The font preview text.
+-- * `font-name`: The initially selected font name.
+-- * `font-size`: The initially selected font size. The default value is `12`.
+-- * `font-style`: The initially selected font style. The available options
+-- are `"regular"`, `"bold"`, `"italic"`, and `"bold italic"`. The default
+-- value is `"regular"`.
+-- * `float`: Show the dialog on top of all desktop windows. The default value
+-- is `false`.
+-- @return selected font, including style and size
+-- @usage ui.dialogs.fontselect{title = 'Font', font_name = 'Monospace',
+-- font_size = 10}
+function fontselect(options) end