Hyprland/src/layout/IHyprLayout.hpp

119 lines
3.8 KiB
C++
Raw Normal View History

#pragma once
#include "../defines.hpp"
#include "../Window.hpp"
struct SWindowRenderLayoutHints {
bool isBorderColor = false;
CColor borderColor;
};
2022-05-16 17:37:46 +02:00
struct SLayoutMessageHeader {
CWindow* pWindow = nullptr;
};
enum eFullscreenMode : uint8_t;
interface IHyprLayout {
public:
2022-03-21 19:18:33 +01:00
/*
Called when a window is created (mapped)
2022-05-14 16:43:30 +02:00
The layout HAS TO set the goal pos and size (anim mgr will use it)
If !animationinprogress, then the anim mgr will not apply an anim.
2022-03-21 19:18:33 +01:00
*/
2022-03-20 11:14:24 +01:00
virtual void onWindowCreated(CWindow*) = 0;
2022-03-21 19:18:33 +01:00
/*
Called when a window is removed (unmapped)
*/
2022-03-20 11:14:24 +01:00
virtual void onWindowRemoved(CWindow*) = 0;
2022-03-21 19:18:33 +01:00
/*
2022-04-02 20:04:32 +02:00
Called when the monitor requires a layout recalculation
2022-03-21 19:18:33 +01:00
this usually means reserved area changes
*/
2022-03-20 11:14:24 +01:00
virtual void recalculateMonitor(const int&) = 0;
2022-04-02 20:04:32 +02:00
/*
Called when the compositor requests a window
to be recalculated, e.g. when pseudo is toggled.
*/
virtual void recalculateWindow(CWindow*) = 0;
2022-03-21 19:18:33 +01:00
/*
Called when a window is requested to be floated
*/
2022-03-20 11:14:24 +01:00
virtual void changeWindowFloatingMode(CWindow*) = 0;
2022-03-21 19:18:33 +01:00
/*
Called when a window is clicked on, beginning a drag
this might be a resize, move, whatever the layout defines it
as.
*/
2022-03-20 11:14:24 +01:00
virtual void onBeginDragWindow() = 0;
2022-06-06 19:32:14 +02:00
/*
Called when a user requests a resize of the current window by a vec
Vector2D holds pixel values
Optional pWindow for a specific window
*/
virtual void resizeActiveWindow(const Vector2D&, CWindow* pWindow = nullptr) = 0;
/*
Called when a user requests a move of the current window by a vec
Vector2D holds pixel values
Optional pWindow for a specific window
*/
virtual void moveActiveWindow(const Vector2D&, CWindow* pWindow = nullptr) = 0;
2022-04-03 13:49:21 +02:00
/*
Called when a window is ended being dragged
(mouse up)
*/
virtual void onEndDragWindow() = 0;
2022-03-21 19:18:33 +01:00
/*
Called whenever the mouse moves, should the layout want to
do anything with it.
Useful for dragging.
*/
2022-03-20 11:14:24 +01:00
virtual void onMouseMove(const Vector2D&) = 0;
2022-03-21 19:18:33 +01:00
/*
Called when a window is created, but is requesting to be floated.
Warning: this also includes stuff like popups, incorrect handling
of which can result in a crash!
*/
2022-03-20 13:37:07 +01:00
virtual void onWindowCreatedFloating(CWindow*) = 0;
2022-03-21 19:18:33 +01:00
/*
Called when a window / the user requests to toggle the fullscreen state of a window
2022-03-21 19:18:33 +01:00
The layout sets all the fullscreen flags.
It can either accept or ignore.
*/
virtual void fullscreenRequestForWindow(CWindow*, eFullscreenMode) = 0;
2022-03-21 19:18:33 +01:00
/*
2022-05-16 17:37:46 +02:00
Called when a dispatcher requests a custom message
The layout is free to ignore.
std::any is the reply. Can be empty.
*/
virtual std::any layoutMessage(SLayoutMessageHeader, std::string) = 0;
/*
Required to be handled, but may return just SWindowRenderLayoutHints()
Called when the renderer requests any special draw flags for
a specific window, e.g. border color for groups.
*/
virtual SWindowRenderLayoutHints requestRenderHints(CWindow*) = 0;
2022-04-20 16:18:58 +02:00
/*
Called when the user requests two windows to be swapped places.
The layout is free to ignore.
*/
virtual void switchWindows(CWindow*, CWindow*) = 0;
2022-04-20 16:53:41 +02:00
/*
Called when the user requests to change the splitratio by X
on a window
*/
virtual void alterSplitRatioBy(CWindow*, float) = 0;
/*
Called when something wants the current layout's name
*/
virtual std::string getLayoutName() = 0;
};