KiCad PCB EDA Suite
DIALOG_EXCHANGE_FOOTPRINTS Class Reference

#include <dialog_exchange_footprints.h>

Inheritance diagram for DIALOG_EXCHANGE_FOOTPRINTS:
DIALOG_EXCHANGE_FOOTPRINTS_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_EXCHANGE_FOOTPRINTS (PCB_EDIT_FRAME *aParent, FOOTPRINT *aFootprint, bool updateMode, bool selectedMode)
 
 ~DIALOG_EXCHANGE_FOOTPRINTS () override
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 

Protected Member Functions

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 setSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int horizPixelsFromDU (int x) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

wxBoxSizer * m_mainSizer
 
wxGridBagSizer * m_upperSizer
 
wxRadioButton * m_matchAll
 
wxRadioButton * m_matchSelected
 
wxRadioButton * m_matchSpecifiedRef
 
wxTextCtrl * m_specifiedRef
 
wxRadioButton * m_matchSpecifiedValue
 
wxTextCtrl * m_specifiedValue
 
wxRadioButton * m_matchSpecifiedID
 
wxTextCtrl * m_specifiedID
 
wxBitmapButton * m_specifiedIDBrowseButton
 
wxBoxSizer * m_changeSizer
 
wxTextCtrl * m_newID
 
wxBitmapButton * m_newIDBrowseButton
 
wxStaticBoxSizer * m_updateOptionsSizer
 
wxCheckBox * m_removeExtraBox
 
wxCheckBox * m_resetTextItemLayers
 
wxCheckBox * m_resetTextItemEffects
 
wxCheckBox * m_resetFabricationAttrs
 
wxCheckBox * m_reset3DModels
 
WX_HTML_REPORT_PANELm_MessageWindow
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

void updateMatchModeRadioButtons (wxUpdateUIEvent &event) override
 
void OnMatchAllClicked (wxCommandEvent &event) override
 
void OnMatchSelectedClicked (wxCommandEvent &event) override
 
void OnMatchRefClicked (wxCommandEvent &event) override
 
void OnMatchValueClicked (wxCommandEvent &event) override
 
void OnMatchIDClicked (wxCommandEvent &event) override
 
void OnOKClicked (wxCommandEvent &event) override
 
void ViewAndSelectFootprint (wxCommandEvent &event) override
 
wxRadioButton * getRadioButtonForMode ()
 
bool isMatch (FOOTPRINT *)
 
bool processMatchingFootprints ()
 
bool processFootprint (FOOTPRINT *aFootprint, const LIB_ID &aNewFPID)
 

Private Attributes

BOARD_COMMIT m_commit
 
PCB_EDIT_FRAMEm_parent
 
FOOTPRINTm_currentFootprint
 
bool m_updateMode
 
int * m_matchMode
 

Detailed Description

Definition at line 36 of file dialog_exchange_footprints.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_EXCHANGE_FOOTPRINTS()

DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS ( PCB_EDIT_FRAME aParent,
FOOTPRINT aFootprint,
bool  updateMode,
bool  selectedMode 
)

Definition at line 61 of file dialog_exchange_footprints.cpp.

