kicad/common/dialogs/dialog_page_settings.cpp

/**
 * @file dialog_page_settings.cpp
 */

/* The "Page Settings" dialog box created by this file (and setpage.h)
 * contains seven checkboxes which *are* shown when that dialog box is
 * invoked in Eeschema, but which are *not* shown when that dialog box is
 * invoked in Pcbnew instead.
 */

#include <fctsys.h>
#include <common.h>
#include <base_struct.h>
#include <class_drawpanel.h>
#include <class_title_block.h>
#include <wxstruct.h>
#include <class_base_screen.h>

#include <wx/valgen.h>
#include <wx/tokenzr.h>

#ifdef EESCHEMA
#include <class_sch_screen.h>
#include <general.h>
#endif

#include <dialog_page_settings.h>


void EDA_DRAW_FRAME::Process_PageSettings( wxCommandEvent& event )
{
    DIALOG_PAGES_SETTINGS frame( this );
    int diag = frame.ShowModal();

    if( m_canvas && diag )
        m_canvas->Refresh();
}


DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* parent ) :
    DIALOG_PAGES_SETTINGS_BASE( parent ),
    m_user_size( PAGE_INFO::Custom )
{
    m_Parent   = parent;
    m_Screen   = m_Parent->GetScreen();
    m_modified = false;

    initDialog();

    GetSizer()->SetSizeHints( this );
    Centre();
}


DIALOG_PAGES_SETTINGS::~DIALOG_PAGES_SETTINGS()
{
}


void DIALOG_PAGES_SETTINGS::initDialog()
{
    wxString    msg;
    double      userSizeX;
    double      userSizeY;

    SetFocus();

#ifdef EESCHEMA
    // Init display value for sheet User size
    wxString format = m_TextSheetCount->GetLabel();
    msg.Printf( format, m_Screen->m_NumberOfScreen );
    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

    const PAGE_INFO& pageInfo = m_Parent->GetPageSettings();

    if( !pageInfo.IsCustom() )
        m_orientationComboBox->SetSelection( pageInfo.IsPortrait() );

    setCurrentPageSizeSelection( pageInfo.GetType() );

    // only a click fires the "selection changed" event, so have to fabricate this check
    wxCommandEvent dummy;
    onPaperSizeChoice( dummy );

    switch( g_UserUnit )
    {
    case MILLIMETRES:
        userSizeX  = m_user_size.GetWidthMils()  * 25.4e-3;
        userSizeY  = m_user_size.GetHeightMils() * 25.4e-3;

        msg.Printf( wxT( "%.2f" ), userSizeX );
        m_TextUserSizeX->SetValue( msg );

        msg.Printf( wxT( "%.2f" ), userSizeY );
        m_TextUserSizeY->SetValue( msg );
        break;

    default:
    case INCHES:
        userSizeX  = m_user_size.GetWidthMils() / 1000.0;
        userSizeY  = m_user_size.GetHeightMils() / 1000.0;

        msg.Printf( wxT( "%.3f" ), userSizeX );
        m_TextUserSizeX->SetValue( msg );

        msg.Printf( wxT( "%.3f" ), userSizeY );
        m_TextUserSizeY->SetValue( msg );
        break;

/*  // you want it in mils, why?
    case UNSCALED_UNITS:
        userSizeX  = m_user_size.GetWidthMils();
        userSizeY  = m_user_size.GetHeightMils();
        msg.Printf( wxT( "%f" ), m_userSizeX );
        m_TextUserSizeX->SetValue( msg );
        msg.Printf( wxT( "%f" ), m_userSizeY );
        m_TextUserSizeY->SetValue( msg );
        break;
*/
    }

#if 0
    m_TextRevision->SetValidator( wxTextValidator( wxFILTER_NONE, &m_Screen->m_Revision ) );
    m_TextTitle->SetValidator( wxTextValidator( wxFILTER_NONE, &m_Screen->m_Title ) );
    m_TextCompany->SetValidator( wxTextValidator( wxFILTER_NONE, &m_Screen->m_Company ) );
    m_TextComment1->SetValidator( wxTextValidator( wxFILTER_NONE, &m_Screen->m_Commentaire1 ) );
    m_TextComment2->SetValidator( wxTextValidator( wxFILTER_NONE, &m_Screen->m_Commentaire2 ) );
    m_TextComment3->SetValidator( wxTextValidator( wxFILTER_NONE, &m_Screen->m_Commentaire3 ) );
    m_TextComment4->SetValidator( wxTextValidator( wxFILTER_NONE, &m_Screen->m_Commentaire4 ) );
#else

    TITLE_BLOCK tb = m_Parent->GetTitleBlock();

    m_TextRevision->SetValue( tb.GetRevision() );
    m_TextTitle->SetValue( tb.GetTitle() );
    m_TextCompany->SetValue( tb.GetCompany() );
    m_TextComment1->SetValue( tb.GetComment1() );
    m_TextComment2->SetValue( tb.GetComment2() );
    m_TextComment3->SetValue( tb.GetComment3() );
    m_TextComment4->SetValue( tb.GetComment4() );
#endif

#ifndef EESCHEMA
    m_RevisionExport->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 );
#endif

    // Make the OK button the default.
    m_sdbSizer1OK->SetDefault();
}


void DIALOG_PAGES_SETTINGS::OnCloseWindow( wxCloseEvent& event )
{
    EndModal( m_modified );
}


