kicad-source/eeschema/tools/sch_edit_tool.h
Jeff Young 6f389fd320 Tighten parent/child undo/redo architecture.
Always look for pre-existing undo/redo record.  Checking for IsNew()
is less robust and should be avoided.  Also moves the checking to a
location where it will be easier to ensure that it's uniform.

Push get-undo-level-item processing down a level so it is uniformly
called.

Make sure tables & labels are uniformly handled.

Remove incorrect usage of Get/SetGroupId() for storing lastPin
(which we don't use anyway).

Lists of deleted and changed items MUST include the screen pointer.
An item could be changed on one screen but not on another.

Also tightens handling of PCB_NETINFO_T items, which are not in the
view.

Also fixes a bug where there is no increment parameter if you assign
the base increment command to a hotkey.
(This was discovered while testing the above changes.)

Also fixes a bug where delete during a move in PCB Editor did an
undo instead of a delete.
(Again, found while testing above.)

An experiment was also run to collapse shared parts of SCH_EDIT_FRAME
and SYMBOL_EDITOR_FRAME into SCH_BASE_EDIT_FRAME.  However, sharing the
undo code actually increased complexity, and there was very little else
of value in SCH_BASE_EDIT_FRAME (other than the Increment() routines).
2025-08-18 19:20:09 +01:00

93 lines
3.2 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019 CERN
* Copyright The 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
*/
#pragma once
#include <tools/sch_tool_base.h>
#include <sch_base_frame.h>
class SCH_EDIT_TOOL : public SCH_TOOL_BASE<SCH_EDIT_FRAME>
{
public:
SCH_EDIT_TOOL();
~SCH_EDIT_TOOL() = default;
static const std::vector<KICAD_T> RotatableItems;
/// @copydoc TOOL_INTERACTIVE::Init()
bool Init() override;
int Rotate( const TOOL_EVENT& aEvent );
int Mirror( const TOOL_EVENT& aEvent );
int Swap( const TOOL_EVENT& aEvent );
int RepeatDrawItem( const TOOL_EVENT& aEvent );
int Properties( const TOOL_EVENT& aEvent );
int EditField( const TOOL_EVENT& aEvent );
int AutoplaceFields( const TOOL_EVENT& aEvent );
int ChangeSymbols( const TOOL_EVENT& aEvent );
int ChangeBodyStyle( const TOOL_EVENT& aEvent );
int EditPageNumber( const TOOL_EVENT& aEvent );
/**
* Change a text type to another one.
*
* The new text, label, hierarchical label, or global label is created from the old text
* and the old text object is deleted.
*
* A tricky case is when the 'old" text is being edited (i.e. moving) because we must
* create a new text, and prepare the undo/redo command data for this change and the
* current move/edit command
*/
int ChangeTextType( const TOOL_EVENT& aEvent );
int JustifyText( const TOOL_EVENT& aEvent );
int BreakWire( const TOOL_EVENT& aEvent );
int CleanupSheetPins( const TOOL_EVENT& aEvent );
int GlobalEdit( const TOOL_EVENT& aEvent );
///< Delete the selected items, or the item under the cursor.
int DoDelete( const TOOL_EVENT& aEvent );
/// Drag and drop
int DdAppendFile( const TOOL_EVENT& aEvent );
/// Modify Attributes (DNP, Exclude, etc.) All attributes are
/// set to true unless all symbols already have the attribute set to true.
int SetAttribute( const TOOL_EVENT& aEvent );
private:
void editFieldText( SCH_FIELD* aField );
void collectUnits( const SCH_SELECTION& aSelection,
std::set<std::pair<SCH_SYMBOL*, SCH_SCREEN*>>& aCollectedUnits );
///< Set up handlers for various events.
void setTransitions() override;
};