63  :
65  m_commit( aParent ),
66  m_parent( aParent ),
67  m_currentFootprint( aFootprint ),
68  m_updateMode( updateMode )
69 {
70  if( !updateMode )
71  {
72  SetTitle( _( "Change Footprints" ) );
73  m_matchAll->SetLabel( _( "Change all footprints on board" ) );
74  m_matchSelected->SetLabel( _( "Change selected footprint" ) );
75  m_matchSpecifiedRef->SetLabel( _( "Change footprints matching reference designator:" ) );
76  m_matchSpecifiedValue->SetLabel( _( "Change footprints matching value:" ) );
77  m_matchSpecifiedID->SetLabel( _( "Change footprints with library id:" ) );
78  m_resetTextItemLayers->SetLabel( _( "Update text layers and visibilities" ) );
79  m_resetTextItemEffects->SetLabel( _( "Update text sizes, styles and positions" ) );
80  m_resetFabricationAttrs->SetLabel( _( "Update fabrication attributes" ) );
81  m_reset3DModels->SetLabel( _( "Update 3D models" ) );
82  }
83 
84 #if 0 // translator hint
85  wxString x = _( "Update/reset strings: there are two cases these descriptions need to cover: "
86  "the user made overrides to a footprint on the PCB and wants to remove them, "
87  "or the user made changes to the library footprint and wants to propagate "
88  "them back to the PCB." );
89 #endif
90 
91  if( m_updateMode )
92  {
93  m_changeSizer->Show( false );
94  }
95  else
96  {
97  m_upperSizer->FindItem( m_matchAll )->Show( false );
99  }
100 
101  if( m_currentFootprint )
102  {
103  m_newID->AppendText( FROM_UTF8( m_currentFootprint->GetFPID().Format().c_str() ) );
104  }
105  else
106  m_upperSizer->FindItem( m_matchSelected )->Show( false );
107 
108  // Use ChangeValue() instead of SetValue() so we don't generate events.
109  if( m_currentFootprint )
111 
112  if( m_currentFootprint )
113  m_specifiedValue->ChangeValue( m_currentFootprint->GetValue() );
114 
115  if( m_currentFootprint )
116  m_specifiedID->ChangeValue( FROM_UTF8( m_currentFootprint->GetFPID().Format().c_str() ) );
117 
119 
120  m_upperSizer->SetEmptyCellSize( wxSize( 0, 0 ) );
121  // The upper sizer has its content modified: re-layout it:
122  m_upperSizer->Layout();
123 
124  // initialize match-mode
125  if( m_updateMode )
127  else
129 
130  wxCommandEvent event;
131  event.SetEventObject( this );
132 
133  switch( *m_matchMode )
134  {
135  case ID_MATCH_FP_ALL: OnMatchAllClicked( event ); break;
136  case ID_MATCH_FP_SELECTED: OnMatchSelectedClicked( event ); break;
137  case ID_MATCH_FP_REF: OnMatchRefClicked( event ); break;
138  case ID_MATCH_FP_VAL: OnMatchValueClicked( event ); break;
139  case ID_MATCH_FP_ID: OnMatchIDClicked( event ); break;
140  default: break;
141  }
142 
143  m_removeExtraBox->SetValue( g_removeExtraTextItems[ m_updateMode ? 0 : 1 ] );
147  m_reset3DModels->SetValue( g_reset3DModels[ m_updateMode ? 0 : 1 ] );
148 
150  m_MessageWindow->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
151 
152  // DIALOG_SHIM needs a unique hash_key because classname is not sufficient
153  // because the update and change versions of this dialog have different controls.
154  m_hash_key = TO_UTF8( GetTitle() );
155 
156  // Ensure m_closeButton (with id = wxID_CANCEL) has the right label
157  // (to fix automatic renaming of button label )
158  m_sdbSizerCancel->SetLabel( _( "Close" ) );
159 
160  if( m_updateMode )
161  m_sdbSizerOK->SetLabel( _( "Update" ) );
162  else
163  m_sdbSizerOK->SetLabel( _( "Change" ) );
164 
165  m_sdbSizerOK->SetDefault();
166 
167  // Now all widgets have the size fixed, call FinishDialogSettings
169 }
void SetLazyUpdate(bool aLazyUpdate)
Forces updating the HTML page, after the report is built in lazy mode If aSort = true,...
void OnMatchIDClicked(wxCommandEvent &event) override
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
const wxString & GetValue() const
Definition: footprint.h:448
std::string m_hash_key
Definition: dialog_shim.h:200
DIALOG_EXCHANGE_FOOTPRINTS_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Update Footprints from Library"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
const char * c_str() const
Definition: utf8.h:102
int g_matchModeForUpdateSelected
void OnMatchAllClicked(wxCommandEvent &event) override
bool g_resetTextItemEffects[2]
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
#define ID_MATCH_FP_ID
#define ID_MATCH_FP_ALL
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool g_resetFabricationAttrs[2]
void OnMatchSelectedClicked(wxCommandEvent &event) override
const wxString & GetReference() const
Definition: footprint.h:426
bool g_reset3DModels[2]
bool g_removeExtraTextItems[2]
#define ID_MATCH_FP_SELECTED
const LIB_ID & GetFPID() const
Definition: footprint.h:190
#define ID_MATCH_FP_REF
int g_matchModeForExchangeSelected
UTF8 Format() const
Definition: lib_id.cpp:233
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
bool g_resetTextItemLayers[2]
#define _(s)
Definition: 3d_actions.cpp:33
void OnMatchRefClicked(wxCommandEvent &event) override
#define ID_MATCH_FP_VAL
void SetFileName(const wxString &aReportFileName)
int g_matchModeForExchange
void OnMatchValueClicked(wxCommandEvent &event) override
int g_matchModeForUpdate
wxBitmap KiBitmap(BITMAPS aBitmap)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104

