sch_base_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) 2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2015-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 SCH_BASE_FRAME_H_
#define SCH_BASE_FRAME_H_

#include <eda_draw_frame.h>
#include <frame_type.h>
#include <sch_draw_panel.h>
#include <sch_screen.h>
#include <schematic_settings.h>

#include <stddef.h>
#include <utility>
#include <vector>
#include <wx/event.h>
#include <wx/gdicmn.h>
#include <wx/string.h>

#include <template_fieldnames.h>


namespace KIGFX
{
 class SCH_RENDER_SETTINGS;
}

class PAGE_INFO;
class TITLE_BLOCK;
class SYMBOL_VIEWER_FRAME;
class SYMBOL_EDIT_FRAME;
class LIB_SYMBOL;
class SYMBOL_LIB;
class SCHLIB_FILTER;
class LIB_ID;
class SYMBOL_LIB_TABLE;
class EESCHEMA_SETTINGS;
class SYMBOL_EDITOR_SETTINGS;

LIB_SYMBOL* SchGetLibSymbol( const LIB_ID& aLibId, SYMBOL_LIB_TABLE* aLibTable,
 SYMBOL_LIB* aCacheLib = nullptr, wxWindow* aParent = nullptr,
 bool aShowErrorMsg = false );

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

 virtual ~SCH_BASE_FRAME();

 void createCanvas();

 SCH_DRAW_PANEL* GetCanvas() const override;
 SCH_SCREEN* GetScreen() const override;

 EESCHEMA_SETTINGS* eeconfig() const;

 SYMBOL_EDITOR_SETTINGS* libeditconfig() const;

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

 KIGFX::SCH_RENDER_SETTINGS* GetRenderSettings();

 COLOR4D GetDrawBgColor() const override;

 virtual bool GetShowAllPins() const { return true; }

 void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
 const PAGE_INFO& GetPageSettings () const override;
 const wxSize GetPageSizeIU() const override;

 const wxPoint& GetGridOrigin() const override
 {
 static wxPoint zero;
 return zero;
 }
 void SetGridOrigin( const wxPoint& aPoint ) override {}

 const TITLE_BLOCK& GetTitleBlock() const override;
 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;

 void UpdateStatusBar() override;

 PICKED_SYMBOL PickSymbolFromLibTree( const SCHLIB_FILTER* aFilter,
 std::vector<PICKED_SYMBOL>& aHistoryList,
 bool aUseLibBrowser,
 int aUnit,
 int aConvert,
 bool aShowFootprints,
 const LIB_ID* aHighlight = nullptr,
 bool aAllowFields = true );

 LIB_SYMBOL* GetLibSymbol( const LIB_ID& aLibId, bool aUseCacheLib = false,
 bool aShowErrorMsg = false );

 PICKED_SYMBOL PickSymbolFromLibBrowser( wxTopLevelWindow* aParent,
 const SCHLIB_FILTER* aFilter,
 const LIB_ID& aPreselectedLibId,
 int aUnit, int aConvert );

 virtual void RedrawScreen( const wxPoint& aCenterPoint, bool aWarpPointer );

 virtual void CenterScreen( const wxPoint& aCenterPoint, bool aWarpPointer );

 void HardRedraw() override;

 void AddToScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen );

 void RemoveFromScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen );

 void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false, bool aUpdateRtree = false );

 void RefreshSelection();

 void SyncView();

 virtual void OnModify() {}

 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;

 COLOR4D GetLayerColor( SCH_LAYER_ID aLayer );

 COLOR_SETTINGS* GetColorSettings() const override;

protected:
 bool saveSymbolLibTables( bool aGlobal, bool aProject );

 SCHEMATIC_SETTINGS m_base_frame_defaults;
};

#endif // SCH_BASE_FRAME_H_