KiCad PCB EDA Suite
Loading...
Searching...
No Matches
tool_action.h File Reference
#include <any>
#include <cassert>
#include <optional>
#include <string>
#include <string_view>
#include <wx/string.h>

Go to the source code of this file.

Classes

class  TOOL_ACTION_GROUP
 Define a group that can be used to group actions (and their events) of similar operations. More...
 
class  TOOL_ACTION_ARGS
 Build up the properties of a TOOL_ACTION in an incremental manner that is static-construction safe. More...
 
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 52 of file tool_action.h.

◆ 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 44 of file tool_action.h.