dialog_shim.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2012-2019 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
 */
 
#ifndef DIALOG_SHIM_
#define DIALOG_SHIM_
 
#include <kicommon.h>
#include <wx/dialog.h>
#include <kiway_player.h>
class wxGridEvent;
 
 
 
struct WINDOW_THAWER
{
 WINDOW_THAWER( wxWindow* aWindow )
 {
 m_window = aWindow;
 m_freezeCount = 0;
 
 while( m_window->IsFrozen() )
 {
 m_window->Thaw();
 m_freezeCount++;
 }
 }
 
 ~WINDOW_THAWER()
 {
 while( m_freezeCount > 0 )
 {
 m_window->Freeze();
 m_freezeCount--;
 }
 }
 
protected:
 wxWindow* m_window;
 int m_freezeCount;
};
 
 
class WDO_ENABLE_DISABLE;
class WX_EVENT_LOOP;
 
// These macros are for DIALOG_SHIM only, NOT for KIWAY_PLAYER. KIWAY_PLAYER
// has its own support for quasi modal and its platform specific issues are different
// than for a wxDialog.
 #define SHOWQUASIMODAL ShowQuasiModal
 #define ENDQUASIMODAL EndQuasiModal
 
class KICOMMON_API DIALOG_SHIM : public wxDialog, public KIWAY_HOLDER
{
public:
 DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,
 const wxPoint& pos = wxDefaultPosition,
 const wxSize& size = wxDefaultSize,
 long style = wxDEFAULT_FRAME_STYLE | wxRESIZE_BORDER,
 const wxString& name = wxDialogNameStr );
 
 ~DIALOG_SHIM();
 
 void SetInitialFocus( wxWindow* aWindow )
 {
 m_initialFocusTarget = aWindow;
 }
 
 int ShowQuasiModal(); // disable only the parent window, otherwise modal.
 
 void EndQuasiModal( int retCode ); // End quasi-modal mode
 
 bool IsQuasiModal() const { return m_qmodal_showing; }
 
 bool Show( bool show ) override;
 
 bool Enable( bool enable ) override;
 
 void OnPaint( wxPaintEvent &event );
 
 void OnModify();
 
 void SetPosition( const wxPoint& aNewPosition );
 
 EDA_UNITS GetUserUnits() const
 {
 return m_units;
 }
 
 void SelectAllInTextCtrls( wxWindowList& children );
 
 void SetupStandardButtons( std::map<int, wxString> aLabels = {} );
 
 static bool IsCtrl( int aChar, const wxKeyEvent& e )
 {
 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
 !e.ShiftDown() && !e.MetaDown();
 }
 
 static bool IsShiftCtrl( int aChar, const wxKeyEvent& e )
 {
 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
 e.ShiftDown() && !e.MetaDown();
 }
 
protected:
 void finishDialogSettings();
 
 void setSizeInDU( int x, int y );
 
 int horizPixelsFromDU( int x ) const;
 
 int vertPixelsFromDU( int y ) const;
 
 void resetSize();
 
 virtual void OnCharHook( wxKeyEvent& aEvt );
 
private:
 void OnCloseWindow( wxCloseEvent& aEvent );
 
 void OnButton( wxCommandEvent& aEvent );
 
 void onChildSetFocus( wxFocusEvent& aEvent );
 
 DECLARE_EVENT_TABLE();
 
protected:
 EDA_UNITS m_units; // userUnits for display and parsing
 std::string m_hash_key; // alternate for class_map when classname re-used
 
 // The following disables the storing of a user size. It is used primarily for dialogs
 // with conditional content which don't need user sizing.
 bool m_useCalculatedSize;
 
 // On MacOS (at least) SetFocus() calls made in the constructor will fail because a
 // window that isn't yet visible will return false to AcceptsFocus(). So we must delay
 // the initial-focus SetFocus() call to the first paint event.
 bool m_firstPaintEvent;
 wxWindow* m_initialFocusTarget;
 bool m_isClosing;
 
 WX_EVENT_LOOP* m_qmodal_loop; // points to nested event_loop, NULL means not qmodal
 // and dismissed
 bool m_qmodal_showing;
 WDO_ENABLE_DISABLE* m_qmodal_parent_disabler;
 
 EDA_BASE_FRAME* m_parentFrame;
 
 std::vector<wxWindow*> m_tabOrder;
 
 // The size asked by the caller, used the first time the dialog is created
 wxSize m_initialSize;
 
 // Used to support first-esc-cancels-edit logic
 std::map<wxWindow*, wxString> m_beforeEditValues;
};
 
#endif // DIALOG_SHIM_