KiCad PCB EDA Suite
panel_text_variables.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) 2020 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #include <panel_text_variables.h>
25 
26 #include <bitmaps.h>
27 #include <confirm.h>
28 #include <validators.h>
29 #include <project.h>
30 #include <grid_tricks.h>
31 #include <widgets/wx_grid.h>
32 
33 #include <algorithm>
34 
36 {
39 };
40 
41 
42 PANEL_TEXT_VARIABLES::PANEL_TEXT_VARIABLES( wxWindow* aParent, PROJECT* aProject ) :
43  PANEL_TEXT_VARIABLES_BASE( aParent ),
44  m_project( aProject ),
45  m_errorRow( -1 ), m_errorCol( -1 ),
46  m_gridWidthsDirty( true )
47 {
48  m_btnAddTextVar->SetBitmap( KiBitmap( small_plus_xpm ) );
49  m_btnDeleteTextVar->SetBitmap( KiBitmap( trash_xpm ) );
50 
51  m_TextVars->DeleteRows( 0, m_TextVars->GetNumberRows() );
52 
53  // prohibit these characters in the alias names: []{}()%~<>"='`;:.,&?/\|$
54  m_nameValidator.SetStyle( wxFILTER_EXCLUDE_CHAR_LIST );
55  m_nameValidator.SetCharExcludes( wxT( "{}[]()%~<>\"='`;:.,&?/\\|$" ) );
56 
57  m_TextVars->PushEventHandler( new GRID_TRICKS( m_TextVars ) );
58  m_TextVars->SetSelectionMode( wxGrid::wxGridSelectionModes::wxGridSelectRows );
59 
60  // wxFormBuilder doesn't include this event...
61  m_TextVars->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( PANEL_TEXT_VARIABLES::OnGridCellChanging ), NULL, this );
62 }
63 
64 
66 {
67  // Delete the GRID_TRICKS.
68  m_TextVars->PopEventHandler( true );
69 
70  m_TextVars->Disconnect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( PANEL_TEXT_VARIABLES::OnGridCellChanging ), NULL, this );
71 }
72 
73 
75 {
76  std::map<wxString, wxString>& variables = m_project->GetTextVars();
77 
78  for( const auto& var : variables )
79  AppendTextVar( var.first, var.second );
80 
81  return true;
82 }
83 
84 
85 void PANEL_TEXT_VARIABLES::AppendTextVar( const wxString& aName, const wxString& aValue )
86 {
87  int i = m_TextVars->GetNumberRows();
88 
89  m_TextVars->AppendRows( 1 );
90 
91  m_TextVars->SetCellValue( i, TV_NAME_COL, aName );
92 
93  wxGridCellAttr* nameCellAttr = m_TextVars->GetOrCreateCellAttr( i, TV_NAME_COL );
94  wxGridCellTextEditor* nameTextEditor = new GRID_CELL_TEXT_EDITOR();
95  nameTextEditor->SetValidator( m_nameValidator );
96  nameCellAttr->SetEditor( nameTextEditor );
97  nameCellAttr->DecRef();
98 
99  m_TextVars->SetCellValue( i, TV_VALUE_COL, aValue );
100 }
101 
102 
104 {
106  return false;
107 
108  for( int row = 0; row < m_TextVars->GetNumberRows(); ++row )
109  {
110  if( m_TextVars->GetCellValue( row, TV_NAME_COL ).IsEmpty() )
111  {
112  m_errorRow = row;
114  m_errorMsg = _( "Variable name cannot be empty." );
115  return false;
116  }
117  }
118 
119  std::map<wxString, wxString>& variables = m_project->GetTextVars();
120 
121  variables.clear();
122 
123  for( int row = 0; row < m_TextVars->GetNumberRows(); ++row )
124  {
125  wxString name = m_TextVars->GetCellValue( row, TV_NAME_COL );
126  wxString value = m_TextVars->GetCellValue( row, TV_VALUE_COL );
127  variables[ name ] = value;
128  }
129 
130  return true;
131 }
132 
133 
135 {
136  int row = event.GetRow();
137  int col = event.GetCol();
138  wxString text = event.GetString();
139 
140  if( text.IsEmpty() && col == TV_NAME_COL )
141  {
142  m_errorMsg = _( "Variable name cannot be empty." );
143  m_errorRow = row;
144  m_errorCol = col;
145 
146  event.Veto();
147  }
148 }
149 
150 
151 void PANEL_TEXT_VARIABLES::OnAddTextVar( wxCommandEvent& event )
152 {
154  return;
155 
156  AppendTextVar( wxEmptyString, wxEmptyString );
157 
158  m_TextVars->MakeCellVisible( m_TextVars->GetNumberRows() - 1, TV_NAME_COL );
159  m_TextVars->SetGridCursor( m_TextVars->GetNumberRows() - 1, TV_NAME_COL );
160 
161  m_TextVars->EnableCellEditControl( true );
162  m_TextVars->ShowCellEditControl();
163 }
164 
165 
166 void PANEL_TEXT_VARIABLES::OnRemoveTextVar( wxCommandEvent& event )
167 {
168  int curRow = m_TextVars->GetGridCursorRow();
169 
170  if( curRow < 0 || m_TextVars->GetNumberRows() <= curRow )
171  return;
172 
173  m_TextVars->CommitPendingChanges( true /* silent mode; we don't care if it's valid */ );
174  m_TextVars->DeleteRows( curRow, 1 );
175 
176  m_TextVars->MakeCellVisible( std::max( 0, curRow-1 ), m_TextVars->GetGridCursorCol() );
177  m_TextVars->SetGridCursor( std::max( 0, curRow-1 ), m_TextVars->GetGridCursorCol() );
178 }
179 
180 
181 void PANEL_TEXT_VARIABLES::OnGridCellChange( wxGridEvent& aEvent )
182 {
183  m_gridWidthsDirty = true;
184 
185  aEvent.Skip();
186 }
187 
188 
189 void PANEL_TEXT_VARIABLES::OnUpdateUI( wxUpdateUIEvent& event )
190 {
191  if( m_gridWidthsDirty && ( !m_TextVars->IsCellEditControlShown() ) )
192  {
193  int width = m_TextVars->GetClientRect().GetWidth();
194 
195  m_TextVars->AutoSizeColumn( TV_NAME_COL );
196  m_TextVars->SetColSize( TV_NAME_COL, std::max( m_TextVars->GetColSize( TV_NAME_COL ), 120 ) );
197 
198  m_TextVars->SetColSize( TV_VALUE_COL, width - m_TextVars->GetColSize( TV_NAME_COL ) );
199  m_gridWidthsDirty = false;
200  }
201 
202  // Handle a grid error. This is delayed to OnUpdateUI so that we can change focus
203  // even when the original validation was triggered from a killFocus event (and for
204  // dialog with notebooks, so that the corresponding notebook page can be shown in
205  // the background when triggered from an OK).
206  if( !m_errorMsg.IsEmpty() )
207  {
208  // We will re-enter this routine when the error dialog is displayed, so make
209  // sure we don't keep putting up more dialogs.
210  wxString errorMsg = m_errorMsg;
211  m_errorMsg = wxEmptyString;
212 
213  DisplayErrorMessage( this, errorMsg );
214 
215  m_TextVars->SetFocus();
216  m_TextVars->MakeCellVisible( m_errorRow, m_errorCol );
217  m_TextVars->SetGridCursor( m_errorRow, m_errorCol );
218 
219  m_TextVars->EnableCellEditControl( true );
220  m_TextVars->ShowCellEditControl();
221  }
222 }
223 
224 
225 void PANEL_TEXT_VARIABLES::OnGridSize( wxSizeEvent& event )
226 {
227  m_gridWidthsDirty = true;
228 
229  event.Skip();
230 }
231 
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:46
VTBL_ENTRY std::map< wxString, wxString > & GetTextVars() const
Definition: project.cpp:79
PROJECT holds project specific data.
Definition: project.h:61
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:252
void OnAddTextVar(wxCommandEvent &event) override
This file is part of the common library.
void OnGridSize(wxSizeEvent &event) override
bool TransferDataToWindow() override
GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GRID ins...
Definition: grid_tricks.h:51
void OnRemoveTextVar(wxCommandEvent &event) override
This class works around a bug in wxGrid where the first keystroke doesn't get sent through the valida...
Definition: validators.h:44
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
void OnGridCellChange(wxGridEvent &event) override
#define NULL
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:174
wxTextValidator m_nameValidator
Class PANEL_TEXT_VARIABLES_BASE.
const char * name
Definition: DXF_plotter.cpp:60
#define _(s)
Definition: 3d_actions.cpp:33
bool TransferDataFromWindow() override
PANEL_TEXT_VARIABLES(wxWindow *aParent, PROJECT *aProject)
void OnUpdateUI(wxUpdateUIEvent &event) override
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20
void OnGridCellChanging(wxGridEvent &event)
Custom text control validator definitions.
void AppendTextVar(const wxString &aName, const wxString &aValue)