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 The 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#include <vector>
34#include <wx/variant.h>
35#include <core/raii.h>
36
37class EDA_BASE_FRAME;
38class UNIT_BINDER;
39
40class wxGridEvent;
41class wxGUIEventLoop;
42class wxInitDialogEvent;
43class wxSpinEvent;
44class wxSpinDoubleEvent;
45class wxStyledTextEvent;
46class wxPropertyGridEvent;
47class wxDataViewEvent;
48
49
67class KICOMMON_API DIALOG_SHIM : public wxDialog, public KIWAY_HOLDER
68{
69public:
70 DIALOG_SHIM( wxWindow* aParent, wxWindowID id, const wxString& title,
71 const wxPoint& pos = wxDefaultPosition,
72 const wxSize& size = wxDefaultSize,
73 long style = wxDEFAULT_FRAME_STYLE | wxRESIZE_BORDER,
74 const wxString& name = wxDialogNameStr );
75
77
82 void SetInitialFocus( wxWindow* aWindow )
83 {
84 m_initialFocusTarget = aWindow;
85 }
86
87 int ShowModal() override;
88
89 int ShowQuasiModal(); // disable only the parent window, otherwise modal.
90
91 void EndQuasiModal( int retCode ); // End quasi-modal mode
92
93 bool IsQuasiModal() const { return m_qmodal_showing; }
94
95 // A quasi-modal dialog disables its parent window. Sadly this disabling is more extreme
96 // than wxWidgets' normal modal dialog disabling, and prevents things like hotkey Cut/Copy/
97 // Paste from working in search controls in standard file dialogs. So when we put up a modal
98 // dialog in front of a quasi-modal, we suspend the quasi-modal dialog parent window
99 // disabling, causing us to fall back to the normal modal dialog parent window disabling.
100 void PrepareForModalSubDialog();
101 void CleanupAfterModalSubDialog();
102
103 bool Show( bool show ) override;
104
105 bool Enable( bool enable ) override;
106
107 void OnPaint( wxPaintEvent &event );
108
109 void OnModify();
110 void ClearModify();
111
116 void SetPosition( const wxPoint& aNewPosition );
117
119 {
120 return m_units;
121 }
122
123 void SelectAllInTextCtrls( wxWindowList& children );
124
125 void SetupStandardButtons( std::map<int, wxString> aLabels = {} );
126
127 static bool IsCtrl( int aChar, const wxKeyEvent& e )
128 {
129 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
130 !e.ShiftDown() && !e.MetaDown();
131 }
132
133 static bool IsShiftCtrl( int aChar, const wxKeyEvent& e )
134 {
135 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
136 e.ShiftDown() && !e.MetaDown();
137 }
138
144 void LoadControlState();
145
149 void SaveControlState();
150
155 void OptOut( wxWindow* aWindow );
156
163 void RegisterUnitBinder( UNIT_BINDER* aUnitBinder, wxWindow* aWindow );
164
165protected:
176 void finishDialogSettings();
177
183 void setSizeInDU( int x, int y );
184
189 int horizPixelsFromDU( int x ) const;
190
195 int vertPixelsFromDU( int y ) const;
196
204 void resetSize();
205
206 virtual void OnCharHook( wxKeyEvent& aEvt );
207
215 virtual void TearDownQuasiModal() {}
216
217private:
222 void OnCloseWindow( wxCloseEvent& aEvent );
223
224 void OnSize( wxSizeEvent& aEvent );
225 void OnMove( wxMoveEvent& aEvent );
226
231 void OnButton( wxCommandEvent& aEvent );
232
233 void onChildSetFocus( wxFocusEvent& aEvent );
234
235 void onInitDialog( wxInitDialogEvent& aEvent );
236
237 std::string generateKey( const wxWindow* aWin ) const;
238
239 void registerUndoRedoHandlers( wxWindowList& aChildren );
240 void recordControlChange( wxWindow* aCtrl );
241 void onCommandEvent( wxCommandEvent& aEvent );
242 void onSpinEvent( wxSpinEvent& aEvent );
243 void onSpinDoubleEvent( wxSpinDoubleEvent& aEvent );
244 void onStyledTextChanged( wxStyledTextEvent& aEvent );
245 void onGridCellChanged( wxGridEvent& aEvent );
246 void onPropertyGridChanged( wxPropertyGridEvent& aEvent );
247 void onDataViewListChanged( wxDataViewEvent& aEvent );
248 void doUndo();
249 void doRedo();
250 wxVariant getControlValue( wxWindow* aCtrl );
251 void setControlValue( wxWindow* aCtrl, const wxVariant& aValue );
252
254
255protected:
256 EDA_UNITS m_units; // userUnits for display and parsing
257 std::string m_hash_key; // optional custom key for persistence
258
259 // The following disables the storing of a user size. It is used primarily for dialogs
260 // with conditional content which don't need user sizing.
262
263 // On MacOS (at least) SetFocus() calls made in the constructor will fail because a
264 // window that isn't yet visible will return false to AcceptsFocus(). So we must delay
265 // the initial-focus SetFocus() call to the first paint event.
269
270 wxGUIEventLoop* m_qmodal_loop; // points to nested event_loop, NULL means not qmodal
271 // and dismissed
274
276
277 std::vector<wxWindow*> m_tabOrder;
278
279 // The size asked by the caller, used the first time the dialog is created
283
284 // Used to support first-esc-cancels-edit logic
285 std::map<wxWindow*, wxString> m_beforeEditValues;
286 std::map<wxWindow*, UNIT_BINDER*> m_unitBinders;
287
289 {
290 wxWindow* ctrl;
291 wxVariant before;
292 wxVariant after;
293 };
294
295 std::vector<UNDO_STEP> m_undoStack;
296 std::vector<UNDO_STEP> m_redoStack;
297 std::map<wxWindow*, wxVariant> m_currentValues;
299};
300
301#endif // DIALOG_SHIM_
const char * name
static bool IsShiftCtrl(int aChar, const wxKeyEvent &e)
bool m_handlingUndoRedo
std::vector< wxWindow * > m_tabOrder
bool m_qmodal_showing
virtual void TearDownQuasiModal()
Override this method to perform dialog tear down actions not suitable for object dtor.
static bool IsCtrl(int aChar, const wxKeyEvent &e)
std::vector< UNDO_STEP > m_redoStack
wxGUIEventLoop * m_qmodal_loop
EDA_UNITS m_units
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition dialog_shim.h:82
WINDOW_DISABLER * m_qmodal_parent_disabler
std::string m_hash_key
bool m_firstPaintEvent
bool m_userResized
std::map< wxWindow *, wxString > m_beforeEditValues
bool IsQuasiModal() const
Definition dialog_shim.h:93
bool m_useCalculatedSize
std::map< wxWindow *, UNIT_BINDER * > m_unitBinders
wxWindow * m_initialFocusTarget
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)
bool m_userPositioned
std::map< wxWindow *, wxVariant > m_currentValues
wxSize m_initialSize
EDA_BASE_FRAME * m_parentFrame
std::vector< UNDO_STEP > m_undoStack
EDA_UNITS GetUserUnits() const
The base frame for deriving all KiCad main window classes.
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
Temporarily disable a window, and then re-enable on destruction.
Definition raii.h:87
EDA_UNITS
Definition eda_units.h:48
#define KICOMMON_API
Definition kicommon.h:28