diff --git a/TermTk/TTkCore/helper.py b/TermTk/TTkCore/helper.py index 4927f075..236076e5 100644 --- a/TermTk/TTkCore/helper.py +++ b/TermTk/TTkCore/helper.py @@ -169,7 +169,8 @@ class TTkHelper: return TTkHelper.rootOverlay(widget) is not None @staticmethod - def overlay(caller, widget, x, y, modal=False, forceBoundaries=True, toolWindow=False): + def overlay(caller, widget, x:int, y:int, modal:bool=False, forceBoundaries:bool=True, toolWindow:bool=False): + '''overlay''' if not caller: caller = TTkHelper._rootWidget wx, wy = TTkHelper.absPos(caller) diff --git a/docs/MDNotes/Games.md b/docs/MDNotes/Games.md index 1acf7b5b..fcc54f4c 100644 --- a/docs/MDNotes/Games.md +++ b/docs/MDNotes/Games.md @@ -26,4 +26,5 @@ For this reason games like MarioBros are not technically possible on a terminal * Whac-A-Mole * Dungeon Master * Flappy Bird -* \ No newline at end of file +* Pacman (Does not require long keypresses) +* Nibbles (Does not require long keypresses) \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 75cec6f4..dc35c336 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -74,6 +74,7 @@ Intro info/installing info/debug + info/resources/index .. toctree:: diff --git a/docs/source/info/dev/clipboard.rst b/docs/source/info/resources/clipboard.rst similarity index 100% rename from docs/source/info/dev/clipboard.rst rename to docs/source/info/resources/clipboard.rst diff --git a/docs/source/info/dev/dragdrop.rst b/docs/source/info/resources/dragdrop.rst similarity index 100% rename from docs/source/info/dev/dragdrop.rst rename to docs/source/info/resources/dragdrop.rst diff --git a/docs/source/info/resources/index.rst b/docs/source/info/resources/index.rst new file mode 100644 index 00000000..1f19488a --- /dev/null +++ b/docs/source/info/resources/index.rst @@ -0,0 +1,9 @@ +Resources +========= + +.. toctree:: + :caption: Resources + :maxdepth: 1 + :hidden: + + modal \ No newline at end of file diff --git a/docs/source/info/dev/input.rst b/docs/source/info/resources/input.rst similarity index 100% rename from docs/source/info/dev/input.rst rename to docs/source/info/resources/input.rst diff --git a/docs/source/info/resources/modal.rst b/docs/source/info/resources/modal.rst new file mode 100644 index 00000000..b4d1d8c4 --- /dev/null +++ b/docs/source/info/resources/modal.rst @@ -0,0 +1,8 @@ +========================= +Overlay Widgets (Windows) +========================= + +An Overlay Widget is a Widget that is placed on top of any other components. +It is normally used to define toolbox or modal windows. +The routine :class:`~TermTk.TTkCore.helper.TTkHelper` -> :class:`~TermTk.TTkCore.helper.TTkHelper.overlay` is required in order to achieve this + diff --git a/docs/source/info/dev/paint.rst b/docs/source/info/resources/paint.rst similarity index 100% rename from docs/source/info/dev/paint.rst rename to docs/source/info/resources/paint.rst