kicad/common/widgets/paged_dialog.cpp

254 lines
7.9 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 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 3 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, see <http://www.gnu.org/licenses/>.
*/
#include <confirm.h>
#include <wx/treebook.h>
#include <wx/treectrl.h>
#include <wx/grid.h>
#include <wx/statline.h>
#include <widgets/paged_dialog.h>
// Maps from dialogTitle <-> pageTitle for keeping track of last-selected pages.
// This is not a simple page index because some dialogs have dynamic page sets.
std::map<wxString, wxString> g_lastPage;
std::map<wxString, wxString> g_lastParentPage;
PAGED_DIALOG::PAGED_DIALOG( wxWindow* aParent, const wxString& aTitle,
const wxString& aAuxiliaryAction ) :
DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
m_title( aTitle ),
m_errorCtrl( nullptr ),
m_errorRow( 0 ),
m_errorCol( 0 ),
m_auxiliaryButton( nullptr )
{
auto mainSizer = new wxBoxSizer( wxVERTICAL );
SetSizer( mainSizer );
m_treebook = new wxTreebook( this, wxID_ANY );
mainSizer->Add( m_treebook, 1, wxEXPAND|wxLEFT|wxTOP, 10 );
auto line = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLI_HORIZONTAL );
mainSizer->Add( line, 0, wxEXPAND|wxLEFT|wxTOP|wxRIGHT, 10 );
auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
if( !aAuxiliaryAction.IsEmpty() )
{
m_auxiliaryButton = new wxButton( this, wxID_ANY, aAuxiliaryAction );
buttonsSizer->Add( m_auxiliaryButton, 0, wxEXPAND|wxRIGHT|wxLEFT, 10 );
}
auto sdbSizer = new wxStdDialogButtonSizer();
auto sdbSizerOK = new wxButton( this, wxID_OK );
sdbSizer->AddButton( sdbSizerOK );
auto sdbSizerCancel = new wxButton( this, wxID_CANCEL );
sdbSizer->AddButton( sdbSizerCancel );
sdbSizer->Realize();
buttonsSizer->Add( sdbSizer, 1, wxEXPAND, 5 );
mainSizer->Add( buttonsSizer, 0, wxALL|wxEXPAND, 5 );
sdbSizerOK->SetDefault();
// We normally save the dialog size and position based on its class-name. This class
// substitutes the title so that each distinctly-titled dialog can have its own saved
// size and position.
m_hash_key = aTitle;
if( m_auxiliaryButton )
m_auxiliaryButton->Connect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PAGED_DIALOG::OnAuxiliaryAction ), nullptr, this );
Connect( wxEVT_UPDATE_UI, wxUpdateUIEventHandler( PAGED_DIALOG::OnUpdateUI ), nullptr, this );
}
// Finish initialization after the bookctrl pages have been added.
void PAGED_DIALOG::finishInitialization()
{
// For some reason adding page labels to the treeCtrl doesn't invalidate its bestSize
// cache so we have to do it by hand
m_treebook->GetTreeCtrl()->InvalidateBestSize();
for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
{
m_treebook->ExpandNode( i );
m_treebook->GetPage( i )->Layout();
}
m_treebook->Fit();
m_treebook->Layout();
FinishDialogSettings();
}
PAGED_DIALOG::~PAGED_DIALOG()
{
// Store the current parentPageTitle/pageTitle hierarchy so we can re-select it
// next time.
wxString lastPage = wxEmptyString;
wxString lastParentPage = wxEmptyString;
int selected = m_treebook->GetSelection();
if( selected != wxNOT_FOUND )
{
lastPage = m_treebook->GetPageText( (unsigned) selected );
int parent = m_treebook->GetPageParent( (unsigned) selected );
if( parent != wxNOT_FOUND )
lastParentPage = m_treebook->GetPageText( (unsigned) parent );
}
g_lastPage[ m_title ] = lastPage;
g_lastParentPage[ m_title ] = lastParentPage;
if( m_auxiliaryButton )
m_auxiliaryButton->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PAGED_DIALOG::OnAuxiliaryAction ), nullptr, this );
Disconnect( wxEVT_UPDATE_UI, wxUpdateUIEventHandler( PAGED_DIALOG::OnUpdateUI ), nullptr, this );
}
bool PAGED_DIALOG::TransferDataToWindow()
{
finishInitialization();
if( !DIALOG_SHIM::TransferDataToWindow() )
return false;
for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
{
wxWindow* page = m_treebook->GetPage( i );
if( !page->TransferDataToWindow() )
return false;
}
// Search for a page matching the lastParentPageTitle/lastPageTitle hierarchy
wxString lastPage = g_lastPage[ m_title ];
wxString lastParentPage = g_lastParentPage[ m_title ];
int lastPageIndex = wxNOT_FOUND;
for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
{
if( m_treebook->GetPageText( i ) == lastPage )
{
int parent = m_treebook->GetPageParent( i );
if( parent == wxNOT_FOUND )
{
if( lastParentPage.IsEmpty() )
lastPageIndex = i;
}
else
{
if( lastParentPage == m_treebook->GetPageText( (unsigned) parent ) )
lastPageIndex = i;
}
}
}
m_treebook->SetSelection( (unsigned) std::max( 0, lastPageIndex ) );
return true;
}
bool PAGED_DIALOG::TransferDataFromWindow()
{
if( !DIALOG_SHIM::TransferDataFromWindow() )
return false;
for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
{
wxWindow* page = m_treebook->GetPage( i );
if( !page->TransferDataFromWindow() )
return false;
}
return true;
}
void PAGED_DIALOG::SetError( const wxString& aMessage, wxWindow* aPage, wxObject* aCtrl,
int aRow, int aCol )
{
for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
{
if( m_treebook->GetPage( i ) == aPage )
{
m_treebook->SetSelection( i );
break;
}
}
// Once the page has been changed we want to wait for it to update before displaying
// the error dialog. So store the rest of the error info and wait for OnUpdateUI.
m_errorMessage = aMessage;
m_errorCtrl = aCtrl;
m_errorRow = aRow;
m_errorCol = aCol;
}
void PAGED_DIALOG::OnUpdateUI( wxUpdateUIEvent& event )
{
// Handle an error. This is delayed to OnUpdateUI so that we can change the focus
// even when the original validation was triggered from a killFocus event, and so
// that the corresponding notebook page can be shown in the background when triggered
// from an OK.
if( m_errorCtrl )
{
// We will re-enter this routine when the error dialog is displayed, so make
// sure we don't keep putting up more dialogs.
wxObject* ctrl = m_errorCtrl;
m_errorCtrl = nullptr;
DisplayErrorMessage( this, m_errorMessage );
auto textCtrl = dynamic_cast<wxTextCtrl*>( ctrl );
if( textCtrl )
{
auto textEntry = dynamic_cast<wxTextEntry*>( textCtrl );
textEntry->SetSelection( -1, -1 );
textCtrl->SetFocus();
return;
}
auto grid = dynamic_cast<wxGrid*>( ctrl );
if( grid )
{
grid->SetFocus();
grid->MakeCellVisible( m_errorRow, m_errorCol );
grid->SetGridCursor( m_errorRow, m_errorCol );
grid->EnableCellEditControl( true );
grid->ShowCellEditControl();
return;
}
}
}