KiCad PCB EDA Suite
dialog_shim.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2012-2019 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef DIALOG_SHIM_
26 #define DIALOG_SHIM_
27 
28 #include <wx/dialog.h>
29 #include <hashtables.h>
30 #include <kiway_player.h>
31 class wxGridEvent;
32 
33 
34 
36 {
37  WINDOW_THAWER( wxWindow* aWindow )
38  {
39  m_window = aWindow;
40  m_freezeCount = 0;
41 
42  while( m_window->IsFrozen() )
43  {
44  m_window->Thaw();
45  m_freezeCount++;
46  }
47  }
48 
50  {
51  while( m_freezeCount > 0 )
52  {
53  m_window->Freeze();
54  m_freezeCount--;
55  }
56  }
57 
58 protected:
59  wxWindow* m_window;
61 };
62 
63 
64 class WDO_ENABLE_DISABLE;
65 class WX_EVENT_LOOP;
66 
67 // These macros are for DIALOG_SHIM only, NOT for KIWAY_PLAYER. KIWAY_PLAYER
68 // has its own support for quasi modal and its platform specific issues are different
69 // than for a wxDialog.
70  #define SHOWQUASIMODAL ShowQuasiModal
71  #define ENDQUASIMODAL EndQuasiModal
72 
83 class DIALOG_SHIM : public wxDialog, public KIWAY_HOLDER
84 {
89  void OnCloseWindow( wxCloseEvent& aEvent );
90 
95  void OnButton( wxCommandEvent& aEvent );
96 
97  void OnCharHook( wxKeyEvent& aEvt );
98 
99 public:
100 
101  DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,
102  const wxPoint& pos = wxDefaultPosition,
103  const wxSize& size = wxDefaultSize,
104  long style = wxDEFAULT_FRAME_STYLE|wxRESIZE_BORDER,
105  const wxString& name = wxDialogNameStr
106  );
107 
108  ~DIALOG_SHIM();
109 
114  void SetInitialFocus( wxWindow* aWindow )
115  {
116  m_initialFocusTarget = aWindow;
117  }
118 
119  int ShowQuasiModal(); // disable only the parent window, otherwise modal.
120 
121  void EndQuasiModal( int retCode ); // End quasi-modal mode
122 
123  bool IsQuasiModal() { return m_qmodal_showing; }
124 
125  bool Show( bool show ) override;
126 
127  bool Enable( bool enable ) override;
128 
129  void OnPaint( wxPaintEvent &event );
130 
132  {
133  return m_units;
134  }
135 
136  static bool IsCtrl( int aChar, const wxKeyEvent& e )
137  {
138  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
139  !e.ShiftDown() && !e.MetaDown();
140  }
141 
142  static bool IsShiftCtrl( int aChar, const wxKeyEvent& e )
143  {
144  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
145  e.ShiftDown() && !e.MetaDown();
146  }
147 
148  static void FixOSXCancelButtonIssue( wxWindow *aWindow );
149 
150 protected:
151 
167  void FinishDialogSettings();
168 
174  void SetSizeInDU( int x, int y );
175 
180  int HorizPixelsFromDU( int x );
181 
186  int VertPixelsFromDU( int y );
187 
195  void ResetSize();
196 
197  EDA_UNITS m_units; // userUnits for display and parsing
198  std::string m_hash_key; // alternate for class_map when classname re-used
199 
200  // On MacOS (at least) SetFocus() calls made in the constructor will fail because a
201  // window that isn't yet visible will return false to AcceptsFocus(). So we must delay
202  // the initial-focus SetFocus() call to the first paint event.
205 
206  WX_EVENT_LOOP* m_qmodal_loop; // points to nested event_loop, NULL means not qmodal
207  // and dismissed
210 
212 
213  std::vector<wxWindow*> m_tabOrder;
214 
215 private:
216  void OnGridEditorShown( wxGridEvent& event );
217  void OnGridEditorHidden( wxGridEvent& event );
218 
219  DECLARE_EVENT_TABLE()
220 };
221 
222 #endif // DIALOG_SHIM_
bool m_qmodal_showing
Definition: dialog_shim.h:208
EDA_UNITS
Definition: common.h:198
KIWAY_HOLDER is a mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_holder.h:39
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
void OnButton(wxCommandEvent &aEvent)
Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal ...
static void FixOSXCancelButtonIssue(wxWindow *aWindow)
std::string m_hash_key
Definition: dialog_shim.h:198
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:213
void ResetSize()
Clear the existing dialog size and position.
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:204
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:83
void OnGridEditorShown(wxGridEvent &event)
void OnGridEditorHidden(wxGridEvent &event)
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:114
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)
Definition: dialog_shim.cpp:71
EDA_UNITS GetUserUnits() const
Definition: dialog_shim.h:131
bool m_firstPaintEvent
Definition: dialog_shim.h:203
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:206
void OnCloseWindow(wxCloseEvent &aEvent)
Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is ...
WINDOW_THAWER(wxWindow *aWindow)
Definition: dialog_shim.h:37
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:211
int ShowQuasiModal()
void SetSizeInDU(int x, int y)
Set the dialog to the given dimensions in "dialog units".
bool IsQuasiModal()
Definition: dialog_shim.h:123
void OnPaint(wxPaintEvent &event)
wxWindow * m_window
Definition: dialog_shim.h:59
bool Show(bool show) override
int VertPixelsFromDU(int y)
Convert an integer number of dialog units to pixels, vertically.
EDA_UNITS m_units
Definition: dialog_shim.h:197
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:209
void OnCharHook(wxKeyEvent &aEvt)
void EndQuasiModal(int retCode)
const char * name
Definition: DXF_plotter.cpp:60
static bool IsShiftCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:142
The base frame for deriving all KiCad main window classes.
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:38
int HorizPixelsFromDU(int x)
Convert an integer number of dialog units to pixels, horizontally.
bool Enable(bool enable) override
static bool IsCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:136