Class HOTKEYS_EDITOR_DIALOG is the child class of HOTKEYS_EDITOR_DIALOG_BASE. More...

#include <dialog_hotkeys_editor.h>

Inheritance diagram for HOTKEYS_EDITOR_DIALOG:

Public Member Functions
	HOTKEYS_EDITOR_DIALOG (EDA_BASE_FRAME aParent, EDA_HOTKEY_CONFIG aHotkeys)

	~HOTKEYS_EDITOR_DIALOG ()

int	ShowQuasiModal ()

void	EndQuasiModal (int retCode)

bool	IsQuasiModal ()

bool	Show (bool show) override

bool	Enable (bool enable) override

KIWAY &	Kiway () const
	Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...

PROJECT &	Prj () const
	Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	Function SetKiway. More...

Protected Member Functions
bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

virtual EDA_BASE_FRAME *	GetParent ()

void	FinishDialogSettings ()
	In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...

void	FixOSXCancelButtonIssue ()
	A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms. More...

Protected Attributes
struct EDA_HOTKEY_CONFIG *	m_hotkeys

WIDGET_HOTKEY_LIST *	m_hotkeyListCtrl

wxBoxSizer *	m_mainSizer

wxStaticText *	m_staticText1

wxPanel *	m_panelHotkeys

wxButton *	m_resetButton

wxButton *	m_defaultButton

wxStdDialogButtonSizer *	m_sdbSizer

wxButton *	m_sdbSizerOK

wxButton *	m_sdbSizerCancel

std::string	m_hash_key

EVENT_LOOP *	m_qmodal_loop

bool	m_qmodal_showing

WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler

Private Member Functions
void	ResetClicked (wxCommandEvent &aEvent) override
	Function ResetClicked Reinit the hotkeys to the initial state (removes all pending changes) More...

void	DefaultsClicked (wxCommandEvent &aEvent) override
	Function DefaultsClicked Set the hotkeys to the default values (values after installation) More...

Detailed Description

Class HOTKEYS_EDITOR_DIALOG is the child class of HOTKEYS_EDITOR_DIALOG_BASE.

This is the class used to create a hotkey editor.

Definition at line 40 of file dialog_hotkeys_editor.h.

Constructor & Destructor Documentation

HOTKEYS_EDITOR_DIALOG::HOTKEYS_EDITOR_DIALOG	(	EDA_BASE_FRAME *	aParent,
		EDA_HOTKEY_CONFIG *	aHotkeys
	)

Definition at line 40 of file dialog_hotkeys_editor.cpp.

References PCAD2KICAD::Center, WIDGET_HOTKEY_LIST::GenSections(), WIDGET_HOTKEY_LIST::InstallOnPanel(), m_hotkeyListCtrl, HOTKEYS_EDITOR_DIALOG_BASE::m_panelHotkeys, and HOTKEYS_EDITOR_DIALOG_BASE::m_sdbSizerOK.

                                       :
     HOTKEYS_EDITOR_DIALOG_BASE( aParent ),
     m_hotkeys( aHotkeys )
 {
     m_hotkeyListCtrl = new WIDGET_HOTKEY_LIST( m_panelHotkeys,
             WIDGET_HOTKEY_LIST::GenSections( aHotkeys ) );
     m_hotkeyListCtrl->InstallOnPanel( m_panelHotkeys );
 
     m_sdbSizerOK->SetDefault();
 
     Layout();
     Center();
 }

HOTKEYS_EDITOR_DIALOG::~HOTKEYS_EDITOR_DIALOG ( )

inline

Definition at line 58 of file dialog_hotkeys_editor.h.

58 {};

Member Function Documentation

void HOTKEYS_EDITOR_DIALOG::DefaultsClicked ( wxCommandEvent & aEvent )

overrideprivatevirtual

Function DefaultsClicked Set the hotkeys to the default values (values after installation)

Parameters

aEvent is the button press event, unused

Reimplemented from HOTKEYS_EDITOR_DIALOG_BASE.

Definition at line 88 of file dialog_hotkeys_editor.cpp.

