toolbars_sch_editor.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2004-2019 KiCad Developers, see AUTHORS.txt for contributors.
 * Copyright (C) 2019 CERN
 *
 * 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
 */
 
#include <advanced_config.h>
#include <api/api_plugin_manager.h>
#include <sch_draw_panel.h>
#include <sch_edit_frame.h>
#include <kiface_base.h>
#include <bitmaps.h>
#include <eeschema_id.h>
#include <pgm_base.h>
#include <python_scripting.h>
#include <tool/tool_manager.h>
#include <tool/action_toolbar.h>
#include <tools/ee_actions.h>
#include <tools/ee_selection_tool.h>
#include <widgets/hierarchy_pane.h>
#include <widgets/wx_aui_utils.h>
#include <widgets/sch_properties_panel.h>
#include <widgets/sch_search_pane.h>
 
/* Create the main Horizontal Toolbar for the schematic editor
 */
void SCH_EDIT_FRAME::ReCreateHToolbar()
{
 if( m_mainToolBar )
 {
 m_mainToolBar->ClearToolbar();
 }
 else
 {
 m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR,
 wxDefaultPosition, wxDefaultSize,
 KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_HORIZONTAL );
 m_mainToolBar->SetAuiManager( &m_auimgr );
 }
 
 // Set up toolbar
 if( Kiface().IsSingle() ) // not when under a project mgr
 {
 m_mainToolBar->Add( ACTIONS::doNew );
 m_mainToolBar->Add( ACTIONS::open );
 }
 
 m_mainToolBar->Add( ACTIONS::save );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EE_ACTIONS::schematicSetup );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::pageSettings );
 m_mainToolBar->Add( ACTIONS::print );
 m_mainToolBar->Add( ACTIONS::plot );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::paste );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::undo );
 m_mainToolBar->Add( ACTIONS::redo );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::find );
 m_mainToolBar->Add( ACTIONS::findAndReplace );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::zoomRedraw );
 m_mainToolBar->Add( ACTIONS::zoomInCenter );
 m_mainToolBar->Add( ACTIONS::zoomOutCenter );
 m_mainToolBar->Add( ACTIONS::zoomFitScreen );
 m_mainToolBar->Add( ACTIONS::zoomFitObjects );
 m_mainToolBar->Add( ACTIONS::zoomTool, ACTION_TOOLBAR::TOGGLE, ACTION_TOOLBAR::CANCEL );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EE_ACTIONS::navigateBack );
 m_mainToolBar->Add( EE_ACTIONS::navigateUp );
 m_mainToolBar->Add( EE_ACTIONS::navigateForward );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EE_ACTIONS::rotateCCW );
 m_mainToolBar->Add( EE_ACTIONS::rotateCW );
 m_mainToolBar->Add( EE_ACTIONS::mirrorV );
 m_mainToolBar->Add( EE_ACTIONS::mirrorH );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::showSymbolEditor );
 m_mainToolBar->Add( ACTIONS::showSymbolBrowser );
 m_mainToolBar->Add( ACTIONS::showFootprintEditor );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EE_ACTIONS::annotate );
 m_mainToolBar->Add( EE_ACTIONS::runERC );
 m_mainToolBar->Add( EE_ACTIONS::showSimulator );
 m_mainToolBar->Add( EE_ACTIONS::assignFootprints );
 m_mainToolBar->Add( EE_ACTIONS::editSymbolFields );
 m_mainToolBar->Add( EE_ACTIONS::generateBOM );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EE_ACTIONS::showPcbNew );
 
 // Add scripting console and API plugins
 bool scriptingAvailable = SCRIPTING::IsWxAvailable();
#ifdef KICAD_IPC_API
 bool haveApiPlugins = Pgm().GetCommonSettings()->m_Api.enable_server &&
 !Pgm().GetPluginManager().GetActionsForScope( PLUGIN_ACTION_SCOPE::SCHEMATIC ).empty();
#else
 bool haveApiPlugins = false;
