KiCad PCB EDA Suite
grid_menu.cpp
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) 2015 CERN
5  * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
6  * @author Maciej Suminski <maciej.suminski@cern.ch>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #include <tool/grid_menu.h>
27 #include <id.h>
28 #include <eda_draw_frame.h>
29 #include <settings/app_settings.h>
30 #include <tool/actions.h>
31 #include <bitmaps.h>
32 #include <base_units.h>
33 
34 using namespace std::placeholders;
35 
37  ACTION_MENU( true ),
38  m_parent( aParent )
39 {
40  SetTitle( _( "Grid" ) );
42 
43  APP_SETTINGS_BASE* settings = m_parent->config();
44  wxArrayString gridsList;
45  int i = ID_POPUP_GRID_START;
46 
47  BuildChoiceList( &gridsList, settings, m_parent->GetUserUnits() != EDA_UNITS::INCHES );
48 
49  for( const wxString& grid : gridsList )
50  Append( i++, grid, wxEmptyString, wxITEM_CHECK );
51 }
52 
53 
54 OPT_TOOL_EVENT GRID_MENU::eventHandler( const wxMenuEvent& aEvent )
55 {
56  OPT_TOOL_EVENT event( ACTIONS::gridPreset.MakeEvent() );
57  event->SetParameter( (intptr_t) aEvent.GetId() - ID_POPUP_GRID_START );
58  return event;
59 }
60 
61 
63 {
64  APP_SETTINGS_BASE* settings = m_parent->config();
65  unsigned int current = settings->m_Window.grid.last_size_idx;
66  wxArrayString gridsList;
67 
68  BuildChoiceList( &gridsList, settings, m_parent->GetUserUnits() != EDA_UNITS::INCHES );
69 
70  for( unsigned int i = 0; i < GetMenuItemCount(); ++i )
71  {
72  wxMenuItem* menuItem = FindItemByPosition( i );
73 
74  menuItem->SetItemLabel( gridsList[ i ] ); // Refresh label in case units have changed
75  menuItem->Check( i == current ); // Refresh checkmark
76  }
77 }
78 
79 
80 void GRID_MENU::BuildChoiceList( wxArrayString* aGridsList, APP_SETTINGS_BASE* aCfg, bool mmFirst )
81 {
82  wxString msg;
83 
84  for( const wxString& gridSize : aCfg->m_Window.grid.sizes )
85  {
86  int val = (int) ValueFromString( EDA_UNITS::MILLIMETRES, gridSize, true );
87  double gridValueMils = To_User_Unit( EDA_UNITS::INCHES, val ) * 1000;
88  double gridValue_mm = To_User_Unit( EDA_UNITS::MILLIMETRES, val );
89 
90  if( mmFirst )
91  msg.Printf( _( "Grid: %.4f mm (%.2f mils)" ), gridValue_mm, gridValueMils );
92  else
93  msg.Printf( _( "Grid: %.2f mils (%.4f mm)" ), gridValueMils, gridValue_mm );
94 
95  aGridsList->Add( msg );
96  }
97 
98 
99  if( !aCfg->m_Window.grid.user_grid_x.empty() )
100  {
101  int val = (int) ValueFromString( EDA_UNITS::INCHES, aCfg->m_Window.grid.user_grid_x, true );
102  double gridValueMils = To_User_Unit( EDA_UNITS::INCHES, val ) * 1000;
103  double gridValue_mm = To_User_Unit( EDA_UNITS::MILLIMETRES, val );
104 
105  if( mmFirst )
106  msg.Printf( _( "User grid: %.4f mm (%.2f mils)" ), gridValue_mm, gridValueMils );
107  else
108  msg.Printf( _( "User grid: %.2f mils (%.4f mm)" ), gridValueMils, gridValue_mm );
109 
110  aGridsList->Add( msg );
111  }
112 }
113 
114 
double To_User_Unit(EDA_UNITS aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:92
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
wxString user_grid_x
Definition: app_settings.h:53
Implementation of conversion functions that require both schematic and board internal units.
ACTION_MENU.
Definition: action_menu.h:44
OPT_TOOL_EVENT eventHandler(const wxMenuEvent &aEvent) override
Event handler stub.
Definition: grid_menu.cpp:54
The base class for create windows for drawing purpose.
const BITMAP_OPAQUE grid_select_xpm[1]
Definition: grid_select.cpp:29
std::vector< wxString > sizes
Definition: app_settings.h:52
EDA_DRAW_FRAME * m_parent
Definition: grid_menu.h:49
static TOOL_ACTION gridPreset
Definition: actions.h:134
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:91
GRID_SETTINGS grid
Definition: app_settings.h:81
void SetIcon(const BITMAP_OPAQUE *aIcon)
Function SetIcon() Assigns an icon for the entry.
Definition: action_menu.cpp:70
static void BuildChoiceList(wxArrayString *aGridsList, APP_SETTINGS_BASE *aCfg, bool mmFirst)
Definition: grid_menu.cpp:80
WINDOW_SETTINGS m_Window
Definition: app_settings.h:153
void SetTitle(const wxString &aTitle) override
Function SetTitle() Sets title for the menu.
Definition: action_menu.cpp:88
#define _(s)
Definition: 3d_actions.cpp:33
void update() override
Update menu state stub.
Definition: grid_menu.cpp:62
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
long long int ValueFromString(EDA_UNITS aUnits, const wxString &aTextValue, bool aUseMils, EDA_DATA_TYPE aType)
Function ValueFromString converts aTextValue in aUnits to internal units used by the application.
Definition: base_units.cpp:471
OPT< TOOL_EVENT > OPT_TOOL_EVENT
Definition: tool_event.h:556
GRID_MENU(EDA_DRAW_FRAME *aParent)
Definition: grid_menu.cpp:36