overlay_dismissal.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/view/view.hpp>
 
#include <cstdint>
 
namespace pulp::view {
 
// ── An overlay's anchor: the trigger that opened it ─────────────────────────
//
// A press on an overlay's own anchor while it is open means "close it", exactly
// like a press outside it or Escape: the overlay is dismissed and the press is
// spent on the close, so the trigger's handler cannot run on the same press and
// open it again. That is what makes a dropdown button TOGGLE. A press on a
// DIFFERENT trigger still switches menus in one press
// (`OverlayDismissalPolicy::trigger_press_passes_through`).
//
// Most overlays never declare one. `route_press_to_active_overlay` records the
// `View::overlay_trigger()` each press is delivered to
// (`RootInteractionState::pending_overlay_opener`), and a claim that follows
// adopts it, which covers every press-opened `@pulp/react`, web-compat, and
// imported popover. Declare it with `View::set_overlay_anchor` when the
// overlay opens some other way — from the keyboard, from a timer — or when its
// opener is not marked as a trigger; an explicit anchor is never replaced by
// the recorded one. The press's NEAREST trigger decides: a trigger between the
// hit view and the anchor means that nearer trigger, not the anchor.

enum class OverlayPressRouting {
    no_overlay,
    routed,
    not_hittable,
    dismissed,
};
 
struct OverlayPressTarget {
    OverlayPressRouting routing = OverlayPressRouting::no_overlay;
    View* target = nullptr;
    bool consume_press = false;
    bool trigger_closed = false;
};

struct OverlayDismissalPolicy {
    bool trigger_press_passes_through = true;

    bool passive_input_outside_overlay_blocked = true;
};

const OverlayDismissalPolicy& overlay_dismissal_policy();
void set_overlay_dismissal_policy(const OverlayDismissalPolicy& policy);

OverlayPressTarget route_press_to_active_overlay(View& root, Point root_pt);

View* hover_target_at(View& root, Point root_pt);

struct PassivePointerRoute {
    View* target = nullptr;
    bool blocked = false;
    View* overlay = nullptr;
};

PassivePointerRoute route_passive_pointer(View& root, Point root_pt);

struct ContextPressResult {
    bool handled = false;
    bool overlay_dismissed = false;
};

ContextPressResult route_context_press(View& root, Point root_pt);

enum class OverlayEscapeResult {
    none,
    modal,
    combo_popup,
    overlay,
};

OverlayEscapeResult route_escape_to_active_overlay(View& root,
                                                   std::uint16_t modifiers = 0,
                                                   bool is_repeat = false);

bool root_overlay_owns_keyboard(View& root);
 
}  // namespace pulp::view