eeschema_helpers.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 3
 * 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/>.
 */
 
#ifndef EESCHEMA_HELPERS_H_
#define EESCHEMA_HELPERS_H_
 
#include <wx/string.h>
#include <sch_io/sch_io_mgr.h>
 
class SCHEMATIC;
class SCH_EDIT_FRAME;
class SETTINGS_MANAGER;
class PROJECT;
class REPORTER;

class EESCHEMA_HELPERS
{
public:
    static void              SetSchEditFrame( SCH_EDIT_FRAME* aSchEditFrame );
    // A root reporter requests strict root-input validation before loader recovery.
    static SCHEMATIC*        LoadSchematic( const wxString& aFileName, bool aSetActive,
                                            bool aForceDefaultProject,
                                            PROJECT* aProject = nullptr,
                                            bool aCalculateConnectivity = true,
                                            REPORTER* aRootReporter = nullptr );
    static SCHEMATIC*        LoadSchematic( const wxString& aFileName,
                                            SCH_IO_MGR::SCH_FILE_T aFormat,
                                            bool aSetActive, bool aForceDefaultProject,
                                            PROJECT* aProject = nullptr,
                                            bool aCalculateConnectivity = true,
                                            REPORTER* aRootReporter = nullptr );
 
private:
    static SCH_EDIT_FRAME*   s_SchEditFrame;
};
 
#endif