kicad/eeschema/dialogs/dialog_print_using_printer.cpp

543 lines
17 KiB
C++
Raw Normal View History

2014-10-21 15:48:00 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2015-2022 KiCad Developers, see AUTHORS.TXT for contributors.
2014-10-21 15:48:00 +00:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
2009-01-17 17:32:20 +00:00
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
#include <pgm_base.h>
#include <confirm.h>
#include <sch_screen.h>
2018-01-30 10:49:51 +00:00
#include <sch_edit_frame.h>
#include <base_units.h>
#include <settings/color_settings.h>
#include <settings/settings_manager.h>
#include <sch_sheet.h>
#include <schematic.h>
#include <sch_sheet_path.h>
#include <dialog_print_using_printer_base.h>
2020-04-14 12:25:00 +00:00
#include <sch_painter.h>
2021-06-03 22:32:32 +00:00
#include <wx/print.h>
2021-06-03 11:49:49 +00:00
#include <wx/printdlg.h>
2021-07-16 20:13:26 +00:00
class DIALOG_PRINT_USING_PRINTER : public DIALOG_PRINT_USING_PRINTER_BASE
{
public:
DIALOG_PRINT_USING_PRINTER( SCH_EDIT_FRAME* aParent );
~DIALOG_PRINT_USING_PRINTER() override;
protected:
void OnMonochromeChecked( wxCommandEvent& event ) override;
void OnUseColorThemeChecked( wxCommandEvent& event ) override;
private:
bool TransferDataToWindow() override;
bool TransferDataFromWindow() override;
2016-09-24 18:53:15 +00:00
void OnPageSetup( wxCommandEvent& event ) override;
void OnPrintPreview( wxCommandEvent& event ) override;
void SavePrintOptions();
SCH_EDIT_FRAME* m_parent;
};
2009-01-17 17:32:20 +00:00
/**
* Custom print out for printing schematics.
*/
class SCH_PRINTOUT : public wxPrintout
2009-01-17 17:32:20 +00:00
{
public:
SCH_PRINTOUT( SCH_EDIT_FRAME* aParent, const wxString& aTitle ) :
2009-01-17 17:32:20 +00:00
wxPrintout( aTitle )
{
2021-07-16 20:13:26 +00:00
wxASSERT( aParent != nullptr );
m_parent = aParent;
}
2016-09-24 18:53:15 +00:00
bool OnPrintPage( int page ) override;
bool HasPage( int page ) override;
bool OnBeginDocument( int startPage, int endPage ) override;
void GetPageInfo( int* minPage, int* maxPage, int* selPageFrom, int* selPageTo ) override;
void PrintPage( SCH_SCREEN* aScreen );
private:
SCH_EDIT_FRAME* m_parent;
2009-01-17 17:32:20 +00:00
};
/**
* Custom schematic print preview frame.
* This derived preview frame remembers its size and position during a session
2009-01-17 17:32:20 +00:00
*/
class SCH_PREVIEW_FRAME : public wxPreviewFrame
2009-01-17 17:32:20 +00:00
{
public:
SCH_PREVIEW_FRAME( wxPrintPreview* aPreview, wxWindow* aParent,
const wxString& aTitle, const wxPoint& aPos = wxDefaultPosition,
const wxSize& aSize = wxDefaultSize ) :
wxPreviewFrame( aPreview, aParent, aTitle, aPos, aSize )
2009-01-17 17:32:20 +00:00
{
}
2009-01-17 17:32:20 +00:00
2016-09-25 17:06:49 +00:00
bool Show( bool show ) override
{
bool ret;
// Show or hide the window. If hiding, save current position and size.
// If showing, use previous position and size.
if( show )
2009-01-17 17:32:20 +00:00
{
ret = wxPreviewFrame::Show( show );
if( s_size.x != 0 && s_size.y != 0 )
SetSize( s_pos.x, s_pos.y, s_size.x, s_size.y, 0 );
2009-01-17 17:32:20 +00:00
}
else
{
// Save the dialog's position & size before hiding
s_size = GetSize();
s_pos = GetPosition();
ret = wxPreviewFrame::Show( show );
}
return ret;
2009-01-17 17:32:20 +00:00
}
private:
static wxPoint s_pos;
static wxSize s_size;
};
2009-01-17 17:32:20 +00:00
wxPoint SCH_PREVIEW_FRAME::s_pos;
wxSize SCH_PREVIEW_FRAME::s_size;
2009-01-17 17:32:20 +00:00
DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER( SCH_EDIT_FRAME* aParent ) :
DIALOG_PRINT_USING_PRINTER_BASE( aParent ),
m_parent( aParent )
{
wxASSERT( aParent );
SetupStandardButtons( { { wxID_OK, _( "Print" ) },
{ wxID_APPLY, _( "Print Preview" ) },
{ wxID_CANCEL, _( "Close" ) } } );
#ifdef __WXMAC__
// Problems with modal on wx-2.9 - Anyway preview is standard for OSX
m_sdbSizer1Apply->Hide();
#endif
m_sdbSizer1OK->SetFocus();
2020-11-16 11:16:44 +00:00
finishDialogSettings();
}
DIALOG_PRINT_USING_PRINTER::~DIALOG_PRINT_USING_PRINTER()
{
SavePrintOptions();
}
bool DIALOG_PRINT_USING_PRINTER::TransferDataToWindow()
2009-01-17 17:32:20 +00:00
{
EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
if( cfg->m_Printing.monochrome )
{
m_checkBackgroundColor->SetValue( false );
m_checkBackgroundColor->Enable( false );
}
m_checkReference->SetValue( cfg->m_Printing.title_block );
m_checkMonochrome->SetValue( cfg->m_Printing.monochrome );
m_checkBackgroundColor->SetValue( cfg->m_Printing.background );
m_checkUseColorTheme->SetValue( cfg->m_Printing.use_theme );
m_colorTheme->Clear();
int width = 0;
int height = 0;
int minwidth = width;
wxString target = cfg->m_Printing.use_theme ? cfg->m_Printing.color_theme : cfg->m_ColorTheme;
for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
{
int pos = m_colorTheme->Append( settings->GetName(), static_cast<void*>( settings ) );
if( settings->GetFilename() == target )
m_colorTheme->SetSelection( pos );
m_colorTheme->GetTextExtent( settings->GetName(), &width, &height );
minwidth = std::max( minwidth, width );
}
m_colorTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
m_colorTheme->Enable( cfg->m_Printing.use_theme );
2012-03-26 21:45:05 +00:00
// Initialize page specific print setup dialog settings.
const PAGE_INFO& pageInfo = m_parent->GetScreen()->GetPageSettings();
wxPageSetupDialogData& pageSetupDialogData = m_parent->GetPageSetupData();
2012-03-26 21:45:05 +00:00
pageSetupDialogData.SetPaperId( pageInfo.GetPaperId() );
if( pageInfo.IsCustom() )
{
if( pageInfo.IsPortrait() )
pageSetupDialogData.SetPaperSize( wxSize( EDA_UNIT_UTILS::Mils2mm( pageInfo.GetWidthMils() ),
EDA_UNIT_UTILS::Mils2mm( pageInfo.GetHeightMils() ) ) );
2012-03-26 21:45:05 +00:00
else
pageSetupDialogData.SetPaperSize( wxSize( EDA_UNIT_UTILS::Mils2mm( pageInfo.GetHeightMils() ),
EDA_UNIT_UTILS::Mils2mm( pageInfo.GetWidthMils() ) ) );
2012-03-26 21:45:05 +00:00
}
pageSetupDialogData.GetPrintData().SetOrientation( pageInfo.GetWxOrientation() );
Layout();
return true;
2009-01-17 17:32:20 +00:00
}
void DIALOG_PRINT_USING_PRINTER::OnUseColorThemeChecked( wxCommandEvent& event )
{
m_colorTheme->Enable( m_checkUseColorTheme->GetValue() );
}
void DIALOG_PRINT_USING_PRINTER::OnMonochromeChecked( wxCommandEvent& event )
{
m_checkBackgroundColor->Enable( !m_checkMonochrome->GetValue() );
if( m_checkMonochrome->GetValue() )
m_checkBackgroundColor->SetValue( false );
else
m_checkBackgroundColor->SetValue( m_parent->eeconfig()->m_Printing.background );
}
void DIALOG_PRINT_USING_PRINTER::SavePrintOptions()
{
EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
cfg->m_Printing.monochrome = m_checkMonochrome->IsChecked();
cfg->m_Printing.title_block = m_checkReference->IsChecked();
if( m_checkBackgroundColor->IsEnabled() )
cfg->m_Printing.background = m_checkBackgroundColor->IsChecked();
else
cfg->m_Printing.background = false;
cfg->m_Printing.use_theme = m_checkUseColorTheme->IsChecked();
COLOR_SETTINGS* theme = static_cast<COLOR_SETTINGS*>(
m_colorTheme->GetClientData( m_colorTheme->GetSelection() ) );
if( theme && m_checkUseColorTheme->IsChecked() )
cfg->m_Printing.color_theme = theme->GetFilename();
}
2009-01-17 17:32:20 +00:00
void DIALOG_PRINT_USING_PRINTER::OnPageSetup( wxCommandEvent& event )
2009-01-17 17:32:20 +00:00
{
wxPageSetupDialog pageSetupDialog( this, &m_parent->GetPageSetupData() );
pageSetupDialog.ShowModal();
2009-01-17 17:32:20 +00:00
m_parent->GetPageSetupData() = pageSetupDialog.GetPageSetupDialogData();
2009-01-17 17:32:20 +00:00
}
void DIALOG_PRINT_USING_PRINTER::OnPrintPreview( wxCommandEvent& event )
2009-01-17 17:32:20 +00:00
{
SavePrintOptions();
2009-01-17 17:32:20 +00:00
// Pass two printout objects: for preview, and possible printing.
wxString title = _( "Preview" );
wxPrintPreview* preview = new wxPrintPreview( new SCH_PRINTOUT( m_parent, title ),
new SCH_PRINTOUT( m_parent, title ),
&m_parent->GetPageSetupData().GetPrintData() );
2009-01-17 17:32:20 +00:00
preview->SetZoom( 100 );
2009-01-17 17:32:20 +00:00
SCH_PREVIEW_FRAME* frame = new SCH_PREVIEW_FRAME( preview, this, title );
frame->SetMinSize( wxSize( 550, 350 ) );
// on first invocation in this runtime session, set to 2/3 size of my parent,
// but will be changed in Show() if not first time as will position.
frame->SetSize( (m_parent->GetSize() * 2) / 3 );
frame->Center();
// On wxGTK, set the flag wxTOPLEVEL_EX_DIALOG is mandatory, if we want
// close the frame using the X box in caption, when the preview frame is run
// from a dialog
frame->SetExtraStyle( frame->GetExtraStyle() | wxTOPLEVEL_EX_DIALOG );
// We use here wxPreviewFrame_WindowModal option to make the wxPrintPreview frame
// modal for its caller only.
2018-04-08 10:28:59 +00:00
// another reason is the fact when closing the frame without this option,
// all top level frames are reenabled.
// With this option, only the parent is reenabled.
// Reenabling all top level frames should be made by the parent dialog.
frame->InitializeWithModality( wxPreviewFrame_WindowModal );
frame->Raise(); // Needed on Ubuntu/Unity to display the frame
2009-01-17 17:32:20 +00:00
frame->Show( true );
}
bool DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow()
2009-01-17 17:32:20 +00:00
{
if( Pgm().m_Printing )
{
DisplayError( this, _( "Previous print job not yet complete." ) );
return false;
}
2009-01-17 17:32:20 +00:00
SavePrintOptions();
2009-01-17 17:32:20 +00:00
int sheet_count = m_parent->Schematic().Root().CountSheets();
wxPrintDialogData printDialogData( m_parent->GetPageSetupData().GetPrintData() );
printDialogData.SetMaxPage( sheet_count );
2009-01-17 17:32:20 +00:00
if( sheet_count > 1 )
printDialogData.EnablePageNumbers( true );
2009-01-17 17:32:20 +00:00
wxPrinter printer( &printDialogData );
SCH_PRINTOUT printout( m_parent, _( "Print Schematic" ) );
Pgm().m_Printing = true;
2009-01-17 17:32:20 +00:00
{
if( !printer.Print( this, &printout, true ) )
{
if( wxPrinter::GetLastError() == wxPRINTER_ERROR )
DisplayError( this, _( "An error occurred attempting to print the schematic." ) );
}
else
{
m_parent->GetPageSetupData() = printer.GetPrintDialogData().GetPrintData();
}
2009-01-17 17:32:20 +00:00
}
2021-07-16 20:13:26 +00:00
Pgm().m_Printing = false;
return true;
2009-01-17 17:32:20 +00:00
}
bool SCH_PRINTOUT::OnPrintPage( int page )
2009-01-17 17:32:20 +00:00
{
SCH_SHEET_LIST sheetList = m_parent->Schematic().GetSheets();
wxCHECK_MSG( page >= 1 && page <= (int)sheetList.size(), false,
wxT( "Cannot print invalid page number." ) );
2021-07-16 20:13:26 +00:00
wxCHECK_MSG( sheetList[ page - 1].LastScreen() != nullptr, false,
wxT( "Cannot print page with NULL screen." ) );
2009-01-17 17:32:20 +00:00
wxString msg;
msg.Printf( _( "Print page %d" ), page );
m_parent->SetMsgPanel( msg, wxEmptyString );
2009-01-17 17:32:20 +00:00
SCH_SCREEN* screen = m_parent->GetScreen();
SCH_SHEET_PATH oldsheetpath = m_parent->GetCurrentSheet();
m_parent->SetCurrentSheet( sheetList[ page - 1 ] );
m_parent->GetCurrentSheet().UpdateAllScreenReferences();
m_parent->SetSheetNumberAndCount();
screen = m_parent->GetCurrentSheet().LastScreen();
PrintPage( screen );
m_parent->SetCurrentSheet( oldsheetpath );
2016-02-15 20:17:51 +00:00
m_parent->GetCurrentSheet().UpdateAllScreenReferences();
m_parent->SetSheetNumberAndCount();
2009-01-17 17:32:20 +00:00
return true;
}
void SCH_PRINTOUT::GetPageInfo( int* minPage, int* maxPage, int* selPageFrom, int* selPageTo )
2009-01-17 17:32:20 +00:00
{
*minPage = *selPageFrom = 1;
*maxPage = *selPageTo = m_parent->Schematic().Root().CountSheets();
2009-01-17 17:32:20 +00:00
}
bool SCH_PRINTOUT::HasPage( int pageNum )
2009-01-17 17:32:20 +00:00
{
return m_parent->Schematic().Root().CountSheets() >= pageNum;
2009-01-17 17:32:20 +00:00
}
bool SCH_PRINTOUT::OnBeginDocument( int startPage, int endPage )
2009-01-17 17:32:20 +00:00
{
if( !wxPrintout::OnBeginDocument( startPage, endPage ) )
return false;
return true;
}
/*
* This is the real print function: print the active screen
*/
void SCH_PRINTOUT::PrintPage( SCH_SCREEN* aScreen )
2009-01-17 17:32:20 +00:00
{
// Warning:
// When printing many pages, changes in the current wxDC will affect all next printings
// because all prints are using the same wxPrinterDC after creation
// So be careful and reinit parameters, especially when using offsets.
2022-01-01 01:36:41 +00:00
VECTOR2I tmp_startvisu;
wxSize pageSizeIU; // Page size in internal units
2022-01-01 01:36:41 +00:00
VECTOR2I old_org;
wxRect fitRect;
wxDC* dc = GetDC();
2009-01-17 17:32:20 +00:00
wxBusyCursor dummy;
// Save current offsets and clip box.
tmp_startvisu = aScreen->m_StartVisu;
old_org = aScreen->m_DrawOrg;
SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
COLOR_SETTINGS* theme = mgr.GetColorSettings( cfg->m_Printing.color_theme );
// Change scale factor and offset to print the whole page.
bool printReference = cfg->m_Printing.title_block;
2009-01-17 17:32:20 +00:00
2022-09-16 23:25:07 +00:00
pageSizeIU = aScreen->GetPageSettings().GetSizeIU( schIUScale.IU_PER_MILS );
FitThisSizeToPaper( pageSizeIU );
fitRect = GetLogicalPaperRect();
2009-01-17 17:32:20 +00:00
// When is the actual paper size does not match the schematic page size, the drawing will
// not be centered on X or Y axis. Give a draw offset to center the schematic page on the
// paper draw area.
2012-03-26 21:45:05 +00:00
int xoffset = ( fitRect.width - pageSizeIU.x ) / 2;
int yoffset = ( fitRect.height - pageSizeIU.y ) / 2;
// Using a wxAffineMatrix2D has a big advantage: it handles different pages orientations
//(PORTRAIT/LANDSCAPE), but the affine matrix is not always supported
if( dc->CanUseTransformMatrix() )
{
wxAffineMatrix2D matrix; // starts from a unity matrix (the current wxDC default)
// Check for portrait/landscape mismatch:
if( ( fitRect.width > fitRect.height ) != ( pageSizeIU.x > pageSizeIU.y ) )
{
// Rotate the coordinates, and keep the draw coordinates inside the page
matrix.Rotate( M_PI_2 );
matrix.Translate( 0, -pageSizeIU.y );
// Recalculate the offsets and page sizes according to the page rotation
std::swap( pageSizeIU.x, pageSizeIU.y );
FitThisSizeToPaper( pageSizeIU );
fitRect = GetLogicalPaperRect();
xoffset = ( fitRect.width - pageSizeIU.x ) / 2;
yoffset = ( fitRect.height - pageSizeIU.y ) / 2;
// All the coordinates will be rotated 90 deg when printing,
// so the X,Y offset vector must be rotated -90 deg before printing
std::swap( xoffset, yoffset );
yoffset = -yoffset;
}
matrix.Translate( xoffset, yoffset );
dc->SetTransformMatrix( matrix );
}
else
{
SetLogicalOrigin( 0, 0 ); // Reset all offset settings made previously.
// When printing previous pages (all prints are using the same wxDC)
OffsetLogicalOrigin( xoffset, yoffset );
}
2012-03-26 21:45:05 +00:00
dc->SetLogicalFunction( wxCOPY );
2009-01-17 17:32:20 +00:00
GRResetPenAndBrush( dc );
COLOR4D savedBgColor = m_parent->GetDrawBgColor();
COLOR4D bgColor = m_parent->GetColorSettings()->GetColor( LAYER_SCHEMATIC_BACKGROUND );
if( cfg->m_Printing.background )
{
if( cfg->m_Printing.use_theme && theme )
bgColor = theme->GetColor( LAYER_SCHEMATIC_BACKGROUND );
}
else
{
bgColor = COLOR4D::WHITE;
}
m_parent->SetDrawBgColor( bgColor );
GRSFilledRect( dc, fitRect.GetX(), fitRect.GetY(), fitRect.GetRight(), fitRect.GetBottom(), 0,
bgColor, bgColor );
if( cfg->m_Printing.monochrome )
GRForceBlackPen( true );
2009-01-17 17:32:20 +00:00
2020-04-14 12:25:00 +00:00
KIGFX::SCH_RENDER_SETTINGS renderSettings( *m_parent->GetRenderSettings() );
renderSettings.SetPrintDC( dc );
if( cfg->m_Printing.use_theme && theme )
renderSettings.LoadColors( theme );
renderSettings.SetBackgroundColor( bgColor );
// The drawing-sheet-item print code is shared between PCBNew and Eeschema, so it's easier
2020-04-14 12:25:00 +00:00
// if they just use the PCB layer.
renderSettings.SetLayerColor( LAYER_DRAWINGSHEET,
renderSettings.GetLayerColor( LAYER_SCHEMATIC_DRAWINGSHEET ) );
2020-04-14 12:25:00 +00:00
if( printReference )
{
m_parent->PrintDrawingSheet( &renderSettings, aScreen, aScreen->Schematic()->GetProperties(),
schIUScale.IU_PER_MILS, aScreen->GetFileName(), wxEmptyString );
}
2009-01-17 17:32:20 +00:00
renderSettings.SetIsPrinting( true );
2020-04-14 12:25:00 +00:00
aScreen->Print( &renderSettings );
m_parent->SetDrawBgColor( savedBgColor );
2009-01-17 17:32:20 +00:00
GRForceBlackPen( false );
aScreen->m_StartVisu = tmp_startvisu;
aScreen->m_DrawOrg = old_org;
2009-01-17 17:32:20 +00:00
}
int InvokeDialogPrintUsingPrinter( SCH_EDIT_FRAME* aCaller )
{
DIALOG_PRINT_USING_PRINTER dlg( aCaller );
return dlg.ShowModal();
}