References _, UTF8::c_str(), DIALOG_SHIM::finishDialogSettings(), LIB_ID::Format(), FROM_UTF8(), g_matchModeForExchange, g_matchModeForExchangeSelected, g_matchModeForUpdate, g_matchModeForUpdateSelected, g_removeExtraTextItems, g_reset3DModels, g_resetFabricationAttrs, g_resetTextItemEffects, g_resetTextItemLayers, FOOTPRINT::GetFPID(), FOOTPRINT::GetReference(), FOOTPRINT::GetValue(), ID_MATCH_FP_ALL, ID_MATCH_FP_ID, ID_MATCH_FP_REF, ID_MATCH_FP_SELECTED, ID_MATCH_FP_VAL, KiBitmap(), DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_changeSizer, m_currentFootprint, DIALOG_SHIM::m_hash_key, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchAll, m_matchMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSelected, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedID, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedRef, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedValue, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_MessageWindow, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_newID, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_newIDBrowseButton, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_removeExtraBox, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_reset3DModels, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetFabricationAttrs, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemEffects, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemLayers, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_sdbSizerCancel, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_sdbSizerOK, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedID, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedIDBrowseButton, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedRef, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedValue, m_updateMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_upperSizer, OnMatchAllClicked(), OnMatchIDClicked(), OnMatchRefClicked(), OnMatchSelectedClicked(), OnMatchValueClicked(), KIWAY_HOLDER::Prj(), WX_HTML_REPORT_PANEL::SetFileName(), WX_HTML_REPORT_PANEL::SetLazyUpdate(), small_library, and TO_UTF8.

◆ ~DIALOG_EXCHANGE_FOOTPRINTS()

DIALOG_EXCHANGE_FOOTPRINTS::~DIALOG_EXCHANGE_FOOTPRINTS ( )
override

Definition at line 172 of file dialog_exchange_footprints.cpp.

173 {
174  g_removeExtraTextItems[ m_updateMode ? 0 : 1 ] = m_removeExtraBox->GetValue();
178  g_reset3DModels[ m_updateMode ? 0 : 1 ] = m_reset3DModels->GetValue();
179 }
bool g_resetTextItemEffects[2]
bool g_resetFabricationAttrs[2]
bool g_reset3DModels[2]
bool g_removeExtraTextItems[2]
bool g_resetTextItemLayers[2]

References g_removeExtraTextItems, g_reset3DModels, g_resetFabricationAttrs, g_resetTextItemEffects, g_resetTextItemLayers, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_removeExtraBox, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_reset3DModels, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetFabricationAttrs, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemEffects, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemLayers, and m_updateMode.

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 307 of file dialog_shim.cpp.

308 {
309  // so we can do logging of this state change:
310  return wxDialog::Enable( enable );
311 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 445 of file dialog_shim.cpp.

446 {
447  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
448  // handle validation in the same way as other dialogs.
449  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
450  return;
451 
452  SetReturnCode( retCode );
453 
454  if( !IsQuasiModal() )
455  {
456  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
457  "wasn't called" );
458  return;
459  }
460 
461  if( m_qmodal_loop )
462  {
463  if( m_qmodal_loop->IsRunning() )
464  m_qmodal_loop->Exit( 0 );
465  else
466  m_qmodal_loop->ScheduleExit( 0 );
467 
469  }
470 
473 
474  Show( false );
475 }
bool IsQuasiModal() const
Definition: dialog_shim.h:107
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
#define NULL
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_SYMBOL::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_SYMBOL::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ finishDialogSettings()

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 after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 148 of file dialog_shim.cpp.

149 {
150  // must be called from the constructor of derived classes,
151  // when all widgets are initialized, and therefore their size fixed
152 
153  // SetSizeHints fixes the minimal size of sizers in the dialog
154  // (SetSizeHints calls Fit(), so no need to call it)
155  GetSizer()->SetSizeHints( this );
156 }

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ getRadioButtonForMode()

wxRadioButton * DIALOG_EXCHANGE_FOOTPRINTS::getRadioButtonForMode ( )
private

Definition at line 205 of file dialog_exchange_footprints.cpp.

206 {
207  switch( *m_matchMode )
208  {
209  case ID_MATCH_FP_ALL: return m_matchAll;
213  case ID_MATCH_FP_ID: return m_matchSpecifiedID;
214  default: return nullptr;
215  }
216 }
#define ID_MATCH_FP_ID
#define ID_MATCH_FP_ALL
#define ID_MATCH_FP_SELECTED
#define ID_MATCH_FP_REF
#define ID_MATCH_FP_VAL

References ID_MATCH_FP_ALL, ID_MATCH_FP_ID, ID_MATCH_FP_REF, ID_MATCH_FP_SELECTED, ID_MATCH_FP_VAL, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchAll, m_matchMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSelected, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedID, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedRef, and DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedValue.

