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 {
85 public:
86  DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,
87  const wxPoint& pos = wxDefaultPosition,
88  const wxSize& size = wxDefaultSize,
89  long style = wxDEFAULT_FRAME_STYLE | wxRESIZE_BORDER,
90  const wxString& name = wxDialogNameStr );
91 
92  ~DIALOG_SHIM();
93 
98  void SetInitialFocus( wxWindow* aWindow )
99  {
100  m_initialFocusTarget = aWindow;
101  }
102 
103  int ShowQuasiModal(); // disable only the parent window, otherwise modal.
104 
105  void EndQuasiModal( int retCode ); // End quasi-modal mode
106 
107  bool IsQuasiModal() const { return m_qmodal_showing; }
108 
109  bool Show( bool show ) override;
110 
111  bool Enable( bool enable ) override;
112 
113  void OnPaint( wxPaintEvent &event );
114 
118  void SetPosition( const wxPoint& aNewPosition );
119 
121  {
122  return m_units;
123  }
124 
125  static bool IsCtrl( int aChar, const wxKeyEvent& e )
126  {
127  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
128  !e.ShiftDown() && !e.MetaDown();
129  }
130 
131  static bool IsShiftCtrl( int aChar, const wxKeyEvent& e )
132  {
133  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
134  e.ShiftDown() && !e.MetaDown();
135  }
136 
137 protected:
148  void finishDialogSettings();
149 
155  void setSizeInDU( int x, int y );
156 
161  int horizPixelsFromDU( int x ) const;
162 
167  int vertPixelsFromDU( int y ) const;
168 
176  void resetSize();
177 
178  virtual void OnCharHook( wxKeyEvent& aEvt );
179 
180 private:
185  void OnCloseWindow( wxCloseEvent& aEvent );
186 
191  void OnButton( wxCommandEvent& aEvent );
192 
193  void OnGridEditorShown( wxGridEvent& event );
194  void OnGridEditorHidden( wxGridEvent& event );
195 
197 
198 protected:
199  EDA_UNITS m_units; // userUnits for display and parsing
200  std::string m_hash_key; // alternate for class_map when classname re-used
201 
202  // The following disables the storing of a user size. It is used primarily for dialogs
203  // with conditional content which don't need user sizing.
205 
206  // On MacOS (at least) SetFocus() calls made in the constructor will fail because a
207  // window that isn't yet visible will return false to AcceptsFocus(). So we must delay
208  // the initial-focus SetFocus() call to the first paint event.
211 
212  WX_EVENT_LOOP* m_qmodal_loop; // points to nested event_loop, NULL means not qmodal
213  // and dismissed
216 
218 
219  std::vector<wxWindow*> m_tabOrder;
220 };
221 
222 #endif // DIALOG_SHIM_
bool m_qmodal_showing
Definition: dialog_shim.h:214
A mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_holder.h:39
void setSizeInDU(int x, int y)
Set the dialog to the given dimensions in "dialog units".
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
void OnButton(wxCommandEvent &aEvent)
Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal ...
std::string m_hash_key
Definition: dialog_shim.h:200
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:219
bool IsQuasiModal() const
Definition: dialog_shim.h:107
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210
int horizPixelsFromDU(int x) const
Convert an integer number of dialog units to pixels, horizontally.
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:98
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:75
EDA_UNITS GetUserUnits() const
Definition: dialog_shim.h:120
bool m_firstPaintEvent
Definition: dialog_shim.h:209
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
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
void SetPosition(const wxPoint &aNewPosition)
Force the position of the dialog to a new position.
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:217
int ShowQuasiModal()
void OnPaint(wxPaintEvent &event)
wxWindow * m_window
Definition: dialog_shim.h:59
bool Show(bool show) override
EDA_UNITS
Definition: eda_units.h:38
EDA_UNITS m_units
Definition: dialog_shim.h:199
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual void OnCharHook(wxKeyEvent &aEvt)
void EndQuasiModal(int retCode)
const char * name
Definition: DXF_plotter.cpp:59
static bool IsShiftCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:131
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:42
void resetSize()
Clear the existing dialog size and position.
int vertPixelsFromDU(int y) const
Convert an integer number of dialog units to pixels, vertically.
bool Enable(bool enable) override
static bool IsCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:125
bool m_useCalculatedSize
Definition: dialog_shim.h:204