/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2009-2014 Jerry Jacobs * Copyright (C) 1992-2020 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 */ /** * This file is part of the common library. * @file eda_doc.h * @see common.h */ #ifndef __INCLUDE__EDA_DOC_H__ #define __INCLUDE__EDA_DOC_H__ 1 /** * Open a document (file) with the suitable browser. * * Environmental variables are substituted before the document name is resolved for * either browser or file. If \a aDocName begins with http: or ftp: or www. the * default internet browser is launched. * * @param aParent main frame. * @param aDocName filename of file to open (Full filename or short filename). * @param aPaths Additional paths to search for local disk datasheet files */ bool GetAssociatedDocument( wxWindow* aParent, const wxString& aDocName, PROJECT* aProject, SEARCH_STACK* aPaths = nullptr ); #endif /* __INCLUDE__EDA_DOC_H__ */