sch_tool_base.h

Go to the documentation of this file.

/*
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <tool/tool_interactive.h>
#include <string>
 
class EDA_ITEM;
class SCH_BASE_FRAME;
class SCH_EDIT_FRAME;
class SYMBOL_EDIT_FRAME;
class SCH_SELECTION_TOOL;
enum class UNDO_REDO;
 
namespace KIGFX
{
class SCH_VIEW;
}
 
class SCH_SELECTION;

 
 
template <class T>
class SCH_TOOL_BASE : public TOOL_INTERACTIVE
{
public:
    SCH_TOOL_BASE( const std::string& aName );
 
    ~SCH_TOOL_BASE() override;

    bool Init() override;

    void Reset( RESET_REASON aReason ) override;

    bool IsSymbolEditor() const;
 
    int Increment( const TOOL_EVENT& aEvent );
 
    int InteractiveDelete( const TOOL_EVENT& aEvent );
 
protected:
    template <class F = SCH_BASE_FRAME>
    F* frame() const
    {
        return getEditFrame<F>();
    }

    EDA_ITEM* getDrawParent() const;

    void updateItem( EDA_ITEM* aItem, bool aUpdateRTree ) const;

    void saveCopyInUndoList( EDA_ITEM* aItem, UNDO_REDO aType, bool aAppend = false, bool aDirtyConnectivity = true );
 
protected:
    T*                  m_frame;
    KIGFX::SCH_VIEW*    m_view;
    SCH_SELECTION_TOOL* m_selectionTool;
    bool                m_isSymbolEditor;
    EDA_ITEM*           m_pickerItem;
};
 
extern template class SCH_TOOL_BASE<SCH_BASE_FRAME>;
extern template class SCH_TOOL_BASE<SCH_EDIT_FRAME>;
extern template class SCH_TOOL_BASE<SYMBOL_EDIT_FRAME>;