Merge pull request #295 from lawsie/dev

0.6.4
lawsie · May 8, 2019 · 3686851 · 3686851
2 parents 84c7f0b + a8ec9ea
commit 3686851
Show file tree

Hide file tree

Showing 79 changed files with 4,692 additions and 1,831 deletions.
diff --git a/docs-src/docs/about.md b/docs-src/docs/about.md
@@ -32,6 +32,6 @@ The aim of guizero is to make the process of creating simple GUIs quick, accessi
 
 ### Version
 
-guizero is currently [version 0.6.3](changelog.md)
+guizero is currently [version 0.6.4](changelog.md)
 
 There may be bugs and features may change and be updated.
diff --git a/docs-src/docs/app.md b/docs-src/docs/app.md
@@ -2,7 +2,17 @@
 
 (Contains a `tkinter.Tk` object)
 
-`__init__(self, title="guizero", width=500, height=500, layout="auto", bgcolor=None, bg=None, visible=True)`
+```python
+__init__(
+    self, 
+    title="guizero", 
+    width=500, 
+    height=500, 
+    layout="auto", 
+    bgcolor=None, 
+    bg=None, 
+    visible=True)
+```
 
 ### What is it?
 The `App` object is the basis of all GUIs created using guizero. It is the main window which contains all of the other widgets.

diff --git a/docs-src/docs/box.md b/docs-src/docs/box.md
@@ -2,7 +2,19 @@
 
 (Contains a `tkinter.Frame` object)
 
-`__init__(self, master, layout="auto", grid=None, align=None, visible=True, enabled=None)`
+```python
+__init__(
+    self,
+    master,
+    layout="auto",
+    grid=None,
+    align=None,
+    visible=True,
+    enabled=None,
+    width=None,
+    height=None,
+    border=None)
+```
 
 ### What is it?
 The `Box` object is an invisible container which can contain other widgets. It is the only object other than `App` which can act as the `master` for other objects and can have its own layout manager.

diff --git a/docs-src/docs/buttongroup.md b/docs-src/docs/buttongroup.md
@@ -2,7 +2,22 @@
 
 (Contains a `tkinter.Frame` object)
 
-`__init__(self, master, options=[], selected=None, horizontal=False, command=None, grid=None, align=None, args=None, visible=True, enabled=None)`
+```python
+__init__(
+    self,
+    master,
+    options=[],
+    selected=None,
+    horizontal=False,
+    command=None,
+    grid=None,
+    align=None,
+    args=None,
+    visible=True,
+    enabled=None,
+    width=None,
+    height=None)
+```
 
 ### What is it?
 The `ButtonGroup` object displays a group of radio buttons, allowing the user to choose a single option.

diff --git a/docs-src/docs/changelog.md b/docs-src/docs/changelog.md
@@ -1,5 +1,12 @@
 # guizero
 
