commit 9cb10eccda93cd36389bd5cc6515e3766d2f1bc0
parent 0ae0d8ae37f5b701a8b555110d529342693eaf90
Author: Ruthard Baudach <ruthard.baudach@web.de>
Date: Mon, 29 Sep 2014 13:05:30 +0200
lib/sup/buffer.rb: comment ask_* functions
Diffstat:
1 file changed, 12 insertions(+), 0 deletions(-)
diff --git a/lib/sup/buffer.rb b/lib/sup/buffer.rb
@@ -396,6 +396,18 @@ EOS
end
end
+ ## ask* functions. these functions display a one-line text field with
+ ## a prompt at the bottom of the screen. answers typed or choosen by
+ ## tab-completion
+ ##
+ ## common arguments are:
+ ##
+ ## domain: token used as key for @textfields, which seems to be a
+ ## dictionary of input field objects
+ ## question: string used as prompt
+ ## completions: array of possible answers, that can be completed by using
+ ## the tab key
+ ## default: default value to return
def ask_with_completions domain, question, completions, default=nil
ask domain, question, default do |s|
s.fix_encoding!