Browse Source

Restructured doc folders

pull/216/head
Eugenio Parodi 2 years ago
parent
commit
85ec8d7c26
  1. 3
      TermTk/TTkCore/helper.py
  2. 3
      docs/MDNotes/Games.md
  3. 1
      docs/source/index.rst
  4. 0
      docs/source/info/resources/clipboard.rst
  5. 0
      docs/source/info/resources/dragdrop.rst
  6. 9
      docs/source/info/resources/index.rst
  7. 0
      docs/source/info/resources/input.rst
  8. 8
      docs/source/info/resources/modal.rst
  9. 0
      docs/source/info/resources/paint.rst

3
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)

3
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
*
* Pacman (Does not require long keypresses)
* Nibbles (Does not require long keypresses)

1
docs/source/index.rst

@ -74,6 +74,7 @@ Intro
info/installing
info/debug
info/resources/index
.. toctree::

0
docs/source/info/dev/clipboard.rst → docs/source/info/resources/clipboard.rst

0
docs/source/info/dev/dragdrop.rst → docs/source/info/resources/dragdrop.rst

9
docs/source/info/resources/index.rst

@ -0,0 +1,9 @@
Resources
=========
.. toctree::
:caption: Resources
:maxdepth: 1
:hidden:
modal

0
docs/source/info/dev/input.rst → docs/source/info/resources/input.rst

8
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

0
docs/source/info/dev/paint.rst → docs/source/info/resources/paint.rst

Loading…
Cancel
Save