+## 0.6.4 - 2019-05-08
+- Fixed TextBox command to be on key release
+- Fix Text not inheriting properties
+- Added add_tk_warning when inserting a tk widget into the wrong container
+- Update docs
+- contributors [martinohanlon](https://github.com/martinohanlon), [hyle01](https://github.com/hyle01) 
+
 ## 0.6.3 - 2019-04-18
 - ListBox scrollbar bug fix (again)
 - Removed pillow requires dependency

diff --git a/docs-src/docs/checkbox.md b/docs-src/docs/checkbox.md
@@ -2,7 +2,20 @@
 
 (Contains a `tkinter.Checkbutton` object)
 
-`__init__(self, master, text, command=None, grid=None, align=None, args=None, visible=True, enabled=None)`
+```python
+__init__(
+    self,
+    master,
+    text="",
+    command=None,
+    grid=None,
+    align=None,
+    args=None,
+    visible=True,
+    enabled=None,
+    width=None,
+    height=None)
+```
 
 ### What is it?
 The `CheckBox` object displays a check box to allow an option to be ticked or unticked

diff --git a/docs-src/docs/combo.md b/docs-src/docs/combo.md
@@ -2,7 +2,20 @@
 
 (Contains a `tkinter.OptionMenu` object)
 
-`__init__(self, master, options=[], selected=None, command=None, grid=None, align=None, visible=True, enabled=None)`
+```python
+__init__(
+    self,
+    master,
+    options=[],
+    selected=None,
+    command=None,
+    grid=None,
+    align=None,
+    visible=True,
+    enabled=None,
+    width=None,
+    height=None)
+```
 
 ### What is it?
 The `Combo` object displays a drop down box allowing a single option to be selected from a list of options.

diff --git a/docs-src/docs/drawing.md b/docs-src/docs/drawing.md
@@ -2,7 +2,17 @@
 
 (Contains a `tkinter.canvas` object)
 
-`__init__(self, master, width=100, height=100, grid=None, align=None, visible=True, enabled=None):`
+```python
+__init__(
+    self, 
+    master, 
+    width=100, 
+    height=100, 
+    grid=None, 
+    align=None, 
+    visible=True, 
+    enabled=None)
+```
 
 ### What is it?
 The `Drawing` object allows shapes, images and text to be created.

diff --git a/docs-src/docs/listbox.md b/docs-src/docs/listbox.md
@@ -2,7 +2,22 @@
 
 (Contains a `tkinter.Listbox` object)
 
-`__init__(self, master, items=None, selected=None, command=None, grid=None, align=None, visible=True, enabled=None, multiselect=False, scrollbar=False)`
+```python
+__init__(
+    self,
+    master,
+    items=None,
+    selected=None,
+    command=None,
+    grid=None,
+    align=None,
+    visible=True,
+    enabled=None,
+    multiselect=False,
+    scrollbar=False,
+    width=None,
+    height=None)
+```
 
 ### What is it?
 The `ListBox` object displays a list of items from which either single or multiple items can be selected.

diff --git a/docs-src/docs/menubar.md b/docs-src/docs/menubar.md
@@ -2,7 +2,13 @@
 
 (Contains a `tkinter.Menu` object)
 
-`__init__(self, master, toplevel, options)`
+```python
+__init__(
+    self, 
+    master, 
+    toplevel, 
+    options)
+```
 
 ### What is it?
 The `MenuBar` object displays a menu at the top of the screen, with each menu option leading to a submenu.

diff --git a/docs-src/docs/multiple_windows.md b/docs-src/docs/multiple_windows.md
@@ -38,7 +38,7 @@ When a `Window` object is created it is immediately displayed on the screen, you
 To make a window which is shown when a button on the `App` is clicked and closed when a button is clicked on the `Window`.
 
 ```python
-from guizero import App, Window
+from guizero import App, Window, PushButton
 
 def open_window():
     window.show()

diff --git a/docs-src/docs/picture.md b/docs-src/docs/picture.md
@@ -2,7 +2,18 @@
 
 (Contains a `tkinter.Label` object)
 
-`__init__(self, master, image=None, grid=None, align=None, visible=True, enabled=None)`
+```python
+__init__(
+    self, 
+    master, 
+    image=None, 
+    grid=None, 
+    align=None, 
+    visible=True, 
+    enabled=None, 
+    width=None, 
+    height=None)
+```
 
 ### What is it?
 The `Picture` object displays an image.

diff --git a/docs-src/docs/pushbutton.md b/docs-src/docs/pushbutton.md
@@ -2,7 +2,24 @@
 
 (Contains a `tkinter.Button` object)
 
-`__init__(self, master, command=None, args=None, text="Button", image=None, pady=10, padx=10, grid=None, align=None, visible=True, enabled=None)`
+```python
+__init__(
+    self,
+    master,
+    command=None,
+    args=None,
+    text="Button",
+    image=None,
+    pady=10,
+    padx=10,
+    grid=None,
+    align=None,
+    icon=None,
+    visible=True,
+    enabled=None,
+    width=None,
+    height=None)
+```
 
 ### What is it?
 The `PushButton` object displays a button with text or an image, which calls a function when pressed.
@@ -16,7 +33,7 @@ Create a `PushButton` object like this:
 ```python
 from guizero import App, PushButton
 def do_nothing():
-  print("Button was pressed")
+    print("Button was pressed")
 
 app = App()
 button = PushButton(app, command=do_nothing)
@@ -28,7 +45,7 @@ Create a picture `PushButton` with an image like this:
 ```python
 from guizero import App, PushButton
 def do_nothing():
-  print("A picture button was pressed")
+    print("A picture button was pressed")
 
 app = App()
 button = PushButton(app, image="button.gif", command=do_nothing)

diff --git a/docs-src/docs/slider.md b/docs-src/docs/slider.md
@@ -2,7 +2,21 @@
 
 (Contains a `tkinter.Scale` object)
 
-`__init__(self, master, start=0, end=100, horizontal=True, command=None, grid=None, align=None)`
+```python
+__init__(
+    self, 
+    master, 
+    start=0, 
+    end=100, 
+    horizontal=True, 
+    command=None, 
+    grid=None, 
+    align=None, 
+    visible=True, 
+    enabled=None, 
+    width=None, 
+    height=None)
+```
 
 ### What is it?
 The `Slider` object displays a bar and selector which can be used to specify a value in a range.

diff --git a/docs-src/docs/text.md b/docs-src/docs/text.md
@@ -2,7 +2,22 @@
 
 (Contains a `tkinter.Label` object)
 
-`__init__(self, master, text="", size=12, color="black", bg=None, font="Helvetica", grid=None, align=None, visible=True, enabled=None)`
+```python
+__init__(
+    self,
+    master,
+    text="",
+    size=12,
+    color="black",
+    bg=None,
+    font="Helvetica",
+    grid=None,
+    align=None,
+    visible=True,
+    enabled=None,
+    width=None,
+    height=None)
+```
 
 ### What is it?
 The `Text` object displays non editable text in your app, useful for titles, labels and instructions.

diff --git a/docs-src/docs/textbox.md b/docs-src/docs/textbox.md
@@ -2,7 +2,21 @@
 
 (Contains a `tkinter.Entry` object)
 
-`__init__(self, master, text="", width=10, height=1, grid=None, align=None, visible=True, enabled=None, multiline=False, scrollbar=False, command=None)`
+```python
+__init__(
+    self,
+    master,
+    text="",
+    width=10,
+    height=1,
+    grid=None,
+    align=None,
+    visible=True,
+    enabled=None,
+    multiline=False,
+    scrollbar=False,
+    command=None)
+```
 
 ### What is it
 The `TextBox` object displays a text box which the user can type in.

diff --git a/docs-src/docs/usingtk.md b/docs-src/docs/usingtk.md
@@ -23,6 +23,14 @@ app.add_tk_widget(spinbox)
 a.display()
 ```
 
+When adding a tk widget to a `Box` or a `Window` you will have to specify its `tk` property when creating the tk widget.
+
+```python
+box = Box(app)
+spinbox = Spinbox(box.tk, from_=0, to=10)
+box.add_tk_widget(spinbox)
+```
+
 ### Using a tkinter method on a guizero object
 
 Each guizero widget itself contains a tk widget - you can find out which by looking on the guizero documentation page for the widget. For example, a guizero `TextBox` contains a tkinter `Entry` object. You can access the internal object using the syntax `<object_name>.tk`.

diff --git a/docs-src/docs/waffle.md b/docs-src/docs/waffle.md
@@ -2,7 +2,24 @@
 
 (Contains a `tkinter.Frame` object)
 
-`__init__(self, master, height=3, width=3, dim=20, pad=5, color="white", dotty=False, grid=None, align=None, command=None, visible=True, enabled=None, bg=None)`
+```python
+__init__(
+    self, 
+    master, 
+    height=3, 
+    width=3, 
+    dim=20, 
+    pad=5, 
+    color="white", 
+    dotty=False, 
+    grid=None, 
+    align=None, 
+    command=None, 
+    remember=True, 
+    visible=True, 
+    enabled=None, 
+    bg=None)
+```
 
 ### What is it
 The `Waffle` object display an n*n grid of squares with custom dimensions and padding

diff --git a/docs-src/docs/window.md b/docs-src/docs/window.md
@@ -2,7 +2,17 @@
 
 (Contains a `tkinter.TopLevel` object)
 
-`__init__(self, master, title="guizero", width=500, height=500, layout="auto", bg=None, visible=True):`
+```python
+__init__(
+    self, 
+    master, 
+    title="guizero", 
+    width=500, 
+    height=500, 
+    layout="auto", 
+    bg=None, 
+    visible=True)
+```
 
 ### What is it?
 A `Window` object is how you create new windows in guizero.