hyprwm/hyprland-wiki
1
0
Fork 0
mirror of https://github.com/hyprwm/hyprland-wiki.git synced 2024-11-26 06:25:59 +01:00
Code Issues Projects Releases Packages Wiki Activity

add cancellable events

Browse source
This commit is contained in:
Vaxry 2023-10-21 14:59:42 +01:00
parent 66d346ec1c
commit edcb741ed1
1 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
pages/Plugins/Development/Event-list.md
View file

@ -3,33 +3,33 @@ These are all the events that can be listened to using Event Hooks.
## Complete list ## Complete list
| name | description | argument(s) | | 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 | CWindow* | ✕ |
| 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<void*>{CWorkspace*, CMonitor*} | | moveWorkspace | fired when a workspace changes its monitor | std::vector<void*>{CWorkspace*, CMonitor*} | ✕ |
| focusedMon | fired on monitor focus change | CMonitor* | | focusedMon | fired on monitor focus change | CMonitor* | ✕ |
| moveWindow | fired when a window changes workspace | std::vector<void*>{CWindow*, CWorkspace*} | | moveWindow | fired when a window changes workspace | std::vector<void*>{CWindow*, CWorkspace*} | ✕ |
| 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 | CWindow* | ✕ |
| closeWindow | fired when a window is unmapped | CWindow* | | closeWindow | fired when a window is unmapped | CWindow* | ✕ |
| urgent | fired when a window requests urgent | CWindow* | | urgent | fired when a window requests urgent | CWindow* | ✕ |
| 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<void*>{CWindow*, uint64_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 | CWindow* | ✕ |
| changeFloatingMode | fired when a window changes float state | CWindow* | | changeFloatingMode | fired when a window changes float state | CWindow* | ✕ |
| 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 | ✔ |
| mouseButton | fired on a mouse button press | wlr_pointer_button_event* | | mouseButton | fired on a mouse button press | wlr_pointer_button_event* | ✔ |
| activeLayout | fired on a keyboard layout change. String pointer temporary, not guaranteed after execution of the handler finishes. | std::vector<void*>{SKeyboard*, std::string*} | | activeLayout | fired on a keyboard layout change. String pointer temporary, not guaranteed after execution of the handler finishes. | std::vector<void*>{SKeyboard*, std::string*} | ✕ |
| 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. | CWindow* | ✕ |
| configReloaded | emitted after the config is reloaded | nullptr | | configReloaded | emitted after the config is reloaded | nullptr | ✕ |