dialog_shim.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef DIALOG_SHIM_
#define DIALOG_SHIM_
 
#include <kicommon.h>
#include <eda_units.h>
#include <kiway_holder.h>
#include <wx/dialog.h>
#include <map>
#include <set>
#include <vector>
#include <wx/variant.h>
#include <core/raii.h>
 
class EDA_BASE_FRAME;
class UNIT_BINDER;
 
class wxGridEvent;
class wxGUIEventLoop;
class wxInitDialogEvent;
class wxSpinEvent;
class wxSpinDoubleEvent;
class wxStyledTextEvent;
class wxPropertyGridEvent;
class wxDataViewEvent;
 

KICOMMON_API wxRect ClampRectToDisplay( const wxRect& aRect, const wxRect& aClientArea );
 

class KICOMMON_API DIALOG_SHIM : public wxDialog, public KIWAY_HOLDER
{
public:
    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 );
 
    ~DIALOG_SHIM();

    void SetInitialFocus( wxWindow* aWindow )
    {
        m_initialFocusTarget = aWindow;
    }
 
    int ShowModal() override;
 
    int ShowQuasiModal();      // disable only the parent window, otherwise modal.
 
    void EndQuasiModal( int retCode );  // End quasi-modal mode
 
    bool IsQuasiModal() const { return m_qmodal_showing; }
 
    // A quasi-modal dialog disables its parent window.  Sadly this disabling is more extreme
    // than wxWidgets' normal modal dialog disabling, and prevents things like hotkey Cut/Copy/
    // Paste from working in search controls in standard file dialogs.  So when we put up a modal
    // dialog in front of a quasi-modal, we suspend the quasi-modal dialog parent window
    // disabling, causing us to fall back to the normal modal dialog parent window disabling.
    void PrepareForModalSubDialog();
    void CleanupAfterModalSubDialog();
 
    bool Show( bool show ) override;
 
    bool Enable( bool enable ) override;
 
    void OnPaint( wxPaintEvent &event );
 
    void OnModify();
    void ClearModify();

    void SetPosition( const wxPoint& aNewPosition );
 
    EDA_UNITS GetUserUnits() const
    {
        return m_units;
    }
 
    void SelectAllInTextCtrls( wxWindowList& children );
 
    void SetupStandardButtons( std::map<int, wxString> aLabels = {} );
 
    static bool IsCtrl( int aChar, const wxKeyEvent& e )
    {
        return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
                !e.ShiftDown() && !e.MetaDown();
    }
 
    static bool IsShiftCtrl( int aChar, const wxKeyEvent& e )
    {
        return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
                e.ShiftDown() && !e.MetaDown();
    }

    void LoadControlState();

    void SaveControlState();

    void OptOut( wxWindow* aWindow );

    void ExcludeFromControlUndoRedo( wxWindow* aWindow );

    void RegisterUnitBinder( UNIT_BINDER* aUnitBinder, wxWindow* aWindow );

    void UnregisterUnitBinder( UNIT_BINDER* aUnitBinder );

    void EndDialogShim( int aReturnCode );
 
protected:
    void finishDialogSettings();

    void clampToWorkArea();

    void setSizeInDU( int x, int y );

    int horizPixelsFromDU( int x ) const;

    int vertPixelsFromDU( int y ) const;

    void resetSize();
 
    virtual void OnCharHook( wxKeyEvent& aEvt );

    virtual void TearDownQuasiModal() {}

    void resetUndoRedoForNewContent( wxWindowList& aChildren );

    void unregisterUnitBinders( wxWindow* aWindow );
 
private:
    void OnCloseWindow( wxCloseEvent& aEvent );
    void OnActivate( wxActivateEvent& aEvent );

    void forceInitialFocus();
 
    void OnSize( wxSizeEvent& aEvent );
    void OnMove( wxMoveEvent& aEvent );

    void OnButton( wxCommandEvent& aEvent );
 
    void onChildSetFocus( wxFocusEvent& aEvent );
 
    void onInitDialog( wxInitDialogEvent& aEvent );

    void focusParentCanvas( bool aDeferUntilFrameActive = false );
 
    std::string generateKey( const wxWindow* aWin ) const;
 
    void registerUndoRedoHandlers( wxWindowList& aChildren );

    void recordControlChange( wxWindow* aCtrl );

    void flushPendingControlChanges();
 
    void onCommandEvent( wxCommandEvent& aEvent );
    void onSpinEvent( wxSpinEvent& aEvent );
    void onSpinDoubleEvent( wxSpinDoubleEvent& aEvent );
    void onStyledTextChanged( wxStyledTextEvent& aEvent );
    void onGridCellChanged( wxGridEvent& aEvent );
    void onPropertyGridChanged( wxPropertyGridEvent& aEvent );
    void onDataViewListChanged( wxDataViewEvent& aEvent );
    void doUndo();
    void doRedo();
    wxVariant getControlValue( wxWindow* aCtrl );
    void setControlValue( wxWindow* aCtrl, const wxVariant& aValue );
 
    DECLARE_EVENT_TABLE();
 
protected:
    EDA_UNITS              m_units;    // userUnits for display and parsing
    std::string            m_hash_key; // optional custom key for persistence
 
    // The following disables the storing of a user size.  It is used primarily for dialogs
    // with conditional content which don't need user sizing.
    bool                   m_useCalculatedSize;
 
    // On MacOS (at least) SetFocus() calls made in the constructor will fail because a
    // window that isn't yet visible will return false to AcceptsFocus().  So we must delay
    // the initial-focus SetFocus() call to the first paint event.
    bool                   m_firstPaintEvent;
    wxWindow*              m_initialFocusTarget;
    bool                   m_isClosing;
 
    wxGUIEventLoop*        m_qmodal_loop;  // points to nested event_loop, NULL means not qmodal
                                           // and dismissed
    bool                   m_qmodal_showing;
    WINDOW_DISABLER*       m_qmodal_parent_disabler;
 
    EDA_BASE_FRAME*        m_parentFrame;
 
    std::vector<wxWindow*> m_tabOrder;
 
    // The size asked by the caller, used the first time the dialog is created
    wxSize                 m_initialSize;
    bool                   m_userPositioned;
    bool                   m_userResized;
 
    // Used to support first-esc-cancels-edit logic
    std::map<wxWindow*, wxString>     m_beforeEditValues;
    std::map<wxWindow*, UNIT_BINDER*> m_unitBinders;
 
    struct UNDO_STEP
    {
        wxWindow* ctrl;
        wxVariant before;
        wxVariant after;
    };
 
    std::vector<UNDO_STEP>            m_undoStack;
    std::vector<UNDO_STEP>            m_redoStack;
    std::map<wxWindow*, wxVariant>    m_currentValues;
    std::set<wxWindow*>               m_controlsWithPendingChanges;
    std::set<wxWindow*>               m_noControlUndoRedo;
    bool                              m_handlingUndoRedo;
    bool                              m_childReleased;
};
 
#endif  // DIALOG_SHIM_