void DIALOG_PAGES_SETTINGS::OnOkClick( wxCommandEvent& event )
{
    SavePageSettings( event );
    m_modified = true;
    Close( true );
}


void DIALOG_PAGES_SETTINGS::OnCancelClick( wxCommandEvent& event )
{
    Close( true );
}


void DIALOG_PAGES_SETTINGS::onPaperSizeChoice( wxCommandEvent& event )
{
    if( m_paperSizeComboBox->GetStringSelection().Contains( PAGE_INFO::Custom ) )
    {
        m_orientationComboBox->Enable( false );
    }
    else
    {
        m_orientationComboBox->Enable( true );
    }
}


void DIALOG_PAGES_SETTINGS::SavePageSettings( wxCommandEvent& event )
{
    wxString    msg;
    double      userSizeX;
    double      userSizeY;
    TITLE_BLOCK tb;

    tb.SetRevision( m_TextRevision->GetValue() );
    tb.SetCompany(  m_TextCompany->GetValue() );
    tb.SetTitle(    m_TextTitle->GetValue() );
    tb.SetComment1( m_TextComment1->GetValue() );
    tb.SetComment2( m_TextComment2->GetValue() );
    tb.SetComment3( m_TextComment3->GetValue() );
    tb.SetComment4( m_TextComment4->GetValue() );

    m_Parent->SetTitleBlock( tb );

    msg = m_TextUserSizeX->GetValue();
    msg.ToDouble( &userSizeX );

    msg = m_TextUserSizeY->GetValue();
    msg.ToDouble( &userSizeY );

    switch( g_UserUnit )
    {
    case MILLIMETRES:
        PAGE_INFO::SetUserWidthMils( int( userSizeX * 1000.0 / 25.4 ) );
        PAGE_INFO::SetUserHeightMils( int( userSizeY * 1000.0 / 25.4 ) );
        break;

    default:
    case INCHES:
        PAGE_INFO::SetUserWidthMils( int( 1000 * userSizeX ) );
        PAGE_INFO::SetUserHeightMils( int( 1000 * userSizeY ) );
        break;

/*      // set in 1/1000ths of an inch, but why?
    case UNSCALED_UNITS:
        PAGE_INFO::SetUserWidthMils( (int) userSizeX );
        PAGE_INFO::SetUserHeightMils( (int) userSizeY );
        break;
*/
    }

    // wxFormBuilder must use "A4", "A3", etc for choices, in all languages/translations
    wxString    paperType = m_paperSizeComboBox->GetStringSelection();

    // construct pageInfo _after_ user settings have been established in case the
    // paperType is custom, otherwise User width and height will not go into effect right away.
    PAGE_INFO   pageInfo;

    if( paperType.Contains( PAGE_INFO::Custom ) )
    {
        pageInfo.SetType( PAGE_INFO::Custom );
    }
    else
    {
        // here we assume translators will keep original paper size spellings
        if( !pageInfo.SetType( paperType ) )
        {
            wxASSERT_MSG( false, wxT( "the translation for paper size must preserve original spellings" ) );
        }

        // set portrait _after_ setting size/type above
        int choice = m_orientationComboBox->GetSelection();
        pageInfo.SetPortrait( choice );
    }

    m_Parent->SetPageSettings( pageInfo );

#ifdef EESCHEMA
    // Exports settings to other sheets if requested:
    SCH_SCREEN* screen;

    // Build the screen list
    SCH_SCREENS ScreenList;

    // Update title blocks for all screens
    for( screen = ScreenList.GetFirst(); screen != NULL; screen = ScreenList.GetNext() )
    {
        if( screen == m_Screen )
            continue;

        TITLE_BLOCK tb2 = screen->GetTitleBlock();

        if( m_RevisionExport->IsChecked() )
            tb2.SetRevision( tb.GetRevision() );

        if( m_TitleExport->IsChecked() )
            tb2.SetTitle( tb.GetTitle() );

        if( m_CompanyExport->IsChecked() )
            tb2.SetCompany( tb.GetCompany() );

        if( m_Comment1Export->IsChecked() )
            tb2.SetComment1( tb.GetComment1() );

        if( m_Comment2Export->IsChecked() )
            tb2.SetComment2( tb.GetComment2() );

        if( m_Comment3Export->IsChecked() )
            tb2.SetComment3( tb.GetComment3() );

        if( m_Comment4Export->IsChecked() )
            tb2.SetComment4( tb.GetComment4() );

        screen->SetTitleBlock( tb2 );
    }

#endif

    m_Screen->SetModify();
    m_Parent->GetCanvas()->Refresh();
}


void DIALOG_PAGES_SETTINGS::setCurrentPageSizeSelection( const wxString& aPaperSize )
{
    // use wxFormBuilder to store the sheet type in the wxRadioButton's label
    // i.e. "A4", "A3", etc, anywhere within the text of the label.

    D(printf("m_paperSizeComboBox->GetCount() = %d\n", (int) m_paperSizeComboBox->GetCount() );)

    // search all the child wxRadioButtons for a label containing our paper type
    for( unsigned i = 0;  i < m_paperSizeComboBox->GetCount();  ++i )
    {
        // parse each label looking for aPaperSize within it
        wxStringTokenizer st( m_paperSizeComboBox->GetString( i ) );

        while( st.HasMoreTokens() )
        {
            if( st.GetNextToken() == aPaperSize )
            {
                m_paperSizeComboBox->SetSelection( i );
                return;
            }
        }
    }
}