References m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::TransferDefaultsToControl().

 {
     m_hotkeyListCtrl->TransferDefaultsToControl();
 }

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 182 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

 {
     // so we can do logging of this state change:
 
 #if defined(DEBUG)
     const char* type_id = typeid( *this ).name();
     printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
 #endif
 
     return wxDialog::Enable( enable );
 }

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 540 of file dialog_shim.cpp.

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, and DIALOG_SHIM::Show().

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCloseDialog(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCloseDialog(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), DIALOG_EXCHANGE_MODULE::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

 {
     // Hook up validator and transfer data from controls handling so quasi-modal dialogs
     // handle validation in the same way as other dialogs.
     if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
         return;
 
     SetReturnCode( retCode );
 
     if( !IsQuasiModal() )
     {
         wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
         return;
     }
 
     m_qmodal_showing = false;
 
     if( m_qmodal_loop )
     {
         if( m_qmodal_loop->IsRunning() )
             m_qmodal_loop->Exit( 0 );
         else
             m_qmodal_loop->ScheduleExit( 0 );
 
         m_qmodal_loop = NULL;
     }
 
     delete m_qmodal_parent_disabler;
     m_qmodal_parent_disabler = 0;
 
     Show( false );
 }

void DIALOG_SHIM::FinishDialogSettings ( )

protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

FinishDialogSettings must be called from derived classes, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

In any case, the best way is to call it in a wxInitDialogEvent handler after calling TransfertDataToWindow(), which is the default wxInitDialogEvent handler wxDialog

Definition at line 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

 {
     // must be called from the constructor of derived classes,
     // when all widgets are initialized, and therefore their size fixed
 
     // SetSizeHints fixes the minimal size of sizers in the dialog
     // (SetSizeHints calls Fit(), so no need to call it)
     GetSizer()->SetSizeHints( this );
 
     // the default position, when calling the first time the dlg
     Center();
 }

void DIALOG_SHIM::FixOSXCancelButtonIssue ( )

protectedinherited

A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.

Definition at line 117 of file dialog_shim.cpp.

Referenced by DIALOG_SHIM::Show().

 {
 #ifdef  __WXMAC__
     // A ugly hack to fix an issue on OSX: ctrl+c closes the dialog instead of
     // copying a text if a  button with wxID_CANCEL is used in a wxStdDialogButtonSizer
     // created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority
     // to copy text standard accelerator, and the dlg is closed when trying to copy text
     wxButton* button = dynamic_cast< wxButton* > ( wxWindow::FindWindowById( wxID_CANCEL, this ) );
 
     if( button )
         button->SetLabel( _( "Cancel" ) );
 #endif
 }

virtual EDA_BASE_FRAME* HOTKEYS_EDITOR_DIALOG::GetParent ( void )

inlineprotectedvirtual

Definition at line 50 of file dialog_hotkeys_editor.h.

Referenced by TransferDataFromWindow().

     {
         return static_cast<EDA_BASE_FRAME*>( HOTKEYS_EDITOR_DIALOG_BASE::GetParent() );
     }

bool DIALOG_SHIM::IsQuasiModal ( )

inlineinherited

Definition at line 93 of file dialog_shim.h.

References DIALOG_SHIM::m_qmodal_showing.

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::EndQuasiModal(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), FOOTPRINT_SELECT_WIDGET::ShowPicker(), EDA_BASE_FRAME::windowClosing(), and DIALOG_SHIM::~DIALOG_SHIM().

93 { return m_qmodal_showing; }

DIALOG_SHIM::m_qmodal_showing

bool m_qmodal_showing

Definition: dialog_shim.h:132

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway.

Referenced by SCH_EDIT_FRAME::AppendOneEEProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), LIB_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), SCH_SHEET::Load(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and DIALOG_EXCHANGE_MODULE::ViewAndSelectFootprint().

     {
         wxASSERT( m_kiway );    // smoke out bugs in Debug build, then Release runs fine.
         return *m_kiway;
     }

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 34 of file kiway_holder.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

 {
     return Kiway().Prj();
 }

void HOTKEYS_EDITOR_DIALOG::ResetClicked ( wxCommandEvent & aEvent )

overrideprivatevirtual

Function ResetClicked Reinit the hotkeys to the initial state (removes all pending changes)

Parameters

aEvent is the button press event, unused

Reimplemented from HOTKEYS_EDITOR_DIALOG_BASE.

Definition at line 83 of file dialog_hotkeys_editor.cpp.

References m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::TransferDataToControl().

 {
     m_hotkeyListCtrl->TransferDataToControl();
 }

void KIWAY_HOLDER::SetKiway	(	wxWindow *	aDest,
		KIWAY *	aKiway
	)

inherited

Function SetKiway.

Parameters

aDest	is the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiway	is often from a parent window, or from KIFACE::CreateWindow().

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

 {
 #if defined(DEBUG)
     // offer a trap point for debugging most any window
     wxASSERT( aDest );
     if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
     {
         int breakhere=1;
         (void) breakhere;
     }
 #endif
 
     (void) aDest;
 
     m_kiway = aKiway;
 }

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 139 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::FixOSXCancelButtonIssue(), EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_SCH_FIND::OnCancel(), DIALOG_ANNOTATE::OnCancelClick(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_MODULE::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

 {
     bool        ret;
     const char* hash_key;
 
     if( m_hash_key.size() )
     {
         // a special case like EDA_LIST_DIALOG, which has multiple uses.
         hash_key = m_hash_key.c_str();
     }
     else
     {
         hash_key = typeid(*this).name();
     }
 
     // Show or hide the window.  If hiding, save current position and size.
     // If showing, use previous position and size.
     if( show )
     {
         wxDialog::Raise();  // Needed on OS X and some other window managers (i.e. Unity)
         ret = wxDialog::Show( show );
 
         // classname is key, returns a zeroed out default EDA_RECT if none existed before.
         EDA_RECT r = class_map[ hash_key ];
 
         if( r.GetSize().x != 0 && r.GetSize().y != 0 )
             SetSize( r.GetPosition().x, r.GetPosition().y, r.GetSize().x, r.GetSize().y, 0 );
     }
     else
     {
         // Save the dialog's position & size before hiding, using classname as key
         EDA_RECT  r( wxDialog::GetPosition(), wxDialog::GetSize() );
         class_map[ hash_key ] = r;
 
         ret = wxDialog::Show( show );
     }
 
     FixOSXCancelButtonIssue();
 
     return ret;
 }

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 495 of file dialog_shim.cpp.

References DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, and DIALOG_SHIM::Show().

Referenced by LIB_EDIT_FRAME::DeleteOnePart(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), InvokeDialogCreateBOMEditor(), LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

 {
     // This is an exception safe way to zero a pointer before returning.
     // Yes, even though DismissModal() clears this first normally, this is
     // here in case there's an exception before the dialog is dismissed.
     struct NULLER
     {
         void*&  m_what;
         NULLER( void*& aPtr ) : m_what( aPtr ) {}
         ~NULLER() { m_what = 0; }   // indeed, set it to NULL on destruction
     } clear_this( (void*&) m_qmodal_loop );
 
     // release the mouse if it's currently captured as the window having it
     // will be disabled when this dialog is shown -- but will still keep the
     // capture making it impossible to do anything in the modal dialog itself
     wxWindow* win = wxWindow::GetCapture();
     if( win )
         win->ReleaseMouse();
 
     // Get the optimal parent
     wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
 
     // Show the optimal parent
     DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
 
     wxASSERT_MSG( !m_qmodal_parent_disabler,
             wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
 
     // quasi-modal: disable only my "optimal" parent
     m_qmodal_parent_disabler = new WDO_ENABLE_DISABLE( parent );
 
     Show( true );
 
     m_qmodal_showing = true;
 
     EVENT_LOOP event_loop;
 
     m_qmodal_loop = &event_loop;
 
     event_loop.Run();
 
     return GetReturnCode();
 }

bool HOTKEYS_EDITOR_DIALOG::TransferDataFromWindow ( )

overrideprotected

Definition at line 68 of file dialog_hotkeys_editor.cpp.

References GetParent(), m_hotkeyListCtrl, m_hotkeys, WIDGET_HOTKEY_LIST::TransferDataFromControl(), and EDA_BASE_FRAME::WriteHotkeyConfig().

 {
     if( !wxDialog::TransferDataToWindow() )
         return false;
 
     if( !m_hotkeyListCtrl->TransferDataFromControl() )
         return false;
 
     // save the hotkeys
     GetParent()->WriteHotkeyConfig( m_hotkeys );
 
     return true;
 }

bool HOTKEYS_EDITOR_DIALOG::TransferDataToWindow ( )

overrideprotected

Definition at line 56 of file dialog_hotkeys_editor.cpp.

References m_hotkeyListCtrl, and WIDGET_HOTKEY_LIST::TransferDataToControl().

 {
     if( !wxDialog::TransferDataToWindow() )
         return false;
 
     if( !m_hotkeyListCtrl->TransferDataToControl() )
         return false;
 
     return true;
 }