Custom print out for printing schematics. More...

Inheritance diagram for SCH_PRINTOUT:

Public Member Functions
	SCH_PRINTOUT (SCH_EDIT_FRAME *aParent, const wxString &aTitle)

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 Attributes
SCH_EDIT_FRAME *	m_parent

Detailed Description

Custom print out for printing schematics.

Definition at line 68 of file dialog_print_using_printer.cpp.

Constructor & Destructor Documentation

◆ SCH_PRINTOUT()

SCH_PRINTOUT::SCH_PRINTOUT	(	SCH_EDIT_FRAME *	aParent,
		const wxString &	aTitle
	)

inline

Definition at line 71 of file dialog_print_using_printer.cpp.

                                                                     :
         wxPrintout( aTitle )
     {
         wxASSERT( aParent != nullptr );
         m_parent = aParent;
     }

References m_parent.

Member Function Documentation

◆ GetPageInfo()

void SCH_PRINTOUT::GetPageInfo	(	int *	minPage,
		int *	maxPage,
		int *	selPageFrom,
		int *	selPageTo
	)

override

Definition at line 376 of file dialog_print_using_printer.cpp.

 {
     *minPage = *selPageFrom = 1;
     *maxPage = *selPageTo   = m_parent->Schematic().Root().CountSheets();
 }

References SCH_SHEET::CountSheets(), m_parent, SCHEMATIC::Root(), and SCH_EDIT_FRAME::Schematic().

◆ HasPage()

bool SCH_PRINTOUT::HasPage ( int page )

override

Definition at line 383 of file dialog_print_using_printer.cpp.

 {
     return m_parent->Schematic().Root().CountSheets() >= pageNum;
 }

References SCH_SHEET::CountSheets(), m_parent, SCHEMATIC::Root(), and SCH_EDIT_FRAME::Schematic().

◆ OnBeginDocument()

bool SCH_PRINTOUT::OnBeginDocument	(	int	startPage,
		int	endPage
	)

override

Definition at line 389 of file dialog_print_using_printer.cpp.

 {
     if( !wxPrintout::OnBeginDocument( startPage, endPage ) )
         return false;
 
     return true;
 }

◆ OnPrintPage()

bool SCH_PRINTOUT::OnPrintPage ( int page )

override

Definition at line 347 of file dialog_print_using_printer.cpp.

 {
     SCH_SHEET_LIST sheetList = m_parent->Schematic().GetSheets();
 
     wxCHECK_MSG( page >= 1 && page <= (int)sheetList.size(), false,
                  wxT( "Cannot print invalid page number." ) );
 
     wxCHECK_MSG( sheetList[ page - 1].LastScreen() != nullptr, false,
                  wxT( "Cannot print page with NULL screen." ) );
 
     wxString msg;
     msg.Printf( _( "Print page %d" ), page );
     m_parent->SetMsgPanel( msg, wxEmptyString );
 
     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 );
     m_parent->GetCurrentSheet().UpdateAllScreenReferences();
     m_parent->SetSheetNumberAndCount();
 
     return true;
 }

References _, SCH_EDIT_FRAME::GetCurrentSheet(), SCH_EDIT_FRAME::GetScreen(), SCHEMATIC::GetSheets(), SCH_SHEET_PATH::LastScreen(), m_parent, PrintPage(), SCH_EDIT_FRAME::Schematic(), SCH_EDIT_FRAME::SetCurrentSheet(), EDA_DRAW_FRAME::SetMsgPanel(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ PrintPage()

void SCH_PRINTOUT::PrintPage ( SCH_SCREEN * aScreen )

Definition at line 401 of file dialog_print_using_printer.cpp.

 {
     wxPoint  tmp_startvisu;
     wxSize   pageSizeIU;             // Page size in internal units
     wxPoint  old_org;
     wxRect   fitRect;
     wxDC*    dc = GetDC();
 
     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;
 
     pageSizeIU = aScreen->GetPageSettings().GetSizeIU();
     FitThisSizeToPaper( pageSizeIU );
 
     fitRect = GetLogicalPaperRect();
 
     // 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.
     int xoffset = ( fitRect.width - pageSizeIU.x ) / 2;
     int yoffset = ( fitRect.height - pageSizeIU.y ) / 2;
 
     if( dc->CanUseTransformMatrix() )
     {
         wxAffineMatrix2D matrix = dc->GetTransformMatrix();
 
         // Check for portrait/landscape mismatch:
         if( ( fitRect.width > fitRect.height ) != ( pageSizeIU.x > pageSizeIU.y ) )
         {
             matrix.Rotate( M_PI_2 );
             xoffset = ( fitRect.height - pageSizeIU.x ) / 2;
             yoffset = ( fitRect.width - pageSizeIU.y ) / 2;
         }
 
         matrix.Translate( xoffset, yoffset );
         dc->SetTransformMatrix( matrix );
     }
     else
     {
         // wxWidgets appears to have a bug when OffsetLogicalOrigin()'s yoffset changes from
         // page to page.
         // NB: this is a workaround, not a fix.  The Y centering will be off, but this is less
         // annoying than a blank page.  See https://bugs.launchpad.net/kicad/+bug/1464773.
         yoffset = 0;
 
         OffsetLogicalOrigin( xoffset, yoffset );
     }
 
     dc->SetLogicalFunction( wxCOPY );
     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( nullptr, dc, fitRect.GetX(), fitRect.GetY(), fitRect.GetRight(),
                    fitRect.GetBottom(), 0, bgColor, bgColor );
 
     if( cfg->m_Printing.monochrome )
         GRForceBlackPen( true );
 
     KIGFX::SCH_RENDER_SETTINGS renderSettings( *m_parent->GetRenderSettings() );
     renderSettings.SetPrintDC( dc );
 
     if( cfg->m_Printing.use_theme && theme )
         renderSettings.LoadColors( theme );
 
     // The drawing-sheet-item print code is shared between PCBNew and Eeschema, so it's easier
     // if they just use the PCB layer.
     renderSettings.SetLayerColor( LAYER_DRAWINGSHEET,
                                   renderSettings.GetLayerColor( LAYER_SCHEMATIC_DRAWINGSHEET ) );
 
     if( printReference )
     {
         m_parent->PrintDrawingSheet( &renderSettings, aScreen, IU_PER_MILS, aScreen->GetFileName(),
                                      wxEmptyString );
     }
 
     renderSettings.SetIsPrinting( true );
 
     aScreen->Print( &renderSettings );
 
     m_parent->SetDrawBgColor( savedBgColor );
 
     GRForceBlackPen( false );
 
     aScreen->m_StartVisu = tmp_startvisu;
     aScreen->m_DrawOrg   = old_org;
 }