KiCad PCB EDA Suite
stackup_predefined_prms.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) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2009-2019 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 
29 #ifndef STACKUP_PREDEFINED_PRMS_H
30 #define STACKUP_PREDEFINED_PRMS_H
31 
32 
33 #include <wx/string.h>
34 #include <wx/arrstr.h>
35 #include <wx/colour.h>
36 
37 #include <layer_ids.h>
38 #include <i18n_utility.h> // For _HKI definition
39 
40 // Keyword used in file to identify the dielectric layer type
41 #define KEY_CORE "core"
42 #define KEY_PREPREG "prepreg"
43 
44 #define KEY_COPPER "copper"
45 
46 // key string used for not specified parameters
47 // Can be translated in dialogs, and is also a keyword
48 // outside dialogs
49 wxString inline NotSpecifiedPrm()
50 {
51  return _HKI( "Not specified" );
52 }
53 
59 bool IsPrmSpecified( const wxString& aPrmValue );
60 
61 // A reasonable Epsilon R value for solder mask dielectric
62 #define DEFAULT_EPSILON_R_SOLDERMASK 3.3
63 
64 // A default Epsilon R value for silkscreen dielectric
65 #define DEFAULT_EPSILON_R_SILKSCREEN 1.0
66 
67 // A minor struct to handle color in gerber job file and dialog
69 {
70  wxString m_ColorName; // the name (in job file) of the color
71  // User values are the HTML coding #rrggbb hexa value.
72  wxColor m_Color; // the color in r,g,b values (0..255)
73 
75  FAB_LAYER_COLOR( const wxString& aColorName, const wxColor& aColor )
76  : m_ColorName( aColorName ), m_Color( aColor )
77  {}
78 };
79 
80 
85 wxArrayString GetCopperFinishStandardList( bool aTranslate );
86 
91 
96 
101 
102 #endif // #ifndef STACKUP_PREDEFINED_PRMS_H
FAB_LAYER_COLOR(const wxString &aColorName, const wxColor &aColor)
bool IsPrmSpecified(const wxString &aPrmValue)
int GetColorUserDefinedListIdx()
int GetColorStandardListCount()
wxString NotSpecifiedPrm()
Some functions to handle hotkeys in KiCad.
wxArrayString GetCopperFinishStandardList(bool aTranslate)
const FAB_LAYER_COLOR * GetColorStandardList()
#define _HKI(x)