eda_draw_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) 2009 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
 * Copyright (C) 1992-2021 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, 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 DRAW_FRAME_H_
#define DRAW_FRAME_H_

#include <eda_base_frame.h>
#include <kiway_player.h>
#include <gal/gal_display_options.h>
#include <gal/color4d.h>
#include <class_draw_panel_gal.h>
#include <origin_transforms.h>
#include <kiid.h>
#include "hotkeys_basic.h"

class EDA_ITEM;
class wxSingleInstanceChecker;
class ACTION_TOOLBAR;
class COLOR_SETTINGS;
class TOOL_MENU;
class APP_SETTINGS_BASE;
class wxFindReplaceData;

namespace KIGFX
{
 class GAL_DISPLAY_OPTIONS;
 class RENDER_SETTINGS;
}

using KIGFX::COLOR4D;
using KIGFX::RENDER_SETTINGS;

#define LIB_EDIT_FRAME_NAME wxT( "LibeditFrame" )
#define SCH_EDIT_FRAME_NAME wxT( "SchematicFrame" )
#define PL_EDITOR_FRAME_NAME wxT( "PlEditorFrame" )
#define FOOTPRINT_WIZARD_FRAME_NAME wxT( "FootprintWizard" )
#define FOOTPRINT_EDIT_FRAME_NAME wxT( "ModEditFrame" )
#define FOOTPRINT_VIEWER_FRAME_NAME wxT( "ModViewFrame" )
#define FOOTPRINT_VIEWER_FRAME_NAME_MODAL wxT( "ModViewFrameModal" )
#define PCB_EDIT_FRAME_NAME wxT( "PcbFrame" )


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

 ~EDA_DRAW_FRAME();

 bool LockFile( const wxString& aFileName );

 void ReleaseFile();

 void ScriptingConsoleEnableDisable();

 bool IsScriptingConsoleVisible();

 wxFindReplaceData& GetFindReplaceData() { return *m_findReplaceData; }
 wxArrayString& GetFindHistoryList() { return m_findStringHistoryList; }

 virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) = 0;
 virtual const PAGE_INFO& GetPageSettings() const = 0;

 virtual const wxSize GetPageSizeIU() const = 0;

 bool GetShowPolarCoords() const { return m_polarCoords; }
 void SetShowPolarCoords( bool aShow ) { m_polarCoords = aShow; }

 void ToggleUserUnits() override;

 void GetUnitPair( EDA_UNITS& aPrimaryUnit, EDA_UNITS& aSecondaryUnits );

 virtual const wxPoint& GetGridOrigin() const = 0;
 virtual void SetGridOrigin( const wxPoint& aPosition ) = 0;

 wxPoint GetNearestGridPosition( const wxPoint& aPosition ) const;

 wxPoint GetNearestHalfGridPosition( const wxPoint& aPosition ) const;

 virtual ORIGIN_TRANSFORMS& GetOriginTransforms()
 { return m_originTransforms; }


 virtual const TITLE_BLOCK& GetTitleBlock() const = 0;
 virtual void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) = 0;

 // the background color of the draw canvas:
 // Virtual because some frames can have a specific way to get/set the bg color
 virtual COLOR4D GetDrawBgColor() const { return m_drawBgColor; }
 virtual void SetDrawBgColor( const COLOR4D& aColor) { m_drawBgColor= aColor ; }

 virtual COLOR_SETTINGS* GetColorSettings() const;

 bool ShowPageLimits() const { return m_showPageLimits; }
 void SetShowPageLimits( bool aShow ) { m_showPageLimits = aShow; }

 bool LibraryFileBrowser( bool doOpen, wxFileName& aFilename, const wxString& wildcard,
 const wxString& ext, bool isDirectory = false, bool aIsGlobal = false,
 const wxString& aGlobalPath = wxEmptyString );

 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;

 virtual wxString GetScreenDesc() const;

 virtual BASE_SCREEN* GetScreen() const { return m_currentScreen; }

 void EraseMsgBox();

 void ReCreateMenuBar() override { }
 virtual void ReCreateHToolbar() = 0;
 virtual void ReCreateVToolbar() = 0;
 virtual void ReCreateOptToolbar() = 0;
 virtual void ReCreateAuxiliaryToolbar() { }

 virtual void UpdateToolbarControlSizes() { }

 /*
 * These 4 functions provide a basic way to show/hide grid and /get/set grid color.
 *
 * These parameters are saved in KiCad config for each main frame.
 */
 bool IsGridVisible() const;
 virtual void SetGridVisibility( bool aVisible );

 virtual COLOR4D GetGridColor() { return m_gridColor; }
 virtual void SetGridColor( const COLOR4D& aColor ) { m_gridColor = aColor; }

 void OnSelectGrid( wxCommandEvent& event );

 void OnGridSettings( wxCommandEvent& event );

 void UpdateGridSelectBox();

 void OnUpdateSelectGrid( wxUpdateUIEvent& aEvent );

 void UpdateZoomSelectBox();

 const wxString GetZoomLevelIndicator() const;

 virtual void OnSelectZoom( wxCommandEvent& event );

 virtual void OnSize( wxSizeEvent& event ) override;

 void OnMove( wxMoveEvent& aEvent ) override;

 virtual void HardRedraw();

 virtual void Zoom_Automatique( bool aWarpPointer );

 void FocusOnLocation( const wxPoint& aPos );

 void AddStandardSubMenus( TOOL_MENU& aMenu );

 void PrintDrawingSheet( const RENDER_SETTINGS* aSettings, BASE_SCREEN* aScreen,
 double aMils2Iu, const wxString& aFilename,
 const wxString& aSheetLayer = wxEmptyString );

 void DisplayToolMsg( const wxString& msg ) override;

 void DisplayConstraintsMsg( const wxString& msg );

 virtual void OnPageSettingsChange() {}

 void UpdateStatusBar() override;

 void DisplayUnitsMsg();

 virtual void DisplayGridMsg();

 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;

 void AppendMsgPanel( const wxString& aTextUpper, const wxString& aTextLower, int aPadding = 6 );

 virtual void ClearMsgPanel();

 void SetMsgPanel( const std::vector< MSG_PANEL_ITEM >& aList );
 void SetMsgPanel( EDA_ITEM* aItem );

 void SetMsgPanel( const wxString& aTextUpper, const wxString& aTextLower, int aPadding = 6 );

 virtual void UpdateMsgPanel();

 virtual EDA_ITEM* GetItem( const KIID& aId ) const { return nullptr; }

 virtual void PrintPage( const RENDER_SETTINGS* aSettings );

 virtual void ActivateGalCanvas();

 virtual void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType );

 virtual EDA_DRAW_PANEL_GAL* GetCanvas() const { return m_canvas; }
 void SetCanvas( EDA_DRAW_PANEL_GAL* aPanel ) { m_canvas = aPanel; }

 wxWindow* GetToolCanvas() const override { return GetCanvas(); }

 KIGFX::GAL_DISPLAY_OPTIONS& GetGalDisplayOptions() { return m_galDisplayOptions; }

 void RefreshCanvas() override
 {
 GetCanvas()->Refresh();
 }

 virtual const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const;

 void RecreateToolbars();

 DECLARE_EVENT_TABLE()

