Add button_dialog, including docs/examples

Author: sreyemnayr

docs/images/dialogs/button.png

@@ -64,6 +64,30 @@ selection.
 .. image:: ../images/dialogs/confirm.png
 
 
+Button dialog
+--------------------------
+
+The :func:`~prompt_toolkit.shortcuts.dialogs.button_dialog` function displays a
+dialog with choices offered as buttons. Buttons are indicated as a list of
+tuples, each providing the label (first) and return value if clicked (second).
+
+.. code:: python
+
+ from prompt_toolkit.shortcuts.dialogs import button_dialog
+
+ result = button_dialog(
+ title='Button dialog example',
+ text='Do you want to confirm?',
+ buttons=[
+ ('Yes', True),
+ ('No', False),
+ ('Maybe...', None)
+ ],
+ )
+
+.. image:: ../images/dialogs/button.png
+
+
 Styling of dialogs
 ------------------
 

docs/pages/dialogs.rst

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+"""
+Example of button dialog window.
+"""
+from __future__ import unicode_literals
+from prompt_toolkit.shortcuts.dialogs import button_dialog
+
+
+def main():
+ result = button_dialog(
+ title='Button dialog example',
+ text='Are you sure?',
+ buttons=[
+ ('Yes', True),
+ ('No', False),
+ ('Maybe...', None),
+ ],
+ )
+
+ print('Result = {}'.format(result))
+
+
+if __name__ == '__main__':
+ main()

examples/dialogs/button_dialog.py

@@ -1,5 +1,5 @@
 from __future__ import unicode_literals
-from .dialogs import yes_no_dialog, input_dialog, message_dialog, radiolist_dialog, progress_dialog
+from .dialogs import yes_no_dialog, button_dialog, input_dialog, message_dialog, radiolist_dialog, progress_dialog
 from .prompt import Prompt, prompt, confirm, create_confirm_prompt, CompleteStyle
 from .utils import print_formatted_text, clear, set_title, clear_title
 
@@ -11,6 +11,7 @@
  'progress_dialog',
  'radiolist_dialog',
  'yes_no_dialog',
+ 'button_dialog',
 
  # Prompts.
  'Prompt',

prompt_toolkit/shortcuts/__init__.py

@@ -1,4 +1,5 @@
 from __future__ import unicode_literals
+import functools
 from prompt_toolkit.application import Application
 from prompt_toolkit.application.current import get_app
 from prompt_toolkit.eventloop import run_in_executor
@@ -12,6 +13,7 @@
 
 __all__ = [
  'yes_no_dialog',
+ 'button_dialog',
  'input_dialog',
  'message_dialog',
  'radiolist_dialog',
@@ -42,6 +44,24 @@ def no_handler():
  return _run_dialog(dialog, style, async_=async_)
 
 
+def button_dialog(title='', text='', buttons=[], style=None,
+ async_=False):
+ """
+ Display a dialog with button choices (given as a list of tuples).
+ Return the value associated with button.
+ """
+ def button_handler(v):
+ get_app().set_result(v)
+
+ dialog = Dialog(
+ title=title,
+ body=Label(text=text, dont_extend_height=True),
+ buttons=[Button(text=t, handler=functools.partial(button_handler, v)) for t, v in buttons],
+ with_background=True)
+
+ return _run_dialog(dialog, style, async_=async_)
+
+
 def input_dialog(title='', text='', ok_text='OK', cancel_text='Cancel',
  completer=None, password=False, style=None, async_=False):
  """