Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
pyrustic committed Sep 1, 2021
1 parent 07783c0 commit fe5f855
Show file tree
Hide file tree
Showing 40 changed files with 269 additions and 756 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Intro Text -->
# Megawidget
<b> A collection of useful widgets for your Tkinter Python apps </b>

This project is part of the [Pyrustic Open Ecosystem](https://pyrustic.github.io).

<!-- Quick Links -->
[Installation](#installation) | [Reference](https://github.com/pyrustic/megawidget/tree/master/docs/reference#readme)

## Overview
The `megawidgets` are extensively used in multiple projects:
- [Hubstore](https://github.com/pyrustic/hubstore): a desktop app to distribute, promote, discover, manage, install, and run Python apps.
- [Dresscode](https://github.com/pyrustic/dresscode): high-productivity framework to build desktop apps.
- [Jupitest](https://github.com/pyrustic/jupitest): graphical test runner.
- [Rustiql](https://github.com/pyrustic/rustiql): graphical SQLite editor.
- and more...

Read the [reference](https://github.com/pyrustic/megawidget/tree/master/docs/reference#readme) !

## Installation
```bash
pip install megawidget
```
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.0.2
0.0.3
38 changes: 9 additions & 29 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,38 @@

# Reference Overview

[megawidget.\_\_init\_\_](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.\_\_init\_\_.md)
[megawidget.\_\_init\_\_](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.\_\_init\_\_.md#megawidget\_\_init\_\_)
<br>


[megawidget.\_\_main\_\_](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.\_\_main\_\_.md)
[megawidget.\_\_main\_\_](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.\_\_main\_\_.md#megawidget\_\_main\_\_)
<br>


[megawidget.choice](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.choice.md)
[megawidget.choice](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.choice.md#megawidgetchoice)
<br>


[megawidget.confirm](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.confirm.md)
[megawidget.confirm](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.confirm.md#megawidgetconfirm)
<br>


[megawidget.hooking.\_\_init\_\_](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.hooking.\_\_init\_\_.md)
[megawidget.pathentry](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.pathentry.md#megawidgetpathentry)
<br>


[megawidget.hooking.ante\_build\_hook](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.hooking.ante\_build\_hook.md)
[megawidget.scrollbox](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.scrollbox.md#megawidgetscrollbox)
<br>


[megawidget.hooking.ante\_release\_hook](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.hooking.ante\_release\_hook.md)
[megawidget.table](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.table.md#megawidgettable)
<br>


[megawidget.hooking.post\_build\_hook](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.hooking.post\_build\_hook.md)
[megawidget.toast](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.toast.md#megawidgettoast)
<br>


[megawidget.hooking.post\_release\_hook](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.hooking.post\_release\_hook.md)
<br>


[megawidget.pathentry](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.pathentry.md)
<br>


[megawidget.scrollbox](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.scrollbox.md)
<br>


[megawidget.table](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.table.md)
<br>


[megawidget.toast](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.toast.md)
<br>


[megawidget.tree](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.tree.md)
[megawidget.tree](https://github.com/pyrustic/megawidget/blob/master/docs/reference/content/megawidget.tree.md#megawidgettree)
<br>

34 changes: 17 additions & 17 deletions docs/reference/content/megawidget.choice.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class Choice:
root.mainloop()
"""

def __init__(self, master=None, title=None, header=None, message=None, items=None, selected=None, flavor='radio', handler=None, geometry=None, cnfs=None):
def __init__(self, master=None, title=None, header=None, message=None, items=None, selected=None, flavor='radio', handler=None, geometry=None, megaconfig=None):
"""
PARAMETERS:
Expand Down Expand Up @@ -108,22 +108,6 @@ class Choice:
LABEL_MESSAGE: {"background": "black"} }
"""

@property
def components(self):
"""
Get the components (widgets instances) used to build this dialog.
This property returns a dict. The keys are:
BODY, LABEL_HEADER, SCROLLBOX, LABEL_MESSAGE,
FRAME_PANE, FRAME_FOOTER, BUTTON_CONTINUE, BUTTON_CANCEL,
RADIOBUTTONS, CHECKBUTTONS.
Warning: radiobuttons and checkbuttons are sequences of widgets positioned
in the sequence according to the index.
Another Warning: check the presence of key before usage.
"""

@property
def flavor(self):
"""
Expand Down Expand Up @@ -154,6 +138,22 @@ class Choice:
"""

@property
def parts(self):
"""
Get the parts (widgets instances) used to build this dialog.
This property returns a dict. The keys are:
BODY, LABEL_HEADER, SCROLLBOX, LABEL_MESSAGE,
FRAME_PANE, FRAME_FOOTER, BUTTON_CONTINUE, BUTTON_CANCEL,
RADIOBUTTONS, CHECKBUTTONS.
Warning: radiobuttons and checkbuttons are sequences of widgets positioned
in the sequence according to the index.
Another Warning: check the presence of key before usage.
"""

@property
def selected(self):
"""
Expand Down
26 changes: 13 additions & 13 deletions docs/reference/content/megawidget.confirm.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class Confirm:
root.mainloop()
"""

def __init__(self, master=None, title=None, header=None, message=None, handler=None, geometry=None, cnfs=None):
def __init__(self, master=None, title=None, header=None, message=None, handler=None, geometry=None, megaconfig=None):
"""
PARAMETERS:
Expand Down Expand Up @@ -76,18 +76,6 @@ class Confirm:
LABEL_MESSAGE: {"background": "black"} }
"""

@property
def components(self):
"""
Get the components (widgets instances) used to build this dialog.
This property returns a dict. The keys are:
BODY, LABEL_HEADER,
LABEL_MESSAGE, FRAME_FOOTER, BUTTON_CANCEL, BUTTON_CONFIRM
Warning: check the presence of key before usage
"""

@property
def handler(self):
"""
Expand All @@ -112,6 +100,18 @@ class Confirm:
Returns True if user confirmed, else get False
"""

@property
def parts(self):
"""
Get the parts (widgets instances) used to build this dialog.
This property returns a dict. The keys are:
BODY, LABEL_HEADER,
LABEL_MESSAGE, FRAME_FOOTER, BUTTON_CANCEL, BUTTON_CONFIRM
Warning: check the presence of key before usage
"""

```

<br>
Expand Down
10 changes: 0 additions & 10 deletions docs/reference/content/megawidget.hooking.__init__.md

This file was deleted.

31 changes: 0 additions & 31 deletions docs/reference/content/megawidget.hooking.ante_build_hook.md

This file was deleted.

83 changes: 0 additions & 83 deletions docs/reference/content/megawidget.hooking.ante_release_hook.md

This file was deleted.

31 changes: 0 additions & 31 deletions docs/reference/content/megawidget.hooking.post_build_hook.md

This file was deleted.

Loading

0 comments on commit fe5f855

Please sign in to comment.