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 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 BASE_EDIT_FRAME_H
#define BASE_EDIT_FRAME_H
 
#include <pcb_base_frame.h>
#include <libraries/library_table.h>
 
class APPEARANCE_CONTROLS;
class LAYER_PAIR_SETTINGS;
class BOARD_ITEM_CONTAINER;
class PANEL_SELECTION_FILTER;
class PCB_TEXTBOX;
class PCB_TABLE;
class PCB_TEXT;
class PCB_SHAPE;
class FILEDLG_HOOK_NEW_LIBRARY;
struct PCB_SELECTION_FILTER_OPTIONS;
class PCB_BARCODE;
class PCB_VERTEX_EDITOR_PANE;

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& aDialogTitle, const wxString& aInitialPath = wxEmptyString );
 
    wxString CreateNewProjectLibrary( const wxString& aDialogTitle, const wxString& aLibName );

    wxString SelectLibrary( const wxString& aDialogTitle, const wxString& aListLabel,
                            const std::vector<std::pair<wxString, bool*>>& aExtraCheckboxes = {} );

    bool AddLibrary( const wxString& aDialogTitle, const wxString& aLibName = wxEmptyString,
                     std::optional<LIBRARY_TABLE_SCOPE> aScope = std::nullopt );

    virtual void OnEditItemRequest( BOARD_ITEM* aItem ) {};

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

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

    void AppendCopyToUndoList( 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 aRehatchShapes = true );

    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 );

    virtual EDA_ANGLE GetRotationAngle() const;
 
    void ShowBarcodePropertiesDialog( PCB_BARCODE* aText );
    void ShowReferenceImagePropertiesDialog( BOARD_ITEM* aBitmap );
    void ShowTextPropertiesDialog( PCB_TEXT* aText );
    int ShowTextBoxPropertiesDialog( PCB_TEXTBOX* aTextBox );
    void ShowGraphicItemPropertiesDialog( PCB_SHAPE* aShape );
 
    void OpenVertexEditor( BOARD_ITEM* aItem );
    void CloseVertexEditor();
    void UpdateVertexEditorSelection( BOARD_ITEM* aItem );
    void OnVertexEditorPaneClosed( PCB_VERTEX_EDITOR_PANE* aPane );
    static wxString VertexEditorPaneName();
 
    wxAuiManager& GetAuiManager() { return m_auimgr; }

    void ActivateGalCanvas() override;

    virtual void SetBoard( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr ) override;
 
    COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) 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;
 
    void ClearListAndDeleteItems( PICKED_ITEMS_LIST* aList );
 
    APPEARANCE_CONTROLS* GetAppearancePanel() { return m_appearancePanel; }

    LAYER_PAIR_SETTINGS* GetLayerPairSettings() { return m_layerPairSettings.get(); }
 
    void ToggleProperties() override;
 
    void GetContextualTextVars( BOARD_ITEM* aSourceItem, const wxString& aCrossRef,
                                wxArrayString* aTokens );
 
    void HighlightSelectionFilter( const PCB_SELECTION_FILTER_OPTIONS& aOptions );
 
    void ClearToolbarControl( int aId ) override;
 
protected:
    void configureToolbars() override;

    wxString createNewLibrary( const wxString& aDialogTitle, const wxString& aLibName,
                               const wxString& aInitialPath, std::optional<LIBRARY_TABLE_SCOPE> aScope = std::nullopt );
 
    void handleActivateEvent( wxActivateEvent& aEvent ) override;
 
    void saveCopyInUndoList( PICKED_ITEMS_LIST* commandToUndo, const PICKED_ITEMS_LIST& aItemsList,
                             UNDO_REDO aCommandType );
 
    void unitsChangeRefresh() override;
 
    void onDarkModeToggle( wxSysColourChangedEvent& aEvent );
 
protected:
    bool                    m_undoRedoBlocked;
 
    PANEL_SELECTION_FILTER*              m_selectionFilterPanel;
    APPEARANCE_CONTROLS*                 m_appearancePanel;
    std::unique_ptr<LAYER_PAIR_SETTINGS> m_layerPairSettings;
 
    PCB_VERTEX_EDITOR_PANE* m_vertexEditorPane;
 
    PCB_LAYER_BOX_SELECTOR* m_SelLayerBox; // a combo box to display and select active layer
 
    wxAuiNotebook*          m_tabbedPanel;        
};
 
#endif