PowerToys/src/modules/fancyzones/lib/FancyZones.h

#pragma once

interface IZoneWindow;
interface IFancyZonesSettings;
interface IZoneSet;

interface __declspec(uuid("{50D3F0F5-736E-4186-BDF4-3D6BEE150C3A}")) IFancyZones : public IUnknown
{
    /**
     * Start and initialize FancyZones.
     */
    IFACEMETHOD_(void, Run)() = 0;
    /**
     * Stop FancyZones and do the clean up.
     */
    IFACEMETHOD_(void, Destroy)() = 0;
};

/**
 * Core FancyZones functionality.
 */
interface __declspec(uuid("{2CB37E8F-87E6-4AEC-B4B2-E0FDC873343F}")) IFancyZonesCallback : public IUnknown
{
    /**
     * @returns Boolean indicating whether a move/size operation is currently active.
     */
    IFACEMETHOD_(bool, InMoveSize)() = 0;
     /**
     * A window is being moved or resized. Track down window position and give zone layout
     * hints if dragging functionality is enabled.
     *
     * @param   window   Handle of window being moved or resized.
     * @param   monitor  Handle of monitor on which windows is moving / resizing.
     * @param   ptScreen Cursor coordinates.
     */
    IFACEMETHOD_(void, MoveSizeStart)(HWND window, HMONITOR monitor, POINT const& ptScreen) = 0;
     /**
     * A window has changed location, shape, or size. Track down window position and give zone layout
     * hints if dragging functionality is enabled.
     *
     * @param   monitor  Handle of monitor on which windows is moving / resizing.
     * @param   ptScreen Cursor coordinates.
     */
    IFACEMETHOD_(void, MoveSizeUpdate)(HMONITOR monitor, POINT const& ptScreen) = 0;
    /**
     * The movement or resizing of a window has finished. Assign window to the zone if it
     * is dropped within zone borders.
     *
     * @param   window   Handle of window being moved or resized.
     * @param   ptScreen Cursor coordinates where window is droped.
     */
    IFACEMETHOD_(void, MoveSizeEnd)(HWND window, POINT const& ptScreen) = 0;
    /**
     * Inform FancyZones that user has switched between virtual desktops.
     */
    IFACEMETHOD_(void, VirtualDesktopChanged)() = 0;
    /**
     * Inform FancyZones that new window is created. FancyZones will try to assign it to the
     * zone insde active zone layout (if information about last zone, in which window was located
     * before being closed, is available).
     *
     * @param   window Handle of newly created window.
     */
    IFACEMETHOD_(void, WindowCreated)(HWND window) = 0;
    /**
     * Process keyboard event.
     *
     * @param   info Information about low level keyboard event.
     * @returns Boolean indicating if this event should be passed on further to other applications
     *          in event chain, or should it be suppressed.
     */
    IFACEMETHOD_(bool, OnKeyDown)(PKBDLLHOOKSTRUCT info) = 0;
    /**
     * Toggle FancyZones editor application.
     */
    IFACEMETHOD_(void, ToggleEditor)() = 0;
    /**
     * Callback triggered when user changes FancyZones settings.
     */
    IFACEMETHOD_(void, SettingsChanged)() = 0;
};

/**
 * Helper functions used by each ZoneWindow (representing work area).
 */
interface __declspec(uuid("{5C8D99D6-34B2-4F4A-A8E5-7483F6869775}")) IZoneWindowHost : public IUnknown
{
    /**
     * Assign window to appropriate zone inside new zone layout.
     */
    IFACEMETHOD_(void, MoveWindowsOnActiveZoneSetChange)() = 0;
    /**
     * @returns Color used to highlight zone while giving zone layout hints.
     */
    IFACEMETHOD_(COLORREF, GetZoneHighlightColor)() = 0;
    /**
     * @returns ZoneWindow (representing work area) currently being processed.
     */
    IFACEMETHOD_(IZoneWindow*, GetParentZoneWindow) (HMONITOR monitor) = 0;
    /**
     * @returns Integer in range [0, 100] indicating opacity of highlited zone (while giving zone layout hints).
     */
    IFACEMETHOD_(int, GetZoneHighlightOpacity)() = 0;
};

winrt::com_ptr<IFancyZones> MakeFancyZones(HINSTANCE hinstance, const winrt::com_ptr<IFancyZonesSettings>& settings) noexcept;