KiCad PCB EDA Suite
gestfich.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-2020 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 
33 #ifndef __INCLUDE__GESTFICH_H__
34 #define __INCLUDE__GESTFICH_H__ 1
35 
36 #include <wx/filename.h>
37 #include <wx/process.h>
38 
39 
43 #define UNIX_STRING_DIR_SEP wxT( "/" )
44 #define WIN_STRING_DIR_SEP wxT( "\\" )
45 
46 /* Forward class declarations. */
47 class EDA_LIST_DIALOG;
48 
49 
56 bool OpenPDF( const wxString& file );
57 void OpenFile( const wxString& file );
58 
59 void PrintFile( const wxString& file );
60 bool CanPrintFile( const wxString& file );
61 
67 void KiCopyFile( const wxString& aSrcPath, const wxString& aDestPath, wxString& aErrors );
68 
87 wxString EDA_FILE_SELECTOR( const wxString& aTitle,
88  const wxString& aPath,
89  const wxString& aFileName,
90  const wxString& aExtension,
91  const wxString& aWildcard,
92  wxWindow* aParent,
93  int aStyle,
94  const bool aKeepWorkingDirectory,
95  const wxPoint& aPosition = wxDefaultPosition,
96  wxString* aMruPath = nullptr );
97 
98 EDA_LIST_DIALOG* GetFileNames( char* Directory, char* Mask );
99 
100 
104 int ExecuteFile( wxWindow* frame, const wxString& ExecFile,
105  const wxString& param = wxEmptyString, wxProcess* callback = nullptr );
106 
112 void AddDelimiterString( wxString& string );
113 
124 wxString KicadDatasPath();
125 
136 wxString FindKicadFile( const wxString& shortname );
137 
148 extern wxString QuoteFullPath( wxFileName& fn, wxPathFormat format = wxPATH_NATIVE );
149 
150 #endif /* __INCLUDE__GESTFICH_H__ */
int ExecuteFile(wxWindow *frame, const wxString &ExecFile, const wxString &param=wxEmptyString, wxProcess *callback=nullptr)
Call the executable file ExecFile with the command line parameters param.
Definition: gestfich.cpp:165
wxString FindKicadFile(const wxString &shortname)
Search the executable file shortname in KiCad binary path and return full file name if found or short...
Definition: gestfich.cpp:102
bool OpenPDF(const wxString &file)
Run the PDF viewer and display a PDF file.
Definition: gestfich.cpp:196
EDA_LIST_DIALOG * GetFileNames(char *Directory, char *Mask)
void AddDelimiterString(wxString &string)
Add un " to the start and the end of string (if not already done).
Definition: gestfich.cpp:42
A dialog which shows:
void OpenFile(const wxString &file)
Definition: gestfich.cpp:257
wxString KicadDatasPath()
Return the data path common to KiCad.
bool CanPrintFile(const wxString &file)
Definition: gestfich.cpp:357
void PrintFile(const wxString &file)
Definition: gestfich.cpp:351
wxString QuoteFullPath(wxFileName &fn, wxPathFormat format=wxPATH_NATIVE)
Quote return value of wxFileName::GetFullPath().
Definition: gestfich.cpp:378
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition: gestfich.cpp:363
wxString EDA_FILE_SELECTOR(const wxString &aTitle, const wxString &aPath, const wxString &aFileName, const wxString &aExtension, const wxString &aWildcard, wxWindow *aParent, int aStyle, const bool aKeepWorkingDirectory, const wxPoint &aPosition=wxDefaultPosition, wxString *aMruPath=nullptr)
A helper function that wraps a call to wxFileSelector.
Definition: gestfich.cpp:52