202 lines
6.6 KiB
C++
202 lines
6.6 KiB
C++
|
/*
|
||
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
||
|
*
|
||
|
* Copyright (C) 2014-2016 CERN
|
||
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
||
|
*
|
||
|
* 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 <bitmaps.h>
|
||
|
#include <tool/actions.h>
|
||
|
#include <tool/tool_manager.h>
|
||
|
#include <eda_draw_frame.h>
|
||
|
#include <class_draw_panel_gal.h>
|
||
|
#include <view/view.h>
|
||
|
#include <view/view_controls.h>
|
||
|
#include <gal/graphics_abstraction_layer.h>
|
||
|
#include <base_screen.h>
|
||
|
#include <tool/common_control.h>
|
||
|
#include <id.h>
|
||
|
#include <project.h>
|
||
|
#include <kiface_i.h>
|
||
|
#include <dialog_configure_paths.h>
|
||
|
#include <eda_doc.h>
|
||
|
|
||
|
#define URL_GET_INVOLVED "http://kicad-pcb.org/contribute/"
|
||
|
|
||
|
|
||
|
void COMMON_CONTROL::Reset( RESET_REASON aReason )
|
||
|
{
|
||
|
m_frame = getEditFrame<EDA_BASE_FRAME>();
|
||
|
}
|
||
|
|
||
|
|
||
|
int COMMON_CONTROL::ConfigurePaths( const TOOL_EVENT& aEvent )
|
||
|
{
|
||
|
KIFACE* kiface = m_frame->Kiway().KiFACE( KIWAY::FACE_PCB );
|
||
|
kiface->CreateWindow( m_frame, DIALOG_CONFIGUREPATHS, &m_frame->Kiway() );
|
||
|
return 0;
|
||
|
}
|
||
|
|
||
|
|
||
|
int COMMON_CONTROL::ShowLibraryTable( const TOOL_EVENT& aEvent )
|
||
|
{
|
||
|
if( aEvent.IsAction( &ACTIONS::showSymbolLibTable ) )
|
||
|
{
|
||
|
KIFACE* kiface = m_frame->Kiway().KiFACE( KIWAY::FACE_SCH );
|
||
|
kiface->CreateWindow( m_frame, DIALOG_SCH_LIBRARY_TABLE, &m_frame->Kiway() );
|
||
|
}
|
||
|
else if( aEvent.IsAction( &ACTIONS::showFootprintLibTable ) )
|
||
|
{
|
||
|
KIFACE* kiface = m_frame->Kiway().KiFACE( KIWAY::FACE_PCB );
|
||
|
kiface->CreateWindow( m_frame, DIALOG_PCB_LIBRARY_TABLE, &m_frame->Kiway() );
|
||
|
}
|
||
|
|
||
|
return 0;
|
||
|
}
|
||
|
|
||
|
|
||
|
int COMMON_CONTROL::ShowPlayer( const TOOL_EVENT& aEvent )
|
||
|
{
|
||
|
FRAME_T playerType = FRAME_SCH_VIEWER;
|
||
|
|
||
|
if( aEvent.IsAction( &ACTIONS::showSymbolBrowser ) )
|
||
|
playerType = FRAME_SCH_VIEWER;
|
||
|
else if( aEvent.IsAction( &ACTIONS::showSymbolEditor ) )
|
||
|
playerType = FRAME_SCH_LIB_EDITOR;
|
||
|
else if( aEvent.IsAction( &ACTIONS::showFootprintBrowser ) )
|
||
|
playerType = FRAME_PCB_MODULE_VIEWER;
|
||
|
else if( aEvent.IsAction( &ACTIONS::showFootprintEditor ) )
|
||
|
playerType = FRAME_PCB_MODULE_EDITOR;
|
||
|
else
|
||
|
wxFAIL_MSG( "ShowPlayer(): unexpected request" );
|
||
|
|
||
|
KIWAY_PLAYER* editor = m_frame->Kiway().Player( playerType, true );
|
||
|
|
||
|
// Needed on Windows, other platforms do not use it, but it creates no issue
|
||
|
if( editor->IsIconized() )
|
||
|
editor->Iconize( false );
|
||
|
|
||
|
editor->Raise();
|
||
|
|
||
|
// Raising the window does not set the focus on Linux. This should work on
|
||
|
// any platform.
|
||
|
if( wxWindow::FindFocus() != editor )
|
||
|
editor->SetFocus();
|
||
|
|
||
|
return 0;
|
||
|
}
|
||
|
|
||
|
|
||
|
int COMMON_CONTROL::ShowHelp( const TOOL_EVENT& aEvent )
|
||
|
{
|
||
|
const SEARCH_STACK& search = m_frame->sys_search();
|
||
|
wxString helpFile;
|
||
|
wxString msg;
|
||
|
|
||
|
/* We have to get document for beginners,
|
||
|
* or the full specific doc
|
||
|
* if event id is wxID_INDEX, we want the document for beginners.
|
||
|
* else the specific doc file (its name is in Kiface().GetHelpFileName())
|
||
|
* The document for beginners is the same for all KiCad utilities
|
||
|
*/
|
||
|
if( aEvent.IsAction( &ACTIONS::gettingStarted ) )
|
||
|
{
|
||
|
// List of possible names for Getting Started in KiCad
|
||
|
const wxChar* names[2] = {
|
||
|
wxT( "getting_started_in_kicad" ),
|
||
|
wxT( "Getting_Started_in_KiCad" )
|
||
|
};
|
||
|
|
||
|
// Search for "getting_started_in_kicad.html" or "getting_started_in_kicad.pdf"
|
||
|
// or "Getting_Started_in_KiCad.html" or "Getting_Started_in_KiCad.pdf"
|
||
|
for( auto& name : names )
|
||
|
{
|
||
|
helpFile = SearchHelpFileFullPath( search, name );
|
||
|
|
||
|
if( !helpFile.IsEmpty() )
|
||
|
break;
|
||
|
}
|
||
|
|
||
|
if( !helpFile )
|
||
|
{
|
||
|
msg = wxString::Format( _( "Html or pdf help file \n%s\nor\n%s could not be found." ),
|
||
|
names[0], names[1] );
|
||
|
wxMessageBox( msg );
|
||
|
return -1;
|
||
|
}
|
||
|
}
|
||
|
else
|
||
|
{
|
||
|
wxString base_name = m_frame->help_name();
|
||
|
|
||
|
helpFile = SearchHelpFileFullPath( search, base_name );
|
||
|
|
||
|
if( !helpFile )
|
||
|
{
|
||
|
msg = wxString::Format( _( "Help file \"%s\" could not be found." ), base_name );
|
||
|
wxMessageBox( msg );
|
||
|
return -1;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
GetAssociatedDocument( m_frame, helpFile );
|
||
|
return 0;
|
||
|
}
|
||
|
|
||
|
|
||
|
int COMMON_CONTROL::ListHotKeys( const TOOL_EVENT& aEvent )
|
||
|
{
|
||
|
DisplayHotkeyList( m_frame, m_toolMgr );
|
||
|
return 0;
|
||
|
}
|
||
|
|
||
|
|
||
|
int COMMON_CONTROL::GetInvolved( const TOOL_EVENT& aEvent )
|
||
|
{
|
||
|
if( !wxLaunchDefaultBrowser( URL_GET_INVOLVED ) )
|
||
|
{
|
||
|
wxString msg;
|
||
|
msg.Printf( _( "Could not launch the default browser.\n"
|
||
|
"For information on how to help the KiCad project, visit %s" ),
|
||
|
URL_GET_INVOLVED );
|
||
|
wxMessageBox( msg, _( "Get involved with KiCad" ), wxOK, m_frame );
|
||
|
}
|
||
|
return 0;
|
||
|
}
|
||
|
|
||
|
|
||
|
void COMMON_CONTROL::setTransitions()
|
||
|
{
|
||
|
Go( &COMMON_CONTROL::ConfigurePaths, ACTIONS::configurePaths.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ShowLibraryTable, ACTIONS::showSymbolLibTable.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ShowLibraryTable, ACTIONS::showFootprintLibTable.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ShowPlayer, ACTIONS::showSymbolBrowser.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ShowPlayer, ACTIONS::showSymbolEditor.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ShowPlayer, ACTIONS::showFootprintBrowser.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ShowPlayer, ACTIONS::showFootprintEditor.MakeEvent() );
|
||
|
|
||
|
Go( &COMMON_CONTROL::ShowHelp, ACTIONS::gettingStarted.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ShowHelp, ACTIONS::help.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::ListHotKeys, ACTIONS::listHotKeys.MakeEvent() );
|
||
|
Go( &COMMON_CONTROL::GetInvolved, ACTIONS::getInvolved.MakeEvent() );
|
||
|
}
|
||
|
|
||
|
|