#include <cstdio>
#include <deque>
#include <iterator>
#include <math/vector2d.h>
#include <optional>
#include <tool/tool_action.h>

Classes
class	TOOL_EVENT
	Generic, UI-independent tool event. More...

class	TOOL_EVENT_LIST
	A list of TOOL_EVENTs, with overloaded \|\| operators allowing for concatenating TOOL_EVENTs with little code. More...

Typedefs
typedef std::optional< TOOL_EVENT >	OPT_TOOL_EVENT

Enumerations
enum	TOOL_EVENT_CATEGORY { TC_NONE = 0x00 , TC_MOUSE = 0x01 , TC_KEYBOARD = 0x02 , TC_COMMAND = 0x04 , TC_MESSAGE = 0x08 , TC_VIEW = 0x10 , TC_ANY = 0xffffffff }
	Internal (GUI-independent) event definitions. More...

enum	TOOL_ACTIONS { TA_NONE = 0x0000 , TA_MOUSE_CLICK = 0x0001 , TA_MOUSE_DBLCLICK = 0x0002 , TA_MOUSE_UP = 0x0004 , TA_MOUSE_DOWN = 0x0008 , TA_MOUSE_DRAG = 0x0010 , TA_MOUSE_MOTION = 0x0020 , TA_MOUSE_WHEEL = 0x0040 , TA_MOUSE = 0x007f , TA_KEY_PRESSED = 0x0080 , TA_KEYBOARD = TA_KEY_PRESSED , TA_VIEW_REFRESH = 0x0100 , TA_VIEW_ZOOM = 0x0200 , TA_VIEW_PAN = 0x0400 , TA_VIEW_DIRTY = 0x0800 , TA_VIEW = 0x0f00 , TA_CHANGE_LAYER = 0x1000 , TA_CANCEL_TOOL = 0x2000 , TA_CHOICE_MENU_UPDATE = 0x4000 , TA_CHOICE_MENU_CHOICE = 0x8000 , TA_CHOICE_MENU_CLOSED = 0x10000 , TA_CHOICE_MENU = TA_CHOICE_MENU_UPDATE \| TA_CHOICE_MENU_CHOICE \| TA_CHOICE_MENU_CLOSED , TA_UNDO_REDO_PRE = 0x20000 , TA_UNDO_REDO_POST = 0x40000 , TA_ACTION = 0x80000 , TA_ACTIVATE = 0x100000 , TA_REACTIVATE = 0x200000 , TA_MODEL_CHANGE = 0x400000 , TA_PRIME = 0x800001 , TA_ANY = 0xffffffff }

enum	TOOL_MOUSE_BUTTONS { BUT_NONE = 0x0 , BUT_LEFT = 0x1 , BUT_RIGHT = 0x2 , BUT_MIDDLE = 0x4 , BUT_AUX1 = 0x8 , BUT_AUX2 = 0x10 , BUT_BUTTON_MASK = BUT_LEFT \| BUT_RIGHT \| BUT_MIDDLE \| BUT_AUX1 \| BUT_AUX2 , BUT_ANY = 0xffffffff }

enum	TOOL_MODIFIERS { MD_SHIFT = 0x1000 , MD_CTRL = 0x2000 , MD_ALT = 0x4000 , MD_MODIFIER_MASK = MD_SHIFT \| MD_CTRL \| MD_ALT }

enum	CONTEXT_MENU_TRIGGER { CMENU_BUTTON = 0 , CMENU_NOW , CMENU_OFF }
	Defines when a context menu is opened. More...

Functions
const TOOL_EVENT_LIST	operator\|\| (const TOOL_EVENT &aEventA, const TOOL_EVENT &aEventB)

const TOOL_EVENT_LIST	operator\|\| (const TOOL_EVENT &aEvent, const TOOL_EVENT_LIST &aEventList)

Typedef Documentation

◆ OPT_TOOL_EVENT

typedef std::optional<TOOL_EVENT> OPT_TOOL_EVENT

Definition at line 557 of file tool_event.h.

Enumeration Type Documentation

◆ CONTEXT_MENU_TRIGGER

enum CONTEXT_MENU_TRIGGER

Defines when a context menu is opened.

Enumerator
CMENU_BUTTON
CMENU_NOW
CMENU_OFF

Definition at line 145 of file tool_event.h.

{
 CMENU_BUTTON = 0, // On the right button
 CMENU_NOW, // Right now (after TOOL_INTERACTIVE::SetContextMenu)
 CMENU_OFF // Never
};

◆ TOOL_ACTIONS

enum TOOL_ACTIONS

Enumerator
TA_NONE
TA_MOUSE_CLICK
TA_MOUSE_DBLCLICK
TA_MOUSE_UP
TA_MOUSE_DOWN
TA_MOUSE_DRAG
TA_MOUSE_MOTION
TA_MOUSE_WHEEL
TA_MOUSE
TA_KEY_PRESSED
TA_KEYBOARD
TA_VIEW_REFRESH
TA_VIEW_ZOOM
TA_VIEW_PAN
TA_VIEW_DIRTY
TA_VIEW
TA_CHANGE_LAYER
TA_CANCEL_TOOL
TA_CHOICE_MENU_UPDATE
TA_CHOICE_MENU_CHOICE
TA_CHOICE_MENU_CLOSED
TA_CHOICE_MENU
TA_UNDO_REDO_PRE
TA_UNDO_REDO_POST
TA_ACTION
TA_ACTIVATE
TA_REACTIVATE
TA_MODEL_CHANGE
TA_PRIME
TA_ANY

