From 863f2a69325908b4d417ee9d5dca7d01ed2d70ad Mon Sep 17 00:00:00 2001 From: Darren Burns Date: Wed, 14 Sep 2022 16:47:34 +0100 Subject: [PATCH] Add verbose tag to events docs --- docs/events/blur.md | 1 + docs/events/descendant_blur.md | 1 + docs/events/descendant_focus.md | 1 + docs/events/enter.md | 1 + docs/events/focus.md | 1 + docs/events/hide.md | 1 + docs/events/key.md | 1 + docs/events/leave.md | 1 + docs/events/load.md | 1 + docs/events/mount.md | 1 + docs/events/mouse_capture.md | 1 + docs/events/mouse_click.md | 1 + docs/events/mouse_down.md | 1 + docs/events/mouse_move.md | 2 +- docs/events/mouse_release.md | 1 + docs/events/mouse_scroll_down.md | 3 ++- docs/events/mouse_scroll_up.md | 1 + docs/events/mouse_up.md | 2 +- docs/events/paste.md | 1 + docs/events/resize.md | 1 + docs/events/screen_resume.md | 1 + docs/events/screen_suspend.md | 1 + docs/events/show.md | 1 + 23 files changed, 24 insertions(+), 3 deletions(-) diff --git a/docs/events/blur.md b/docs/events/blur.md index b3b0647ae..a9046e3a6 100644 --- a/docs/events/blur.md +++ b/docs/events/blur.md @@ -3,6 +3,7 @@ The `Blur` event is sent to a widget when it loses focus. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/descendant_blur.md b/docs/events/descendant_blur.md index ed768235b..e58e575ab 100644 --- a/docs/events/descendant_blur.md +++ b/docs/events/descendant_blur.md @@ -3,6 +3,7 @@ The `DescendantBlur` event is sent to a widget when one of its children loses focus. - [x] Bubbles +- [x] Verbose ## Attributes diff --git a/docs/events/descendant_focus.md b/docs/events/descendant_focus.md index 6652ad04f..6c5c75b9e 100644 --- a/docs/events/descendant_focus.md +++ b/docs/events/descendant_focus.md @@ -3,6 +3,7 @@ The `DescendantFocus` event is sent to a widget when one of its descendants receives focus. - [x] Bubbles +- [x] Verbose ## Attributes diff --git a/docs/events/enter.md b/docs/events/enter.md index 3c67cf193..ded210cfa 100644 --- a/docs/events/enter.md +++ b/docs/events/enter.md @@ -3,6 +3,7 @@ The `Enter` event is sent to a widget when the mouse pointer first moves over a widget. - [ ] Bubbles +- [x] Verbose ## Attributes diff --git a/docs/events/focus.md b/docs/events/focus.md index 693cc825e..0a9ae1900 100644 --- a/docs/events/focus.md +++ b/docs/events/focus.md @@ -3,6 +3,7 @@ The `Focus` event is sent to a widget when it receives input focus. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/hide.md b/docs/events/hide.md index 659fbdeaf..81cc2a3b7 100644 --- a/docs/events/hide.md +++ b/docs/events/hide.md @@ -3,6 +3,7 @@ The `Hide` event is sent to a widget when it is hidden from view. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/key.md b/docs/events/key.md index cc7e8fb3f..516cdafa6 100644 --- a/docs/events/key.md +++ b/docs/events/key.md @@ -3,6 +3,7 @@ The `Key` event is sent to a widget when the user presses a key on the keyboard. - [x] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/leave.md b/docs/events/leave.md index 94af5f28c..0759a7468 100644 --- a/docs/events/leave.md +++ b/docs/events/leave.md @@ -3,6 +3,7 @@ The `Leave` event is sent to a widget when the mouse pointer moves off a widget. - [ ] Bubbles +- [x] Verbose ## Attributes diff --git a/docs/events/load.md b/docs/events/load.md index e90a3b9ee..07b74eda5 100644 --- a/docs/events/load.md +++ b/docs/events/load.md @@ -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. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/mount.md b/docs/events/mount.md index 2cec12d56..ce664a1aa 100644 --- a/docs/events/mount.md +++ b/docs/events/mount.md @@ -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. - [ ] Bubbles +- [x] Verbose ## Attributes diff --git a/docs/events/mouse_capture.md b/docs/events/mouse_capture.md index 0ee4b94af..56c8b718a 100644 --- a/docs/events/mouse_capture.md +++ b/docs/events/mouse_capture.md @@ -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. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/mouse_click.md b/docs/events/mouse_click.md index 00f6d3b47..cd9ddcdd5 100644 --- a/docs/events/mouse_click.md +++ b/docs/events/mouse_click.md @@ -3,6 +3,7 @@ The `Click` event is sent to a widget when the user clicks a mouse button. - [x] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/mouse_down.md b/docs/events/mouse_down.md index 8cfda384c..eac4585ed 100644 --- a/docs/events/mouse_down.md +++ b/docs/events/mouse_down.md @@ -3,6 +3,7 @@ The `MouseDown` event is sent to a widget when a mouse button is pressed. - [x] Bubbles +- [x] Verbose ## Attributes diff --git a/docs/events/mouse_move.md b/docs/events/mouse_move.md index 21cc56bce..b8d4774ac 100644 --- a/docs/events/mouse_move.md +++ b/docs/events/mouse_move.md @@ -3,6 +3,7 @@ The `MouseMove` event is sent to a widget when the mouse pointer is moved over a widget. - [x] Bubbles +- [x] Verbose ## 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 | | `screen_x` | int | Mouse x coordinate relative to the screen | | `screen_y` | int | Mouse y coordinate relative to the screen | - diff --git a/docs/events/mouse_release.md b/docs/events/mouse_release.md index 3b70ad2d5..efe6b02fd 100644 --- a/docs/events/mouse_release.md +++ b/docs/events/mouse_release.md @@ -3,6 +3,7 @@ The `MouseRelease` event is sent to a widget when it is no longer receiving mouse events outside of its borders. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/mouse_scroll_down.md b/docs/events/mouse_scroll_down.md index 14535f51e..d0e756fbe 100644 --- a/docs/events/mouse_scroll_down.md +++ b/docs/events/mouse_scroll_down.md @@ -3,10 +3,11 @@ The `MouseScrollDown` event is sent to a widget when the scroll wheel (or trackpad equivalent) is moved _down_. - [x] Bubbles +- [x] Verbose ## Attributes | attribute | type | purpose | -| --------- | ---- | -------------------------------------- | +|-----------|------|----------------------------------------| | `x` | int | Mouse x coordinate, relative to Widget | | `y` | int | Mouse y coordinate, relative to Widget | diff --git a/docs/events/mouse_scroll_up.md b/docs/events/mouse_scroll_up.md index ead79e2d8..4d98eea9a 100644 --- a/docs/events/mouse_scroll_up.md +++ b/docs/events/mouse_scroll_up.md @@ -3,6 +3,7 @@ The `MouseScrollUp` event is sent to a widget when the scroll wheel (or trackpad equivalent) is moved _up_. - [x] Bubbles +- [x] Verbose ## Attributes diff --git a/docs/events/mouse_up.md b/docs/events/mouse_up.md index 656f3fde2..5e855e2c9 100644 --- a/docs/events/mouse_up.md +++ b/docs/events/mouse_up.md @@ -3,6 +3,7 @@ The `MouseUp` event is sent to a widget when the user releases a mouse button. - [x] Bubbles +- [x] Verbose ## 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 | | `screen_x` | int | Mouse x coordinate relative to the screen | | `screen_y` | int | Mouse y coordinate relative to the screen | - diff --git a/docs/events/paste.md b/docs/events/paste.md index ac2237a4e..019463c8f 100644 --- a/docs/events/paste.md +++ b/docs/events/paste.md @@ -3,6 +3,7 @@ The `Paste` event is sent to a widget when the user pastes text. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/resize.md b/docs/events/resize.md index 4ccd2e4d4..be57261df 100644 --- a/docs/events/resize.md +++ b/docs/events/resize.md @@ -3,6 +3,7 @@ The `Resize` event is sent to a widget when its size changes and when it is first made visible. - [x] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/screen_resume.md b/docs/events/screen_resume.md index e6b0e9691..13f603d82 100644 --- a/docs/events/screen_resume.md +++ b/docs/events/screen_resume.md @@ -3,6 +3,7 @@ The `ScreenResume` event is sent to a **Screen** when it becomes current. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/screen_suspend.md b/docs/events/screen_suspend.md index d79ed8e13..b5a6d3f4b 100644 --- a/docs/events/screen_suspend.md +++ b/docs/events/screen_suspend.md @@ -3,6 +3,7 @@ The `ScreenSuspend` event is sent to a **Screen** when it is replaced by another screen. - [ ] Bubbles +- [ ] Verbose ## Attributes diff --git a/docs/events/show.md b/docs/events/show.md index a06aed18a..755757459 100644 --- a/docs/events/show.md +++ b/docs/events/show.md @@ -3,6 +3,7 @@ The `Show` event is sent to a widget when it becomes visible. - [ ] Bubbles +- [ ] Verbose ## Attributes