footprint_editor_control.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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/>.
 */
 
#ifndef FOOTPRINT_EDITOR_CONTROL_H
#define FOOTPRINT_EDITOR_CONTROL_H
 
#include <tools/pcb_tool_base.h>
 
 
class FOOTPRINT_EDIT_FRAME;
class DIALOG_FOOTPRINT_CHECKER;

class FOOTPRINT_EDITOR_CONTROL : public PCB_TOOL_BASE
{
public:
    FOOTPRINT_EDITOR_CONTROL();

    void Reset( RESET_REASON aReason ) override;

    bool Init() override;
 
    int NewFootprint( const TOOL_EVENT& aEvent );
    int CreateFootprint( const TOOL_EVENT& aEvent );
 
    int Save( const TOOL_EVENT& aEvent );
    int SaveAs( const TOOL_EVENT& aEvent );
    int Revert( const TOOL_EVENT& aEvent );
 
    int EditFootprint( const TOOL_EVENT& aEvent );
    int EditLibraryFootprint( const TOOL_EVENT& aEvent );
    int CutCopyFootprint( const TOOL_EVENT& aEvent );
    int PasteFootprint( const TOOL_EVENT& aEvent );
    int DuplicateFootprint( const TOOL_EVENT& aEvent );
    int RenameFootprint( const TOOL_EVENT& aEvent );
    int DeleteFootprint( const TOOL_EVENT& aEvent );
    int ImportFootprint( const TOOL_EVENT& aEvent );
    int ExportFootprint( const TOOL_EVENT& aEvent );

    int CompareLibraryWithFile( const TOOL_EVENT& aEvent );
    int OpenDirectory( const TOOL_EVENT& aEvent );
    int OpenWithTextEditor( const TOOL_EVENT& aEvent );
    int ShowDatasheet( const TOOL_EVENT& aEvent );
 
    int ToggleLayersManager( const TOOL_EVENT& aEvent );
    int ToggleProperties( const TOOL_EVENT& aEvent );
    int Properties( const TOOL_EVENT& aEvent );
    void editFootprintPropertiesFromLibrary( const LIB_ID& aLibId );
 
    int EditTextAndGraphics( const TOOL_EVENT& aEvent );
 
    int CheckFootprint( const TOOL_EVENT& aEvent );
    void CrossProbe( const PCB_MARKER* aMarker );
    void DestroyCheckerDialog();
 
    int CleanupGraphics( const TOOL_EVENT& aEvent );
    int RepairFootprint( const TOOL_EVENT& aEvent );
 
    int NextTab( const TOOL_EVENT& aEvent );
    int PrevTab( const TOOL_EVENT& aEvent );
    int CloseTab( const TOOL_EVENT& aEvent );

    int DefaultPadProperties( const TOOL_EVENT& aEvent );
 
private:
    void setTransitions() override;

    void tryToSaveFootprintInLibrary( FOOTPRINT& aFootprint, const LIB_ID& aLibId );
 
    // Line-mode handlers
    int ChangeLineMode( const TOOL_EVENT& aEvent );
    int OnAngleSnapModeChanged( const TOOL_EVENT& aEvent );
 
    FOOTPRINT_EDIT_FRAME*      m_frame;
    DIALOG_FOOTPRINT_CHECKER*  m_checkerDialog;
 
    // A private clipboard for cut/copy/past of an entire footprint
    std::unique_ptr<FOOTPRINT> m_copiedFootprint;
};
 
#endif  // FOOTPRINT_EDITOR_CONTROL_H