Add usage of the new filedlg customize api for improved windows file dialogs

kicad/tools/kicad_manager_control.cpp

@@ -41,38 +41,11 @@
 #include <wx/filedlg.h>
 #include "dialog_pcm.h"
 
-
+#if wxCHECK_VERSION( 3, 1, 7 )
-///> Helper widget to select whether a new directory should be created for a project.
+#include "widgets/filedlg_hook_new_project.h"
-class DIR_CHECKBOX : public wxPanel
+#else
-{
+#include "widgets/legacy_dir_checkbox.h"
-public:
+#endif
-    DIR_CHECKBOX( wxWindow* aParent )
-            : wxPanel( aParent )
-    {
-        m_cbCreateDir = new wxCheckBox( this, wxID_ANY,
-                                        _( "Create a new folder for the project" ) );
-        m_cbCreateDir->SetValue( true );
-
-        wxBoxSizer* sizer = new wxBoxSizer( wxHORIZONTAL );
-        sizer->Add( m_cbCreateDir, 0, wxALL, 8 );
-
-        SetSizerAndFit( sizer );
-    }
-
-    bool CreateNewDir() const
-    {
-        return m_cbCreateDir->GetValue();
-    }
-
-    static wxWindow* Create( wxWindow* aParent )
-    {
-        return new DIR_CHECKBOX( aParent );
-    }
-
-protected:
-    wxCheckBox* m_cbCreateDir;
-};
-
 
 KICAD_MANAGER_CONTROL::KICAD_MANAGER_CONTROL() :
         TOOL_INTERACTIVE( "kicad.Control" ),
@@ -94,7 +67,12 @@ int KICAD_MANAGER_CONTROL::NewProject( const TOOL_EVENT& aEvent )
                          ProjectFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
     // Add a "Create a new directory" checkbox
+#if wxCHECK_VERSION( 3, 1, 7 )
+    FILEDLG_HOOK_NEW_PROJECT newProjectHook;
+    dlg.SetCustomizeHook( newProjectHook );
+#else
     dlg.SetExtraControlCreator( &DIR_CHECKBOX::Create );
+#endif
 
     if( dlg.ShowModal() == wxID_CANCEL )
         return -1;
@@ -112,7 +90,15 @@ int KICAD_MANAGER_CONTROL::NewProject( const TOOL_EVENT& aEvent )
         pro.MakeAbsolute();
 
     // Append a new directory with the same name of the project file.
-    if( static_cast<DIR_CHECKBOX*>( dlg.GetExtraControl() )->CreateNewDir() )
+    bool createNewDir = false;
+
+#if wxCHECK_VERSION( 3, 1, 7 )
+    createNewDir = newProjectHook.GetCreateNewDir();
+#else
+    createNewDir = static_cast<DIR_CHECKBOX*>( dlg.GetExtraControl() )->CreateNewDir();
+#endif
+
+    if( createNewDir )
         pro.AppendDir( pro.GetName() );
 
     // Check if the project directory is empty if it already exists.
@@ -191,7 +177,13 @@ int KICAD_MANAGER_CONTROL::NewFromTemplate( const TOOL_EVENT& aEvent )
                          wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
     // Add a "Create a new directory" checkbox
+#if wxCHECK_VERSION( 3, 1, 7 )
+    FILEDLG_HOOK_NEW_PROJECT newProjectHook;
+    dlg.SetCustomizeHook( newProjectHook );
+#else
     dlg.SetExtraControlCreator( &DIR_CHECKBOX::Create );
+#endif
+
 
     if( dlg.ShowModal() == wxID_CANCEL )
         return -1;
@@ -208,8 +200,15 @@ int KICAD_MANAGER_CONTROL::NewFromTemplate( const TOOL_EVENT& aEvent )
     if( !fn.IsAbsolute() )
         fn.MakeAbsolute();
 
+    bool createNewDir = false;
+#if wxCHECK_VERSION( 3, 1, 7 )
+    createNewDir = newProjectHook.GetCreateNewDir();
+#else
+    createNewDir = static_cast<DIR_CHECKBOX*>( dlg.GetExtraControl() )->CreateNewDir();
+#endif
+
     // Append a new directory with the same name of the project file.
-    if( static_cast<DIR_CHECKBOX*>( dlg.GetExtraControl() )->CreateNewDir() )
+    if( createNewDir )
         fn.AppendDir( fn.GetName() );
 
     // Check if the project directory is empty if it already exists.

kicad/widgets/filedlg_hook_new_project.h

@@ -0,0 +1,53 @@
+/*
+* This program source code file is part of KiCad, a free EDA CAD application.
+*
+* Copyright (C) 2022 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/>.
+*/
+
+#ifndef FILEDLG_HOOK_NEW_PROJECT_H
+#define FILEDLG_HOOK_NEW_PROJECT_H
+
+#include <wx/filedlgcustomize.h>
+
+class wxFileDialog;
+
+class FILEDLG_HOOK_NEW_PROJECT : public wxFileDialogCustomizeHook
+{
+public:
+    FILEDLG_HOOK_NEW_PROJECT(){};
+
+    virtual void AddCustomControls( wxFileDialogCustomize& customizer ) override
+    {
+        m_cb = customizer.AddCheckBox( _( "Create a new folder for the project" ) );
+        m_cb->SetValue( true );
+    }
+
+    virtual void TransferDataFromCustomControls() override
+    {
+        m_createNewDir = m_cb->GetValue();
+    }
+
+    bool GetCreateNewDir() const { return m_createNewDir; }
+
+private:
+    bool m_createNewDir;
+
+    wxFileDialogCheckBox* m_cb;
+
+    wxDECLARE_NO_COPY_CLASS( FILEDLG_HOOK_NEW_PROJECT );
+};
+
+#endif

kicad/widgets/legacy_dir_checkbox.h

@@ -0,0 +1,51 @@
+/*
+* This program source code file is part of KiCad, a free EDA CAD application.
+*
+* Copyright (C) 2022 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/>.
+*/
+
+#ifndef LEGACY_DIR_CHECKBOX_H
+#define LEGACY_DIR_CHECKBOX_H
+
+#include <wx/checkbox.h>
+#include <wx/panel.h>
+#include <wx/sizer.h>
+
+///> Helper widget to select whether a new directory should be created for a project.
+class DIR_CHECKBOX : public wxPanel
+{
+public:
+    DIR_CHECKBOX( wxWindow* aParent ) : wxPanel( aParent )
+    {
+        m_cbCreateDir =
+                new wxCheckBox( this, wxID_ANY, _( "Create a new folder for the project" ) );
+        m_cbCreateDir->SetValue( true );
+
+        wxBoxSizer* sizer = new wxBoxSizer( wxHORIZONTAL );
+        sizer->Add( m_cbCreateDir, 0, wxALL, 8 );
+
+        SetSizerAndFit( sizer );
+    }
+
+    bool CreateNewDir() const { return m_cbCreateDir->GetValue(); }
+
+    static wxWindow* Create( wxWindow* aParent ) { return new DIR_CHECKBOX( aParent ); }
+
+protected:
+    wxCheckBox* m_cbCreateDir;
+};
+
+#endif