KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_print_gerbview.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) 2010-2016 Jean-Pierre Charras jp.charras at wanadoo.fr
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 * Copyright (C) 2018 CERN
7 * Author: Maciej Suminski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#include <kiface_base.h>
28#include <confirm.h>
30#include <gerbview_printout.h>
31#include <gerbview.h>
32#include <gerbview_frame.h>
33#include <gerber_file_image.h>
35#include <tool/tool_manager.h>
38#include <wx/checklst.h>
39
40// TODO(JE)
41#define OPTKEY_LAYERBASE wxT( "PlotLayer_%d" )
42
43
45{
46public:
49
50private:
52 {
53 wxASSERT( dynamic_cast<BOARD_PRINTOUT_SETTINGS*>( m_settings ) );
54 return static_cast<BOARD_PRINTOUT_SETTINGS*>( m_settings );
55 }
56
57 bool TransferDataToWindow() override;
58
59 void createExtraOptions();
60 void createLeftPanel();
61
62 void onSelectAllClick( wxCommandEvent& event );
63 void onDeselectAllClick( wxCommandEvent& event );
64
66 void setListBoxValue( wxCheckListBox* aList, bool aValue );
67
69 bool isLayerEnabled( unsigned int aLayer ) const;
70
73
74 void saveSettings() override;
75
76 wxPrintout* createPrintout( const wxString& aTitle ) override
77 {
79 aTitle );
80 }
81
83
84 // Number of layers in each list
85 static constexpr unsigned int LAYER_PER_LIST = 16;
86
87 // Number of layer list widgets
88 static constexpr unsigned int LAYER_LIST_COUNT = 2;
89
90 // Extra widgets
94 wxCheckBox* m_checkboxMirror;
95
96 // Map layer numbers to items on the list
97 std::unordered_map<int, int> m_layerToItemMap;
98};
99
100
102 DIALOG_PRINT_GENERIC( aParent, aSettings ),
103 m_parent( aParent )
104{
107}
108
109
111{
113 return false;
114
116 int itemIdx = 0;
117
118 // Create layer list
119 for( unsigned ii = 0; ii < images->ImagesMaxCount(); ++ii )
120 {
121 unsigned int listIdx = itemIdx / LAYER_PER_LIST;
122
123 if( listIdx >= LAYER_LIST_COUNT )
124 {
125 wxFAIL;
126 break;
127 }
128
129 GERBER_FILE_IMAGE* gbrImage = images->GetGbrImage( ii );
130
131 if( !gbrImage )
132 continue;
133
134 wxFileName filename( gbrImage->m_FileName );
135 wxCheckListBox* listBox = m_layerLists[listIdx];
136 listBox->Append( filename.GetFullName() );
137
138 if( settings()->m_LayerSet.test( ii) )
139 listBox->Check( ii, true );
140
141 wxASSERT( m_layerToItemMap.count( ii ) == 0 );
142 m_layerToItemMap[ii] = itemIdx;
143
144 ++itemIdx;
145 }
146
147 m_checkboxMirror->SetValue( settings()->m_Mirror );
148
149 // Update the dialog layout when layers are added
150 GetSizer()->Fit( this );
151
152 return true;
153}
154
155
157{
158 wxGridBagSizer* optionsSizer = getOptionsSizer();
159 wxStaticBox* box = getOptionsBox();
160 int rows = optionsSizer->GetEffectiveRowsCount();
161 int cols = optionsSizer->GetEffectiveColsCount();
162
163 // Print mirrored
164 m_checkboxMirror = new wxCheckBox( box, wxID_ANY, _( "Print mirrored" ) );
165 optionsSizer->Add( m_checkboxMirror, wxGBPosition( rows, 0 ), wxGBSpan( 1, cols ), wxBOTTOM|wxRIGHT|wxLEFT, 5 );
166}
167
168
170{
171 wxStaticBox* box = new wxStaticBox( this, wxID_ANY, _( "Include Layers" ) );
172 wxStaticBoxSizer* sbLayersSizer = new wxStaticBoxSizer( box, wxVERTICAL );
173
174 // Layer lists
175 wxBoxSizer* bLayerListsSizer = new wxBoxSizer( wxHORIZONTAL );
176
177 for( unsigned int i = 0; i < LAYER_LIST_COUNT; ++i )
178 {
179 m_layerLists[i] = new wxCheckListBox( sbLayersSizer->GetStaticBox(), wxID_ANY );
180 bLayerListsSizer->Add( m_layerLists[i], 1, wxEXPAND, 5 );
181 }
182
183 // Select/Unselect all buttons
184 m_buttonSelectAll = new wxButton( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Select all" ) );
185 m_buttonDeselectAll = new wxButton( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Deselect all" ) );
186
187 m_buttonSelectAll->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
188 wxCommandEventHandler( DIALOG_PRINT_GERBVIEW::onSelectAllClick ), nullptr, this );
189 m_buttonDeselectAll->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
190 wxCommandEventHandler( DIALOG_PRINT_GERBVIEW::onDeselectAllClick ), nullptr, this );
191
192 wxBoxSizer* buttonSizer = new wxBoxSizer( wxHORIZONTAL );
193 buttonSizer->Add( m_buttonSelectAll, 1, wxALL, 5 );
194 buttonSizer->Add( m_buttonDeselectAll, 1, wxALL, 5 );
195
196 // Static box sizer layout
197 sbLayersSizer->Add( bLayerListsSizer, 1, wxEXPAND, 5 );
198 sbLayersSizer->Add( buttonSizer, 0, wxEXPAND, 5 );
199
200 getMainSizer()->Insert( 0, sbLayersSizer, 1, wxEXPAND | wxALL, 5 );
201}
202
203
204void DIALOG_PRINT_GERBVIEW::onSelectAllClick( wxCommandEvent& event )
205{
206 for( wxCheckListBox* checkbox : m_layerLists )
207 setListBoxValue( checkbox, true );
208}
209
210
211void DIALOG_PRINT_GERBVIEW::onDeselectAllClick( wxCommandEvent& event )
212{
213 for( wxCheckListBox* checkbox : m_layerLists )
214 setListBoxValue( checkbox, false );
215}
216
217
218void DIALOG_PRINT_GERBVIEW::setListBoxValue( wxCheckListBox* aList, bool aValue )
219{
220 for( unsigned int i = 0; i < aList->GetCount(); ++i )
221 aList->Check( i, aValue );
222}
223
224
225bool DIALOG_PRINT_GERBVIEW::isLayerEnabled( unsigned int aLayer ) const
226{
227 auto layerMapIt = m_layerToItemMap.find( aLayer );
228
229 if( layerMapIt == m_layerToItemMap.end() )
230 return false;
231
232 unsigned int itemNr = layerMapIt->second;
233 unsigned int listIdx = itemNr / LAYER_PER_LIST;
234 unsigned int itemIdx = itemNr % LAYER_PER_LIST;
235 wxCHECK( listIdx < LAYER_LIST_COUNT, false );
236 wxCheckListBox* listBox = m_layerLists[listIdx];
237
238 return itemIdx < listBox->GetCount() && listBox->IsChecked( itemIdx );
239}
240
241
243{
244 settings()->m_LayerSet = LSET();
245 int& pageCount = settings()->m_pageCount;
246 pageCount = 0;
247
248 unsigned int layer = 0;
249
250 for( unsigned int j = 0; j < LAYER_LIST_COUNT; ++j )
251 {
252 for( unsigned int i = 0; i < LAYER_PER_LIST; ++i )
253 {
254 if( isLayerEnabled( layer ) )
255 {
256 settings()->m_LayerSet.set( layer );
257 ++pageCount;
258 }
259
260 ++layer;
261 }
262 }
263
264 return pageCount;
265}
266
267
269{
271
272 settings()->m_Mirror = m_checkboxMirror->GetValue();
273
275}
276
277
279{
280 // Selection affects the original item visibility
282
285 DIALOG_PRINT_GERBVIEW dlg( m_frame, &settings );
286 dlg.ForcePrintBorder( false );
287 dlg.ShowModal();
288
289 return 0;
290}
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: actions.h:221
BASE_SET & set(size_t pos)
Definition: base_set.h:116
wxStaticBox * getOptionsBox()
bool TransferDataToWindow() override
void ForcePrintBorder(bool aValue)
Set 'print border and title block' to a requested value and hides the corresponding checkbox.
wxGridBagSizer * getOptionsSizer()
PRINTOUT_SETTINGS * m_settings
static constexpr unsigned int LAYER_PER_LIST
static constexpr unsigned int LAYER_LIST_COUNT
void setListBoxValue(wxCheckListBox *aList, bool aValue)
Check whether a layer is enabled in a listbox.
std::unordered_map< int, int > m_layerToItemMap
wxCheckListBox * m_layerLists[LAYER_LIST_COUNT]
~DIALOG_PRINT_GERBVIEW()=default
bool isLayerEnabled(unsigned int aLayer) const
Update layerset basing on the selected layers.
BOARD_PRINTOUT_SETTINGS * settings() const
DIALOG_PRINT_GERBVIEW(GERBVIEW_FRAME *aParent, BOARD_PRINTOUT_SETTINGS *aSettings)
bool TransferDataToWindow() override
void onDeselectAllClick(wxCommandEvent &event)
(Un)check all items in a checklist box
wxPrintout * createPrintout(const wxString &aTitle) override
Create a printout with a requested title.
void onSelectAllClick(wxCommandEvent &event)
int ShowModal() override
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:41
GERBER_FILE_IMAGE_LIST is a helper class to handle a list of GERBER_FILE_IMAGE files which are loaded...
GERBER_FILE_IMAGE * GetGbrImage(int aIdx)
Hold the image data and parameters for one gerber file and layer parameters.
wxString m_FileName
Full File Name for this layer.
GERBVIEW_FRAME * m_frame
int Print(const TOOL_EVENT &aEvent)
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
const PAGE_INFO & GetPageSettings() const override
GBR_LAYOUT * GetGerberLayout() const
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:220
Generic, UI-independent tool event.
Definition: tool_event.h:168
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:150
This file is part of the common library.
#define _(s)
LSET m_LayerSet
Layers to print.
bool m_Mirror
Print mirrored.
COLOR_SETTINGS * m_colorSettings
The color settings to be used for printing.
Definition: printout.h:66
int m_pageCount
Number of pages to print.
Definition: printout.h:61