KiCad PCB EDA Suite
ACTIONS Class Referenceabstract

Class ACTIONS. More...

#include <actions.h>

Inheritance diagram for ACTIONS:
GERBVIEW_ACTIONS PCB_ACTIONS

Public Types

enum  CURSOR_EVENT_TYPE {
  CURSOR_UP, CURSOR_DOWN, CURSOR_LEFT, CURSOR_RIGHT,
  CURSOR_CLICK, CURSOR_DBL_CLICK, CURSOR_FAST_MOVE = 0x8000
}
 

Cursor control event types

More...
 
enum  REMOVE_FLAGS { REMOVE_FLAGS::NORMAL = 0x00, REMOVE_FLAGS::ALT = 0x01 }
 

Remove event modifier flags

More...
 

Public Member Functions

virtual ~ACTIONS ()
 
virtual OPT< TOOL_EVENTTranslateLegacyId (int aId)=0
 Function TranslateLegacyId() Translates legacy tool ids to the corresponding TOOL_ACTION name. More...
 
virtual void RegisterAllTools (TOOL_MANAGER *aToolManager)=0
 

Registers all valid tools for an application with the tool manager

More...
 

Static Public Attributes

static TOOL_ACTION cancelInteractive
 
static TOOL_ACTION zoomIn
 
static TOOL_ACTION zoomOut
 
static TOOL_ACTION zoomInCenter
 
static TOOL_ACTION zoomOutCenter
 
static TOOL_ACTION zoomCenter
 
static TOOL_ACTION zoomFitScreen
 
static TOOL_ACTION zoomPreset
 
static TOOL_ACTION zoomTool
 
static TOOL_ACTION gridFast1
 
static TOOL_ACTION gridFast2
 
static TOOL_ACTION gridNext
 
static TOOL_ACTION gridPrev
 
static TOOL_ACTION gridSetOrigin
 
static TOOL_ACTION gridResetOrigin
 
static TOOL_ACTION gridPreset
 

Detailed Description

Class ACTIONS.

Gathers all the actions that are shared by tools. The instance of a subclass of ACTIONS is created inside of ACTION_MANAGER object that registers the actions.

Definition at line 41 of file actions.h.

Member Enumeration Documentation

Cursor control event types

Enumerator
CURSOR_UP 
CURSOR_DOWN 
CURSOR_LEFT 
CURSOR_RIGHT 
CURSOR_CLICK 
CURSOR_DBL_CLICK 
CURSOR_FAST_MOVE 

Definition at line 82 of file actions.h.

enum ACTIONS::REMOVE_FLAGS
strong

Remove event modifier flags

Enumerator
NORMAL 
ALT 

Definition at line 86 of file actions.h.

86 { NORMAL = 0x00, ALT = 0x01 };

Constructor & Destructor Documentation

virtual ACTIONS::~ACTIONS ( )
inlinevirtual

Definition at line 45 of file actions.h.

45 {};

Member Function Documentation

virtual void ACTIONS::RegisterAllTools ( TOOL_MANAGER aToolManager)
pure virtual

Registers all valid tools for an application with the tool manager

Implemented in PCB_ACTIONS, and GERBVIEW_ACTIONS.

Referenced by GERBVIEW_FRAME::setupTools().

virtual OPT<TOOL_EVENT> ACTIONS::TranslateLegacyId ( int  aId)
pure virtual

Function TranslateLegacyId() Translates legacy tool ids to the corresponding TOOL_ACTION name.

Parameters
aIdis legacy tool id to be translated.
Returns
std::string is name of the corresponding TOOL_ACTION. It may be empty, if there is no corresponding TOOL_ACTION.

Implemented in PCB_ACTIONS, and GERBVIEW_ACTIONS.

Referenced by TOOL_DISPATCHER::DispatchWxCommand().

Member Data Documentation

TOOL_ACTION ACTIONS::cancelInteractive
static
TOOL_ACTION ACTIONS::gridFast1
static

Definition at line 61 of file actions.h.

Referenced by PCBNEW_CONTROL::setTransitions().

TOOL_ACTION ACTIONS::gridFast2
static

Definition at line 62 of file actions.h.

Referenced by PCBNEW_CONTROL::setTransitions().

TOOL_ACTION ACTIONS::gridNext
static

Definition at line 63 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

TOOL_ACTION ACTIONS::gridPreset
static

Definition at line 67 of file actions.h.

Referenced by GRID_MENU::eventHandler(), and COMMON_TOOLS::setTransitions().

TOOL_ACTION ACTIONS::gridPrev
static

Definition at line 64 of file actions.h.

Referenced by COMMON_TOOLS::setTransitions().

TOOL_ACTION ACTIONS::gridResetOrigin
static

Definition at line 66 of file actions.h.

Referenced by PCBNEW_CONTROL::setTransitions().

TOOL_ACTION ACTIONS::gridSetOrigin
static
TOOL_ACTION ACTIONS::zoomCenter
static

Definition at line 55 of file actions.h.

Referenced by TOOL_MENU::AddStandardSubMenus(), and COMMON_TOOLS::setTransitions().

TOOL_ACTION ACTIONS::zoomIn
static
TOOL_ACTION ACTIONS::zoomOut
static
TOOL_ACTION ACTIONS::zoomPreset
static

Definition at line 57 of file actions.h.

Referenced by ZOOM_MENU::eventHandler(), and COMMON_TOOLS::setTransitions().

TOOL_ACTION ACTIONS::zoomTool
static

The documentation for this class was generated from the following files: