KiCad PCB EDA Suite
eda_doc.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2009-2014 Jerry Jacobs
5  * Copyright (C) 1992-2014 KiCad Developers, see CHANGELOG.TXT for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
31 #ifndef __INCLUDE__EDA_DOC_H__
32 #define __INCLUDE__EDA_DOC_H__ 1
33 
34 
41 int KeyWordOk( const wxString& aKeyList, const wxString& aDatabase );
42 
52 bool GetAssociatedDocument( wxWindow* aParent,
53  const wxString& aDocName,
54  const wxPathList* aPaths = NULL );
55 
56 
57 #endif /* __INCLUDE__EDA_DOC_H__ */
bool GetAssociatedDocument(wxWindow *aParent, const wxString &aDocName, const wxPathList *aPaths=NULL)
Function GetAssociatedDocument open a document (file) with the suitable browser.
Definition: eda_doc.cpp:86
int KeyWordOk(const wxString &aKeyList, const wxString &aDatabase)
Function KeyWordOk searches aKeyList for any words found in aDatabase.
Definition: eda_doc.cpp:211