Referenced by updateMatchModeRadioButtons().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:79

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

167 {
168  wxSize sz( x, 0 );
169  return ConvertDialogToPixels( sz ).x;
170 }

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), and DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ IsCtrl()

static bool DIALOG_SHIM::IsCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 125 of file dialog_shim.h.

126  {
127  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
128  !e.ShiftDown() && !e.MetaDown();
129  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ isMatch()

bool DIALOG_EXCHANGE_FOOTPRINTS::isMatch ( FOOTPRINT aFootprint)
private

Definition at line 182 of file dialog_exchange_footprints.cpp.

183 {
184  LIB_ID specifiedID;
185 
186  switch( *m_matchMode )
187  {
188  case ID_MATCH_FP_ALL:
189  return true;
191  return aFootprint == m_currentFootprint;
192  case ID_MATCH_FP_REF:
193  return WildCompareString( m_specifiedRef->GetValue(), aFootprint->GetReference(), false );
194  case ID_MATCH_FP_VAL:
195  return WildCompareString( m_specifiedValue->GetValue(), aFootprint->GetValue(), false );
196  case ID_MATCH_FP_ID:
197  specifiedID.Parse( m_specifiedID->GetValue() );
198  return aFootprint->GetFPID() == specifiedID;
199  default:
200  return false; // just to quiet compiler warnings....
201  }
202 }
const wxString & GetValue() const
Definition: footprint.h:448
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
#define ID_MATCH_FP_ID
#define ID_MATCH_FP_ALL
bool WildCompareString(const wxString &pattern, const wxString &string_to_tst, bool case_sensitive)
Compare a string against wild card (* and ?) pattern using the usual rules.
Definition: string.cpp:519
const wxString & GetReference() const
Definition: footprint.h:426
#define ID_MATCH_FP_SELECTED
const LIB_ID & GetFPID() const
Definition: footprint.h:190
#define ID_MATCH_FP_REF
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
#define ID_MATCH_FP_VAL

References FOOTPRINT::GetFPID(), FOOTPRINT::GetReference(), FOOTPRINT::GetValue(), ID_MATCH_FP_ALL, ID_MATCH_FP_ID, ID_MATCH_FP_REF, ID_MATCH_FP_SELECTED, ID_MATCH_FP_VAL, m_currentFootprint, m_matchMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedID, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedRef, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedValue, LIB_ID::Parse(), and WildCompareString().

Referenced by processMatchingFootprints().

◆ IsQuasiModal()

◆ IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 131 of file dialog_shim.h.

132  {
133  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
134  e.ShiftDown() && !e.MetaDown();
135  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return 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 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:78

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and ViewAndSelectFootprint().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 536 of file dialog_shim.cpp.

537 {
538  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
539  {
540  if( m_parentFrame )
541  {
543  return;
544  }
545  }
546  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
547  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
548  {
549  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
550  return;
551  }
552  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
553  {
554  wxWindow* currentWindow = wxWindow::FindFocus();
555  int currentIdx = -1;
556  int delta = aEvt.ShiftDown() ? -1 : 1;
557 
558  auto advance = [&]( int& idx )
559  {
560  // Wrap-around modulus
561  int size = m_tabOrder.size();
562  idx = ( ( idx + delta ) % size + size ) % size;
563  };
564 
565  for( size_t i = 0; i < m_tabOrder.size(); ++i )
566  {
567  if( m_tabOrder[i] == currentWindow )
568  {
569  currentIdx = (int) i;
570  break;
571  }
572  }
573 
574  if( currentIdx >= 0 )
575  {
576  advance( currentIdx );
577 
578  //todo: We don't currently have non-textentry dialog boxes but this will break if
579  // we add them.
580 #ifdef __APPLE__
581  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
582  advance( currentIdx );
583 #endif
584 
585  m_tabOrder[ currentIdx ]->SetFocus();
586  return;
587  }
588  }
589 
590  aEvt.Skip();
591 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:219
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:217
virtual void ToggleUserUnits()

References DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

◆ OnMatchAllClicked()

void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 246 of file dialog_exchange_footprints.cpp.

247 {
249 
250  if( event.GetEventObject() == this )
252  else
253  m_matchAll->SetFocus();
254 }
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
#define ID_MATCH_FP_ALL

References ID_MATCH_FP_ALL, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchAll, m_matchMode, and DIALOG_SHIM::SetInitialFocus().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS().

◆ OnMatchIDClicked()

void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 290 of file dialog_exchange_footprints.cpp.

291 {
293 
294  if( event.GetEventObject() == this )
296  else if( event.GetEventObject() != m_specifiedID )
297  m_specifiedID->SetFocus();
298 }
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
#define ID_MATCH_FP_ID

References ID_MATCH_FP_ID, m_matchMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedID, and DIALOG_SHIM::SetInitialFocus().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS().

◆ OnMatchRefClicked()

void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 268 of file dialog_exchange_footprints.cpp.

269 {
271 
272  if( event.GetEventObject() == this )
274  else if( event.GetEventObject() != m_specifiedRef )
275  m_specifiedRef->SetFocus();
276 }
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
#define ID_MATCH_FP_REF

References ID_MATCH_FP_REF, m_matchMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedRef, and DIALOG_SHIM::SetInitialFocus().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS().

◆ OnMatchSelectedClicked()

void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 257 of file dialog_exchange_footprints.cpp.

258 {
260 
261  if( event.GetEventObject() == this )
263  else
264  m_matchSelected->SetFocus();
265 }
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
#define ID_MATCH_FP_SELECTED

References ID_MATCH_FP_SELECTED, m_matchMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSelected, and DIALOG_SHIM::SetInitialFocus().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS().

◆ OnMatchValueClicked()

void DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 279 of file dialog_exchange_footprints.cpp.

280 {
282 
283  if( event.GetEventObject() == this )
285  else if( event.GetEventObject() != m_specifiedValue )
286  m_specifiedValue->SetFocus();
287 }
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
#define ID_MATCH_FP_VAL

References ID_MATCH_FP_VAL, m_matchMode, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedValue, and DIALOG_SHIM::SetInitialFocus().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS().

◆ OnOKClicked()

void DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 301 of file dialog_exchange_footprints.cpp.

302 {
303  wxBusyCursor dummy;
304 
306  m_MessageWindow->Flush( false );
307 
309  {
310  m_parent->Compile_Ratsnest( true );
311  m_parent->GetCanvas()->Refresh();
312  }
313 
314  m_MessageWindow->Flush( false );
315 
316  m_commit.Push( wxT( "Changed footprint" ) );
317 }
void Compile_Ratsnest(bool aDisplayStatus)
Create the entire board ratsnest.
Definition: ratsnest.cpp:41
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void Flush(bool aSort=false)
Set the visible severity filter.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void Clear()
return the number of messages matching the given severity mask.
virtual void Push(const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true, bool aSetDirtyBit=true) override
Revert the commit by restoring the modified items state.

References WX_HTML_REPORT_PANEL::Clear(), PCB_BASE_FRAME::Compile_Ratsnest(), dummy(), WX_HTML_REPORT_PANEL::Flush(), PCB_BASE_FRAME::GetCanvas(), m_commit, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_MessageWindow, m_parent, processMatchingFootprints(), BOARD_COMMIT::Push(), and EDA_DRAW_PANEL_GAL::Refresh().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 352 of file dialog_shim.cpp.

353 {
354  if( m_firstPaintEvent )
355  {
357 
358  selectAllInTextCtrls( GetChildren() );
359 
362  else
363  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
364 
365  m_firstPaintEvent = false;
366  }
367 
368  event.Skip();
369 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210
bool m_firstPaintEvent
Definition: dialog_shim.h:209
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:68
static void selectAllInTextCtrls(wxWindowList &children)

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ processFootprint()

bool DIALOG_EXCHANGE_FOOTPRINTS::processFootprint ( FOOTPRINT aFootprint,
const LIB_ID aNewFPID 
)
private

Definition at line 364 of file dialog_exchange_footprints.cpp.

365 {
366  LIB_ID oldFPID = aFootprint->GetFPID();
367  wxString msg;
368 
369  // Load new footprint.
370  if( m_updateMode )
371  {
372  msg.Printf( _( "Update footprint %s from '%s' to '%s'" ),
373  aFootprint->GetReference(),
374  oldFPID.Format().c_str(),
375  aNewFPID.Format().c_str() );
376  }
377  else
378  {
379  msg.Printf( _( "Change footprint %s from '%s' to '%s'" ),
380  aFootprint->GetReference(),
381  oldFPID.Format().c_str(),
382  aNewFPID.Format().c_str() );
383  }
384 
385  FOOTPRINT* newFootprint = m_parent->LoadFootprint( aNewFPID );
386 
387  if( !newFootprint )
388  {
389  msg << ": " << _( "*** footprint not found ***" );
391  return false;
392  }
393 
394  m_parent->ExchangeFootprint( aFootprint, newFootprint, m_commit,
395  m_removeExtraBox->GetValue(),
396  m_resetTextItemLayers->GetValue(),
397  m_resetTextItemEffects->GetValue(),
398  m_resetFabricationAttrs->GetValue(),
399  m_reset3DModels->GetValue() );
400 
401  if( aFootprint == m_currentFootprint )
402  m_currentFootprint = newFootprint;
403 
404  msg += ": OK";
406 
407  return true;
408 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const char * c_str() const
Definition: utf8.h:102
void ExchangeFootprint(FOOTPRINT *aExisting, FOOTPRINT *aNew, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetFabricationAttrs=true, bool reset3DModels=true)
Replace aExisting footprint by aNew footprint using the Existing footprint settings (position,...
const wxString & GetReference() const
Definition: footprint.h:426
FOOTPRINT * LoadFootprint(const LIB_ID &aFootprintId)
Attempt to load aFootprintId from the footprint library table.
const LIB_ID & GetFPID() const
Definition: footprint.h:190
UTF8 Format() const
Definition: lib_id.cpp:233
void Report(const wxString &aText, SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
Reports the string.
#define _(s)
Definition: 3d_actions.cpp:33

References _, UTF8::c_str(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_ID::Format(), FOOTPRINT::GetFPID(), FOOTPRINT::GetReference(), PCB_BASE_FRAME::LoadFootprint(), m_commit, m_currentFootprint, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_MessageWindow, m_parent, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_removeExtraBox, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_reset3DModels, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetFabricationAttrs, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemEffects, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemLayers, m_updateMode, WX_HTML_REPORT_PANEL::Report(), RPT_SEVERITY_ACTION, and RPT_SEVERITY_ERROR.

Referenced by processMatchingFootprints().

◆ processMatchingFootprints()

bool DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints ( )
private

Definition at line 320 of file dialog_exchange_footprints.cpp.

321 {
322  bool change = false;
323  LIB_ID newFPID;
324  wxString value;
325 
326  if( m_parent->GetBoard()->Footprints().empty() )
327  return false;
328 
329  if( !m_updateMode )
330  {
331  newFPID.Parse( m_newID->GetValue() );
332 
333  if( !newFPID.IsValid() )
334  return false;
335  }
336 
337  /* The change is done from the last footprint because processFootprint() modifies the last
338  * item in the list.
339  */
340  for( auto it = m_parent->GetBoard()->Footprints().rbegin();
341  it != m_parent->GetBoard()->Footprints().rend(); it++ )
342  {
343  auto mod = *it;
344 
345  if( !isMatch( mod ) )
346  continue;
347 
348  if( m_updateMode )
349  {
350  if( processFootprint( mod, mod->GetFPID() ) )
351  change = true;
352  }
353  else
354  {
355  if( processFootprint( mod, newFPID ) )
356  change = true;
357  }
358  }
359 
360  return change;
361 }
bool processFootprint(FOOTPRINT *aFootprint, const LIB_ID &aNewFPID)
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:168
FOOTPRINTS & Footprints()
Definition: board.h:305
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
BOARD * GetBoard() const

References BOARD::Footprints(), PCB_BASE_FRAME::GetBoard(), isMatch(), LIB_ID::IsValid(), DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_newID, m_parent, m_updateMode, LIB_ID::Parse(), and processFootprint().

Referenced by OnOKClicked().

◆ resetSize()

void DIALOG_SHIM::resetSize ( )
protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 282 of file dialog_shim.cpp.

283 {
284  const char* hash_key;
285 
286  if( m_hash_key.size() )
287  {
288  // a special case like EDA_LIST_DIALOG, which has multiple uses.
289  hash_key = m_hash_key.c_str();
290  }
291  else
292  {
293  hash_key = typeid(*this).name();
294  }
295 
296  RECT_MAP::iterator it = class_map.find( hash_key );
297 
298  if( it == class_map.end() )
299  return;
300 
301  EDA_RECT rect = it->second;
302  rect.SetSize( 0, 0 );
303  class_map[ hash_key ] = rect;
304 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:139
Handle the component boundary box.
Definition: eda_rect.h:42

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 98 of file dialog_shim.h.

99  {
100  m_initialFocusTarget = aWindow;
101  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_INSPECTION_REPORTER::DIALOG_INSPECTION_REPORTER(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_EDIT_ONE_FIELD::init(), OnMatchAllClicked(), OnMatchIDClicked(), OnMatchRefClicked(), OnMatchSelectedClicked(), OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

43 {
44 #if defined(DEBUG)
45  // offer a trap point for debugging most any window
46  wxASSERT( aDest );
47  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
48  {
49  int breakhere=1;
50  (void) breakhere;
51  }
52 #endif
53 
54  (void) aDest;
55 
56  m_kiway = aKiway;
57 }
KIWAY * m_kiway
Definition: kiway_holder.h:78
const char * name
Definition: DXF_plotter.cpp:59

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 187 of file dialog_shim.cpp.

188 {
189  wxDialog::SetPosition( aNewPosition );
190 
191  // Now update the stored position:
192  const char* hash_key;
193 
194  if( m_hash_key.size() )
195  {
196  // a special case like EDA_LIST_DIALOG, which has multiple uses.
197  hash_key = m_hash_key.c_str();
198  }
199  else
200  {
201  hash_key = typeid(*this).name();
202  }
203 
204  RECT_MAP::iterator it = class_map.find( hash_key );
205 
206  if( it == class_map.end() )
207  return;
208 
209  EDA_RECT rect = it->second;
210  rect.SetOrigin( aNewPosition );
211 
212  class_map[ hash_key ] = rect;
213 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
std::string m_hash_key
Definition: dialog_shim.h:200
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:126
static RECT_MAP class_map
Handle the component boundary box.
Definition: eda_rect.h:42

References class_map, DIALOG_SHIM::m_hash_key, EDA_RECT::SetOrigin(), and PCAD2KICAD::SetPosition().

Referenced by DIALOG_SCH_FIND::DIALOG_SCH_FIND(), and PCB_BASE_FRAME::SelectOneLayer().

◆ setSizeInDU()

void DIALOG_SHIM::setSizeInDU ( int  x,
int  y 
)
protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 159 of file dialog_shim.cpp.

160 {
161  wxSize sz( x, y );
162  SetSize( ConvertDialogToPixels( sz ) );
163 }

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 216 of file dialog_shim.cpp.

217 {
218  bool ret;
219  const char* hash_key;
220 
221  if( m_hash_key.size() )
222  {
223  // a special case like EDA_LIST_DIALOG, which has multiple uses.
224  hash_key = m_hash_key.c_str();
225  }
226  else
227  {
228  hash_key = typeid(*this).name();
229  }
230 
231  // Show or hide the window. If hiding, save current position and size.
232  // If showing, use previous position and size.
233  if( show )
234  {
235 #ifndef __WINDOWS__
236  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
237 #endif
238  ret = wxDialog::Show( show );
239 
240  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
241  EDA_RECT savedDialogRect = class_map[ hash_key ];
242 
243  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
244  {
245  if( m_useCalculatedSize )
246  {
247  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
248  wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
249  }
250  else
251  {
252  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
253  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
254  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
255  0 );
256  }
257  }
258 
259  // Be sure that the dialog appears in a visible area
260  // (the dialog position might have been stored at the time when it was
261  // shown on another display)
262  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
263  Centre();
264  }
265  else
266  {
267  // Save the dialog's position & size before hiding, using classname as key
268  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
269 
270 #ifdef __WXMAC__
271  if ( m_eventLoop )
272  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
273 #endif
274 
275  ret = wxDialog::Show( show );
276  }
277 
278  return ret;
279 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:107
Handle the component boundary box.
Definition: eda_rect.h:42
bool m_useCalculatedSize
Definition: dialog_shim.h:204
const wxSize GetSize() const
Definition: eda_rect.h:96

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 395 of file dialog_shim.cpp.

396 {
397  // This is an exception safe way to zero a pointer before returning.
398  // Yes, even though DismissModal() clears this first normally, this is
399  // here in case there's an exception before the dialog is dismissed.
400  struct NULLER
401  {
402  void*& m_what;
403  NULLER( void*& aPtr ) : m_what( aPtr ) {}
404  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
405  } clear_this( (void*&) m_qmodal_loop );
406 
407  // release the mouse if it's currently captured as the window having it
408  // will be disabled when this dialog is shown -- but will still keep the
409  // capture making it impossible to do anything in the modal dialog itself
410  wxWindow* win = wxWindow::GetCapture();
411  if( win )
412  win->ReleaseMouse();
413 
414  // Get the optimal parent
415  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
416 
417  wxASSERT_MSG( !m_qmodal_parent_disabler,
418  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
419 
420  // quasi-modal: disable only my "optimal" parent
422 
423  // Apple in its infinite wisdom will raise a disabled window before even passing
424  // us the event, so we have no way to stop it. Instead, we must set an order on
425  // the windows so that the quasi-modal will be pushed in front of the disabled
426  // window when it is raised.
428 
429  Show( true );
430 
431  m_qmodal_showing = true;
432 
433  WX_EVENT_LOOP event_loop;
434 
435  m_qmodal_loop = &event_loop;
436 
437  event_loop.Run();
438 
439  m_qmodal_showing = false;
440 
441  return GetReturnCode();
442 }
bool m_qmodal_showing
Definition: dialog_shim.h:214
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:42
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:62

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ updateMatchModeRadioButtons()

void DIALOG_EXCHANGE_FOOTPRINTS::updateMatchModeRadioButtons ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 219 of file dialog_exchange_footprints.cpp.

220 {
221  wxRadioButton* rb_button = getRadioButtonForMode();
222 
223  wxRadioButton* rb_butt_list[] =
224  {
225  m_matchAll,
230  nullptr // end of list
231  };
232 
233  // Ensure the button state is ok. Only one button can be checked
234  // Change button state only if its state is incorrect, otherwise
235  // we have issues depending on the platform.
236  for( int ii = 0; rb_butt_list[ii]; ++ii )
237  {
238  bool state = rb_butt_list[ii] == rb_button;
239 
240  if( rb_butt_list[ii]->GetValue() != state )
241  rb_butt_list[ii]->SetValue( state );
242  }
243 }

References getRadioButtonForMode(), DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchAll, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSelected, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedID, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedRef, and DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_matchSpecifiedValue.

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 173 of file dialog_shim.cpp.

174 {
175  wxSize sz( 0, y );
176  return ConvertDialogToPixels( sz ).y;
177 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ ViewAndSelectFootprint()

void DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXCHANGE_FOOTPRINTS_BASE.

Definition at line 574 of file dialog_exchange_footprints.cpp.

575 {
576  wxString newname = m_newID->GetValue();
577 
579 
580  if( frame->ShowModal( &newname, this ) )
581  {
582  if( event.GetEventObject() == m_newIDBrowseButton )
583  m_newID->SetValue( newname );
584  else
585  m_specifiedID->SetValue( newname );
586  }
587 
588  frame->Destroy();
589 }
virtual bool ShowModal(wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until t...
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:61
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:357
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

References KIWAY_PLAYER::Destroy(), FRAME_FOOTPRINT_VIEWER_MODAL, KIWAY_HOLDER::Kiway(), DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_newID, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_newIDBrowseButton, DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedID, KIWAY::Player(), and KIWAY_PLAYER::ShowModal().

Member Data Documentation

◆ m_changeSizer

wxBoxSizer* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_changeSizer
protectedinherited

◆ m_commit

BOARD_COMMIT DIALOG_EXCHANGE_FOOTPRINTS::m_commit
private

Definition at line 39 of file dialog_exchange_footprints.h.

Referenced by OnOKClicked(), and processFootprint().

◆ m_currentFootprint

FOOTPRINT* DIALOG_EXCHANGE_FOOTPRINTS::m_currentFootprint
private

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 209 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 210 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SetInitialFocus().

◆ m_mainSizer

wxBoxSizer* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_mainSizer
protectedinherited

◆ m_matchAll

◆ m_matchMode

◆ m_matchSelected

◆ m_matchSpecifiedID

◆ m_matchSpecifiedRef

◆ m_matchSpecifiedValue

◆ m_MessageWindow

WX_HTML_REPORT_PANEL* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_MessageWindow
protectedinherited

◆ m_newID

wxTextCtrl* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_newID
protectedinherited

◆ m_newIDBrowseButton

◆ m_parent

PCB_EDIT_FRAME* DIALOG_EXCHANGE_FOOTPRINTS::m_parent
private

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 217 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 212 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 214 of file dialog_shim.h.

Referenced by DIALOG_SHIM::IsQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_removeExtraBox

wxCheckBox* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_removeExtraBox
protectedinherited

◆ m_reset3DModels

wxCheckBox* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_reset3DModels
protectedinherited

◆ m_resetFabricationAttrs

wxCheckBox* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetFabricationAttrs
protectedinherited

◆ m_resetTextItemEffects

wxCheckBox* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemEffects
protectedinherited

◆ m_resetTextItemLayers

wxCheckBox* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_resetTextItemLayers
protectedinherited

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerOK

◆ m_specifiedID

◆ m_specifiedIDBrowseButton

wxBitmapButton* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_specifiedIDBrowseButton
protectedinherited

◆ m_specifiedRef

◆ m_specifiedValue

◆ m_tabOrder

◆ m_units

◆ m_updateMode

bool DIALOG_EXCHANGE_FOOTPRINTS::m_updateMode
private

◆ m_updateOptionsSizer

wxStaticBoxSizer* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_updateOptionsSizer
protectedinherited

◆ m_upperSizer

wxGridBagSizer* DIALOG_EXCHANGE_FOOTPRINTS_BASE::m_upperSizer
protectedinherited

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

The documentation for this class was generated from the following files: