sketchingpy.dialog_struct

 1"""Utilities for showing simple dialog boxes..
 2
 3License:
 4    BSD
 5"""
 6
 7import typing
 8
 9
10class DialogLayer:
11    """Facade which allows for simple dialog boxes."""
12
13    def show_alert(self, message: str, callback: typing.Optional[typing.Callable[[], None]] = None):
14        """Show an alert dialog box.
15
16        Args:
17            callback: Method to invoke when the box closes.
18            message: The string to show the user.
19        """
20        raise NotImplementedError('Use implementor.')
21
22    def show_prompt(self, message: str,
23        callback: typing.Optional[typing.Callable[[str], None]] = None):
24        """Get a string input from the user.
25
26        Args:
27            message: The message to display to the user within the dialog.
28            callback: Method to invoke when the box closes with a single string parameter provided
29                by the user. Not invoked if cancelled.
30        """
31        raise NotImplementedError('Use implementor.')
32
33    def get_file_save_location(self,
34        callback: typing.Optional[typing.Callable[[str], None]] = None):
35        """Get either the filename or full location for saving a file.
36
37        Args:
38            callback: Method to invoke when the box closes with single string parameter which is the
39                filename or the path selected by the user. Not invoked if cancelled.
40        """
41        raise NotImplementedError('Use implementor.')
42
43    def get_file_load_location(self,
44        callback: typing.Optional[typing.Callable[[str], None]] = None):
45        """Get either the filename or full location for opening a file.
46
47        Args:
48            callback: Method to invoke when the box closes with single string parameter which is the
49                filename or the path selected by the user. Not invoked if cancelled.
50        """
51        raise NotImplementedError('Use implementor.')