pulp::view::OverlayPressTarget Struct Reference

#include <overlay_dismissal.hpp>

Public Attributes
OverlayPressRouting	routing = OverlayPressRouting::no_overlay
View *	target = nullptr
	Non-null only when routing == OverlayPressRouting::routed.
bool	consume_press = false
	True when an outside press dismissed an overlay that opted to consume that initiating pointer sequence.
bool	trigger_closed = false
	The press landed on the anchor of an overlay it dismissed — the button that opened that dropdown — so it was a TOGGLE: the overlay closed, and the press is consumed so the trigger cannot reopen it on the same gesture.

Member Data Documentation

consume_press

bool pulp::view::OverlayPressTarget::consume_press = false

True when an outside press dismissed an overlay that opted to consume that initiating pointer sequence.

Hosts must stop before gesture and ordinary hit-test routing so the same press cannot mutate the underlay.

False even for such an overlay when the press landed on an overlay TRIGGER and OverlayDismissalPolicy::trigger_press_passes_through is set: switching dropdowns is one press, not two.

Always true when the press landed on the trigger that OPENED a dismissed overlay (trigger_closed), whatever that overlay's own setting.

routing

OverlayPressRouting pulp::view::OverlayPressTarget::routing = OverlayPressRouting::no_overlay

target

View* pulp::view::OverlayPressTarget::target = nullptr

Non-null only when routing == OverlayPressRouting::routed.

trigger_closed

bool pulp::view::OverlayPressTarget::trigger_closed = false

The press landed on the anchor of an overlay it dismissed — the button that opened that dropdown — so it was a TOGGLE: the overlay closed, and the press is consumed so the trigger cannot reopen it on the same gesture.

The third dismissal reason alongside an outside press and Escape; see the anchor section above.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/core/view/include/pulp/view/overlay_dismissal.hpp