Definition at line 58 of file tool_event.h.

{
 // UI input events
 TA_NONE = 0x0000,
 TA_MOUSE_CLICK = 0x0001,
 TA_MOUSE_DBLCLICK = 0x0002,
 TA_MOUSE_UP = 0x0004,
 TA_MOUSE_DOWN = 0x0008,
 TA_MOUSE_DRAG = 0x0010,
 TA_MOUSE_MOTION = 0x0020,
 TA_MOUSE_WHEEL = 0x0040,
 TA_MOUSE = 0x007f,
 
 TA_KEY_PRESSED = 0x0080,
 TA_KEYBOARD = TA_KEY_PRESSED,
 
 // View related events
 TA_VIEW_REFRESH = 0x0100,
 TA_VIEW_ZOOM = 0x0200,
 TA_VIEW_PAN = 0x0400,
 TA_VIEW_DIRTY = 0x0800,
 TA_VIEW = 0x0f00,
 
 TA_CHANGE_LAYER = 0x1000,
 
 // Tool cancel event. Issued automagically when the user hits escape or selects End Tool from
 // the context menu.
 TA_CANCEL_TOOL = 0x2000,
 
 // Context menu update. Issued whenever context menu is open and the user hovers the mouse
 // over one of choices. Used in dynamic highlighting in disambiguation menu
 TA_CHOICE_MENU_UPDATE = 0x4000,
 
 // Context menu choice. Sent if the user picked something from the context menu or
 // closed it without selecting anything.
 TA_CHOICE_MENU_CHOICE = 0x8000,
 
 // Context menu is closed, no matter whether anything has been chosen or not.
 TA_CHOICE_MENU_CLOSED = 0x10000,
 
 TA_CHOICE_MENU = TA_CHOICE_MENU_UPDATE | TA_CHOICE_MENU_CHOICE | TA_CHOICE_MENU_CLOSED,
 
 // This event is sent *before* undo/redo command is performed.
 TA_UNDO_REDO_PRE = 0x20000,
 
 // This event is sent *after* undo/redo command is performed.
 TA_UNDO_REDO_POST = 0x40000,
 
 // Tool action (allows one to control tools).
 TA_ACTION = 0x80000,
 
 // Tool activation event.
 TA_ACTIVATE = 0x100000,
 
 // Tool re-activation event for tools already on the stack
 TA_REACTIVATE = 0x200000,
 
 // Model has changed (partial update).
 TA_MODEL_CHANGE = 0x400000,
 
 // Tool priming event (a special mouse click)
 TA_PRIME = 0x800001,
 
 TA_ANY = 0xffffffff
};

◆ TOOL_EVENT_CATEGORY

enum TOOL_EVENT_CATEGORY

Internal (GUI-independent) event definitions.

Enumerator
TC_NONE
TC_MOUSE
TC_KEYBOARD
TC_COMMAND
TC_MESSAGE
TC_VIEW
TC_ANY

Definition at line 47 of file tool_event.h.

{
 TC_NONE = 0x00,
 TC_MOUSE = 0x01,
 TC_KEYBOARD = 0x02,
 TC_COMMAND = 0x04,
 TC_MESSAGE = 0x08,
 TC_VIEW = 0x10,
 TC_ANY = 0xffffffff
};

◆ TOOL_MODIFIERS

enum TOOL_MODIFIERS

Enumerator
MD_SHIFT
MD_CTRL
MD_ALT
MD_MODIFIER_MASK

Definition at line 136 of file tool_event.h.

{
 MD_SHIFT = 0x1000,
 MD_CTRL = 0x2000,
 MD_ALT = 0x4000,
 MD_MODIFIER_MASK = MD_SHIFT | MD_CTRL | MD_ALT,
};

◆ TOOL_MOUSE_BUTTONS

enum TOOL_MOUSE_BUTTONS

Enumerator
BUT_NONE
BUT_LEFT
BUT_RIGHT
BUT_MIDDLE
BUT_AUX1
BUT_AUX2
BUT_BUTTON_MASK
BUT_ANY

Definition at line 124 of file tool_event.h.

{
 BUT_NONE = 0x0,
 BUT_LEFT = 0x1,
 BUT_RIGHT = 0x2,
 BUT_MIDDLE = 0x4,
 BUT_AUX1 = 0x8,
 BUT_AUX2 = 0x10,
 BUT_BUTTON_MASK = BUT_LEFT | BUT_RIGHT | BUT_MIDDLE | BUT_AUX1 | BUT_AUX2,
 BUT_ANY = 0xffffffff
};

Function Documentation

◆ operator||() [1/2]

const TOOL_EVENT_LIST operator\|\|	(	const TOOL_EVENT &	aEvent,
		const TOOL_EVENT_LIST &	aEventList
	)

inline

Definition at line 693 of file tool_event.h.

{
 TOOL_EVENT_LIST l( aEventList );
 
 l.Add( aEvent );
 return l;
}

References TOOL_EVENT_LIST::Add().

◆ operator||() [2/2]

const TOOL_EVENT_LIST operator\|\|	(	const TOOL_EVENT &	aEventA,
		const TOOL_EVENT &	aEventB
	)