pcbnew_scripting_helpers.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 NBEE Embedded Systems SL, Miguel Angel Ajo <[email protected]>
 * Copyright (C) 2013-2023 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 __PCBNEW_SCRIPTING_HELPERS_H
#define __PCBNEW_SCRIPTING_HELPERS_H
 
#include <deque>
#include <pcb_io/pcb_io_mgr.h>
#include <layer_ids.h>
 
class PCB_EDIT_FRAME;
class BOARD;
class SETTINGS_MANAGER;
class BOARD_ITEM;
enum class EDA_UNITS;
enum PCB_LAYER_ID : int;
 
/* we could be including all these methods as static in a class, but
 * we want plain pcbnew.<method_name> access from python
 */
 
#ifndef SWIG
void ScriptingSetPcbEditFrame( PCB_EDIT_FRAME* aPCBEdaFrame );
void ScriptingOnDestructPcbEditFrame( PCB_EDIT_FRAME* aPCBEdaFrame );
 
#endif
 
// For Python scripts: return the current board.
BOARD*  GetBoard();
 
BOARD* LoadBoard( const wxString& aFileName, PCB_IO_MGR::PCB_FILE_T aFormat );
 
#ifndef SWIG
BOARD* LoadBoard( const wxString& aFileName, PCB_IO_MGR::PCB_FILE_T aFormat, bool aSetActive );
#endif
 
// Default LoadBoard() to load .kicad_pcb files:.
#ifndef SWIG
 
BOARD* LoadBoard( const wxString& aFileName, bool aSetActive );
#endif
 
BOARD* LoadBoard( const wxString& aFileName );
 
BOARD*  NewBoard( wxString& aFileName );
 
SETTINGS_MANAGER* GetSettingsManager();
 
BOARD* CreateEmptyBoard();
 
bool SaveBoard( wxString& aFileName, BOARD* aBoard, bool aSkipSettings = false );
 
wxArrayString GetFootprintLibraries();
 
wxArrayString GetFootprints( const wxString& aNickName );
 
bool ExportSpecctraDSN( wxString& aFullFilename );
 
bool ExportSpecctraDSN( BOARD* aBoard, wxString& aFullFilename );
 
bool ExportVRML( const wxString& aFullFileName, double aMMtoWRMLunit, bool aIncludeUnspecified,
                 bool aIncludeDNP, bool aExport3DFiles,
                 bool aUseRelativePaths, const wxString& a3D_Subdir, double aXRef, double aYRef );
 
bool ImportSpecctraSES( wxString& aFullFilename );
 
bool ImportSpecctraSES( BOARD* aBoard, wxString& aFullFilename );
 
bool ExportFootprintsToLibrary( bool aStoreInNewLib, const wxString& aLibName = wxEmptyString,
                                wxString* aLibPath = nullptr );
 
void Refresh();
 
void UpdateUserInterface();
 
int GetUserUnits();
 
std::deque<BOARD_ITEM*> GetCurrentSelection();
 
void FocusOnItem( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer = UNDEFINED_LAYER );
 
bool IsActionRunning();
 
bool WriteDRCReport( BOARD* aBoard, const wxString& aFileName, EDA_UNITS aUnits,
                     bool aReportAllTrackErrors );
 
wxString GetLanguage();
 
#endif      // __PCBNEW_SCRIPTING_HELPERS_H