events: update CWindow*

This commit is contained in:
Vaxry 2024-04-27 12:44:12 +01:00
parent c0ef210d31
commit d0c5cf55d8

View file

@ -16,23 +16,23 @@ M: means std::unordered_map<std::string, std::any> following props are members.
| name | description | argument(s) | cancellable | | name | description | argument(s) | cancellable |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| tick | fired on a tick, meaning once per (1000 / highestMonitorHz) ms | nullptr | ✕ | | tick | fired on a tick, meaning once per (1000 / highestMonitorHz) ms | nullptr | ✕ |
| activeWindow | fired on active window change | CWindow* | ✕ | | activeWindow | fired on active window change | PHLWINDOW | ✕ |
| keyboardFocus | fired on keyboard focus change. Contains the newly focused surface | wlr_surface* | ✕ | | keyboardFocus | fired on keyboard focus change. Contains the newly focused surface | wlr_surface* | ✕ |
| moveWorkspace | fired when a workspace changes its monitor | std::vector<std::any>{CWorkspace*, PHLWORKSPACE} | ✕ | | moveWorkspace | fired when a workspace changes its monitor | std::vector<std::any>{CWorkspace*, PHLWORKSPACE} | ✕ |
| focusedMon | fired on monitor focus change | CMonitor* | ✕ | | focusedMon | fired on monitor focus change | CMonitor* | ✕ |
| moveWindow | fired when a window changes workspace | std::vector<std::any>{CWindow*, PHLWORKSPACE} | ✕ | | moveWindow | fired when a window changes workspace | std::vector<std::any>{PHLWINDOW, PHLWORKSPACE} | ✕ |
| openLayer | fired when a LS is mapped | CLayerSurface* | ✕ | | openLayer | fired when a LS is mapped | CLayerSurface* | ✕ |
| closeLayer | fired when a LS is unmapped | CLayerSurface* | ✕ | | closeLayer | fired when a LS is unmapped | CLayerSurface* | ✕ |
| openWindow | fired when a window is mapped | CWindow* | ✕ | | openWindow | fired when a window is mapped | PHLWINDOW | ✕ |
| closeWindow | fired when a window is unmapped | CWindow* | ✕ | | closeWindow | fired when a window is unmapped | PHLWINDOW | ✕ |
| urgent | fired when a window requests urgent | CWindow* | ✕ | | urgent | fired when a window requests urgent | PHLWINDOW | ✕ |
| minimize | fired when a window requests a minimize status change. Second param is 1 or 0 | std::vector<void*>{CWindow*, uint64_t} | ✕ | | minimize | fired when a window requests a minimize status change. Second param is 1 or 0 | std::vector<std::any>{PHLWINDOW, int64_t} | ✕ |
| monitorAdded | fired when a monitor is plugged in | CMonitor* | ✕ | | monitorAdded | fired when a monitor is plugged in | CMonitor* | ✕ |
| monitorRemoved | fired when a monitor is unplugged | CMonitor* | ✕ | | monitorRemoved | fired when a monitor is unplugged | CMonitor* | ✕ |
| createWorkspace | fired when a workspace is created | CWorkspace* | ✕ | | createWorkspace | fired when a workspace is created | CWorkspace* | ✕ |
| destroyWorkspace | fired when a workspace is destroyed | CWorkspace* | ✕ | | destroyWorkspace | fired when a workspace is destroyed | CWorkspace* | ✕ |
| fullscreen | fired when a window changes fullscreen state | CWindow* | ✕ | | fullscreen | fired when a window changes fullscreen state | PHLWINDOW | ✕ |
| changeFloatingMode | fired when a window changes float state | CWindow* | ✕ | | changeFloatingMode | fired when a window changes float state | PHLWINDOW | ✕ |
| workspace | fired on a workspace change (only ones explicitly requested by a user) | CWorkspace* | ✕ | | workspace | fired on a workspace change (only ones explicitly requested by a user) | CWorkspace* | ✕ |
| submap | fired on a submap change | std::string | ✕ | | submap | fired on a submap change | std::string | ✕ |
| mouseMove | fired when the cursor moves. Param is coords. | const Vector2D | ✔ | | mouseMove | fired when the cursor moves. Param is coords. | const Vector2D | ✔ |
@ -45,11 +45,11 @@ M: means std::unordered_map<std::string, std::any> following props are members.
| preRender | fired before a frame for a monitor is about to be rendered | CMonitor* | ✕ | | preRender | fired before a frame for a monitor is about to be rendered | CMonitor* | ✕ |
| screencast | fired when the screencopy state of a client changes. Keep in mind there might be multiple separate clients. | std::vector<uint64_t>{state, framesInHalfSecond, owner} | ✕ | | screencast | fired when the screencopy state of a client changes. Keep in mind there might be multiple separate clients. | std::vector<uint64_t>{state, framesInHalfSecond, owner} | ✕ |
| render | fired at various stages of rendering to allow your plugin to render stuff. See `src/SharedDefs.hpp` for a list with explanations | eRenderStage | ✕ | | render | fired at various stages of rendering to allow your plugin to render stuff. See `src/SharedDefs.hpp` for a list with explanations | eRenderStage | ✕ |
| windowtitle | emitted when a window title changes. | CWindow* | ✕ | | windowtitle | emitted when a window title changes. | PHLWINDOW | ✕ |
| configReloaded | emitted after the config is reloaded | nullptr | ✕ | | configReloaded | emitted after the config is reloaded | nullptr | ✕ |
| preConfigReload | emitted before a config reload | nullptr | ✕ | | preConfigReload | emitted before a config reload | nullptr | ✕ |
| keyPress | emitted on a key press | M: `event`:`wlr_keyboard_key_event*`, `keyboard`:`SKeyboard*` | ✔ | | keyPress | emitted on a key press | M: `event`:`wlr_keyboard_key_event*`, `keyboard`:`SKeyboard*` | ✔ |
| pin | emitted when a window is pinned or unpinned | CWindow* | ✕ | | pin | emitted when a window is pinned or unpinned | PHLWINDOW | ✕ |
| swipeBegin | emitted when a touchpad swipe is commenced | `wlr_pointer_swipe_begin_event*` | ✔ | | swipeBegin | emitted when a touchpad swipe is commenced | `wlr_pointer_swipe_begin_event*` | ✔ |
| swipeUpdate | emitted when a touchpad swipe is updated | `wlr_pointer_swipe_update_event*` | ✔ | | swipeUpdate | emitted when a touchpad swipe is updated | `wlr_pointer_swipe_update_event*` | ✔ |
| swipeEnd | emitted when a touchpad swipe is ended | `wlr_pointer_swipe_end_event*` | ✔ | | swipeEnd | emitted when a touchpad swipe is ended | `wlr_pointer_swipe_end_event*` | ✔ |