toolbars_symbol_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) 2004 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#include <advanced_config.h>
#include <api/api_plugin_manager.h>
#include <eeschema_id.h>
#include <pgm_base.h>
#include <settings/common_settings.h>
#include <symbol_edit_frame.h>
#include <sch_painter.h>
#include <symbol_editor_settings.h>
#include <symbol_library_manager.h>
#include <toolbars_symbol_editor.h>
#include <tool/action_menu.h>
#include <tool/action_toolbar.h>
#include <tool/tool_manager.h>
#include <tool/ui/toolbar_context_menu_registry.h>
#include <tools/sch_actions.h>
#include <tools/sch_selection_tool.h>
#include <widgets/sch_properties_panel.h>
#include <widgets/wx_aui_utils.h>
#include <wx/combobox.h>
 
#ifdef __UNIX__
#define LISTBOX_WIDTH 140
#else
#define LISTBOX_WIDTH 120
#endif
 
 
std::optional<TOOLBAR_CONFIGURATION> SYMBOL_EDIT_TOOLBAR_SETTINGS::DefaultToolbarConfig( TOOLBAR_LOC aToolbar )
{
    TOOLBAR_CONFIGURATION config;
 
    // clang-format off
    switch( aToolbar )
    {
    case TOOLBAR_LOC::TOP_AUX:
        return std::nullopt;
 
    case TOOLBAR_LOC::LEFT:
        config.AppendAction( ACTIONS::toggleGrid )
              .WithContextMenu(
                      []( TOOL_MANAGER* aToolMgr )
                      {
                          SCH_SELECTION_TOOL* selTool = aToolMgr->GetTool<SCH_SELECTION_TOOL>();
                          auto               menu = std::make_unique<ACTION_MENU>( false, selTool );
                          menu->Add( ACTIONS::gridProperties );
                          return menu;
                      } )
              .AppendAction( ACTIONS::toggleGridOverrides )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Units" ) )
                            .AddAction( ACTIONS::millimetersUnits )
                            .AddAction( ACTIONS::inchesUnits )
                            .AddAction( ACTIONS::milsUnits ) )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Crosshair modes" ) )
                            .AddAction( ACTIONS::cursorSmallCrosshairs )
                            .AddAction( ACTIONS::cursorFullCrosshairs )
                            .AddAction( ACTIONS::cursor45Crosshairs ) );
 
        config.AppendSeparator()
              .AppendAction( SCH_ACTIONS::showElectricalTypes )
              .AppendAction( SCH_ACTIONS::showHiddenPins )
              .AppendAction( SCH_ACTIONS::showHiddenFields );
        //    .AppendAction( SCH_ACTIONS::togglePinAltIcons );
 
        if( ADVANCED_CFG::GetCfg().m_DrawBoundingBoxes )
            config.AppendAction( ACTIONS::toggleBoundingBoxes );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::showLibraryTree )
              .AppendAction( ACTIONS::showProperties );
        break;
 
    case TOOLBAR_LOC::RIGHT:
        config.AppendAction( ACTIONS::selectionTool );
 
        config.AppendSeparator()
              .AppendAction( SCH_ACTIONS::placeSymbolPin )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Text objects" ) )
                            .AddAction( SCH_ACTIONS::placeSymbolText )
                            .AddAction( SCH_ACTIONS::drawSymbolTextBox ) )
              .AppendAction( SCH_ACTIONS::drawRectangle )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Circle" ) )
                            .AddAction( SCH_ACTIONS::drawCircle )
                            .AddAction( SCH_ACTIONS::drawEllipse ) )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Arc" ) )
                            .AddAction( SCH_ACTIONS::drawArcCenter )
                            .AddAction( SCH_ACTIONS::drawArcStartEndMid )
                            .AddAction( SCH_ACTIONS::drawArcStartEndCenter )
                            .AddAction( SCH_ACTIONS::drawArcTangent )
                            .AddAction( SCH_ACTIONS::drawArcStartDirEnd )
                            .AddAction( SCH_ACTIONS::drawEllipseArc ) )
              .AppendAction( SCH_ACTIONS::drawBezier )
              .AppendAction( SCH_ACTIONS::drawSymbolLines )
              .AppendAction( SCH_ACTIONS::drawSymbolPolygon )
              .AppendAction( SCH_ACTIONS::placeSymbolAnchor )
              .AppendAction( ACTIONS::deleteTool);
        break;
 
    case TOOLBAR_LOC::TOP_MAIN:
        config.AppendAction( SCH_ACTIONS::newSymbol )
              .AppendAction( ACTIONS::saveAll )
              .AppendAction( ACTIONS::save );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::undo )
              .AppendAction( ACTIONS::redo );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::find )
              .AppendAction( ACTIONS::findAndReplace );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::zoomRedraw )
              .AppendAction( ACTIONS::zoomInCenter )
              .AppendAction( ACTIONS::zoomOutCenter )
              .AppendAction( ACTIONS::zoomFitScreen )
              .AppendAction( ACTIONS::zoomTool );
 
        config.AppendSeparator()
              .AppendAction( SCH_ACTIONS::rotateCCW )
              .AppendAction( SCH_ACTIONS::rotateCW )
              .AppendAction( SCH_ACTIONS::mirrorV )
              .AppendAction( SCH_ACTIONS::mirrorH );
 
        config.AppendSeparator()
              .AppendAction( SCH_ACTIONS::symbolProperties )
              .AppendAction( SCH_ACTIONS::pinTable );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::showDatasheet )
              .AppendAction( SCH_ACTIONS::checkSymbol );
 
        config.AppendSeparator()
              .AppendControl( ACTION_TOOLBAR_CONTROLS::bodyStyleSelector );
 
        config.AppendSeparator()
              .AppendControl( ACTION_TOOLBAR_CONTROLS::unitSelector );
 
        config.AppendSeparator()
              .AppendAction( SCH_ACTIONS::toggleSyncedPinsMode );
 
        config.AppendSeparator()
              .AppendAction( SCH_ACTIONS::addSymbolToSchematic );
 
        config.AppendSeparator()
              .AppendControl( ACTION_TOOLBAR_CONTROLS::ipcScripting );
        break;
    }
 
    // clang-format on
    return config;
}
 
 
void SYMBOL_EDIT_FRAME::configureToolbars()
{
    SCH_BASE_FRAME::configureToolbars();
 
    auto unitDisplayFactory =
            [this]( ACTION_TOOLBAR* aToolbar )
            {
                if( !m_unitSelectBox )
                {
                    m_unitSelectBox = new wxComboBox( aToolbar, ID_LIBEDIT_SELECT_UNIT_NUMBER,
                                                      wxEmptyString, wxDefaultPosition,
                                                      wxSize( LISTBOX_WIDTH, -1 ), 0,
                                                      nullptr, wxCB_READONLY );
                }
 
                aToolbar->Add( m_unitSelectBox );
            };
 
    auto bodyDisplayFactory =
            [this]( ACTION_TOOLBAR* aToolbar )
            {
                if( !m_bodyStyleSelectBox )
                {
                    m_bodyStyleSelectBox = new wxComboBox( aToolbar, ID_LIBEDIT_SELECT_BODY_STYLE,
                                                           wxEmptyString, wxDefaultPosition,
                                                           wxSize( LISTBOX_WIDTH, -1 ), 0,
                                                           nullptr, wxCB_READONLY );
                }
 
                aToolbar->Add( m_bodyStyleSelectBox );
            };
 
    RegisterCustomToolbarControlFactory( ACTION_TOOLBAR_CONTROLS::unitSelector, unitDisplayFactory );
    RegisterCustomToolbarControlFactory( ACTION_TOOLBAR_CONTROLS::bodyStyleSelector, bodyDisplayFactory );
 
    // IPC/Scripting plugin control
    auto pluginControlFactory =
            [this]( ACTION_TOOLBAR* aToolbar )
            {
                bool haveApiPlugins = Pgm().GetCommonSettings()->m_Api.enable_server
                                        && !Pgm().GetPluginManager().GetActionsForScope( PluginActionScope() ).empty();
 
                if( haveApiPlugins )
                {
                    aToolbar->AddScaledSeparator( aToolbar->GetParent() );
                    AddApiPluginTools( aToolbar );
                }
            };
 
    RegisterCustomToolbarControlFactory( ACTION_TOOLBAR_CONTROLS::ipcScripting, pluginControlFactory );
}
 
 
void SYMBOL_EDIT_FRAME::ClearToolbarControl( int aId )
{
    SCH_BASE_FRAME::ClearToolbarControl( aId );
 
    switch( aId )
    {
    case ID_LIBEDIT_SELECT_UNIT_NUMBER: m_unitSelectBox = nullptr;      break;
    case ID_LIBEDIT_SELECT_BODY_STYLE:  m_bodyStyleSelectBox = nullptr; break;
    }
}