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-2018 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 
73 
83 class DIALOG_SHIM : public wxDialog, public KIWAY_HOLDER
84 {
91  void OnCloseWindow( wxCloseEvent& aEvent );
92 
99  void OnButton( wxCommandEvent& aEvent );
100 
101 public:
102 
103  DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,
104  const wxPoint& pos = wxDefaultPosition,
105  const wxSize& size = wxDefaultSize,
106  long style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER,
107  const wxString& name = wxDialogNameStr
108  );
109 
110  ~DIALOG_SHIM();
111 
116  void SetInitialFocus( wxWindow* aWindow )
117  {
118  m_initialFocusTarget = aWindow;
119  }
120 
121  int ShowQuasiModal(); // disable only the parent window, otherwise modal.
122 
123  void EndQuasiModal( int retCode ); // End quasi-modal mode
124 
125  bool IsQuasiModal() { return m_qmodal_showing; }
126 
127  bool Show( bool show ) override;
128 
129  bool Enable( bool enable ) override;
130 
131  void OnPaint( wxPaintEvent &event );
132 
133  EDA_UNITS_T GetUserUnits() const override { return m_units; }
134 
135 protected:
136 
152  void FinishDialogSettings();
153 
159  void SetSizeInDU( int x, int y );
160 
165  int HorizPixelsFromDU( int x );
166 
171  int VertPixelsFromDU( int y );
172 
173  EDA_UNITS_T m_units; // userUnits for display and parsing
174  std::string m_hash_key; // alternate for class_map when classname re-used
175 
176  // On MacOS (at least) SetFocus() calls made in the constructor will fail because a
177  // window that isn't yet visible will return false to AcceptsFocus(). So we must delay
178  // the initial-focus SetFocus() call to the first paint event.
181 
182  // variables for quasi-modal behavior support, only used by a few derivatives.
183  WX_EVENT_LOOP* m_qmodal_loop; // points to nested event_loop, NULL means not qmodal and dismissed
186 
187 private:
188  void OnGridEditorShown( wxGridEvent& event );
189  void OnGridEditorHidden( wxGridEvent& event );
190 
191  DECLARE_EVENT_TABLE()
192 };
193 
194 #endif // DIALOG_SHIM_
bool m_qmodal_showing
Definition: dialog_shim.h:184
Class KIWAY_HOLDER is a mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_player.h:49
#define WX_EVENT_LOOP
Definition: kiway_player.h:107
void OnButton(wxCommandEvent &aEvent)
Function OnCloseWindow.
std::string m_hash_key
Definition: dialog_shim.h:174
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:180
Class DIALOG_SHIM may sit in the inheritance tree between wxDialog and any class written by wxFormBui...
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:116
bool m_firstPaintEvent
Definition: dialog_shim.h:179
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:183
void OnCloseWindow(wxCloseEvent &aEvent)
Function OnCloseWindow.
WINDOW_THAWER(wxWindow *aWindow)
Definition: dialog_shim.h:37
int ShowQuasiModal()
void SetSizeInDU(int x, int y)
Set the dialog to the given dimensions in "dialog units".
bool IsQuasiModal()
Definition: dialog_shim.h:125
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.
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:185
void EndQuasiModal(int retCode)
DIALOG_SHIM(wxWindow *aParent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER, const wxString &name=wxDialogNameStr)
Definition: dialog_shim.cpp:67
const char * name
Definition: DXF_plotter.cpp:61
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
int HorizPixelsFromDU(int x)
Convert an integer number of dialog units to pixels, horizontally.
bool Enable(bool enable) override
EDA_UNITS_T m_units
Definition: dialog_shim.h:173
EDA_UNITS_T
Definition: common.h:157
EDA_UNITS_T GetUserUnits() const override
Definition: dialog_shim.h:133