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( LSEQ seq = m_layerList; seq; ++seq )
150 {
151 PCB_LAYER_ID layer = *seq;
152
153 int checkIndex = m_layerCheckListBox->Append( board->GetLayerName( layer ) );
154
155 if( settings()->m_LayerSet.test( layer ) )
156 m_layerCheckListBox->Check( checkIndex );
157 }
158
159 m_checkAsItems->SetValue( settings()->m_AsItemCheckboxes );
160 m_checkboxMirror->SetValue( settings()->m_Mirror );
161 m_titleBlock->SetValue( settings()->m_titleBlock );
162
164
165 m_checkBackground->SetValue( cfg->m_Printing.background );
166 m_checkUseTheme->SetValue( cfg->m_Printing.use_theme );
167
168 m_colorTheme->Clear();
169
170 int width = 0;
171 int height = 0;
172 int minwidth = width;
173
174 wxString target = cfg->m_Printing.use_theme ? cfg->m_Printing.color_theme : cfg->m_ColorTheme;
175
177 {
178 int pos = m_colorTheme->Append( settings->GetName(), static_cast<void*>( settings ) );
179
180 if( settings->GetFilename() == target )
181 m_colorTheme->SetSelection( pos );
182
183 m_colorTheme->GetTextExtent( settings->GetName(), &width, &height );
184 minwidth = std::max( minwidth, width );
185 }
186
187 m_colorTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
188
189 wxCommandEvent dummy;
191
192 // Options to plot pads and vias holes
193 m_drillMarksChoice->SetSelection( (int)settings()->m_DrillMarks );
194
195 // Print all layers one one page or separately
196 m_checkboxPagePerLayer->SetValue( settings()->m_Pagination
199
200 // Update the dialog layout when layers are added
201 GetSizer()->Fit( this );
202
203 return true;
204}
205
206
208{
209 wxGridBagSizer* optionsSizer = getOptionsSizer();
210 wxStaticBox* box = getOptionsBox();
211 int rows = optionsSizer->GetEffectiveRowsCount();
212 int cols = optionsSizer->GetEffectiveColsCount();
213
214 m_checkAsItems = new wxCheckBox( box, wxID_ANY,
215 _( "Print according to objects tab of appearance manager" ) );
216 optionsSizer->Add( m_checkAsItems, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ),
217 wxLEFT|wxRIGHT|wxBOTTOM, 5 );
218
219 m_checkBackground = new wxCheckBox( box, wxID_ANY, _( "Print background color" ) );
220 optionsSizer->Add( m_checkBackground, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ),
221 wxLEFT|wxRIGHT|wxBOTTOM, 5 );
222
223 m_checkUseTheme = new wxCheckBox( box, wxID_ANY,
224 _( "Use a different color theme for printing:" ) );
225 optionsSizer->Add( m_checkUseTheme, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ),
226 wxLEFT|wxRIGHT, 5 );
227
228 m_checkUseTheme->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED,
230
231 wxArrayString m_colorThemeChoices;
232 m_colorTheme = new wxChoice( box, wxID_ANY, wxDefaultPosition, wxDefaultSize,
233 m_colorThemeChoices, 0 );
234 m_colorTheme->SetSelection( 0 );
235
236 optionsSizer->Add( m_colorTheme, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 2 ),
237 wxLEFT, 28 );
238
239 rows++;
240
241 // Drill marks option
242 auto drillMarksLabel = new wxStaticText( box, wxID_ANY, _( "Drill marks:" ) );
243 std::vector<wxString> drillMarkChoices = { _( "No drill mark" ),
244 _( "Small mark" ),
245 _( "Real drill" ) };
246 m_drillMarksChoice = new wxChoice( box, wxID_ANY, wxDefaultPosition, wxDefaultSize,
247 drillMarkChoices.size(), drillMarkChoices.data(), 0 );
248 m_drillMarksChoice->SetSelection( 0 );
249
250 optionsSizer->Add( drillMarksLabel, wxGBPosition( rows, 0 ), wxGBSpan( 1, 1 ),
251 wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT|wxBOTTOM, 5 );
252 optionsSizer->Add( m_drillMarksChoice, wxGBPosition( rows++, 1 ), wxGBSpan( 1, cols - 1 ),
253 wxALIGN_CENTER_VERTICAL|wxLEFT|wxRIGHT|wxBOTTOM, 5 );
254
255 // Print mirrored
256 m_checkboxMirror = new wxCheckBox( box, wxID_ANY, _( "Print mirrored" ) );
257
258 optionsSizer->Add( m_checkboxMirror, wxGBPosition( rows++, 0 ), wxGBSpan( 1, cols ),
259 wxLEFT|wxRIGHT|wxBOTTOM, 5 );
260
261 // Pagination
262 m_checkboxPagePerLayer = new wxCheckBox( box, wxID_ANY, _( "Print one page per layer" ) );
263
264 m_checkboxPagePerLayer->Bind( wxEVT_COMMAND_CHECKBOX_CLICKED,
266
267 m_checkboxEdgesOnAllPages = new wxCheckBox( box, wxID_ANY,
268 _( "Print board edges on all pages" ) );
269
270 optionsSizer->Add( m_checkboxPagePerLayer, wxGBPosition( rows++, 0 ), wxGBSpan( 1, cols ),
271 wxLEFT|wxRIGHT, 5 );
272 optionsSizer->Add( m_checkboxEdgesOnAllPages, wxGBPosition( rows++, 0 ), wxGBSpan( 1, cols ),
273 wxLEFT, 28 );
274}
275
276
278{
279 wxStaticBox* box = new wxStaticBox( this, wxID_ANY, _( "Include Layers" ) );
280 wxStaticBoxSizer* sbLayersSizer = new wxStaticBoxSizer( box, wxVERTICAL );
281
282 m_layerCheckListBox = new wxCheckListBox( sbLayersSizer->GetStaticBox(), wxID_ANY );
283 m_layerCheckListBox->SetMinSize( wxSize( 180, -1 ) );
284
285 sbLayersSizer->Add( m_layerCheckListBox, 1, wxEXPAND|wxBOTTOM|wxRIGHT, 5 );
286
287 getMainSizer()->Insert( 0, sbLayersSizer, 1, wxEXPAND | wxALL, 5 );
288
289 m_popMenu = new wxMenu();
290 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_SELECT_FAB_LAYERS,
291 _( "Select Fab Layers" ), wxEmptyString ) );
292
293 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_SELECT_COPPER_LAYERS,
294 _( "Select all Copper Layers" ), wxEmptyString ) );
295
296 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_DESELECT_COPPER_LAYERS,
297 _( "Deselect all Copper Layers" ), wxEmptyString ) );
298
299 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_SELECT_ALL_LAYERS,
300 _( "Select all Layers" ), wxEmptyString ) );
301
302 m_popMenu->Append( new wxMenuItem( m_popMenu, ID_DESELECT_ALL_LAYERS,
303 _( "Deselect all Layers" ), wxEmptyString ) );
304
305 this->Bind( wxEVT_RIGHT_DOWN,
306 [&]( wxMouseEvent& aEvent )
307 {
308 this->PopupMenu( m_popMenu, aEvent.GetPosition() );
309 } );
310
311 m_layerCheckListBox->Bind( wxEVT_RIGHT_DOWN,
312 [&]( wxMouseEvent& aEvent )
313 {
314 this->PopupMenu( m_popMenu, aEvent.GetPosition() );
315 } );
316}
317
318
319void DIALOG_PRINT_PCBNEW::onUseThemeClicked( wxCommandEvent& event )
320{
321 m_colorTheme->Enable( m_checkUseTheme->GetValue() );
322}
323
324
326{
327 if( m_checkboxPagePerLayer->GetValue() )
328 {
329 m_checkboxEdgesOnAllPages->Enable( true );
330 m_checkboxEdgesOnAllPages->SetValue( settings()->m_PrintEdgeCutsOnAllPages );
331 }
332 else
333 {
334 m_checkboxEdgesOnAllPages->Enable( false );
335 m_checkboxEdgesOnAllPages->SetValue( false );
336 }
337}
338
339
340void DIALOG_PRINT_PCBNEW::onColorModeClicked( wxCommandEvent& event )
341{
343
344 m_settings->m_blackWhite = m_outputMode->GetSelection();
345
349}
350
351
352// Select or deselect groups of layers in the layers list:
353void DIALOG_PRINT_PCBNEW::onPopUpLayers( wxCommandEvent& event )
354{
355 // Build a list of layers for usual fabrication: copper layers + tech layers without courtyard
356 LSET fab_layer_set = ( LSET::AllCuMask() | LSET::AllTechMask() ) & ~LSET( 2, B_CrtYd, F_CrtYd );
357
358 switch( event.GetId() )
359 {
360 case ID_SELECT_FAB_LAYERS: // Select layers usually needed to build a board
361 for( unsigned i = 0; i < m_layerList.size(); i++ )
362 {
363 LSET layermask( m_layerList[ i ] );
364
365 if( ( layermask & fab_layer_set ).any() )
366 m_layerCheckListBox->Check( i, true );
367 else
368 m_layerCheckListBox->Check( i, false );
369 }
370 break;
371
373 for( unsigned i = 0; i < m_layerList.size(); i++ )
374 {
375 if( IsCopperLayer( m_layerList[i] ) )
376 m_layerCheckListBox->Check( i, true );
377 }
378 break;
379
381 for( unsigned i = 0; i < m_layerList.size(); i++ )
382 {
383 if( IsCopperLayer( m_layerList[i] ) )
384 m_layerCheckListBox->Check( i, false );
385 }
386 break;
387
389 for( unsigned i = 0; i < m_layerList.size(); i++ )
390 m_layerCheckListBox->Check( i, true );
391 break;
392
394 for( unsigned i = 0; i < m_layerList.size(); i++ )
395 m_layerCheckListBox->Check( i, false );
396 break;
397
398 default:
399 break;
400 }
401}
402
403
405{
406 settings()->m_LayerSet = LSET();
407 int& pageCount = settings()->m_pageCount;
408 pageCount = 0;
409
410 for( unsigned i = 0; i < m_layerList.size(); i++ )
411 {
412 if( m_layerCheckListBox->IsChecked( i ) )
413 {
414 ++pageCount;
415 settings()->m_LayerSet.set( m_layerList[i] );
416 }
417 }
418
419 // In Pcbnew force the EDGE layer to be printed or not with the other layers
421
422 // All layers on one page (only if there is at least one layer selected)
423 if( !m_checkboxPagePerLayer->GetValue() && pageCount > 0 )
424 pageCount = 1;
425
426 return pageCount;
427}
428
429
431{
433
435
436 settings()->m_DrillMarks = static_cast<DRILL_MARKS>( m_drillMarksChoice->GetSelection() );
437
438 if( m_checkboxPagePerLayer->GetValue() )
439 {
442 }
443 else
444 {
446 }
447
448 settings()->m_Mirror = m_checkboxMirror->GetValue();
449
451
452 cfg->m_Printing.background = m_checkBackground->GetValue();
454 cfg->m_Printing.use_theme = m_checkUseTheme->GetValue();
455
456 int sel = m_colorTheme->GetSelection();
457 COLOR_SETTINGS* theme = static_cast<COLOR_SETTINGS*>( m_colorTheme->GetClientData( sel ) );
458
459 if( theme && m_checkUseTheme->IsChecked() )
460 {
461 cfg->m_Printing.color_theme = theme->GetFilename();
462 settings()->m_colorSettings = theme;
463 }
464 else
465 {
467 }
468
470}
471
472
473int PCB_CONTROL::Print( const TOOL_EVENT& aEvent )
474{
475 // Selection affects the origin item visibility
477
480
482 dlg.ForcePrintBorder( false );
483
484 dlg.ShowModal();
485
486 return 0;
487}
488
489
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:173
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:658
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:545
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:73
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:95
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition: layer_ids.h:519
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:573
LSEQ UIOrder() const
Definition: lset.cpp:1012
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:931
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:863
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:216
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:145
#define _(s)
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:879
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_CrtYd
Definition: layer_ids.h:118
@ B_CrtYd
Definition: layer_ids.h:117
wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:151
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