Added the possibility to pass a callback to char_by_char and word_by_word methods. Added the possibility to pass arguments to callbacks passed to char_by_char and word_by_word methods (via the parameter cargs which accept an infinite number of arguments). DialogBox class is now context manager. Removal of character encoding indications in all file headers (utf-8 by default in python3). Update version numbers in __init__.py and setup.py. Add an example in doc/examples (context.py).

Author: Tim-ats-d

doc/examples/context.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+# context.py
+
+import curses
+
+from visualdialog import DialogBox
+
+
+def main(stdscr):
+    monologue = (
+        "I will be the narrator of this story.",
+        "I will guide you throughout your adventure."
+    )
+
+    # Makes the cursor invisible.
+    curses.curs_set(0)
+
+    # Definition of several colors pairs.
+    curses.start_color()
+    curses.init_pair(1, curses.COLOR_WHITE, curses.COLOR_BLACK)
+    curses.init_pair(2, curses.COLOR_CYAN, curses.COLOR_BLACK)
+
+    with DialogBox(
+            5, 5,  # Position 5;5 in terminal.
+            40, 6,  # Length and width (in character).
+            title="Narrator", title_colors_pair_nb=1) as narrator:  # We catch the dialog box with as.
+
+        # Definition of accepted key codes to pass a dialog.
+        # See documentation of the curses constants for more informations.
+        narrator.confirm_dialog_key = (10, 32)  # Key Enter and Space.
+
+        # We iterate on each sentence contained in monologue.
+        for text in monologue:
+            narrator.char_by_char(stdscr,
+                text,
+                2)  # Display of the reply variable colored with color pair 2.
+
+            narrator.getkey(stdscr)  # Waiting for a key press.
+            stdscr.clear()  # Clear the screen.
+
+
+# Execution of the function.
+curses.wrapper(main)

doc/examples/monologue.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# monologue_example.py
+# monologue.py
 
 import curses
 
@@ -25,14 +25,14 @@ def main(stdscr):
 
     textbox = DialogBox(
         20, 15,   # Position 20;15 in terminal.
-        40, 6,    # Length and width (in character).
+        40, 6,   # Length and width (in character).
         title="Dogm", title_colors_pair_nb=3)  # Title and color_pair used to colored title.
 
     # Definition of accepted key codes to pass a dialog.
     # See documentation of the curses constants for more informations.
     textbox.confirm_dialog_key = (10, 32)  # Key Enter and Space.
 
-    # Display each sentence contains in text.
+    # We iterate on each sentence contained in replys.
     for reply in replys:
         textbox.char_by_char(stdscr,
             reply,

setup.py

@@ -1,12 +1,11 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
 from setuptools import setup, find_packages
 
 
 setup(
     name="visualdialog",
-    version=0.2,
+    version=0.4,
     packages=find_packages(),
     author="Arnouts Timéo",
     author_email="[email protected]",

visualdialog/__init__.py

@@ -1,10 +1,9 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 
 """
 A librairie which provides class and functions to make easier dialog box in terminal.
 """
 
-__version__ = 0.3
+__version__ = 0.4
 
 from .core import DialogBox

visualdialog/core.py

@@ -32,7 +32,7 @@
 import textwrap
 import time
 
-from typing import Tuple
+from typing import Any, Callable, Tuple
 
 
 class DialogBox :
@@ -51,8 +51,8 @@ def __init__(self,
         self.pos_x, self.pos_y = pos_x, pos_y
         self.box_length, self.box_width = box_length, box_width
 
-        self.text_pos_x = pos_x + 2
-        self.text_pos_y = pos_y + 3
+        self.text_pos_x = pos_x + 2  # Compensation for the left border of the dialog box.
+        self.text_pos_y = pos_y + 3  # Compensation for the upper border of the dialog box.
 
         self.nb_char_max_line = box_length - 2
         self.nb_lines_max = box_width - 2
@@ -69,6 +69,12 @@ def __init__(self,
 
         self.end_dialog_indicator_char = end_dialog_indicator[:1] # We keep only first character.
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, traceback):
+        ...
+
     def framing_box(self, stdscr):
         """Displays dialog box and his title.
 
@@ -105,7 +111,7 @@ def getkey(self, stdscr):
 
     def _display_end_dialog_indicator(self, stdscr,
             colors_pair_nb: int = None, blink: bool = True):
-        """Displays an end of dialog indicator in the lower right corner."""
+        """Displays an end of dialog indicator in the lower right corner of textbox."""
         if self.end_dialog_indicator_char:
             blink = curses.A_BLINK if blink else curses.A_NORMAL
 
@@ -115,7 +121,9 @@ def _display_end_dialog_indicator(self, stdscr,
     def char_by_char(self, stdscr,
             text: str, colors_pair_nb: int,
             flash_screen: bool = False,
-            delay: int = .05, random_delay: Tuple[int, int] = (0, 0)):
+            delay: int = .05, random_delay: Tuple[int, int] = (0, 0),
+            callback: Callable = None,
+            cargs=()):
         """Writes the given text character by character at position self.pos_x;self.pos_y.
 
         The colors_pair_nb corresponds to the number of the curses color pair with which the text
@@ -146,13 +154,18 @@ def char_by_char(self, stdscr,
             else:
                 time.sleep(delay + random.uniform(*random_delay))
 
+            if callback:
+                callback(*cargs)
+
         self._display_end_dialog_indicator(stdscr)
 
     def word_by_word(self, stdscr,
             text: str, colors_pair_nb: int,
             cut_char: str = " ",
             flash_screen: bool = False,
-            delay: int = .05, random_delay: Tuple[int, int] = (0, 0)):
+            delay: int = .05, random_delay: Tuple[int, int] = (0, 0),
+            callback: Callable = None,
+            cargs=()):
         """Writes the given text word by word at position at position self.pos_x;self.pos_y.
 
         The colors_pair_nb corresponds to the number of the curses color pair with which the text
@@ -184,6 +197,9 @@ def word_by_word(self, stdscr,
             offsetting_x += len(word) + 1  # Compensates for the space between words.
             time.sleep(delay + random.uniform(*random_delay))
 
+            if callback:
+                callback(*cargs)
+
         self._display_end_dialog_indicator(stdscr)
 
 
@@ -210,13 +226,32 @@ def main(stdscr):
 
     textbox.confirm_dialog_key = (10, 32)
 
+    def func(reply: str):
+        stdscr.addstr(0, 0, reply)
+
     for reply in text:
         textbox.framing_box(stdscr)
-        textbox.char_by_char(stdscr, reply, 2)
+        textbox.char_by_char(stdscr, reply, 2, cargs=(reply,), callback=func)
 
         textbox.getkey(stdscr)
         stdscr.clear()
 
+def main2(stdscr):
+    curses.curs_set(0)
+
+    curses.start_color()
+    curses.init_pair(1, curses.COLOR_RED, curses.COLOR_BLACK)
+    curses.init_pair(2, curses.COLOR_CYAN, curses.COLOR_BLACK)
+    curses.init_pair(3, curses.COLOR_GREEN, curses.COLOR_BLACK)
+
+    with DialogBox(
+            20, 15,
+            40, 6,
+            title="Test", title_colors_pair_nb=3,
+            end_dialog_indicator="t") as e:
+
+        e.framing_box(stdscr)
+        e.char_by_char(stdscr, "c'est le grand test", 2)
 
 if __name__ == "__main__":
-    curses.wrapper(main)
+    curses.wrapper(main2)