KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 <[email protected]>
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 <kicommon.h>
29#include <eda_units.h>
30#include <kiway_holder.h>
31#include <wx/dialog.h>
32#include <map>
33
34class EDA_BASE_FRAME;
35
36class wxGridEvent;
37class wxGUIEventLoop;
38
39
41{
42 WINDOW_THAWER( wxWindow* aWindow )
43 {
44 m_window = aWindow;
45 m_freezeCount = 0;
46
47 while( m_window->IsFrozen() )
48 {
49 m_window->Thaw();
51 }
52 }
53
55 {
56 while( m_freezeCount > 0 )
57 {
58 m_window->Freeze();
60 }
61 }
62
63protected:
64 wxWindow* m_window;
66};
67
68
70
71// These macros are for DIALOG_SHIM only, NOT for KIWAY_PLAYER. KIWAY_PLAYER
72// has its own support for quasi modal and its platform specific issues are different
73// than for a wxDialog.
74 #define SHOWQUASIMODAL ShowQuasiModal
75 #define ENDQUASIMODAL EndQuasiModal
76
87class KICOMMON_API DIALOG_SHIM : public wxDialog, public KIWAY_HOLDER
88{
89public:
90 DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,
91 const wxPoint& pos = wxDefaultPosition,
92 const wxSize& size = wxDefaultSize,
93 long style = wxDEFAULT_FRAME_STYLE | wxRESIZE_BORDER,
94 const wxString& name = wxDialogNameStr );
95
97
102 void SetInitialFocus( wxWindow* aWindow )
103 {
104 m_initialFocusTarget = aWindow;
105 }
106
107 int ShowQuasiModal(); // disable only the parent window, otherwise modal.
108
109 void EndQuasiModal( int retCode ); // End quasi-modal mode
110
111 bool IsQuasiModal() const { return m_qmodal_showing; }
112
113 bool Show( bool show ) override;
114
115 bool Enable( bool enable ) override;
116
117 void OnPaint( wxPaintEvent &event );
118
119 void OnModify();
120 void ClearModify();
121
126 void SetPosition( const wxPoint& aNewPosition );
127
129 {
130 return m_units;
131 }
132
133 void SelectAllInTextCtrls( wxWindowList& children );
134
135 void SetupStandardButtons( std::map<int, wxString> aLabels = {} );
136
137 static bool IsCtrl( int aChar, const wxKeyEvent& e )
138 {
139 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
140 !e.ShiftDown() && !e.MetaDown();
141 }
142
143 static bool IsShiftCtrl( int aChar, const wxKeyEvent& e )
144 {
145 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
146 e.ShiftDown() && !e.MetaDown();
147 }
148
149protected:
160 void finishDialogSettings();
161
167 void setSizeInDU( int x, int y );
168
173 int horizPixelsFromDU( int x ) const;
174
179 int vertPixelsFromDU( int y ) const;
180
188 void resetSize();
189
190 virtual void OnCharHook( wxKeyEvent& aEvt );
191
192private:
197 void OnCloseWindow( wxCloseEvent& aEvent );
198
203 void OnButton( wxCommandEvent& aEvent );
204
205 void onChildSetFocus( wxFocusEvent& aEvent );
206
208
209protected:
210 EDA_UNITS m_units; // userUnits for display and parsing
211 std::string m_hash_key; // alternate for class_map when classname re-used
212
213 // The following disables the storing of a user size. It is used primarily for dialogs
214 // with conditional content which don't need user sizing.
216
217 // On MacOS (at least) SetFocus() calls made in the constructor will fail because a
218 // window that isn't yet visible will return false to AcceptsFocus(). So we must delay
219 // the initial-focus SetFocus() call to the first paint event.
223
224 wxGUIEventLoop* m_qmodal_loop; // points to nested event_loop, NULL means not qmodal
225 // and dismissed
228
230
231 std::vector<wxWindow*> m_tabOrder;
232
233 // The size asked by the caller, used the first time the dialog is created
235
236 // Used to support first-esc-cancels-edit logic
237 std::map<wxWindow*, wxString> m_beforeEditValues;
238};
239
240#endif // DIALOG_SHIM_
const char * name
Definition: DXF_plotter.cpp:57
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:88
static bool IsShiftCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:143
bool m_isClosing
Definition: dialog_shim.h:222
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:231
bool m_qmodal_showing
Definition: dialog_shim.h:226
static bool IsCtrl(int aChar, const wxKeyEvent &e)
Definition: dialog_shim.h:137
wxGUIEventLoop * m_qmodal_loop
Definition: dialog_shim.h:224
EDA_UNITS m_units
Definition: dialog_shim.h:210
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:102
std::string m_hash_key
Definition: dialog_shim.h:211
bool m_firstPaintEvent
Definition: dialog_shim.h:220
std::map< wxWindow *, wxString > m_beforeEditValues
Definition: dialog_shim.h:237
bool IsQuasiModal() const
Definition: dialog_shim.h:111
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:227
bool m_useCalculatedSize
Definition: dialog_shim.h:215
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:221
wxSize m_initialSize
Definition: dialog_shim.h:234
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:229
EDA_UNITS GetUserUnits() const
Definition: dialog_shim.h:128
The base frame for deriving all KiCad main window classes.
A mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_holder.h:39
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:47
EDA_UNITS
Definition: eda_units.h:46
#define KICOMMON_API
Definition: kicommon.h:28
WINDOW_THAWER(wxWindow *aWindow)
Definition: dialog_shim.h:42
wxWindow * m_window
Definition: dialog_shim.h:64