KiCad PCB EDA Suite
tool_event.h File Reference
#include <cstdio>
#include <deque>
#include <iterator>
#include <math/vector2d.h>
#include <core/optional.h>
#include <cassert>

Go to the source code of this file.

Classes

class  TOOL_EVENT
 Class TOOL_EVENT. More...
 
class  TOOL_EVENT_LIST
 Class TOOL_EVENT_LIST. More...
 

Typedefs

typedef OPT< TOOL_EVENTOPT_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_CONTEXT_MENU_UPDATE = 0x4000, TA_CONTEXT_MENU_CHOICE = 0x8000,
  TA_CONTEXT_MENU_CLOSED = 0x10000, TA_CONTEXT_MENU = TA_CONTEXT_MENU_UPDATE | TA_CONTEXT_MENU_CHOICE | TA_CONTEXT_MENU_CLOSED, TA_UNDO_REDO_PRE = 0x20000, TA_UNDO_REDO_POST = 0x40000,
  TA_ACTION = 0x80000, TA_ACTIVATE = 0x100000, TA_MODEL_CHANGE = 0x200000, TA_ANY = 0xffffffff
}
 
enum  TOOL_MOUSE_BUTTONS {
  BUT_NONE = 0x0, BUT_LEFT = 0x1, BUT_RIGHT = 0x2, BUT_MIDDLE = 0x4,
  BUT_BUTTON_MASK = BUT_LEFT | BUT_RIGHT | BUT_MIDDLE, 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  TOOL_ACTION_SCOPE { AS_CONTEXT = 1, AS_ACTIVE, AS_GLOBAL }
 Scope of tool actions. More...
 
enum  TOOL_ACTION_FLAGS { AF_NONE = 0, AF_ACTIVATE = 1, AF_NOTIFY = 2 }
 Flags for tool actions. More...
 
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

Definition at line 495 of file tool_event.h.

Enumeration Type Documentation

Defines when a context menu is opened.

Enumerator
CMENU_BUTTON 
CMENU_NOW 
CMENU_OFF 

Definition at line 156 of file tool_event.h.

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

Flags for tool actions.

Enumerator
AF_NONE 
AF_ACTIVATE 
AF_NOTIFY 

Action activates a tool

Definition at line 148 of file tool_event.h.

149 {
150  AF_NONE = 0,
151  AF_ACTIVATE = 1,
152  AF_NOTIFY = 2
153 };
Action activates a tool
Definition: tool_event.h:152

Scope of tool actions.

Enumerator
AS_CONTEXT 
AS_ACTIVE 

Action belongs to a particular tool (i.e. a part of a pop-up menu)

AS_GLOBAL 

All active tools

Global action (toolbar/main menu event, global shortcut)

Definition at line 140 of file tool_event.h.

141 {
142  AS_CONTEXT = 1,
143  AS_ACTIVE,
144  AS_GLOBAL
145 };
Action belongs to a particular tool (i.e. a part of a pop-up menu)
Definition: tool_event.h:143
All active tools
Definition: tool_event.h:144
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_CONTEXT_MENU_UPDATE 
TA_CONTEXT_MENU_CHOICE 
TA_CONTEXT_MENU_CLOSED 
TA_CONTEXT_MENU 
TA_UNDO_REDO_PRE 
TA_UNDO_REDO_POST 
TA_ACTION 
TA_ACTIVATE 
TA_MODEL_CHANGE 
TA_ANY 

Definition at line 61 of file tool_event.h.

62 {
63  // UI input events
64  TA_NONE = 0x0000,
65  TA_MOUSE_CLICK = 0x0001,
66  TA_MOUSE_DBLCLICK = 0x0002,
67  TA_MOUSE_UP = 0x0004,
68  TA_MOUSE_DOWN = 0x0008,
69  TA_MOUSE_DRAG = 0x0010,
70  TA_MOUSE_MOTION = 0x0020,
71  TA_MOUSE_WHEEL = 0x0040,
72  TA_MOUSE = 0x007f,
73 
74  TA_KEY_PRESSED = 0x0080,
76 
77  // View related events
78  TA_VIEW_REFRESH = 0x0100,
79  TA_VIEW_ZOOM = 0x0200,
80  TA_VIEW_PAN = 0x0400,
81  TA_VIEW_DIRTY = 0x0800,
82  TA_VIEW = 0x0f00,
83 
84  TA_CHANGE_LAYER = 0x1000,
85 
86  // Tool cancel event. Issued automagically when the user hits escape or selects End Tool from
87  // the context menu.
88  TA_CANCEL_TOOL = 0x2000,
89 
90  // Context menu update. Issued whenever context menu is open and the user hovers the mouse
91  // over one of choices. Used in dynamic highligting in disambiguation menu
92  TA_CONTEXT_MENU_UPDATE = 0x4000,
93 
94  // Context menu choice. Sent if the user picked something from the context menu or
95  // closed it without selecting anything.
96  TA_CONTEXT_MENU_CHOICE = 0x8000,
97 
98  // Context menu is closed, no matter whether anything has been chosen or not.
99  TA_CONTEXT_MENU_CLOSED = 0x10000,
100 
102 
103  // This event is sent *before* undo/redo command is performed.
104  TA_UNDO_REDO_PRE = 0x20000,
105 
106  // This event is sent *after* undo/redo command is performed.
107  TA_UNDO_REDO_POST = 0x40000,
108 
109  // Tool action (allows one to control tools).
110  TA_ACTION = 0x80000,
111 
112  // Tool activation event.
113  TA_ACTIVATE = 0x100000,
114 
115  // Model has changed (partial update).
116  TA_MODEL_CHANGE = 0x200000,
117 
118  TA_ANY = 0xffffffff
119 };

Internal (GUI-independent) event definitions.

Enums are mostly self-explanatory.

Enumerator
TC_NONE 
TC_MOUSE 
TC_KEYBOARD 
TC_COMMAND 
TC_MESSAGE 
TC_VIEW 
TC_ANY 

Definition at line 50 of file tool_event.h.

51 {
52  TC_NONE = 0x00,
53  TC_MOUSE = 0x01,
54  TC_KEYBOARD = 0x02,
55  TC_COMMAND = 0x04,
56  TC_MESSAGE = 0x08,
57  TC_VIEW = 0x10,
58  TC_ANY = 0xffffffff
59 };
Enumerator
MD_SHIFT 
MD_CTRL 
MD_ALT 
MD_MODIFIER_MASK 

Definition at line 131 of file tool_event.h.

132 {
133  MD_SHIFT = 0x1000,
134  MD_CTRL = 0x2000,
135  MD_ALT = 0x4000,
137 };
Enumerator
BUT_NONE 
BUT_LEFT 
BUT_RIGHT 
BUT_MIDDLE 
BUT_BUTTON_MASK 
BUT_ANY 

Definition at line 121 of file tool_event.h.

122 {
123  BUT_NONE = 0x0,
124  BUT_LEFT = 0x1,
125  BUT_RIGHT = 0x2,
126  BUT_MIDDLE = 0x4,
128  BUT_ANY = 0xffffffff
129 };

Function Documentation

const TOOL_EVENT_LIST operator|| ( const TOOL_EVENT aEventA,
const TOOL_EVENT aEventB 
)
inline

Definition at line 613 of file tool_event.h.

References TOOL_EVENT_LIST::Add().

614 {
615  TOOL_EVENT_LIST l;
616 
617  l.Add( aEventA );
618  l.Add( aEventB );
619 
620  return l;
621 }
Class TOOL_EVENT_LIST.
Definition: tool_event.h:503
void Add(const TOOL_EVENT &aEvent)
Function Add() Adds a tool event to the list.
Definition: tool_event.h:542
const TOOL_EVENT_LIST operator|| ( const TOOL_EVENT aEvent,
const TOOL_EVENT_LIST aEventList 
)
inline

Definition at line 623 of file tool_event.h.

References TOOL_EVENT_LIST::Add().

625 {
626  TOOL_EVENT_LIST l( aEventList );
627 
628  l.Add( aEvent );
629  return l;
630 }
Class TOOL_EVENT_LIST.
Definition: tool_event.h:503