kicad/eeschema/tools/ee_actions.h

250 lines
7.8 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019 CERN
* Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef EESCHEMA_ACTIONS_H
#define EESCHEMA_ACTIONS_H
#include <tool/tool_action.h>
#include <tool/actions.h>
#include <core/optional.h>
class TOOL_EVENT;
class TOOL_MANAGER;
/**
* Gather all the actions that are shared by tools. The instance of SCH_ACTIONS is created
* inside of ACTION_MANAGER object that registers the actions.
*/
class EE_ACTIONS : public ACTIONS
{
public:
// Selection Tool
/// Activation of the selection tool
static TOOL_ACTION selectionActivate;
/// Select the junction, wire or bus segment under the cursor.
static TOOL_ACTION selectNode;
/// If current selection is a wire or bus, expand to entire connection.
/// Otherwise, select connection under cursor.
static TOOL_ACTION selectConnection;
/// Clears the current selection
static TOOL_ACTION clearSelection;
/// Selects an item (specified as the event parameter).
static TOOL_ACTION addItemToSel;
static TOOL_ACTION removeItemFromSel;
/// Selects a list of items (specified as the event parameter)
static TOOL_ACTION addItemsToSel;
static TOOL_ACTION removeItemsFromSel;
/// Runs a selection menu to select from a list of items
static TOOL_ACTION selectionMenu;
// Locking
static TOOL_ACTION toggleLock;
static TOOL_ACTION lock;
static TOOL_ACTION unlock;
// Schematic Tools
static TOOL_ACTION addNeededJunctions;
static TOOL_ACTION pickerTool;
static TOOL_ACTION placeSymbol;
static TOOL_ACTION placePower;
static TOOL_ACTION drawWire;
static TOOL_ACTION drawBus;
static TOOL_ACTION unfoldBus;
static TOOL_ACTION placeNoConnect;
static TOOL_ACTION placeJunction;
static TOOL_ACTION placeBusWireEntry;
static TOOL_ACTION placeLabel;
static TOOL_ACTION placeGlobalLabel;
static TOOL_ACTION placeHierLabel;
static TOOL_ACTION drawSheet;
static TOOL_ACTION placeSheetPin;
static TOOL_ACTION importSheetPin;
static TOOL_ACTION placeSchematicText;
static TOOL_ACTION drawLines;
static TOOL_ACTION placeImage;
static TOOL_ACTION finishLineWireOrBus;
static TOOL_ACTION finishWire;
static TOOL_ACTION finishBus;
static TOOL_ACTION finishLine;
static TOOL_ACTION finishSheet;
// Symbol Tools
static TOOL_ACTION placeSymbolPin;
static TOOL_ACTION placeSymbolText;
static TOOL_ACTION drawSymbolRectangle;
static TOOL_ACTION drawSymbolCircle;
static TOOL_ACTION drawSymbolArc;
static TOOL_ACTION drawSymbolLines;
static TOOL_ACTION placeSymbolAnchor;
static TOOL_ACTION finishDrawing;
// Interactive Editing
static TOOL_ACTION alignToGrid;
static TOOL_ACTION symbolMoveActivate; // Symbol editor move tool activate
static TOOL_ACTION moveActivate; // Schematic editor move tool activate
static TOOL_ACTION move;
static TOOL_ACTION drag;
static TOOL_ACTION repeatDrawItem;
static TOOL_ACTION rotateCW;
static TOOL_ACTION rotateCCW;
static TOOL_ACTION mirrorX;
static TOOL_ACTION mirrorY;
static TOOL_ACTION properties;
static TOOL_ACTION editReference;
static TOOL_ACTION editValue;
static TOOL_ACTION editFootprint;
static TOOL_ACTION autoplaceFields;
static TOOL_ACTION toggleDeMorgan;
static TOOL_ACTION showDeMorganStandard;
static TOOL_ACTION showDeMorganAlternate;
static TOOL_ACTION editSymbolUnit;
static TOOL_ACTION toLabel;
static TOOL_ACTION toHLabel;
static TOOL_ACTION toGLabel;
static TOOL_ACTION toText;
static TOOL_ACTION breakWire;
static TOOL_ACTION breakBus;
static TOOL_ACTION pointEditorAddCorner;
static TOOL_ACTION pointEditorRemoveCorner;
/// Inspection and Editing
static TOOL_ACTION showDatasheet;
static TOOL_ACTION runERC;
static TOOL_ACTION annotate;
static TOOL_ACTION editSymbolFields;
static TOOL_ACTION editSymbolLibraryLinks;
static TOOL_ACTION symbolProperties;
static TOOL_ACTION pinTable;
static TOOL_ACTION changeSymbols;
static TOOL_ACTION updateSymbols;
static TOOL_ACTION changeSymbol;
static TOOL_ACTION updateSymbol;
static TOOL_ACTION assignFootprints;
static TOOL_ACTION assignNetclass;
static TOOL_ACTION showBusManager;
static TOOL_ACTION schematicSetup;
static TOOL_ACTION editPageNumber;
static TOOL_ACTION checkSymbol;
static TOOL_ACTION rescueSymbols;
static TOOL_ACTION remapSymbols;
// Suite operations
static TOOL_ACTION editWithLibEdit;
static TOOL_ACTION showPcbNew;
static TOOL_ACTION importFPAssignments;
static TOOL_ACTION exportNetlist;
static TOOL_ACTION generateBOM;
static TOOL_ACTION addSymbolToSchematic;
// Library management
static TOOL_ACTION saveLibraryAs;
static TOOL_ACTION saveSymbolAs;
static TOOL_ACTION newSymbol;
static TOOL_ACTION editSymbol;
static TOOL_ACTION duplicateSymbol;
static TOOL_ACTION deleteSymbol;
static TOOL_ACTION cutSymbol;
static TOOL_ACTION copySymbol;
static TOOL_ACTION pasteSymbol;
static TOOL_ACTION importSymbol;
static TOOL_ACTION exportSymbol;
// Library editor tool actions
static TOOL_ACTION saveInSchematic;
// Hierarchy navigation
static TOOL_ACTION enterSheet;
static TOOL_ACTION leaveSheet;
static TOOL_ACTION navigateHierarchy;
static TOOL_ACTION hypertextCommand;
// Global edit tools
static TOOL_ACTION cleanupSheetPins;
static TOOL_ACTION editTextAndGraphics;
// Miscellaneous
static TOOL_ACTION toggleHiddenPins;
static TOOL_ACTION toggleHiddenFields;
static TOOL_ACTION toggleSyncedPinsMode;
static TOOL_ACTION restartMove;
static TOOL_ACTION explicitCrossProbe;
static TOOL_ACTION pushPinLength;
static TOOL_ACTION pushPinNameSize;
static TOOL_ACTION pushPinNumSize;
static TOOL_ACTION showElectricalTypes;
static TOOL_ACTION showComponentTree;
static TOOL_ACTION toggleForceHV;
static TOOL_ACTION drawSheetOnClipboard;
static TOOL_ACTION exportSymbolView;
static TOOL_ACTION exportSymbolAsSVG;
// SPICE
static TOOL_ACTION runSimulation;
static TOOL_ACTION simProbe;
static TOOL_ACTION simTune;
// Net highlighting
static TOOL_ACTION highlightNet;
static TOOL_ACTION clearHighlight;
static TOOL_ACTION updateNetHighlighting;
static TOOL_ACTION highlightNetTool;
///< @copydoc COMMON_ACTIONS::TranslateLegacyId()
virtual OPT<TOOL_EVENT> TranslateLegacyId( int aId ) override
{
return OPT<TOOL_EVENT>();
}
};
//
// For LibEdit
//
inline VECTOR2I mapCoords( const wxPoint& aCoord )
{
return VECTOR2I( aCoord.x, -aCoord.y );
}
inline wxPoint mapCoords( const VECTOR2I& aCoord )
{
return wxPoint( aCoord.x, -aCoord.y );
}
inline wxPoint mapCoords( const int x, const int y )
{
return wxPoint( x, -y );
}
#endif