You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

57 lines
2.0 KiB

  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. /**
  25. * This file is part of the common library.
  26. * @file eda_doc.h
  27. * @see common.h
  28. */
  29. #ifndef __INCLUDE__EDA_DOC_H__
  30. #define __INCLUDE__EDA_DOC_H__ 1
  31. /**
  32. * Function KeywordMatch
  33. * searches \a aKeyList for any words found in \a aDatabase.
  34. *
  35. * @return true if keyword is found.
  36. */
  37. bool KeywordMatch( const wxString& aKeys, const wxString& aDatabase );
  38. /**
  39. * Function GetAssociatedDocument
  40. * open a document (file) with the suitable browser
  41. * @param aParent = main frame
  42. * @param aDocName = filename of file to open (Full filename or short filename)
  43. * if \a aDocName begins with http: or ftp: or www. the default internet browser is launched
  44. * @param aPaths = a wxPathList to explore.
  45. * if NULL or aDocName is a full filename, aPath is not used.
  46. */
  47. bool GetAssociatedDocument( wxWindow* aParent,
  48. const wxString& aDocName,
  49. const wxPathList* aPaths = NULL );
  50. #endif /* __INCLUDE__EDA_DOC_H__ */