From e11660127659e85af68a53be32be68de664c5a04 Mon Sep 17 00:00:00 2001 From: Eugenio Parodi Date: Wed, 26 Apr 2023 13:07:31 +0100 Subject: [PATCH] Added Examples in the doc --- docs/source/index.rst | 2 + tutorial/000-examples.rst | 50 ++++++++++++++++++++++ tutorial/examples/README.md | 25 ----------- tutorial/examples/README.rst | 1 + tutorial/examples/TTkLineEdit/Events.01.py | 41 ++++++++++++++++++ 5 files changed, 94 insertions(+), 25 deletions(-) create mode 100644 tutorial/000-examples.rst delete mode 100644 tutorial/examples/README.md create mode 120000 tutorial/examples/README.rst create mode 100755 tutorial/examples/TTkLineEdit/Events.01.py diff --git a/docs/source/index.rst b/docs/source/index.rst index e71b294b..460692a5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,6 +26,8 @@ Intro :maxdepth: 1 :caption: Tutorials + tutorial/000-examples.rst + tutorial/001-helloworld.rst tutorial/002-layout.rst tutorial/003-signalslots.rst diff --git a/tutorial/000-examples.rst b/tutorial/000-examples.rst new file mode 100644 index 00000000..6153885c --- /dev/null +++ b/tutorial/000-examples.rst @@ -0,0 +1,50 @@ +.. _pyTermTk: https://github.com/ceccopierangiolieugenio/pyTermTk +.. _TermTk: https://github.com/ceccopierangiolieugenio/pyTermTk + +======================== +pyTermTk_ - < **Examples** > +======================== + +TTkLineEdit +=========== + +Init +---- + +`TTkLineEdit/Init.01.py `_ - (`try Online `_) + +.. code:: bash + + # to run it just exec: + tutorial/examples/TTkLineEdit/Init.01.py + # or + python3 tutorial/examples/TTkLineEdit/Init.01.py + +Set/Get Text +------------ + +`TTkLineEdit/SetGet.01.py `_ - (`try Online `_) + +.. code:: bash + + # to run it just exec: + tutorial/examples/TTkLineEdit/SetGet.01.py + # or + python3 tutorial/examples/TTkLineEdit/SetGet.01.py + +Events +------ +TBD + +TTkTextEdit +=========== + +Set/Get/Append Text +------------------- +TBD + +Export +------ +TBD + +pippo \ No newline at end of file diff --git a/tutorial/examples/README.md b/tutorial/examples/README.md deleted file mode 100644 index ecb36161..00000000 --- a/tutorial/examples/README.md +++ /dev/null @@ -1,25 +0,0 @@ -## TTkLineEdit -### Init - -[TTkLineEdit/Init.01.py](TTkLineEdit/Init.01.py) - ([try Online](https://ceccopierangiolieugenio.github.io/pyTermTk/sandbox/sandbox.html?fileUri=https://raw.githubusercontent.com/ceccopierangiolieugenio/pyTermTk/main/tutorial/examples/TTkLineEdit/Init.01.py)) -```bash -# to run it just exec: -tutorial/examples/TTkLineEdit/Init.01.py -# or -python3 tutorial/examples/TTkLineEdit/Init.01.py -``` -### Set/Get Text -[TTkLineEdit/SetGet.01.py](TTkLineEdit/SetGet.01.py) - ([try Online](https://ceccopierangiolieugenio.github.io/pyTermTk/sandbox/sandbox.html?fileUri=https://raw.githubusercontent.com/ceccopierangiolieugenio/pyTermTk/main/tutorial/examples/TTkLineEdit/SetGet.01.py)) -```bash -# to run it just exec: -tutorial/examples/TTkLineEdit/SetGet.01.py -# or -python3 tutorial/examples/TTkLineEdit/SetGet.01.py -``` -### Events -TBD -## TTkTextEdit -### Set/Get/Append Text -TBD -### Export -TBD \ No newline at end of file diff --git a/tutorial/examples/README.rst b/tutorial/examples/README.rst new file mode 120000 index 00000000..0cb2e3b4 --- /dev/null +++ b/tutorial/examples/README.rst @@ -0,0 +1 @@ +../000-examples.rst \ No newline at end of file diff --git a/tutorial/examples/TTkLineEdit/Events.01.py b/tutorial/examples/TTkLineEdit/Events.01.py new file mode 100755 index 00000000..f05be4b4 --- /dev/null +++ b/tutorial/examples/TTkLineEdit/Events.01.py @@ -0,0 +1,41 @@ +#!/usr/bin/env python3 + +# MIT License +# +# Copyright (c) 2023 Eugenio Parodi +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +# Those 2 lines are required to use the TermTk library straight from the main folder +import sys, os +sys.path.append(os.path.join(sys.path[0],'../../..')) + +import TermTk as ttk + +root=ttk.TTk() + +le1 = ttk.TTkLineEdit(parent=root, pos=(2,2), size=(20,1)) +le1.setText("This is a Test") + +txt = le1.text() + +le2 = ttk.TTkLineEdit(parent=root, pos=(2,5), size=(20,1)) +le2.setText(txt) + +root.mainloop() \ No newline at end of file