KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2021 KiCad Developers, see AUTHORS.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#ifndef GESTFICH_H
26#define GESTFICH_H
27
28#include <kicommon.h>
29#include <wx/filename.h>
30#include <wx/process.h>
31
32
36#define UNIX_STRING_DIR_SEP wxT( "/" )
37#define WIN_STRING_DIR_SEP wxT( "\\" )
38
39/* Forward class declarations. */
40class EDA_LIST_DIALOG;
41
42
49KICOMMON_API bool OpenPDF( const wxString& file );
50KICOMMON_API void OpenFile( const wxString& file );
51
57KICOMMON_API void KiCopyFile( const wxString& aSrcPath, const wxString& aDestPath,
58 wxString& aErrors );
59
69KICOMMON_API int ExecuteFile( const wxString& aEditorName, const wxString& aFileName = wxEmptyString,
70 wxProcess* aCallback = nullptr, bool aFileForKicad = true );
71
77KICOMMON_API void QuoteString( wxString& string );
78
89KICOMMON_API wxString FindKicadFile( const wxString& shortname );
90
101KICOMMON_API extern wxString QuoteFullPath( wxFileName& fn, wxPathFormat format = wxPATH_NATIVE );
102
103
108KICOMMON_API bool RmDirRecursive( const wxString& aDirName, wxString* aErrors = nullptr );
109
110#endif /* GESTFICH_H */
A dialog which shows:
KICOMMON_API void OpenFile(const wxString &file)
Definition: gestfich.cpp:286
KICOMMON_API wxString QuoteFullPath(wxFileName &fn, wxPathFormat format=wxPATH_NATIVE)
Quote return value of wxFileName::GetFullPath().
Definition: gestfich.cpp:320
KICOMMON_API void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition: gestfich.cpp:305
KICOMMON_API bool OpenPDF(const wxString &file)
Run the PDF viewer and display a PDF file.
Definition: gestfich.cpp:250
KICOMMON_API void QuoteString(wxString &string)
Add un " to the start and the end of string (if not already done).
Definition: gestfich.cpp:44
KICOMMON_API 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:54
KICOMMON_API bool RmDirRecursive(const wxString &aDirName, wxString *aErrors=nullptr)
Removes the directory aDirName and all its contents including subdirectories and their files.
Definition: gestfich.cpp:326
KICOMMON_API int ExecuteFile(const wxString &aEditorName, const wxString &aFileName=wxEmptyString, wxProcess *aCallback=nullptr, bool aFileForKicad=true)
Call the executable file aEditorName with the parameter aFileName.
Definition: gestfich.cpp:139
#define KICOMMON_API
Definition: kicommon.h:28