kicad/common/dialogs/dialog_page_settings.cpp

920 lines
29 KiB
C++

/*
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 1992-2018 Kicad Developers, see AUTHORS.txt for contributors.
*
* 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
*/
#include <base_screen.h>
#include <confirm.h>
#include <dialog_page_settings.h>
#include <eda_draw_frame.h>
#include <eda_item.h>
#include <gr_basic.h>
#include <kiface_i.h>
#include <math/util.h> // for KiROUND, Clamp
#include <project.h>
#include <title_block.h>
#include <tool/actions.h>
#include <tool/tool_manager.h>
#include <wildcards_and_files_ext.h>
#include <page_layout/ws_data_model.h>
#include <page_layout/ws_painter.h>
#include <wx/valgen.h>
#include <wx/tokenzr.h>
#ifdef EESCHEMA
#include <general.h>
#include <sch_edit_frame.h>
#include <sch_screen.h>
#include <schematic.h>
#include <eeschema_settings.h>
#endif
#define MAX_PAGE_EXAMPLE_SIZE 200
// List of page formats.
// they are prefixed by "_HKI" (already in use for hotkeys) instead of "_",
// because we need both the translated and the not translated version.
// when displayed in dialog we should explicitly call wxGetTranslation()
// to show the translated version.
// See hotkeys_basic.h for more info
#define _HKI( x ) wxT( x )
static const wxString pageFmts[] =
{
_HKI("A5 148x210mm"),
_HKI("A4 210x297mm"),
_HKI("A3 297x420mm"),
_HKI("A2 420x594mm"),
_HKI("A1 594x841mm"),
_HKI("A0 841x1189mm"),
_HKI("A 8.5x11in"),
_HKI("B 11x17in"),
_HKI("C 17x22in"),
_HKI("D 22x34in"),
_HKI("E 34x44in"),
_HKI("USLetter 8.5x11in"), // USLetter without space is correct
_HKI("USLegal 8.5x14in"), // USLegal without space is correct
_HKI("USLedger 11x17in"), // USLedger without space is correct
_HKI("User (Custom)"), // size defined by user. The string must contain "Custom"
// to be recognized in code
};
DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* parent, wxSize aMaxUserSizeMils ) :
DIALOG_PAGES_SETTINGS_BASE( parent ),
m_initialized( false ),
m_customSizeX( parent, m_userSizeXLabel, m_userSizeXCtrl, m_userSizeXUnits, false ),
m_customSizeY( parent, m_userSizeYLabel, m_userSizeYCtrl, m_userSizeYUnits, false )
{
m_parent = parent;
m_screen = m_parent->GetScreen();
m_projectPath = Prj().GetProjectPath();
m_page_bitmap = NULL;
m_maxPageSizeMils = aMaxUserSizeMils;
m_tb = m_parent->GetTitleBlock();
m_customFmt = false;
m_localPrjConfigChanged = false;
m_pagelayout = new WS_DATA_MODEL;
wxString serialization;
WS_DATA_MODEL::GetTheInstance().SaveInString( serialization );
m_pagelayout->SetPageLayout( TO_UTF8( serialization ) );
m_PickDate->SetValue( wxDateTime::Now() );
if( parent->GetName() == PL_EDITOR_FRAME_NAME )
{
SetTitle( _( "Preview Settings" ) );
m_staticTextPaper->SetLabel( _( "Preview Paper" ) );
m_staticTextTitleBlock->SetLabel( _( "Preview Title Block Data" ) );
}
else
{
SetTitle( _( "Page Settings" ) );
m_staticTextPaper->SetLabel( _( "Paper" ) );
m_staticTextTitleBlock->SetLabel( _( "Title Block" ) );
}
initDialog();
GetSizer()->SetSizeHints( this );
Centre();
}
DIALOG_PAGES_SETTINGS::~DIALOG_PAGES_SETTINGS()
{
#ifdef EESCHEMA
auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
wxASSERT( cfg );
cfg->m_PageSettings.export_paper = m_PaperExport->GetValue();
cfg->m_PageSettings.export_revision = m_RevisionExport->GetValue();
cfg->m_PageSettings.export_date = m_DateExport->GetValue();
cfg->m_PageSettings.export_title = m_TitleExport->GetValue();
cfg->m_PageSettings.export_company = m_CompanyExport->GetValue();
cfg->m_PageSettings.export_comment1 = m_Comment1Export->GetValue();
cfg->m_PageSettings.export_comment2 = m_Comment2Export->GetValue();
cfg->m_PageSettings.export_comment3 = m_Comment3Export->GetValue();
cfg->m_PageSettings.export_comment4 = m_Comment4Export->GetValue();
cfg->m_PageSettings.export_comment5 = m_Comment5Export->GetValue();
cfg->m_PageSettings.export_comment6 = m_Comment6Export->GetValue();
cfg->m_PageSettings.export_comment7 = m_Comment7Export->GetValue();
cfg->m_PageSettings.export_comment8 = m_Comment8Export->GetValue();
cfg->m_PageSettings.export_comment9 = m_Comment9Export->GetValue();
#endif
delete m_page_bitmap;
delete m_pagelayout;
}
void DIALOG_PAGES_SETTINGS::initDialog()
{
wxString msg;
// initialize page format choice box and page format list.
// The first shows translated strings, the second contains not translated strings
m_paperSizeComboBox->Clear();
for( const wxString& pageFmt : pageFmts )
{
m_pageFmt.Add( pageFmt );
m_paperSizeComboBox->Append( wxGetTranslation( pageFmt ) );
}
// initialize the page layout descr filename
SetWksFileName( BASE_SCREEN::m_PageLayoutDescrFileName );
#ifdef EESCHEMA
// Init display value for schematic sub-sheet number
wxString format = m_TextSheetCount->GetLabel();
msg.Printf( format, m_screen->m_NumberOfScreens );
m_TextSheetCount->SetLabel( msg );
format = m_TextSheetNumber->GetLabel();
msg.Printf( format, m_screen->m_ScreenNumber );
m_TextSheetNumber->SetLabel( msg );
#else
m_TextSheetCount->Show( false );
m_TextSheetNumber->Show( false );
#endif
m_pageInfo = m_parent->GetPageSettings();
SetCurrentPageSizeSelection( m_pageInfo.GetType() );
m_orientationComboBox->SetSelection( m_pageInfo.IsPortrait() );
// only a click fires the "selection changed" event, so have to fabricate this check
wxCommandEvent dummy;
OnPaperSizeChoice( dummy );
if( m_customFmt )
{
m_customSizeX.SetValue( m_pageInfo.GetWidthMils() * IU_PER_MILS );
m_customSizeY.SetValue( m_pageInfo.GetHeightMils() * IU_PER_MILS );
}
else
{
m_customSizeX.SetValue( m_pageInfo.GetCustomWidthMils() * IU_PER_MILS );
m_customSizeY.SetValue( m_pageInfo.GetCustomHeightMils() * IU_PER_MILS );
}
m_TextRevision->SetValue( m_tb.GetRevision() );
m_TextDate->SetValue( m_tb.GetDate() );
m_TextTitle->SetValue( m_tb.GetTitle() );
m_TextCompany->SetValue( m_tb.GetCompany() );
m_TextComment1->SetValue( m_tb.GetComment( 0 ) );
m_TextComment2->SetValue( m_tb.GetComment( 1 ) );
m_TextComment3->SetValue( m_tb.GetComment( 2 ) );
m_TextComment4->SetValue( m_tb.GetComment( 3 ) );
m_TextComment5->SetValue( m_tb.GetComment( 4 ) );
m_TextComment6->SetValue( m_tb.GetComment( 5 ) );
m_TextComment7->SetValue( m_tb.GetComment( 6 ) );
m_TextComment8->SetValue( m_tb.GetComment( 7 ) );
m_TextComment9->SetValue( m_tb.GetComment( 8 ) );
#ifdef EESCHEMA
auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
wxASSERT( cfg );
m_PaperExport->SetValue( cfg->m_PageSettings.export_paper );
m_RevisionExport->SetValue( cfg->m_PageSettings.export_revision );
m_DateExport->SetValue( cfg->m_PageSettings.export_date );
m_TitleExport->SetValue( cfg->m_PageSettings.export_title );
m_CompanyExport->SetValue( cfg->m_PageSettings.export_company );
m_Comment1Export->SetValue( cfg->m_PageSettings.export_comment1 );
m_Comment2Export->SetValue( cfg->m_PageSettings.export_comment2 );
m_Comment3Export->SetValue( cfg->m_PageSettings.export_comment3 );
m_Comment4Export->SetValue( cfg->m_PageSettings.export_comment4 );
m_Comment5Export->SetValue( cfg->m_PageSettings.export_comment5 );
m_Comment6Export->SetValue( cfg->m_PageSettings.export_comment6 );
m_Comment7Export->SetValue( cfg->m_PageSettings.export_comment7 );
m_Comment8Export->SetValue( cfg->m_PageSettings.export_comment8 );
m_Comment9Export->SetValue( cfg->m_PageSettings.export_comment9 );
#else
m_PaperExport->Show( false );
m_RevisionExport->Show( false );
m_DateExport->Show( false );
m_TitleExport->Show( false );
m_CompanyExport->Show( false );
m_Comment1Export->Show( false );
m_Comment2Export->Show( false );
m_Comment3Export->Show( false );
m_Comment4Export->Show( false );
m_Comment5Export->Show( false );
m_Comment6Export->Show( false );
m_Comment7Export->Show( false );
m_Comment8Export->Show( false );
m_Comment9Export->Show( false );
#endif
GetPageLayoutInfoFromDialog();
UpdatePageLayoutExample();
// Make the OK button the default.
m_sdbSizerOK->SetDefault();
m_initialized = true;
}
void DIALOG_PAGES_SETTINGS::OnOkClick( wxCommandEvent& event )
{
if( !m_customSizeX.Validate( MIN_PAGE_SIZE_MILS, m_maxPageSizeMils.x, EDA_UNITS::MILS ) )
return;
if( !m_customSizeY.Validate( MIN_PAGE_SIZE_MILS, m_maxPageSizeMils.y, EDA_UNITS::MILS ) )
return;
if( SavePageSettings() )
{
m_screen->SetModify();
if( LocalPrjConfigChanged() )
m_parent->SaveProjectSettings();
// Call the post processing (if any) after changes
m_parent->OnPageSettingsChange();
}
event.Skip();
}
void DIALOG_PAGES_SETTINGS::OnPaperSizeChoice( wxCommandEvent& event )
{
int idx = m_paperSizeComboBox->GetSelection();
if( idx < 0 )
idx = 0;
const wxString paperType = m_pageFmt[idx];
if( paperType.Contains( PAGE_INFO::Custom ) )
{
m_orientationComboBox->Enable( false );
m_customSizeX.Enable( true );
m_customSizeY.Enable( true );
m_customFmt = true;
}
else
{
m_orientationComboBox->Enable( true );
#if 0
// ForcePortrait() does not exist, but could be useful.
// so I leave these lines, which could be seen as a todo feature
if( paperType.ForcePortrait() )
{
m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
m_orientationComboBox->Enable( false );
}
#endif
m_customSizeX.Enable( false );
m_customSizeY.Enable( false );
m_customFmt = false;
}
GetPageLayoutInfoFromDialog();
UpdatePageLayoutExample();
}
void DIALOG_PAGES_SETTINGS::OnUserPageSizeXTextUpdated( wxCommandEvent& event )
{
if( m_initialized )
{
GetPageLayoutInfoFromDialog();
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnUserPageSizeYTextUpdated( wxCommandEvent& event )
{
if( m_initialized )
{
GetPageLayoutInfoFromDialog();
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnPageOrientationChoice( wxCommandEvent& event )
{
if( m_initialized )
{
GetPageLayoutInfoFromDialog();
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnRevisionTextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextRevision->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetRevision( m_TextRevision->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnDateTextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextDate->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetDate( m_TextDate->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnTitleTextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextTitle->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetTitle( m_TextTitle->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnCompanyTextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextCompany->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetCompany( m_TextCompany->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment1TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment1->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 0, m_TextComment1->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment2TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment2->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 1, m_TextComment2->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment3TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment3->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 2, m_TextComment3->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment4TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment4->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 3, m_TextComment4->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment5TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment5->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 4, m_TextComment5->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment6TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment6->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 5, m_TextComment6->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment7TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment7->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 6, m_TextComment7->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment8TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment8->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 7, m_TextComment8->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnComment9TextUpdated( wxCommandEvent& event )
{
if( m_initialized && m_TextComment9->IsModified() )
{
GetPageLayoutInfoFromDialog();
m_tb.SetComment( 8, m_TextComment9->GetValue() );
UpdatePageLayoutExample();
}
}
void DIALOG_PAGES_SETTINGS::OnDateApplyClick( wxCommandEvent& event )
{
wxDateTime datetime = m_PickDate->GetValue();
wxString date =
// We can choose different formats. Only one must be uncommented
//
// datetime.Format( wxLocale::GetInfo( wxLOCALE_SHORT_DATE_FMT ) );
// datetime.Format( wxLocale::GetInfo( wxLOCALE_LONG_DATE_FMT ) );
// datetime.Format( wxT("%Y-%b-%d") );
datetime.FormatISODate();
m_TextDate->SetValue( date );
}
bool DIALOG_PAGES_SETTINGS::SavePageSettings()
{
bool success = false;
wxString fileName = GetWksFileName();
if( fileName != BASE_SCREEN::m_PageLayoutDescrFileName )
{
wxString fullFileName = WS_DATA_MODEL::MakeFullFileName( fileName, m_projectPath );
if( !fullFileName.IsEmpty() && !wxFileExists( fullFileName ) )
{
wxString msg;
msg.Printf( _( "Page layout description file \"%s\" not found." ), fullFileName );
wxMessageBox( msg );
return false;
}
BASE_SCREEN::m_PageLayoutDescrFileName = fileName;
WS_DATA_MODEL& pglayout = WS_DATA_MODEL::GetTheInstance();
pglayout.SetPageLayout( fullFileName );
m_localPrjConfigChanged = true;
}
int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
const wxString paperType = m_pageFmt[idx];
if( paperType.Contains( PAGE_INFO::Custom ) )
{
GetCustomSizeMilsFromDialog();
success = m_pageInfo.SetType( PAGE_INFO::Custom );
if( success )
{
PAGE_INFO::SetCustomWidthMils( m_layout_size.x );
PAGE_INFO::SetCustomHeightMils( m_layout_size.y );
m_pageInfo.SetWidthMils( m_layout_size.x );
m_pageInfo.SetHeightMils( m_layout_size.y );
}
}
else
{
// search for longest common string first, e.g. A4 before A
if( paperType.Contains( PAGE_INFO::USLetter ) )
success = m_pageInfo.SetType( PAGE_INFO::USLetter );
else if( paperType.Contains( PAGE_INFO::USLegal ) )
success = m_pageInfo.SetType( PAGE_INFO::USLegal );
else if( paperType.Contains( PAGE_INFO::USLedger ) )
success = m_pageInfo.SetType( PAGE_INFO::USLedger );
else if( paperType.Contains( PAGE_INFO::GERBER ) )
success = m_pageInfo.SetType( PAGE_INFO::GERBER );
else if( paperType.Contains( PAGE_INFO::A5 ) )
success = m_pageInfo.SetType( PAGE_INFO::A5 );
else if( paperType.Contains( PAGE_INFO::A4 ) )
success = m_pageInfo.SetType( PAGE_INFO::A4 );
else if( paperType.Contains( PAGE_INFO::A3 ) )
success = m_pageInfo.SetType( PAGE_INFO::A3 );
else if( paperType.Contains( PAGE_INFO::A2 ) )
success = m_pageInfo.SetType( PAGE_INFO::A2 );
else if( paperType.Contains( PAGE_INFO::A1 ) )
success = m_pageInfo.SetType( PAGE_INFO::A1 );
else if( paperType.Contains( PAGE_INFO::A0 ) )
success = m_pageInfo.SetType( PAGE_INFO::A0 );
else if( paperType.Contains( PAGE_INFO::A ) )
success = m_pageInfo.SetType( PAGE_INFO::A );
else if( paperType.Contains( PAGE_INFO::B ) )
success = m_pageInfo.SetType( PAGE_INFO::B );
else if( paperType.Contains( PAGE_INFO::C ) )
success = m_pageInfo.SetType( PAGE_INFO::C );
else if( paperType.Contains( PAGE_INFO::D ) )
success = m_pageInfo.SetType( PAGE_INFO::D );
else if( paperType.Contains( PAGE_INFO::E ) )
success = m_pageInfo.SetType( PAGE_INFO::E );
if( success )
{
int choice = m_orientationComboBox->GetSelection();
m_pageInfo.SetPortrait( choice != 0 );
}
}
if( !success )
{
wxASSERT_MSG( false, _( "the translation for paper size must preserve original spellings" ) );
m_pageInfo.SetType( PAGE_INFO::A4 );
}
m_parent->SetPageSettings( m_pageInfo );
m_tb.SetRevision( m_TextRevision->GetValue() );
m_tb.SetDate( m_TextDate->GetValue() );
m_tb.SetCompany( m_TextCompany->GetValue() );
m_tb.SetTitle( m_TextTitle->GetValue() );
m_tb.SetComment( 0, m_TextComment1->GetValue() );
m_tb.SetComment( 1, m_TextComment2->GetValue() );
m_tb.SetComment( 2, m_TextComment3->GetValue() );
m_tb.SetComment( 3, m_TextComment4->GetValue() );
m_tb.SetComment( 4, m_TextComment5->GetValue() );
m_tb.SetComment( 5, m_TextComment6->GetValue() );
m_tb.SetComment( 6, m_TextComment7->GetValue() );
m_tb.SetComment( 7, m_TextComment8->GetValue() );
m_tb.SetComment( 8, m_TextComment9->GetValue() );
m_parent->SetTitleBlock( m_tb );
#ifdef EESCHEMA
wxCHECK_MSG( dynamic_cast<SCH_EDIT_FRAME*>( m_parent ), true,
"DIALOG_PAGES_SETTINGS::OnDateApplyClick frame is not a schematic frame!" );
// Exports settings to other sheets if requested:
SCH_SCREENS ScreenList( dynamic_cast<SCH_EDIT_FRAME*>( m_parent )->Schematic().Root() );
// Update page info and/or title blocks for all screens
for( SCH_SCREEN* screen = ScreenList.GetFirst(); screen; screen = ScreenList.GetNext() )
{
if( screen == m_screen )
continue;
if( m_PaperExport->IsChecked() )
screen->SetPageSettings( m_pageInfo );
TITLE_BLOCK tb2 = screen->GetTitleBlock();
if( m_RevisionExport->IsChecked() )
tb2.SetRevision( m_tb.GetRevision() );
if( m_DateExport->IsChecked() )
tb2.SetDate( m_tb.GetDate() );
if( m_TitleExport->IsChecked() )
tb2.SetTitle( m_tb.GetTitle() );
if( m_CompanyExport->IsChecked() )
tb2.SetCompany( m_tb.GetCompany() );
if( m_Comment1Export->IsChecked() )
tb2.SetComment( 0, m_tb.GetComment( 0 ) );
if( m_Comment2Export->IsChecked() )
tb2.SetComment( 1, m_tb.GetComment( 1 ) );
if( m_Comment3Export->IsChecked() )
tb2.SetComment( 2, m_tb.GetComment( 2 ) );
if( m_Comment4Export->IsChecked() )
tb2.SetComment( 3, m_tb.GetComment( 3 ) );
if( m_Comment5Export->IsChecked() )
tb2.SetComment( 4, m_tb.GetComment( 4 ) );
if( m_Comment6Export->IsChecked() )
tb2.SetComment( 5, m_tb.GetComment( 5 ) );
if( m_Comment7Export->IsChecked() )
tb2.SetComment( 6, m_tb.GetComment( 6 ) );
if( m_Comment8Export->IsChecked() )
tb2.SetComment( 7, m_tb.GetComment( 7 ) );
if( m_Comment9Export->IsChecked() )
tb2.SetComment( 8, m_tb.GetComment( 8 ) );
screen->SetTitleBlock( tb2 );
}
#endif
return true;
}
void DIALOG_PAGES_SETTINGS::SetCurrentPageSizeSelection( const wxString& aPaperSize )
{
// search all the not translated label list containing our paper type
for( unsigned i = 0; i < m_pageFmt.GetCount(); ++i )
{
// parse each label looking for aPaperSize within it
wxStringTokenizer st( m_pageFmt[i] );
while( st.HasMoreTokens() )
{
if( st.GetNextToken() == aPaperSize )
{
m_paperSizeComboBox->SetSelection( i );
return;
}
}
}
}
void DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample()
{
int lyWidth, lyHeight;
wxSize clamped_layout_size( Clamp( MIN_PAGE_SIZE_MILS, m_layout_size.x, m_maxPageSizeMils.x ),
Clamp( MIN_PAGE_SIZE_MILS, m_layout_size.y, m_maxPageSizeMils.y ) );
double lyRatio = clamped_layout_size.x < clamped_layout_size.y ?
(double) clamped_layout_size.y / clamped_layout_size.x :
(double) clamped_layout_size.x / clamped_layout_size.y;
if( clamped_layout_size.x < clamped_layout_size.y )
{
lyHeight = MAX_PAGE_EXAMPLE_SIZE;
lyWidth = KiROUND( (double) lyHeight / lyRatio );
}
else
{
lyWidth = MAX_PAGE_EXAMPLE_SIZE;
lyHeight = KiROUND( (double) lyWidth / lyRatio );
}
if( m_page_bitmap )
{
m_PageLayoutExampleBitmap->SetBitmap( wxNullBitmap );
delete m_page_bitmap;
}
m_page_bitmap = new wxBitmap( lyWidth + 1, lyHeight + 1 );
if( m_page_bitmap->IsOk() )
{
double scaleW = (double) lyWidth / clamped_layout_size.x;
double scaleH = (double) lyHeight / clamped_layout_size.y;
// Prepare DC.
wxSize example_size( lyWidth + 1, lyHeight + 1 );
wxMemoryDC memDC;
memDC.SelectObject( *m_page_bitmap );
memDC.SetClippingRegion( wxPoint( 0, 0 ), example_size );
memDC.Clear();
memDC.SetUserScale( scaleW, scaleH );
// Get logical page size and margins.
PAGE_INFO pageDUMMY;
// Get page type
int idx = m_paperSizeComboBox->GetSelection();
if( idx < 0 )
idx = 0;
wxString pageFmtName = m_pageFmt[idx].BeforeFirst( ' ' );
bool portrait = clamped_layout_size.x < clamped_layout_size.y;
pageDUMMY.SetType( pageFmtName, portrait );
if( m_customFmt )
{
pageDUMMY.SetWidthMils( clamped_layout_size.x );
pageDUMMY.SetHeightMils( clamped_layout_size.y );
}
// Draw layout preview.
wxString emptyString;
GRResetPenAndBrush( &memDC );
WS_DATA_MODEL::SetAltInstance( m_pagelayout );
KIGFX::WS_RENDER_SETTINGS renderSettings;
renderSettings.SetDefaultPenWidth( 1 );
renderSettings.SetLayerColor( LAYER_WORKSHEET, COLOR4D( RED ) );
renderSettings.SetPrintDC( &memDC );
GRFilledRect( NULL, &memDC, 0, 0, m_layout_size.x, m_layout_size.y, WHITE, WHITE );
PrintPageLayout( &renderSettings, pageDUMMY, emptyString, emptyString, m_tb,
m_screen->m_NumberOfScreens, m_screen->m_ScreenNumber, 1, &Prj() );
memDC.SelectObject( wxNullBitmap );
m_PageLayoutExampleBitmap->SetBitmap( *m_page_bitmap );
WS_DATA_MODEL::SetAltInstance( NULL );
// Refresh the dialog.
Layout();
Refresh();
}
}
void DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog()
{
int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
const wxString paperType = m_pageFmt[idx];
// here we assume translators will keep original paper size spellings
if( paperType.Contains( PAGE_INFO::Custom ) )
{
GetCustomSizeMilsFromDialog();
if( m_layout_size.x && m_layout_size.y )
{
if( m_layout_size.x < m_layout_size.y )
m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
else
m_orientationComboBox->SetStringSelection( _( "Landscape" ) );
}
}
else
{
PAGE_INFO pageInfo; // SetType() later to lookup size
static const wxChar* papers[] = {
// longest common string first, since sequential search below
PAGE_INFO::A5,
PAGE_INFO::A4,
PAGE_INFO::A3,
PAGE_INFO::A2,
PAGE_INFO::A1,
PAGE_INFO::A0,
PAGE_INFO::A,
PAGE_INFO::B,
PAGE_INFO::C,
PAGE_INFO::D,
PAGE_INFO::E,
PAGE_INFO::USLetter,
PAGE_INFO::USLegal,
PAGE_INFO::USLedger,
};
unsigned i;
for( i=0; i < arrayDim( papers ); ++i )
{
if( paperType.Contains( papers[i] ) )
{
pageInfo.SetType( papers[i] );
break;
}
}
wxASSERT( i != arrayDim(papers) ); // dialog UI match the above list?
m_layout_size = pageInfo.GetSizeMils();
// swap sizes to match orientation
bool isPortrait = (bool) m_orientationComboBox->GetSelection();
if( ( isPortrait && m_layout_size.x >= m_layout_size.y ) ||
( !isPortrait && m_layout_size.x < m_layout_size.y ) )
{
m_layout_size.Set( m_layout_size.y, m_layout_size.x );
}
}
}
void DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog()
{
double customSizeX = (double) m_customSizeX.GetValue() / IU_PER_MILS;
double customSizeY = (double) m_customSizeY.GetValue() / IU_PER_MILS;
// Prepare to painless double -> int conversion.
customSizeX = Clamp( double( INT_MIN ), customSizeX, double( INT_MAX ) );
customSizeY = Clamp( double( INT_MIN ), customSizeY, double( INT_MAX ) );
m_layout_size = wxSize( KiROUND( customSizeX ), KiROUND( customSizeY ) );
}
void DIALOG_PAGES_SETTINGS::OnWksFileSelection( wxCommandEvent& event )
{
wxFileName fn = GetWksFileName();
wxString name = GetWksFileName();
wxString path;
if( fn.IsAbsolute() )
{
path = fn.GetPath();
name = fn.GetFullName();
}
else
{
path = m_projectPath;
}
// Display a file picker dialog
wxFileDialog fileDialog( this, _( "Select Page Layout Description File" ),
path, name, PageLayoutDescrFileWildcard(),
wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
if( fileDialog.ShowModal() != wxID_OK )
return;
wxString fileName = fileDialog.GetPath();
// Try to remove the path, if the path is the current working dir,
// or the dir of kicad.pro (template), and use a relative path
wxString shortFileName = WS_DATA_MODEL::MakeShortFileName( fileName, m_projectPath );
// For Win/Linux/macOS compatibility, a relative path is a good idea
if( shortFileName != GetWksFileName() && shortFileName != fileName )
{
wxString msg = wxString::Format( _(
"The page layout description file name has changed.\n"
"Do you want to use the relative path:\n"
"\"%s\"\n"
"instead of\n"
"\"%s\"?" ), shortFileName, fileName );
if( !IsOK( this, msg ) )
shortFileName = fileName;
}
SetWksFileName( shortFileName );
if( m_pagelayout == NULL )
m_pagelayout = new WS_DATA_MODEL;
m_pagelayout->SetPageLayout( fileName );
GetPageLayoutInfoFromDialog();
UpdatePageLayoutExample();
}