pcb_base_edit_frame.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 (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * 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 BASE_EDIT_FRAME_H
#define BASE_EDIT_FRAME_H

#include <pcb_base_frame.h>

class APPEARANCE_CONTROLS;
class BOARD_ITEM_CONTAINER;
class PANEL_SELECTION_FILTER;

class PCB_BASE_EDIT_FRAME : public PCB_BASE_FRAME
{
public:
    PCB_BASE_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
                         const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
                         long aStyle, const wxString& aFrameName );

    virtual ~PCB_BASE_EDIT_FRAME();

    bool TryBefore( wxEvent& aEvent ) override;

    void doCloseWindow() override;

    wxString CreateNewLibrary( const wxString& aLibName = wxEmptyString,
                               const wxString& aProposedName = wxEmptyString );

    wxString CreateNewProjectLibrary( const wxString& aLibName = wxEmptyString,
                                      const wxString& aProposedName = wxEmptyString );

    bool AddLibrary( const wxString& aLibName = wxEmptyString, FP_LIB_TABLE* aTable = nullptr );

    virtual void OnEditItemRequest( BOARD_ITEM* aItem ) = 0;

    void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand ) override;

    void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aCommandType ) override;

    void RestoreCopyFromRedoList( wxCommandEvent& aEvent );

    void RestoreCopyFromUndoList( wxCommandEvent& aEvent );

    void RollbackFromUndo();

    void PutDataInPreviousState( PICKED_ITEMS_LIST* aList );

    bool UndoRedoBlocked() const
    {
        return m_undoRedoBlocked;
    }

    void UndoRedoBlock( bool aBlock = true )
    {
        m_undoRedoBlocked = aBlock;
    }

    void SetGridVisibility( bool aVisible ) override;

    void SetObjectVisible( GAL_LAYER_ID aLayer, bool aVisible = true );

    int GetRotationAngle() const { return m_rotationAngle; }

    void SetRotationAngle( int aRotationAngle );

    void ShowTextPropertiesDialog( BOARD_ITEM* aText );
    void ShowGraphicItemPropertiesDialog( BOARD_ITEM* aItem );

    void ActivateGalCanvas() override;

    virtual void SetBoard( BOARD* aBoard ) override;

    COLOR_SETTINGS* GetColorSettings() const override;

    /* full undo redo management : */

    // use EDA_BASE_FRAME::ClearUndoRedoList()
    // use EDA_BASE_FRAME::PushCommandToUndoList( PICKED_ITEMS_LIST* aItem )
    // use EDA_BASE_FRAME::PushCommandToRedoList( PICKED_ITEMS_LIST* aItem )

    void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;

    wxString GetDesignRulesPath();

    APPEARANCE_CONTROLS* GetAppearancePanel() { return m_appearancePanel; }

    virtual void OnLayerAlphaChanged();

protected:
    FP_LIB_TABLE* selectLibTable( bool aOptional = false );

    wxString createNewLibrary( const wxString& aLibName, const wxString& aProposedName,
                               FP_LIB_TABLE* aTable );

    void handleActivateEvent( wxActivateEvent& aEvent ) override;

    void unitsChangeRefresh() override;

protected:
    int                     m_rotationAngle;        // Rotation step (in tenths of a degree)
    bool                    m_undoRedoBlocked;

    PANEL_SELECTION_FILTER* m_selectionFilterPanel;
    APPEARANCE_CONTROLS*    m_appearancePanel;
};

#endif