#endif
 
 if( scriptingAvailable || haveApiPlugins )
 {
 m_mainToolBar->AddScaledSeparator( this );
 
 if( scriptingAvailable )
 m_mainToolBar->Add( EE_ACTIONS::showPythonConsole, ACTION_TOOLBAR::TOGGLE );
 
 if( haveApiPlugins )
 addApiPluginTools();
 }
 
 // after adding the tools to the toolbar, must call Realize() to reflect the changes
 m_mainToolBar->KiRealize();
}
 
 
/* Create Vertical Right Toolbar
 */
void SCH_EDIT_FRAME::ReCreateVToolbar()
{
 if( m_drawToolBar )
 {
 m_drawToolBar->ClearToolbar();
 }
 else
 {
 m_drawToolBar = new ACTION_TOOLBAR( this, ID_V_TOOLBAR, wxDefaultPosition, wxDefaultSize,
 KICAD_AUI_TB_STYLE | wxAUI_TB_VERTICAL );
 m_drawToolBar->SetAuiManager( &m_auimgr );
 }
 
 // Set up toolbar
 m_drawToolBar->Add( ACTIONS::selectionTool, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::highlightNetTool, ACTION_TOOLBAR::TOGGLE );
 
 m_drawToolBar->AddScaledSeparator( this );
 m_drawToolBar->Add( EE_ACTIONS::placeSymbol, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placePower, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawWire, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawBus, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeBusWireEntry, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeNoConnect, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeJunction, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeLabel, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeClassLabel, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeGlobalLabel, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeHierLabel, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawSheet, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeSheetPin, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::syncAllSheetsPins, ACTION_TOOLBAR::TOGGLE );
 
 m_drawToolBar->AddScaledSeparator( this );
 m_drawToolBar->Add( EE_ACTIONS::placeSchematicText, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawTextBox, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawTable, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawRectangle, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawCircle, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawArc, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::drawLines, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( EE_ACTIONS::placeImage, ACTION_TOOLBAR::TOGGLE );
 m_drawToolBar->Add( ACTIONS::deleteTool, ACTION_TOOLBAR::TOGGLE );
 
 m_drawToolBar->KiRealize();
}
 
 
/* Create Vertical Left Toolbar (Option Toolbar)
 */
void SCH_EDIT_FRAME::ReCreateOptToolbar()
{
 if( m_optionsToolBar )
 {
 m_optionsToolBar->ClearToolbar();
 }
 else
 {
 m_optionsToolBar = new ACTION_TOOLBAR( this, ID_OPT_TOOLBAR,
 wxDefaultPosition, wxDefaultSize,
 KICAD_AUI_TB_STYLE | wxAUI_TB_VERTICAL );
 m_optionsToolBar->SetAuiManager( &m_auimgr );
 }
 
 m_optionsToolBar->Add( ACTIONS::toggleGrid, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( ACTIONS::toggleGridOverrides, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( ACTIONS::inchesUnits, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( ACTIONS::milsUnits, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( ACTIONS::millimetersUnits, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( ACTIONS::toggleCursorStyle, ACTION_TOOLBAR::TOGGLE );
 
 m_optionsToolBar->AddScaledSeparator( this );
 m_optionsToolBar->Add( EE_ACTIONS::toggleHiddenPins, ACTION_TOOLBAR::TOGGLE );
 
 m_optionsToolBar->AddScaledSeparator( this );
 m_optionsToolBar->Add( EE_ACTIONS::lineModeFree, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( EE_ACTIONS::lineMode90, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( EE_ACTIONS::lineMode45, ACTION_TOOLBAR::TOGGLE );
 
 m_optionsToolBar->AddScaledSeparator( this );
 m_optionsToolBar->Add( EE_ACTIONS::toggleAnnotateAuto, ACTION_TOOLBAR::TOGGLE );
 
 m_optionsToolBar->AddScaledSeparator( this );
 m_optionsToolBar->Add( EE_ACTIONS::showHierarchy, ACTION_TOOLBAR::TOGGLE );
 m_optionsToolBar->Add( ACTIONS::showProperties, ACTION_TOOLBAR::TOGGLE );
 
 if( ADVANCED_CFG::GetCfg().m_DrawBoundingBoxes )
 m_optionsToolBar->Add( ACTIONS::toggleBoundingBoxes, ACTION_TOOLBAR::TOGGLE );
 
 EE_SELECTION_TOOL* selTool = m_toolManager->GetTool<EE_SELECTION_TOOL>();
 std::unique_ptr<ACTION_MENU> gridMenu = std::make_unique<ACTION_MENU>( false, selTool );
 gridMenu->Add( ACTIONS::gridProperties );
 m_optionsToolBar->AddToolContextMenu( ACTIONS::toggleGrid, std::move( gridMenu ) );
 
 m_optionsToolBar->KiRealize();
}
 
 
void SCH_EDIT_FRAME::ToggleSearch()
{
 EESCHEMA_SETTINGS* cfg = eeconfig();
 
 // Ensure m_show_search is up to date (the pane can be closed outside the menu)
 m_show_search = m_auimgr.GetPane( SearchPaneName() ).IsShown();
 
 m_show_search = !m_show_search;
 
 wxAuiPaneInfo& searchPaneInfo = m_auimgr.GetPane( SearchPaneName() );
 searchPaneInfo.Show( m_show_search );
 
 if( m_show_search )
 {
 searchPaneInfo.Direction( cfg->m_AuiPanels.search_panel_dock_direction );
 
 if( cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_TOP
 || cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_BOTTOM )
 {
 SetAuiPaneSize( m_auimgr, searchPaneInfo, -1, cfg->m_AuiPanels.search_panel_height );
 }
 else if( cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_LEFT
 || cfg->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_RIGHT )
 {
 SetAuiPaneSize( m_auimgr, searchPaneInfo, cfg->m_AuiPanels.search_panel_width, -1 );
 }
 
 m_searchPane->FocusSearch();
 }
 else
 {
 cfg->m_AuiPanels.search_panel_height = m_searchPane->GetSize().y;
 cfg->m_AuiPanels.search_panel_width = m_searchPane->GetSize().x;
 cfg->m_AuiPanels.search_panel_dock_direction = searchPaneInfo.dock_direction;
 m_auimgr.Update();
 }
}
 
 
void SCH_EDIT_FRAME::ToggleProperties()
{
 if( !m_propertiesPanel )
 return;
 
 bool show = !m_propertiesPanel->IsShownOnScreen();
 
 wxAuiPaneInfo& propertiesPaneInfo = m_auimgr.GetPane( PropertiesPaneName() );
 propertiesPaneInfo.Show( show );
 
 updateSelectionFilterVisbility();
 
 EESCHEMA_SETTINGS* settings = eeconfig();
 
 if( show )
 {
 SetAuiPaneSize( m_auimgr, propertiesPaneInfo,
 settings->m_AuiPanels.properties_panel_width, -1 );
 }
 else
 {
 settings->m_AuiPanels.properties_panel_width = m_propertiesPanel->GetSize().x;
 m_auimgr.Update();
 }
}
 
 
void SCH_EDIT_FRAME::ToggleSchematicHierarchy()
{
 EESCHEMA_SETTINGS* cfg = eeconfig();
 
 wxCHECK( cfg, /* void */ );
 
 wxAuiPaneInfo& hierarchy_pane = m_auimgr.GetPane( SchematicHierarchyPaneName() );
 
 hierarchy_pane.Show( !hierarchy_pane.IsShown() );
 
 updateSelectionFilterVisbility();
 
 if( hierarchy_pane.IsShown() )
 {
 if( hierarchy_pane.IsFloating() )
 {
 hierarchy_pane.FloatingSize( cfg->m_AuiPanels.hierarchy_panel_float_width,
 cfg->m_AuiPanels.hierarchy_panel_float_height );
 m_auimgr.Update();
 }
 else if( cfg->m_AuiPanels.hierarchy_panel_docked_width > 0 )
 {
 // SetAuiPaneSize also updates m_auimgr
 SetAuiPaneSize( m_auimgr, hierarchy_pane,
 cfg->m_AuiPanels.hierarchy_panel_docked_width, -1 );
 }
 }
 else
 {
 if( hierarchy_pane.IsFloating() )
 {
 cfg->m_AuiPanels.hierarchy_panel_float_width = hierarchy_pane.floating_size.x;
 cfg->m_AuiPanels.hierarchy_panel_float_height = hierarchy_pane.floating_size.y;
 }
 else
 {
 cfg->m_AuiPanels.hierarchy_panel_docked_width = m_hierarchy->GetSize().x;
 }
 
 m_auimgr.Update();
 }
}