KiCad PCB EDA Suite
tool_action.h File Reference
#include <string>
#include <cassert>
#include <wx/string.h>

Go to the source code of this file.

Classes

class  TOOL_ACTION
 Represent a single user action. More...
 

Enumerations

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...
 

Enumeration Type Documentation

◆ TOOL_ACTION_FLAGS

Flags for tool actions.

Enumerator
AF_NONE 
AF_ACTIVATE 

Action activates a tool.

AF_NOTIFY 

Action is a notification (it is by default passed to all tools)

Definition at line 49 of file tool_action.h.

50{
51 AF_NONE = 0,
52 AF_ACTIVATE = 1,
53 AF_NOTIFY = 2
54};
@ AF_ACTIVATE
Action activates a tool.
Definition: tool_action.h:52
@ AF_NOTIFY
Action is a notification (it is by default passed to all tools)
Definition: tool_action.h:53
@ AF_NONE
Definition: tool_action.h:51

◆ TOOL_ACTION_SCOPE

Scope of tool actions.

Enumerator
AS_CONTEXT 

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

AS_ACTIVE 

All active tools.

AS_GLOBAL 

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

Definition at line 41 of file tool_action.h.

42{
43 AS_CONTEXT = 1,
44 AS_ACTIVE,
46};
@ AS_GLOBAL
Global action (toolbar/main menu event, global shortcut)
Definition: tool_action.h:45
@ AS_ACTIVE
All active tools.
Definition: tool_action.h:44
@ AS_CONTEXT
Action belongs to a particular tool (i.e. a part of a pop-up menu)
Definition: tool_action.h:43