KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_print_pcbnew.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, jean-pierre.charras at wanadoo.fr
5 * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 * Copyright (C) 2018-2023 CERN
7 *
8 * @author Maciej Suminski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
28#include <kiface_base.h>
29#include <pcbnew_settings.h>
30#include <pcbplot.h>
31#include <board.h>
32#include <tool/tool_manager.h>
33#include <tools/pcb_actions.h>
34#include <tools/pcb_control.h>
36#include <pcbnew_printout.h>
37#include <wx/checklst.h>
38
39
41{
42public:
45
46private:
47 enum
48 {
56 };
57
59 {
60 wxASSERT( dynamic_cast<PCBNEW_PRINTOUT_SETTINGS*>( m_settings ) );
61 return static_cast<PCBNEW_PRINTOUT_SETTINGS*>( m_settings );
62 }
63
64 bool TransferDataToWindow() override;
65
66 void createExtraOptions();
67 void createLeftPanel();
68
69 void onUseThemeClicked( wxCommandEvent& event );
70 void onPagePerLayerClicked( wxCommandEvent& event );
71 void onColorModeClicked( wxCommandEvent& event );
72 void onPopUpLayers( wxCommandEvent& event );
73
76
77 void saveSettings() override;
78
79 wxPrintout* createPrintout( const wxString& aTitle ) override
80 {
81 return new PCBNEW_PRINTOUT( m_parent->GetBoard(), *settings(),
82 m_parent->GetCanvas()->GetView(), aTitle );
83 }
84
86 LSEQ m_layerList; // List to hold CheckListBox layer numbers
87 wxMenu* m_popMenu;
88
89 wxCheckListBox* m_layerCheckListBox;
90 wxCheckBox* m_checkboxMirror;
94 wxCheckBox* m_checkAsItems;
95 wxCheckBox* m_checkBackground;
96 wxCheckBox* m_checkUseTheme;
97 wxChoice* m_colorTheme;
98};
99
100
102 PCBNEW_PRINTOUT_SETTINGS* aSettings ) :
103 DIALOG_PRINT_GENERIC( aParent, aSettings ),
104 m_parent( aParent )
105{
107
110
111 m_infoText->SetFont( KIUI::GetInfoFont( this ) );
112 m_infoText->SetLabel( _( "Right-click for layer selection commands." ) );
113 m_infoText->Show( true );
114
116
117 m_popMenu->Bind( wxEVT_COMMAND_MENU_SELECTED,
118 wxCommandEventHandler( DIALOG_PRINT_PCBNEW::onPopUpLayers ), this,
120
121 m_outputMode->Bind( wxEVT_COMMAND_CHOICE_SELECTED, &DIALOG_PRINT_PCBNEW::onColorModeClicked,
122 this );
123}
124
125
127{
128 m_popMenu->Unbind( wxEVT_COMMAND_MENU_SELECTED,
129 wxCommandEventHandler( DIALOG_PRINT_PCBNEW::onPopUpLayers ), this,
131
132 m_outputMode->Unbind( wxEVT_COMMAND_CHOICE_SELECTED, &DIALOG_PRINT_PCBNEW::onColorModeClicked,
133 this );
134}
135
136
138{
140 return false;
141
142 BOARD* board = m_parent->GetBoard();
143
144 // Create layer list
145 // Could devote a PlotOrder() function in place of UIOrder().
147
148 // Populate the check list box by all enabled layers names
149 for( PCB_LAYER_ID layer : m_layerList )
150 {
151 int checkIndex = m_layerCheckListBox->Append( board->GetLayerName( layer ) );
152
153 if( settings()->m_LayerSet.test( layer ) )
154 m_layerCheckListBox->Check( checkIndex );
155 }
156
157 m_checkAsItems->SetValue( settings()->m_AsItemCheckboxes );
158 m_checkboxMirror->SetValue( settings()->m_Mirror );
159 m_titleBlock->SetValue( settings()->m_titleBlock );
160
162
163 m_checkBackground->SetValue( cfg->m_Printing.background );
164 m_checkUseTheme->SetValue( cfg->m_Printing.use_theme );
165
166 m_colorTheme->Clear();
167
168 int width = 0;
169 int height = 0;
170 int minwidth = width;
171
172 wxString target = cfg->m_Printing.use_theme ? cfg->m_Printing.color_theme : cfg->m_ColorTheme;
173
175 {
176 int pos = m_colorTheme->Append( settings->GetName(), static_cast<void*>( settings ) );
177
178 if( settings->GetFilename() == target )
179 m_colorTheme->SetSelection( pos );
180
181 m_colorTheme->GetTextExtent( settings->GetName(), &width, &height );
182 minwidth = std::max( minwidth, width );
183 }
184
185 m_colorTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
186
187 wxCommandEvent dummy;
189
190 // Options to plot pads and vias holes
191 m_drillMarksChoice->SetSelection( (int)settings()->m_DrillMarks );
192
193 // Print all layers one one page or separately
194 m_checkboxPagePerLayer->SetValue( settings()->m_Pagination
197
198 // Update the dialog layout when layers are added
199 GetSizer()->Fit( this );
200
201 return true;
202}
203
204
206{
207 wxGridBagSizer* optionsSizer = getOptionsSizer();
208 wxStaticBox* box = getOptionsBox();
209 int rows = optionsSizer->GetEffectiveRowsCount();
210 int cols = optionsSizer->GetEffectiveColsCount();
211
212 m_checkAsItems = new wxCheckBox( box, wxID_ANY,
213 _( "Print according to objects tab of appearance manager" ) );
214 optionsSizer->Add( m_checkAsItems, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ),
215 wxLEFT|wxRIGHT|wxBOTTOM, 5 );
216
217 m_checkBackground = new wxCheckBox( box, wxID_ANY, _( "Print background color" ) );
218 optionsSizer->Add( m_checkBackground, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ),
219 wxLEFT|wxRIGHT|wxBOTTOM, 5 );
220
221 m_checkUseTheme = new wxCheckBox( box, wxID_ANY,
222 _( "Use a different color theme for printing:" ) );
223 optionsSizer->Add( m_checkUseTheme, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ),
224 wxLEFT|wxRIGHT, 5 );
225
226 m_checkUseTheme->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED,
228
229 wxArrayString m_colorThemeChoices;
230 m_colorTheme = new wxChoice( box, wxID_ANY, wxDefaultPosition, wxDefaultSize,
231 m_colorThemeChoices, 0 );
232 m_colorTheme->SetSelection( 0 );
233
234 optionsSizer->Add( m_colorTheme, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 2 ),
235 wxLEFT, 28 );
236
237 rows++;
238
239 // Drill marks option
240 auto drillMarksLabel = new wxStaticText( box, wxID_ANY, _( "Drill marks:" ) );
241 std::vector<wxString> drillMarkChoices = { _( "No drill mark" ),
242 _( "Small mark" ),
243 _( "Real drill" ) };
244 m_drillMarksChoice = new wxChoice( box, wxID_ANY, wxDefaultPosition, wxDefaultSize,
245 drillMarkChoices.size(), drillMarkChoices.data(), 0 );
246 m_drillMarksChoice->SetSelection( 0 );
247
248 optionsSizer->Add( drillMarksLabel, wxGBPosition( rows, 0 ), wxGBSpan( 1, 1 ),
249 wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT|wxBOTTOM, 5 );
250 optionsSizer->Add( m_drillMarksChoice, wxGBPosition( rows++, 1 ), wxGBSpan( 1, cols - 1 ),
251 wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT|wxBOTTOM, 5 );
252
253 // Print mirrored
254 m_checkboxMirror = new wxCheckBox( box, wxID_ANY, _( "Print mirrored" ) );
255
256 optionsSizer->Add( m_checkboxMirror, wxGBPosition( rows++, 0 ), wxGBSpan( 1, cols ),
257 wxLEFT|wxRIGHT|wxBOTTOM, 5 );
258
259 // Pagination
260 m_checkboxPagePerLayer = new wxCheckBox( box, wxID_ANY, _( "Print one page per layer" ) );
261
262 m_checkboxPagePerLayer->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED,
264
265 m_checkboxEdgesOnAllPages = new wxCheckBox( box, wxID_ANY,
266 _( "Print board edges on all pages" ) );
267
268 optionsSizer->Add( m_checkboxPagePerLayer, wxGBPosition( rows++, 0 ), wxGBSpan( 1, cols ),
269 wxLEFT|wxRIGHT, 5 );
270 optionsSizer->Add( m_checkboxEdgesOnAllPages, wxGBPosition( rows++, 0 ), wxGBSpan( 1, cols ),
271 wxLEFT, 28 );
272}
273
274
276{
277 wxStaticBox* box = new wxStaticBox( this, wxID_ANY, _( "Include Layers" ) );
278 wxStaticBoxSizer* sbLayersSizer = new wxStaticBoxSizer( box, wxVERTICAL );
279
280 m_layerCheckListBox = new wxCheckListBox( sbLayersSizer->GetStaticBox(), wxID_ANY );
281 m_layerCheckListBox->SetMinSize( wxSize( 180, -1 ) );
282
283 sbLayersSizer->Add( m_layerCheckListBox, 1, wxEXPAND|wxBOTTOM|wxRIGHT, 5 );
284
285 getMainSizer()->Insert( 0, sbLayersSizer, 1, wxEXPAND | wxALL, 5 );
286
287 m_popMenu = new wxMenu();
288 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_SELECT_FAB_LAYERS,
289 _( "Select Fab Layers" ), wxEmptyString ) );
290
291 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_SELECT_COPPER_LAYERS,
292 _( "Select all Copper Layers" ), wxEmptyString ) );
293
294 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_DESELECT_COPPER_LAYERS,
295 _( "Deselect all Copper Layers" ), wxEmptyString ) );
296
297 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_SELECT_ALL_LAYERS,
298 _( "Select all Layers" ), wxEmptyString ) );
299
300 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_DESELECT_ALL_LAYERS,
301 _( "Deselect all Layers" ), wxEmptyString ) );
302
303 this->Bind( wxEVT_RIGHT_DOWN,
304 [&]( wxMouseEvent& aEvent )
305 {
306 this->PopupMenu( m_popMenu, aEvent.GetPosition() );
307 } );
308
309 m_layerCheckListBox->Bind( wxEVT_RIGHT_DOWN,
310 [&]( wxMouseEvent& aEvent )
311 {
312 this->PopupMenu( m_popMenu, aEvent.GetPosition() );
313 } );
314}
315
316
317void DIALOG_PRINT_PCBNEW::onUseThemeClicked( wxCommandEvent& event )
318{
319 m_colorTheme->Enable( m_checkUseTheme->GetValue() );
320}
321
322
324{
325 if( m_checkboxPagePerLayer->GetValue() )
326 {
327 m_checkboxEdgesOnAllPages->Enable( true );
328 m_checkboxEdgesOnAllPages->SetValue( settings()->m_PrintEdgeCutsOnAllPages );
329 }
330 else
331 {
332 m_checkboxEdgesOnAllPages->Enable( false );
333 m_checkboxEdgesOnAllPages->SetValue( false );
334 }
335}
336
337
338void DIALOG_PRINT_PCBNEW::onColorModeClicked( wxCommandEvent& event )
339{
341
342 m_settings->m_blackWhite = m_outputMode->GetSelection();
343
347}
348
349
350// Select or deselect groups of layers in the layers list:
351void DIALOG_PRINT_PCBNEW::onPopUpLayers( wxCommandEvent& event )
352{
353 // Build a list of layers for usual fabrication: copper layers + tech layers without courtyard
354 LSET fab_layer_set = ( LSET::AllCuMask() | LSET::AllTechMask() ) & ~LSET( { B_CrtYd, F_CrtYd } );
355
356 switch( event.GetId() )
357 {
358 case ID_SELECT_FAB_LAYERS: // Select layers usually needed to build a board
359 for( unsigned i = 0; i < m_layerList.size(); i++ )
360 {
361 LSET layermask( m_layerList[ i ] );
362
363 if( ( layermask & fab_layer_set ).any() )
364 m_layerCheckListBox->Check( i, true );
365 else
366 m_layerCheckListBox->Check( i, false );
367 }
368 break;
369
371 for( unsigned i = 0; i < m_layerList.size(); i++ )
372 {
373 if( IsCopperLayer( m_layerList[i] ) )
374 m_layerCheckListBox->Check( i, true );
375 }
376 break;
377
379 for( unsigned i = 0; i < m_layerList.size(); i++ )
380 {
381 if( IsCopperLayer( m_layerList[i] ) )
382 m_layerCheckListBox->Check( i, false );
383 }
384 break;
385
387 for( unsigned i = 0; i < m_layerList.size(); i++ )
388 m_layerCheckListBox->Check( i, true );
389 break;
390
392 for( unsigned i = 0; i < m_layerList.size(); i++ )
393 m_layerCheckListBox->Check( i, false );
394 break;
395
396 default:
397 break;
398 }
399}
400
401
403{
404 settings()->m_LayerSet = LSET();
405 int& pageCount = settings()->m_pageCount;
406 pageCount = 0;
407
408 for( unsigned i = 0; i < m_layerList.size(); i++ )
409 {
410 if( m_layerCheckListBox->IsChecked( i ) )
411 {
412 ++pageCount;
414 }
415 }
416
417 // In Pcbnew force the EDGE layer to be printed or not with the other layers
419
420 // All layers on one page (only if there is at least one layer selected)
421 if( !m_checkboxPagePerLayer->GetValue() && pageCount > 0 )
422 pageCount = 1;
423
424 return pageCount;
425}
426
427
429{
431
433
434 settings()->m_DrillMarks = static_cast<DRILL_MARKS>( m_drillMarksChoice->GetSelection() );
435
436 if( m_checkboxPagePerLayer->GetValue() )
437 {
440 }
441 else
442 {
444 }
445
446 settings()->m_Mirror = m_checkboxMirror->GetValue();
447
449
450 cfg->m_Printing.background = m_checkBackground->GetValue();
452 cfg->m_Printing.use_theme = m_checkUseTheme->GetValue();
453
454 int sel = m_colorTheme->GetSelection();
455 COLOR_SETTINGS* theme = static_cast<COLOR_SETTINGS*>( m_colorTheme->GetClientData( sel ) );
456
457 if( theme && m_checkUseTheme->IsChecked() )
458 {
459 cfg->m_Printing.color_theme = theme->GetFilename();
460 settings()->m_colorSettings = theme;
461 }
462 else
463 {
465 }
466
468}
469
470
471int PCB_CONTROL::Print( const TOOL_EVENT& aEvent )
472{
473 // Selection affects the origin item visibility
475
478
480 dlg.ForcePrintBorder( false );
481
482 dlg.ShowModal();
483
484 return 0;
485}
486
487
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:175
BASE_SET & set(size_t pos=std::numeric_limits< size_t >::max(), bool value=true)
Definition: base_set.h:61
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:289
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:757
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:575
Color settings are a bit different than most of the settings objects in that there can be more than o...
APP_SETTINGS_BASE * m_config
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
wxCheckBox * m_checkboxPagePerLayer
void onPopUpLayers(wxCommandEvent &event)
Update layerset basing on the selected layers.
wxPrintout * createPrintout(const wxString &aTitle) override
Create a printout with a requested title.
PCB_BASE_EDIT_FRAME * m_parent
DIALOG_PRINT_PCBNEW(PCB_BASE_EDIT_FRAME *aParent, PCBNEW_PRINTOUT_SETTINGS *aSettings)
wxCheckBox * m_checkboxEdgesOnAllPages
bool TransferDataToWindow() override
void saveSettings() override
void onColorModeClicked(wxCommandEvent &event)
void onPagePerLayerClicked(wxCommandEvent &event)
wxCheckListBox * m_layerCheckListBox
void onUseThemeClicked(wxCommandEvent &event)
PCBNEW_PRINTOUT_SETTINGS * settings() const
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
SETTINGS_MANAGER * GetSettingsManager() const
wxString GetFilename() const
Definition: json_settings.h:80
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:95
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition: lseq.h:47
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:35
LSEQ UIOrder() const
Definition: lset.cpp:865
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:800
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:732
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:68
Common, abstract interface for edit frames.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
PCBNEW_SETTINGS * GetPcbNewSettings() const
const PAGE_INFO & GetPageSettings() const override
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
BOARD * GetBoard() const
PCB_BASE_FRAME * m_frame
Grid origin marker.
Definition: pcb_control.h:147
int Print(const TOOL_EVENT &aEvent)
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
bool m_isFootprintEditor
std::vector< COLOR_SETTINGS * > GetColorSettingsList()
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
Generic, UI-independent tool event.
Definition: tool_event.h:167
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
#define _(s)
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:531
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_CrtYd
Definition: layer_ids.h:117
@ B_CrtYd
Definition: layer_ids.h:116
KICOMMON_API wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:154
DRILL_MARKS
Plots and prints can show holes in pads and vias 3 options are available:
std::vector< FAB_LAYER_COLOR > dummy
bool background
Whether or not to print background color.
Definition: app_settings.h:128
wxString color_theme
Color theme to use for printing.
Definition: app_settings.h:132
bool use_theme
If false, display color theme will be used.
Definition: app_settings.h:131
LSET m_LayerSet
Layers to print.
bool m_Mirror
Print mirrored.
enum PCBNEW_PRINTOUT_SETTINGS::PAGINATION_T m_Pagination
bool m_PrintEdgeCutsOnAllPages
Print board outline on each page.
enum DRILL_MARKS m_DrillMarks
bool m_AsItemCheckboxes
Honor checkboxes in the Items tab of the Layers Manager.
COLOR_SETTINGS * m_colorSettings
The color settings to be used for printing.
Definition: printout.h:66
bool m_blackWhite
Print in B&W or Color.
Definition: printout.h:60
int m_pageCount
Number of pages to print.
Definition: printout.h:61
bool m_background
Print background color.
Definition: printout.h:62