pl_editor_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) 2013 CERN
 * Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
 * @author Jean-Pierre Charras, jp.charras at wanadoo.fr
 *
 * 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  _PL_EDITOR_FRAME_H
#define  _PL_EDITOR_FRAME_H
 
 
#include <eda_draw_frame.h>
#include <base_screen.h>
#include "pl_editor_layout.h"
#include "pl_draw_panel_gal.h"
 
#include <memory>
 
class PL_DRAW_PANEL_GAL;
class PROPERTIES_FRAME;
class DS_DATA_ITEM;
class wxChoice;
class NL_PL_EDITOR_PLUGIN;
 
 
class PL_EDITOR_FRAME : public EDA_DRAW_FRAME
{
public:
    PL_EDITOR_FRAME( KIWAY* aKiway, wxWindow* aParent );
    ~PL_EDITOR_FRAME();
 
    PROPERTIES_FRAME* GetPropertiesFrame() { return m_propertiesPagelayout; }
 
    void ShowDesignInspector();
 
    bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;
 
    bool LoadDrawingSheetFile( const wxString& aFullFileName );
 
    bool SaveDrawingSheetFile( const wxString& aFullFileName );
 
    bool InsertDrawingSheetFile( const wxString& aFullFileName );
 
    bool IsContentModified() const override;
 
    void OnExit( wxCommandEvent& aEvent );
 
    bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
    void doCloseWindow() override;
 
    // The Tool Framework initialization
    void setupTools();
 
    // Virtual basic functions:
    void ReCreateHToolbar() override;
    void UpdateToolbarControlSizes() override;
 
    void SetPageSettings(const PAGE_INFO&) override;
    const PAGE_INFO& GetPageSettings () const override;
    const VECTOR2I   GetPageSizeIU() const override;
 
    PL_DRAW_PANEL_GAL* GetCanvas() const override;
    SELECTION& GetCurrentSelection() override;
 
    const VECTOR2I& GetGridOrigin() const override { return m_grid_origin; }
    void SetGridOrigin( const VECTOR2I& aPoint ) override { m_grid_origin = aPoint; }
 
    VECTOR2I ReturnCoordOriginCorner() const;
 
    const TITLE_BLOCK& GetTitleBlock() const override;
    void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
 
    void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
 
    void DisplayGridMsg() override;
 
    void UpdateStatusBar() override;
 
    void OnNewDrawingSheet();
 
    void ReCreateVToolbar() override;
 
    void ReCreateOptToolbar() override;
 
    const PL_EDITOR_LAYOUT& GetPageLayout() const { return m_pageLayout; }
    PL_EDITOR_LAYOUT& GetPageLayout() { return m_pageLayout; }
 
    const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
 
    bool GetPageNumberOption() const;
 
    void UpdateTitleAndInfo();
 
    void UpdateMsgPanelInfo();
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void OnSelectPage( wxCommandEvent& event );
 
    void OnSelectCoordOriginCorner( wxCommandEvent& event );
 
    void ToPrinter( bool doPreview );
 
    void Files_io( wxCommandEvent& event );
 
    virtual void PrintPage( const RENDER_SETTINGS* aSettings ) override;
 
    void OnFileHistory( wxCommandEvent& event );
    void OnClearFileHistory( wxCommandEvent& aEvent );
 
    wxString GetCurrentFileName() const override;
 
    void SetCurrentFileName( const wxString& aName );
 
    void HardRedraw() override;
 
    DS_DATA_ITEM* AddDrawingSheetItem( int aType );
 
    void OnModify() override;
 
    void SaveCopyInUndoList();
 
    void GetLayoutFromRedoList();
 
    void GetLayoutFromUndoList();
 
    void RollbackFromUndo();
 
    void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
 
protected:
    bool saveCurrentPageLayout();
 
    void setupUIConditions() override;
 
    void doReCreateMenuBar() override;
 
    void DoWithAcceptedFiles() override;
 
    DECLARE_EVENT_TABLE();
 
private:
    void handleActivateEvent( wxActivateEvent& aEvent ) override;
    void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
 
protected:
    PROPERTIES_FRAME* m_propertiesPagelayout;
 
private:
    PL_EDITOR_LAYOUT  m_pageLayout;
 
    int               m_propertiesFrameWidth; // last width (in pixels) of m_propertiesPagelayout
 
    wxChoice*         m_originSelectBox;      // Corner origin choice for coordinates
    int               m_originSelectChoice;   // the last choice for m_originSelectBox
    wxChoice*         m_pageSelectBox;        // The page number sel'ector (page 1 or other pages
                                              // useful when there are some items which are
    wxString          m_mruImagePath;         // Most recently used path for placing a new image
                                              // only on page 1, not on page 1
    VECTOR2I          m_grid_origin;
 
    std::unique_ptr<NL_PL_EDITOR_PLUGIN> m_spaceMouse;
};
 
#endif /* _PL_EDITOR_FRAME_H */