pulp::view::win_input::PointerSession Class Reference

Host-neutral model of the single Win32 capture bracket owned by an editor. More...

#include <win_pointer_input.hpp>

Classes
struct	Terminal

Public Types
enum class	Phase {   idle , raw , gesture_candidate , gesture_claimed ,   terminal }

Public Member Functions
bool	begin (MouseButton button) noexcept
bool	active () const noexcept
bool	accepts (MouseButton button) const noexcept
bool	accepts (uint64_t generation, MouseButton button) const noexcept
bool	gesture_in_flight () const noexcept
bool	claimed () const noexcept
MouseButton	button () const noexcept
Phase	phase () const noexcept
uint64_t	generation () const noexcept
void	mark_claimed () noexcept
Terminal	terminalize () noexcept
void	finish_terminal (const Terminal &terminal) noexcept

Detailed Description

Host-neutral model of the single Win32 capture bracket owned by an editor.

Win32 can synchronously re-enter the wndproc from capture calls and view callbacks, so transitions must be visible before those calls happen.

Member Enumeration Documentation

Phase

enum class pulp::view::win_input::PointerSession::Phase

strong

Enumerator
idle
raw
gesture_candidate
gesture_claimed
terminal

Member Function Documentation

accepts() [1/2]

bool pulp::view::win_input::PointerSession::accepts ( MouseButton button ) const

inlinenoexcept

accepts() [2/2]

bool pulp::view::win_input::PointerSession::accepts ( uint64_t generation, MouseButton button ) const

inlinenoexcept

active()

bool pulp::view::win_input::PointerSession::active ( ) const

inlinenoexcept

begin()

bool pulp::view::win_input::PointerSession::begin ( MouseButton button )

inlinenoexcept

button()

MouseButton pulp::view::win_input::PointerSession::button ( ) const

inlinenoexcept

claimed()

bool pulp::view::win_input::PointerSession::claimed ( ) const

inlinenoexcept

finish_terminal()

void pulp::view::win_input::PointerSession::finish_terminal ( const Terminal & terminal )

inlinenoexcept

generation()

uint64_t pulp::view::win_input::PointerSession::generation ( ) const

inlinenoexcept

gesture_in_flight()

bool pulp::view::win_input::PointerSession::gesture_in_flight ( ) const

inlinenoexcept

mark_claimed()

void pulp::view::win_input::PointerSession::mark_claimed ( )

inlinenoexcept

phase()

Phase pulp::view::win_input::PointerSession::phase ( ) const

inlinenoexcept

terminalize()

Terminal pulp::view::win_input::PointerSession::terminalize ( )

inlinenoexcept

---

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

• /home/runner/work/pulp/pulp/core/view/include/pulp/view/platform/win_pointer_input.hpp