#include <picker_tool.h>

Inheritance diagram for PICKER_TOOL_BASE:

Public Types
enum	pickerEndState { WAIT_CANCEL , CLICK_CANCEL , END_ACTIVATE , EVT_CANCEL , EXCEPTION_CANCEL }

typedef std::function< bool(const VECTOR2D &)>	CLICK_HANDLER
	Event handler types.

typedef std::function< void(const VECTOR2D &)>	MOTION_HANDLER

typedef std::function< void(void)>	CANCEL_HANDLER

typedef std::function< void(const int &)>	FINALIZE_HANDLER

typedef std::function< bool(void)>	AREA_HANDLER
	Called once a rubber-band drag has left its result in the selection.

Public Member Functions
	PICKER_TOOL_BASE ()

virtual	~PICKER_TOOL_BASE ()=default

void	SetCursor (KICURSOR aCursor)

void	SetSnapping (bool aSnap)

void	ClearHandlers ()

void	SetClickHandler (CLICK_HANDLER aHandler)
	Set a handler for mouse click event.

void	SetMotionHandler (MOTION_HANDLER aHandler)
	Set a handler for mouse motion.

void	SetAreaHandler (AREA_HANDLER aHandler)
	Set a handler for a rubber-band drag.

void	SetCancelHandler (CANCEL_HANDLER aHandler)
	Set a handler for cancel events (ESC or context-menu Cancel).

void	SetFinalizeHandler (FINALIZE_HANDLER aHandler)
	Set a handler for the finalize event.

int	CurrentModifiers () const

Protected Member Functions
virtual void	reset ()
	Reinitializes tool to its initial state.

Protected Attributes
EDA_DRAW_FRAME *	m_frame

KICURSOR	m_cursor

bool	m_snap

int	m_modifiers

std::optional< CLICK_HANDLER >	m_clickHandler

std::optional< MOTION_HANDLER >	m_motionHandler

std::optional< AREA_HANDLER >	m_areaHandler

std::optional< CANCEL_HANDLER >	m_cancelHandler

std::optional< FINALIZE_HANDLER >	m_finalizeHandler

std::optional< VECTOR2D >	m_picked

Detailed Description

Definition at line 32 of file picker_tool.h.

Member Typedef Documentation

◆ AREA_HANDLER

typedef std::function<bool(void)> PICKER_TOOL_BASE::AREA_HANDLER

Called once a rubber-band drag has left its result in the selection.

Definition at line 42 of file picker_tool.h.

◆ CANCEL_HANDLER

typedef std::function<void(void)> PICKER_TOOL_BASE::CANCEL_HANDLER

Definition at line 38 of file picker_tool.h.

◆ CLICK_HANDLER

typedef std::function<bool(const VECTOR2D&)> PICKER_TOOL_BASE::CLICK_HANDLER

Event handler types.

Definition at line 36 of file picker_tool.h.

◆ FINALIZE_HANDLER

typedef std::function<void(const int&)> PICKER_TOOL_BASE::FINALIZE_HANDLER

Definition at line 39 of file picker_tool.h.

◆ MOTION_HANDLER

typedef std::function<void(const VECTOR2D&)> PICKER_TOOL_BASE::MOTION_HANDLER

Definition at line 37 of file picker_tool.h.

Member Enumeration Documentation

◆ pickerEndState

enum PICKER_TOOL_BASE::pickerEndState

Enumerator
WAIT_CANCEL
CLICK_CANCEL
END_ACTIVATE
EVT_CANCEL
EXCEPTION_CANCEL

Definition at line 44 of file picker_tool.h.

Constructor & Destructor Documentation

◆ PICKER_TOOL_BASE()

PICKER_TOOL_BASE::PICKER_TOOL_BASE ( )

inline

Definition at line 53 of file picker_tool.h.

References m_frame, m_modifiers, m_snap, and reset().

Referenced by PCB_PICKER_TOOL::PCB_PICKER_TOOL(), PICKER_TOOL::PICKER_TOOL(), and PICKER_TOOL::PICKER_TOOL().

◆ ~PICKER_TOOL_BASE()

virtual PICKER_TOOL_BASE::~PICKER_TOOL_BASE ( )

virtualdefault

Member Function Documentation

◆ ClearHandlers()

void PICKER_TOOL_BASE::ClearHandlers ( )

inline

Definition at line 67 of file picker_tool.h.

References m_areaHandler, m_cancelHandler, m_clickHandler, m_finalizeHandler, and m_motionHandler.

Referenced by PCB_PICKER_TOOL::ClearHandlers(), SCH_EDITOR_CONTROL::HighlightNetCursor(), SCH_TOOL_BASE< T >::InteractiveDelete(), SCH_EDITOR_CONTROL::SimProbe(), and SCH_EDITOR_CONTROL::SimTune().

◆ CurrentModifiers()

int PICKER_TOOL_BASE::CurrentModifiers ( ) const

inline

Definition at line 130 of file picker_tool.h.

References m_modifiers.

Referenced by PCB_PICKER_TOOL::SelectPointInteractively().

◆ reset()

void PICKER_TOOL_BASE::reset ( )

protectedvirtual

Reinitializes tool to its initial state.

Reimplemented in PCB_PICKER_TOOL.

Definition at line 28 of file picker_tool.cpp.

References ARROW, m_areaHandler, m_cancelHandler, m_clickHandler, m_cursor, m_finalizeHandler, m_motionHandler, m_picked, and m_snap.

Referenced by PICKER_TOOL::Main(), PICKER_TOOL_BASE(), and PCB_PICKER_TOOL::reset().

◆ SetAreaHandler()

void PICKER_TOOL_BASE::SetAreaHandler ( AREA_HANDLER aHandler )

inline

Set a handler for a rubber-band drag.

The picker otherwise swallows it.

The drag runs the selection tool's own area loop, so the selection already holds what the box caught. Return true to stay armed, as with the click handler.

Definition at line 104 of file picker_tool.h.

References m_areaHandler.

Referenced by MATCH_PROPERTIES_TOOL::runInteractive().