format code and doc
This commit is contained in:
parent
bc822c0af7
commit
1a96642615
|
@ -37,23 +37,23 @@ local widgetprompt = { mt = {} }
|
|||
-- @param promptbox The promptbox to run.
|
||||
local function run(promptbox)
|
||||
return prompt.run {
|
||||
prompt = promptbox.prompt,
|
||||
textbox = promptbox.widget,
|
||||
fg_cursor = promptbox.fg_cursor,
|
||||
bg_cursor = promptbox.bg_cursor,
|
||||
ul_cursor = promptbox.ul_cursor,
|
||||
font = promptbox.font,
|
||||
autoexec = promptbox.autoexec,
|
||||
highlighter = promptbox.highlighter,
|
||||
exe_callback = promptbox.exe_callback,
|
||||
completion_callback = promptbox.completion_callback,
|
||||
history_path = promptbox.history_path,
|
||||
history_max = promptbox.history_max,
|
||||
done_callback = promptbox.done_callback,
|
||||
changed_callback = promptbox.changed_callback,
|
||||
keypressed_callback = promptbox.keypressed_callback,
|
||||
prompt = promptbox.prompt,
|
||||
textbox = promptbox.widget,
|
||||
fg_cursor = promptbox.fg_cursor,
|
||||
bg_cursor = promptbox.bg_cursor,
|
||||
ul_cursor = promptbox.ul_cursor,
|
||||
font = promptbox.font,
|
||||
autoexec = promptbox.autoexec,
|
||||
highlighter = promptbox.highlighter,
|
||||
exe_callback = promptbox.exe_callback,
|
||||
completion_callback = promptbox.completion_callback,
|
||||
history_path = promptbox.history_path,
|
||||
history_max = promptbox.history_max,
|
||||
done_callback = promptbox.done_callback,
|
||||
changed_callback = promptbox.changed_callback,
|
||||
keypressed_callback = promptbox.keypressed_callback,
|
||||
keyreleased_callback = promptbox.keyreleased_callback,
|
||||
hook = promptbox.hook
|
||||
hook = promptbox.hook
|
||||
}
|
||||
end
|
||||
|
||||
|
@ -70,8 +70,10 @@ end
|
|||
--
|
||||
-- @tparam table args Prompt arguments.
|
||||
-- @tparam[opt="Run: "] string args.prompt Prompt text.
|
||||
-- @tparam[opt=`beautiful.prompt_bg` or `beautiful.bg_normal`] color args.bg Prompt background color.
|
||||
-- @tparam[opt=`beautiful.prompt_fg` or `beautiful.fg_normal`] color args.fg Prompt foreground color.
|
||||
-- @tparam[opt=`beautiful.prompt_bg` or `beautiful.bg_normal`] color args.bg
|
||||
-- Prompt background color.
|
||||
-- @tparam[opt=`beautiful.prompt_fg` or `beautiful.fg_normal`] color args.fg
|
||||
-- Prompt foreground color.
|
||||
-- @tparam[opt] gears.color args.fg_cursor
|
||||
-- @tparam[opt] gears.color args.bg_cursor
|
||||
-- @tparam[opt] gears.color args.ul_cursor
|
||||
|
@ -80,15 +82,17 @@ end
|
|||
-- @tparam[opt] function args.highlighter A function to add syntax highlighting
|
||||
-- to the command.
|
||||
-- @tparam[opt] function args.exe_callback The callback function to call with
|
||||
-- command as argument when finished.
|
||||
-- command as argument when finished.
|
||||
-- @tparam[opt=`awful.completion.shell`] function args.completion_callback
|
||||
-- The callback function to call to get completion. See @{awful.prompt.run} for details.
|
||||
-- The callback function to call to get completion. See @{awful.prompt.run}
|
||||
-- for details.
|
||||
-- @tparam[opt=`gears.filesystem.get_cache_dir() .. '/history'`] string
|
||||
-- args.history_path File path where the history should be saved.
|
||||
-- @tparam[opt=50] integer args.history_max Set the maximum entries in history file.
|
||||
-- @tparam[opt=50] integer args.history_max Set the maximum entries in
|
||||
-- history file.
|
||||
-- @tparam[opt] function args.done_callback
|
||||
-- The callback function to always call without arguments, regardless of
|
||||
-- whether the prompt was cancelled. See @{awful.prompt.run} for details.
|
||||
-- The callback function to always call without arguments, regardless of
|
||||
-- whether the prompt was cancelled. See @{awful.prompt.run} for details.
|
||||
-- @tparam[opt] function args.changed_callback The callback function to call
|
||||
-- with command as argument when a command was changed.
|
||||
-- @tparam[opt] function args.keypressed_callback The callback function to call
|
||||
|
@ -97,7 +101,8 @@ end
|
|||
-- with mod table, key and command as arguments when a key was pressed.
|
||||
-- @tparam[opt] table args.hook Similar to @{awful.key}. It will call a function
|
||||
-- for the matching modifiers + key. See @{awful.prompt.run} for details.
|
||||
-- @return An instance of prompt widget, inherits from `wibox.container.background`.
|
||||
-- @return An instance of prompt widget, inherits from
|
||||
-- `wibox.container.background`.
|
||||
-- @function awful.widget.prompt
|
||||
function widgetprompt.new(args)
|
||||
args = args or {}
|
||||
|
@ -115,9 +120,12 @@ function widgetprompt.new(args)
|
|||
promptbox.font = args.font or nil
|
||||
promptbox.autoexec = args.autoexec or nil
|
||||
promptbox.highlighter = args.highlighter or nil
|
||||
promptbox.exe_callback = args.exe_callback or function (...) promptbox:spawn_and_handle_error(...) end
|
||||
promptbox.exe_callback = args.exe_callback or function (...)
|
||||
promptbox:spawn_and_handle_error(...)
|
||||
end
|
||||
promptbox.completion_callback = args.completion_callback or completion.shell
|
||||
promptbox.history_path = args.history_path or gfs.get_cache_dir() .. '/history'
|
||||
promptbox.history_path = args.history_path or
|
||||
gfs.get_cache_dir() .. 'history'
|
||||
promptbox.history_max = args.history_max or nil
|
||||
promptbox.done_callback = args.done_callback or nil
|
||||
promptbox.changed_callback = args.changed_callback or nil
|
||||
|
|
Loading…
Reference in New Issue