protected:
 virtual void SetScreen( BASE_SCREEN* aScreen ) { m_currentScreen = aScreen; }

 void unitsChangeRefresh() override;

 void setupUnits( APP_SETTINGS_BASE* aCfg );

 std::vector<wxWindow*> findDialogs();

 void resolveCanvasType();

 EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting();

 bool saveCanvasTypeSetting( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType );

 virtual void handleActivateEvent( wxActivateEvent& aEvent );
 void onActivate( wxActivateEvent& aEvent );


 wxSocketServer* m_socketServer;
 std::vector<wxSocketBase*> m_sockets; 

 std::unique_ptr<wxSingleInstanceChecker> m_file_checker;

 bool m_showPageLimits; // True to display the page limits
 COLOR4D m_gridColor; // Grid color
 COLOR4D m_drawBgColor; // The background color of the draw canvas; BLACK for
 // Pcbnew, BLACK or WHITE for Eeschema
 int m_undoRedoCountMax; // Default Undo/Redo command Max depth, to be handed
 // to screens
 bool m_polarCoords; // For those frames that support polar coordinates

 bool m_showBorderAndTitleBlock; // Show the drawing sheet (border & title block).
 long m_firstRunDialogSetting; // Show first run dialog on startup

 wxChoice* m_gridSelectBox;
 wxChoice* m_zoomSelectBox;

 ACTION_TOOLBAR* m_mainToolBar;
 ACTION_TOOLBAR* m_auxiliaryToolBar; // Additional tools under main toolbar
 ACTION_TOOLBAR* m_drawToolBar; // Drawing tools (typically on right edge of window)
 ACTION_TOOLBAR* m_optionsToolBar; // Options (typically on left edge of window)

 wxFindReplaceData* m_findReplaceData;
 wxArrayString m_findStringHistoryList;
 wxArrayString m_replaceStringHistoryList;

 EDA_MSG_PANEL* m_messagePanel;
 int m_msgFrameHeight;

 COLOR_SETTINGS* m_colorSettings;

 EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType;

private:
 BASE_SCREEN* m_currentScreen; 
 EDA_DRAW_PANEL_GAL* m_canvas;

 KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions;

 ORIGIN_TRANSFORMS m_originTransforms;
};

#endif // DRAW_FRAME_H_