Add verbose tag to events docs

This commit is contained in:
Darren Burns
2022-09-14 16:47:34 +01:00
parent bc229b4ee6
commit 863f2a6932
23 changed files with 24 additions and 3 deletions

View File

@@ -3,6 +3,7 @@
The `Blur` event is sent to a widget when it loses focus. The `Blur` event is sent to a widget when it loses focus.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `DescendantBlur` event is sent to a widget when one of its children loses focus. The `DescendantBlur` event is sent to a widget when one of its children loses focus.
- [x] Bubbles - [x] Bubbles
- [x] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `DescendantFocus` event is sent to a widget when one of its descendants receives focus. The `DescendantFocus` event is sent to a widget when one of its descendants receives focus.
- [x] Bubbles - [x] Bubbles
- [x] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Enter` event is sent to a widget when the mouse pointer first moves over a widget. The `Enter` event is sent to a widget when the mouse pointer first moves over a widget.
- [ ] Bubbles - [ ] Bubbles
- [x] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Focus` event is sent to a widget when it receives input focus. The `Focus` event is sent to a widget when it receives input focus.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Hide` event is sent to a widget when it is hidden from view. The `Hide` event is sent to a widget when it is hidden from view.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Key` event is sent to a widget when the user presses a key on the keyboard. The `Key` event is sent to a widget when the user presses a key on the keyboard.
- [x] Bubbles - [x] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Leave` event is sent to a widget when the mouse pointer moves off a widget. The `Leave` event is sent to a widget when the mouse pointer moves off a widget.
- [ ] Bubbles - [ ] Bubbles
- [x] Verbose
## Attributes ## Attributes

View File

@@ -5,6 +5,7 @@ The `Load` event is sent to the app prior to switching the terminal to applicati
The load event is typically used to do any setup actions required by the app that don't change the display. The load event is typically used to do any setup actions required by the app that don't change the display.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -5,6 +5,7 @@ The `Mount` event is sent to a widget and Application when it is first mounted.
The mount event is typically used to set the initial state of a widget or to add new children widgets. The mount event is typically used to set the initial state of a widget or to add new children widgets.
- [ ] Bubbles - [ ] Bubbles
- [x] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `MouseCapture` event is sent to a widget when it is capturing mouse events from outside of its borders on the screen. The `MouseCapture` event is sent to a widget when it is capturing mouse events from outside of its borders on the screen.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Click` event is sent to a widget when the user clicks a mouse button. The `Click` event is sent to a widget when the user clicks a mouse button.
- [x] Bubbles - [x] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `MouseDown` event is sent to a widget when a mouse button is pressed. The `MouseDown` event is sent to a widget when a mouse button is pressed.
- [x] Bubbles - [x] Bubbles
- [x] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `MouseMove` event is sent to a widget when the mouse pointer is moved over a widget. The `MouseMove` event is sent to a widget when the mouse pointer is moved over a widget.
- [x] Bubbles - [x] Bubbles
- [x] Verbose
## Attributes ## Attributes
@@ -18,4 +19,3 @@ The `MouseMove` event is sent to a widget when the mouse pointer is moved over a
| `ctrl` | bool | Ctrl key pressed if True | | `ctrl` | bool | Ctrl key pressed if True |
| `screen_x` | int | Mouse x coordinate relative to the screen | | `screen_x` | int | Mouse x coordinate relative to the screen |
| `screen_y` | int | Mouse y coordinate relative to the screen | | `screen_y` | int | Mouse y coordinate relative to the screen |

View File

@@ -3,6 +3,7 @@
The `MouseRelease` event is sent to a widget when it is no longer receiving mouse events outside of its borders. The `MouseRelease` event is sent to a widget when it is no longer receiving mouse events outside of its borders.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,10 +3,11 @@
The `MouseScrollDown` event is sent to a widget when the scroll wheel (or trackpad equivalent) is moved _down_. The `MouseScrollDown` event is sent to a widget when the scroll wheel (or trackpad equivalent) is moved _down_.
- [x] Bubbles - [x] Bubbles
- [x] Verbose
## Attributes ## Attributes
| attribute | type | purpose | | attribute | type | purpose |
| --------- | ---- | -------------------------------------- | |-----------|------|----------------------------------------|
| `x` | int | Mouse x coordinate, relative to Widget | | `x` | int | Mouse x coordinate, relative to Widget |
| `y` | int | Mouse y coordinate, relative to Widget | | `y` | int | Mouse y coordinate, relative to Widget |

View File

@@ -3,6 +3,7 @@
The `MouseScrollUp` event is sent to a widget when the scroll wheel (or trackpad equivalent) is moved _up_. The `MouseScrollUp` event is sent to a widget when the scroll wheel (or trackpad equivalent) is moved _up_.
- [x] Bubbles - [x] Bubbles
- [x] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `MouseUp` event is sent to a widget when the user releases a mouse button. The `MouseUp` event is sent to a widget when the user releases a mouse button.
- [x] Bubbles - [x] Bubbles
- [x] Verbose
## Attributes ## Attributes
@@ -18,4 +19,3 @@ The `MouseUp` event is sent to a widget when the user releases a mouse button.
| `ctrl` | bool | Ctrl key pressed if True | | `ctrl` | bool | Ctrl key pressed if True |
| `screen_x` | int | Mouse x coordinate relative to the screen | | `screen_x` | int | Mouse x coordinate relative to the screen |
| `screen_y` | int | Mouse y coordinate relative to the screen | | `screen_y` | int | Mouse y coordinate relative to the screen |

View File

@@ -3,6 +3,7 @@
The `Paste` event is sent to a widget when the user pastes text. The `Paste` event is sent to a widget when the user pastes text.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Resize` event is sent to a widget when its size changes and when it is first made visible. The `Resize` event is sent to a widget when its size changes and when it is first made visible.
- [x] Bubbles - [x] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `ScreenResume` event is sent to a **Screen** when it becomes current. The `ScreenResume` event is sent to a **Screen** when it becomes current.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `ScreenSuspend` event is sent to a **Screen** when it is replaced by another screen. The `ScreenSuspend` event is sent to a **Screen** when it is replaced by another screen.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes

View File

@@ -3,6 +3,7 @@
The `Show` event is sent to a widget when it becomes visible. The `Show` event is sent to a widget when it becomes visible.
- [ ] Bubbles - [ ] Bubbles
- [ ] Verbose
## Attributes ## Attributes