KiCad PCB EDA Suite
DIALOG_CHANGE_SYMBOLS Class Reference

Dialog to update or change schematic library symbols. More...

#include <dialog_change_symbols.h>

Inheritance diagram for DIALOG_CHANGE_SYMBOLS:
DIALOG_CHANGE_SYMBOLS_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  MODE { MODE::CHANGE = 0, MODE::UPDATE }
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_CHANGE_SYMBOLS (SCH_EDIT_FRAME *aParent, SCH_COMPONENT *aSymbol, MODE aMode=MODE::UPDATE)
 
 ~DIALOG_CHANGE_SYMBOLS () 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 launchMatchIdSymbolBrowser (wxCommandEvent &aEvent) override
 
void launchNewIdSymbolBrowser (wxCommandEvent &aEvent) override
 
void onMatchTextKillFocus (wxFocusEvent &event) override
 
void onOkButtonClicked (wxCommandEvent &aEvent) override
 
void onMatchByAll (wxCommandEvent &aEvent) override
 
void onMatchBySelected (wxCommandEvent &aEvent) override
 
void onMatchByReference (wxCommandEvent &aEvent) override
 
void onMatchByValue (wxCommandEvent &aEvent) override
 
void onMatchById (wxCommandEvent &aEvent) override
 
void onSelectAll (wxCommandEvent &event) override
 
void onSelectNone (wxCommandEvent &event) override
 Select or deselect all fields in the listbox widget. More...
 
void checkAll (bool aCheck)
 
virtual void OnMatchText (wxCommandEvent &event)
 
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_matchSizer
 
wxRadioButton * m_matchAll
 
wxRadioButton * m_matchBySelection
 
wxRadioButton * m_matchByReference
 
wxTextCtrl * m_specifiedReference
 
wxRadioButton * m_matchByValue
 
wxTextCtrl * m_specifiedValue
 
wxRadioButton * m_matchById
 
wxTextCtrl * m_specifiedId
 
wxBitmapButton * m_matchIdBrowserButton
 
wxStaticLine * m_staticline1
 
wxBoxSizer * m_newIdSizer
 
wxTextCtrl * m_newId
 
wxBitmapButton * m_newIdBrowserButton
 
wxStaticBoxSizer * m_updateFieldsSizer
 
wxCheckListBox * m_fieldsBox
 
wxButton * m_selAllBtn
 
wxButton * m_selNoneBtn
 
wxStaticBoxSizer * m_updateOptionsSizer
 
wxCheckBox * m_removeExtraBox
 
wxCheckBox * m_resetEmptyFields
 
wxCheckBox * m_resetFieldText
 
wxCheckBox * m_resetFieldVisibilities
 
wxCheckBox * m_resetFieldEffects
 
wxCheckBox * m_resetFieldPositions
 
wxCheckBox * m_resetAttributes
 
WX_HTML_REPORT_PANELm_messagePanel
 
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 updateFieldsList ()
 
bool isMatch (SCH_COMPONENT *aSymbol, SCH_SHEET_PATH *aInstance)
 
bool processMatchingSymbols ()
 
bool processSymbol (SCH_COMPONENT *aSymbol, const SCH_SHEET_PATH *aInstance, const LIB_ID &aNewId, bool aAppendToUndo)
 

Private Attributes

SCH_COMPONENTm_symbol
 
MODE m_mode
 Set of field names that should have values updated. More...
 
std::set< wxString > m_updateFields
 

Detailed Description

Dialog to update or change schematic library symbols.

Definition at line 37 of file dialog_change_symbols.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.

◆ MODE

Enumerator
CHANGE 
UPDATE 

Definition at line 40 of file dialog_change_symbols.h.

40 { CHANGE = 0, UPDATE };

Constructor & Destructor Documentation

◆ DIALOG_CHANGE_SYMBOLS()

DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS ( SCH_EDIT_FRAME aParent,
SCH_COMPONENT aSymbol,
MODE  aMode = MODE::UPDATE 
)

Definition at line 52 of file dialog_change_symbols.cpp.

53  :
54  DIALOG_CHANGE_SYMBOLS_BASE( aParent ),
55  m_symbol( aSymbol),
56  m_mode( aMode )
57 {
58  wxASSERT( aParent );
59 
60  if( m_mode == MODE::UPDATE )
61  {
62  m_newIdSizer->Show( false );
63  }
64  else
65  {
66  m_matchAll->SetLabel( _( "Change all symbols in schematic" ) );
67  SetTitle( _( "Change Symbols" ) );
68  m_matchSizer->FindItem( m_matchAll )->Show( false );
69  }
70 
71  if( m_symbol )
72  {
73  SCH_SHEET_PATH* currentSheet = &aParent->Schematic().CurrentSheet();
74 
75  if( m_mode == MODE::CHANGE )
76  m_matchBySelection->SetLabel( _( "Change selected Symbol" ) );
77 
78  m_newId->AppendText( FROM_UTF8( m_symbol->GetLibId().Format().c_str() ) );
79  m_specifiedReference->ChangeValue( m_symbol->GetRef( currentSheet ) );
80  m_specifiedValue->ChangeValue( m_symbol->GetValue( currentSheet, false ) );
81  m_specifiedId->ChangeValue( FROM_UTF8( m_symbol->GetLibId().Format().c_str() ) );
82  }
83  else
84  {
85  m_matchSizer->FindItem( m_matchBySelection )->Show( false );
86  }
87 
90 
91  if( m_mode == MODE::CHANGE )
92  {
93  m_matchByReference->SetLabel( _( "Change symbols matching reference designator:" ) );
94  m_matchByValue->SetLabel( _( "Change symbols matching value:" ) );
95  m_matchById->SetLabel( _( "Change symbols matching library identifier:" ) );
96  }
97 
98  m_matchSizer->SetEmptyCellSize( wxSize( 0, 0 ) );
99  m_matchSizer->Layout();
100 
101  for( int i = 0; i < MANDATORY_FIELDS; ++i )
102  {
104 
105  if( i == REFERENCE_FIELD )
106  m_fieldsBox->Check( i, g_selectRefDes );
107  else if( i == VALUE_FIELD )
108  m_fieldsBox->Check( i, g_selectValue );
109  else
110  m_fieldsBox->Check( i, true );
111  }
112 
113  m_messagePanel->SetLazyUpdate( true );
114  m_messagePanel->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
115 
116  if( aSymbol && aSymbol->IsSelected() )
117  {
118  m_matchBySelection->SetValue( true );
119  }
120  else
121  {
122  if( aMode == MODE::UPDATE )
123  m_matchAll->SetValue( true );
124  else
125  m_matchByReference->SetValue( true );
126  }
127 
129 
130  if( m_mode == MODE::CHANGE )
131  {
132  m_updateFieldsSizer->GetStaticBox()->SetLabel( _( "Update Fields" ) );
133  m_removeExtraBox->SetLabel( _( "Remove fields if not in new symbol" ) );
134  m_resetEmptyFields->SetLabel( _( "Reset fields if empty in new symbol" ) );
135  m_resetFieldText->SetLabel( _( "Update field text" ) );
136  m_resetFieldVisibilities->SetLabel( _( "Update field visibilities" ) );
137  m_resetFieldEffects->SetLabel( _( "Update field sizes and styles" ) );
138  m_resetFieldPositions->SetLabel( _( "Update field positions" ) );
139  m_resetAttributes->SetLabel( _( "Update symbol attributes" ) );
140  }
141 
142  m_removeExtraBox->SetValue( g_removeExtraFields[ (int) m_mode ] );
143  m_resetEmptyFields->SetValue( g_resetEmptyFields[ (int) m_mode ] );
144  m_resetFieldText->SetValue( g_resetFieldText[ (int) m_mode ] );
146  m_resetFieldEffects->SetValue( g_resetFieldEffects[ (int) m_mode ] );
147  m_resetFieldPositions->SetValue( g_resetFieldPositions[ (int) m_mode ] );
148  m_resetAttributes->SetValue( g_resetAttributes[ (int) m_mode ] );
149 
150  // DIALOG_SHIM needs a unique hash_key because classname is not sufficient
151  // because the update and change versions of this dialog have different controls.
152  m_hash_key = TO_UTF8( GetTitle() );
153 
154  // Ensure m_closeButton (with id = wxID_CANCEL) has the right label
155  // (to fix automatic renaming of button label )
156  m_sdbSizerCancel->SetLabel( _( "Close" ) );
157 
158  if( m_mode == MODE::CHANGE )
159  m_sdbSizerOK->SetLabel( _( "Change" ) );
160  else
161  m_sdbSizerOK->SetLabel( _( "Update" ) );
162 
163  m_sdbSizerOK->SetDefault();
164 
165  // Now all widgets have the size fixed, call FinishDialogSettings
167 }
Field Reference of part, i.e. "IC21".
void SetLazyUpdate(bool aLazyUpdate)
Forces updating the HTML page, after the report is built in lazy mode If aSort = true,...
bool g_resetAttributes[2]
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
bool IsSelected() const
Definition: eda_item.h:172
std::string m_hash_key
Definition: dialog_shim.h:200
bool g_resetEmptyFields[2]
bool g_removeExtraFields[2]
const char * c_str() const
Definition: utf8.h:102
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
bool g_resetFieldVisibilities[2]
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:82
bool g_resetFieldEffects[2]
Field Value of part, i.e. "3.3K".
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Definition: sch_symbol.cpp:588
DIALOG_CHANGE_SYMBOLS_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Update Symbols from Library"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
SCHEMATIC & Schematic() const
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslate=true)
Return a default symbol field name for field aFieldNdx for all components.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
const BITMAP_OPAQUE small_library_xpm[1]
bool g_selectValue
UTF8 Format() const
Definition: lib_id.cpp:233
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
bool g_resetFieldText[2]
WX_HTML_REPORT_PANEL * m_messagePanel
#define _(s)
Definition: 3d_actions.cpp:33
bool g_selectRefDes
bool g_resetFieldPositions[2]
MODE m_mode
Set of field names that should have values updated.
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:141
void SetFileName(const wxString &aReportFileName)
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:189
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:427

References _, UTF8::c_str(), CHANGE, SCHEMATIC::CurrentSheet(), DIALOG_SHIM::finishDialogSettings(), LIB_ID::Format(), FROM_UTF8(), g_removeExtraFields, g_resetAttributes, g_resetEmptyFields, g_resetFieldEffects, g_resetFieldPositions, g_resetFieldText, g_resetFieldVisibilities, g_selectRefDes, g_selectValue, TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_COMPONENT::GetLibId(), SCH_COMPONENT::GetRef(), SCH_COMPONENT::GetValue(), EDA_ITEM::IsSelected(), KiBitmap(), DIALOG_CHANGE_SYMBOLS_BASE::m_fieldsBox, DIALOG_SHIM::m_hash_key, DIALOG_CHANGE_SYMBOLS_BASE::m_matchAll, DIALOG_CHANGE_SYMBOLS_BASE::m_matchById, DIALOG_CHANGE_SYMBOLS_BASE::m_matchByReference, DIALOG_CHANGE_SYMBOLS_BASE::m_matchBySelection, DIALOG_CHANGE_SYMBOLS_BASE::m_matchByValue, DIALOG_CHANGE_SYMBOLS_BASE::m_matchIdBrowserButton, DIALOG_CHANGE_SYMBOLS_BASE::m_matchSizer, DIALOG_CHANGE_SYMBOLS_BASE::m_messagePanel, m_mode, DIALOG_CHANGE_SYMBOLS_BASE::m_newId, DIALOG_CHANGE_SYMBOLS_BASE::m_newIdBrowserButton, DIALOG_CHANGE_SYMBOLS_BASE::m_newIdSizer, DIALOG_CHANGE_SYMBOLS_BASE::m_removeExtraBox, DIALOG_CHANGE_SYMBOLS_BASE::m_resetAttributes, DIALOG_CHANGE_SYMBOLS_BASE::m_resetEmptyFields, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldEffects, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldPositions, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldText, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldVisibilities, DIALOG_CHANGE_SYMBOLS_BASE::m_sdbSizerCancel, DIALOG_CHANGE_SYMBOLS_BASE::m_sdbSizerOK, DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedId, DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedReference, DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedValue, m_symbol, DIALOG_CHANGE_SYMBOLS_BASE::m_updateFieldsSizer, MANDATORY_FIELDS, KIWAY_HOLDER::Prj(), REFERENCE_FIELD, SCH_EDIT_FRAME::Schematic(), WX_HTML_REPORT_PANEL::SetFileName(), WX_HTML_REPORT_PANEL::SetLazyUpdate(), small_library_xpm, TO_UTF8, UPDATE, updateFieldsList(), and VALUE_FIELD.

◆ ~DIALOG_CHANGE_SYMBOLS()

DIALOG_CHANGE_SYMBOLS::~DIALOG_CHANGE_SYMBOLS ( )
override

Definition at line 209 of file dialog_change_symbols.cpp.

210 {
212  g_selectValue = m_fieldsBox->IsChecked( VALUE_FIELD );
213 
214  g_removeExtraFields[ (int) m_mode ] = m_removeExtraBox->GetValue();
215  g_resetEmptyFields[ (int) m_mode ] = m_resetEmptyFields->GetValue();
216  g_resetFieldText[ (int) m_mode ] = m_resetFieldText->GetValue();
218  g_resetFieldEffects[ (int) m_mode ] = m_resetFieldEffects->GetValue();
219  g_resetFieldPositions[ (int) m_mode ] = m_resetFieldPositions->GetValue();
220  g_resetAttributes[ (int) m_mode ] = m_resetAttributes->GetValue();
221 }
Field Reference of part, i.e. "IC21".
bool g_resetAttributes[2]
bool g_resetEmptyFields[2]
bool g_removeExtraFields[2]
bool g_resetFieldVisibilities[2]
bool g_resetFieldEffects[2]
Field Value of part, i.e. "3.3K".
bool g_selectValue
bool g_resetFieldText[2]
bool g_selectRefDes
bool g_resetFieldPositions[2]
MODE m_mode
Set of field names that should have values updated.

References g_removeExtraFields, g_resetAttributes, g_resetEmptyFields, g_resetFieldEffects, g_resetFieldPositions, g_resetFieldText, g_resetFieldVisibilities, g_selectRefDes, g_selectValue, DIALOG_CHANGE_SYMBOLS_BASE::m_fieldsBox, m_mode, DIALOG_CHANGE_SYMBOLS_BASE::m_removeExtraBox, DIALOG_CHANGE_SYMBOLS_BASE::m_resetAttributes, DIALOG_CHANGE_SYMBOLS_BASE::m_resetEmptyFields, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldEffects, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldPositions, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldText, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldVisibilities, REFERENCE_FIELD, and VALUE_FIELD.

Member Function Documentation

◆ checkAll()

void DIALOG_CHANGE_SYMBOLS::checkAll ( bool  aCheck)
protected

Definition at line 346 of file dialog_change_symbols.cpp.

347 {
348  for( unsigned i = 0; i < m_fieldsBox->GetCount(); ++i )
349  m_fieldsBox->Check( i, aCheck );
350 }

References DIALOG_CHANGE_SYMBOLS_BASE::m_fieldsBox.

Referenced by onSelectAll(), and onSelectNone().

◆ 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_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_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_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_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_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), 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().

◆ 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_CHANGE_SYMBOLS::isMatch ( SCH_COMPONENT aSymbol,
SCH_SHEET_PATH aInstance 
)
private

Definition at line 382 of file dialog_change_symbols.cpp.

383 {
384  LIB_ID id;
385 
386  wxCHECK( aSymbol, false );
387 
388  SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
389 
390  wxCHECK( frame, false );
391 
392  if( m_matchAll->GetValue() )
393  {
394  return true;
395  }
396  else if( m_matchBySelection->GetValue() )
397  {
398  return aSymbol == m_symbol;
399  }
400  else if( m_matchByReference->GetValue() )
401  {
402  return WildCompareString( m_specifiedReference->GetValue(),
403  aSymbol->GetRef( aInstance, false ), false );
404  }
405  else if( m_matchByValue->GetValue() )
406  {
407  return WildCompareString( m_specifiedValue->GetValue(),
408  aSymbol->GetValue( aInstance, false ), false );
409  }
410  else if( m_matchById )
411  {
412  id.Parse( m_specifiedId->GetValue() );
413  return aSymbol->GetLibId() == id;
414  }
415 
416  return false;
417 }
Schematic editor (Eeschema) main window.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Definition: sch_symbol.cpp:588
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:499
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:189
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:427

References SCH_COMPONENT::GetLibId(), SCH_COMPONENT::GetRef(), SCH_COMPONENT::GetValue(), DIALOG_CHANGE_SYMBOLS_BASE::m_matchAll, DIALOG_CHANGE_SYMBOLS_BASE::m_matchById, DIALOG_CHANGE_SYMBOLS_BASE::m_matchByReference, DIALOG_CHANGE_SYMBOLS_BASE::m_matchBySelection, DIALOG_CHANGE_SYMBOLS_BASE::m_matchByValue, DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedId, DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedReference, DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedValue, m_symbol, and WildCompareString().

Referenced by processMatchingSymbols(), and updateFieldsList().

◆ 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::BuildLIBRARY_LISTBOX(), 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(), launchMatchIdSymbolBrowser(), 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 DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ launchMatchIdSymbolBrowser()

void DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 224 of file dialog_change_symbols.cpp.

225 {
226  wxString newName = m_specifiedId->GetValue();
227 
228  KIWAY_PLAYER* frame = Kiway().Player( FRAME_SCH_VIEWER_MODAL, true );
229 
230  if( frame->ShowModal( &newName, this ) )
231  {
232  m_specifiedId->SetValue( newName );
234  }
235 
236  frame->Destroy();
237 }
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:345
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

References KIWAY_PLAYER::Destroy(), FRAME_SCH_VIEWER_MODAL, KIWAY_HOLDER::Kiway(), DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedId, KIWAY::Player(), KIWAY_PLAYER::ShowModal(), and updateFieldsList().

◆ launchNewIdSymbolBrowser()

void DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 240 of file dialog_change_symbols.cpp.

241 {
242  wxString newName = m_newId->GetValue();
243 
244  KIWAY_PLAYER* frame = Kiway().Player( FRAME_SCH_VIEWER_MODAL, true );
245 
246  if( frame->ShowModal( &newName, this ) )
247  {
248  m_newId->SetValue( newName );
250  }
251 
252  frame->Destroy();
253 }
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:345
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

References KIWAY_PLAYER::Destroy(), FRAME_SCH_VIEWER_MODAL, KIWAY_HOLDER::Kiway(), DIALOG_CHANGE_SYMBOLS_BASE::m_newId, KIWAY::Player(), KIWAY_PLAYER::ShowModal(), and updateFieldsList().

◆ 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().

◆ onMatchByAll()

void DIALOG_CHANGE_SYMBOLS::onMatchByAll ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 170 of file dialog_change_symbols.cpp.

171 {
173 }

References updateFieldsList().

◆ onMatchById()

void DIALOG_CHANGE_SYMBOLS::onMatchById ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 196 of file dialog_change_symbols.cpp.

197 {
199  m_specifiedId->SetFocus();
200 }

References DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedId, and updateFieldsList().

◆ onMatchByReference()

void DIALOG_CHANGE_SYMBOLS::onMatchByReference ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

◆ onMatchBySelected()

void DIALOG_CHANGE_SYMBOLS::onMatchBySelected ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 176 of file dialog_change_symbols.cpp.

177 {
179 }

References updateFieldsList().

◆ onMatchByValue()

void DIALOG_CHANGE_SYMBOLS::onMatchByValue ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

◆ OnMatchText()

virtual void DIALOG_CHANGE_SYMBOLS_BASE::OnMatchText ( wxCommandEvent &  event)
inlineprotectedvirtualinherited

◆ onMatchTextKillFocus()

void DIALOG_CHANGE_SYMBOLS::onMatchTextKillFocus ( wxFocusEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 203 of file dialog_change_symbols.cpp.

204 {
206 }

References updateFieldsList().

◆ onOkButtonClicked()

void DIALOG_CHANGE_SYMBOLS::onOkButtonClicked ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 353 of file dialog_change_symbols.cpp.

354 {
355  wxBusyCursor dummy;
356  SCH_EDIT_FRAME* parent = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
357 
358  wxCHECK( parent, /* void */ );
359 
361  m_messagePanel->Flush( false );
362 
363  // Create the set of fields to be updated
364  m_updateFields.clear();
365 
366  for( unsigned i = 0; i < m_fieldsBox->GetCount(); ++i )
367  {
368  if( m_fieldsBox->IsChecked( i ) )
369  m_updateFields.insert( m_fieldsBox->GetString( i ) );
370  }
371 
372  if( processMatchingSymbols() )
373  {
374  parent->TestDanglingEnds(); // This will also redraw the changed symbols.
375  parent->OnModify();
376  }
377 
378  m_messagePanel->Flush( false );
379 }
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
Schematic editor (Eeschema) main window.
std::set< wxString > m_updateFields
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
void Clear()
return the number of messages matching the given severity mask.
WX_HTML_REPORT_PANEL * m_messagePanel
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...

References WX_HTML_REPORT_PANEL::Clear(), dummy(), WX_HTML_REPORT_PANEL::Flush(), DIALOG_CHANGE_SYMBOLS_BASE::m_fieldsBox, DIALOG_CHANGE_SYMBOLS_BASE::m_messagePanel, m_updateFields, SCH_EDIT_FRAME::OnModify(), processMatchingSymbols(), and SCH_EDIT_FRAME::TestDanglingEnds().

◆ 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:56
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().

◆ onSelectAll()

void DIALOG_CHANGE_SYMBOLS::onSelectAll ( wxCommandEvent &  event)
inlineoverrideprotectedvirtual

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 57 of file dialog_change_symbols.h.

58  {
59  checkAll( true );
60  }

References checkAll().

◆ onSelectNone()

void DIALOG_CHANGE_SYMBOLS::onSelectNone ( wxCommandEvent &  event)
inlineoverrideprotectedvirtual

Select or deselect all fields in the listbox widget.

Reimplemented from DIALOG_CHANGE_SYMBOLS_BASE.

Definition at line 62 of file dialog_change_symbols.h.

References checkAll().

◆ 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:174

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::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), 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_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), 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(), SCH_EDIT_FRAME::doAutoSave(), PCB_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(), 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(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_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(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_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(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), 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_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_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ processMatchingSymbols()

bool DIALOG_CHANGE_SYMBOLS::processMatchingSymbols ( )
private

Definition at line 420 of file dialog_change_symbols.cpp.

421 {
422  SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
423 
424  wxCHECK( frame, false );
425 
426  LIB_ID newId;
427  bool appendToUndo = false;
428  bool changed = false;
429  SCH_SHEET_LIST hierarchy = frame->Schematic().GetSheets();
430 
431  if( m_mode == MODE::CHANGE )
432  {
433  newId.Parse( m_newId->GetValue() );
434 
435  if( !newId.IsValid() )
436  return false;
437  }
438 
439  for( SCH_SHEET_PATH& instance : hierarchy )
440  {
441  SCH_SCREEN* screen = instance.LastScreen();
442 
443  wxCHECK2( screen, continue );
444 
445  std::vector<SCH_COMPONENT*> components;
446 
447  for( SCH_ITEM* item : screen->Items().OfType( SCH_COMPONENT_T ) )
448  components.push_back( static_cast<SCH_COMPONENT*>( item ) );
449 
450  for( SCH_COMPONENT* symbol : components )
451  {
452  if( !isMatch( symbol, &instance ) )
453  continue;
454 
455  if( m_mode == MODE::UPDATE )
456  {
457  if( processSymbol( symbol, &instance, symbol->GetLibId(), appendToUndo ) )
458  changed = true;
459  }
460  else
461  {
462  if( processSymbol( symbol, &instance, newId, appendToUndo ) )
463  changed = true;
464  }
465 
466  if( changed )
467  appendToUndo = true;
468  }
469  }
470 
472 
473  return changed;
474 }
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:219
Schematic editor (Eeschema) main window.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void UpdateAllScreenReferences()
Update all the symbol references for this sheet path.
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:168
SCHEMATIC & Schematic() const
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:111
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
bool isMatch(SCH_COMPONENT *aSymbol, SCH_SHEET_PATH *aInstance)
EE_RTREE & Items()
Definition: sch_screen.h:162
Schematic symbol object.
Definition: sch_symbol.h:79
SCH_SHEET_PATH & GetCurrentSheet() const
MODE m_mode
Set of field names that should have values updated.
bool processSymbol(SCH_COMPONENT *aSymbol, const SCH_SHEET_PATH *aInstance, const LIB_ID &aNewId, bool aAppendToUndo)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:196

References CHANGE, SCH_EDIT_FRAME::GetCurrentSheet(), SCHEMATIC::GetSheets(), isMatch(), LIB_ID::IsValid(), SCH_SCREEN::Items(), m_mode, DIALOG_CHANGE_SYMBOLS_BASE::m_newId, EE_RTREE::OfType(), LIB_ID::Parse(), processSymbol(), SCH_COMPONENT_T, SCH_EDIT_FRAME::Schematic(), UPDATE, and SCH_SHEET_PATH::UpdateAllScreenReferences().

Referenced by onOkButtonClicked().

◆ processSymbol()

bool DIALOG_CHANGE_SYMBOLS::processSymbol ( SCH_COMPONENT aSymbol,
const SCH_SHEET_PATH aInstance,
const LIB_ID aNewId,
bool  aAppendToUndo 
)
private

Definition at line 477 of file dialog_change_symbols.cpp.

479 {
480  wxCHECK( aSymbol, false );
481  wxCHECK( aNewId.IsValid(), false );
482 
483  SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
484  SCH_SCREEN* screen = aInstance->LastScreen();
485 
486  wxCHECK( frame, false );
487 
488  LIB_ID oldId = aSymbol->GetLibId();
489  wxString msg;
490  wxString references;
491 
492  for( SYMBOL_INSTANCE_REFERENCE instance : aSymbol->GetInstanceReferences() )
493  {
494  if( references.IsEmpty() )
495  references = instance.m_Reference;
496  else
497  references += " " + instance.m_Reference;
498  }
499 
500  if( m_mode == MODE::UPDATE )
501  {
502  if( aSymbol->GetInstanceReferences().size() == 1 )
503  {
504  msg.Printf( _( "Update symbol %s from '%s' to '%s'" ),
505  references,
506  oldId.Format().c_str(),
507  aNewId.Format().c_str() );
508  }
509  else
510  {
511  msg.Printf( _( "Update symbols %s from '%s' to '%s'" ),
512  references,
513  oldId.Format().c_str(),
514  aNewId.Format().c_str() );
515  }
516  }
517  else
518  {
519  if( aSymbol->GetInstanceReferences().size() == 1 )
520  {
521  msg.Printf( _( "Change symbol %s from '%s' to '%s'" ),
522  references,
523  oldId.Format().c_str(),
524  aNewId.Format().c_str() );
525  }
526  else
527  {
528  msg.Printf( _( "Change symbols %s from '%s' to '%s'" ),
529  references,
530  oldId.Format().c_str(),
531  aNewId.Format().c_str() );
532  }
533  }
534 
535  LIB_PART* libSymbol = frame->GetLibPart( aNewId );
536 
537  if( !libSymbol )
538  {
539  msg << ": " << _( "*** symbol not found ***" );
541  return false;
542  }
543 
544  std::unique_ptr<LIB_PART> flattenedSymbol = libSymbol->Flatten();
545 
546  if( flattenedSymbol->GetUnitCount() < aSymbol->GetUnit() )
547  {
548  msg << ": " << _( "*** new symbol has too few units ***" );
550  return false;
551  }
552 
553  // Removing the symbol needs to be done before the LIB_PART is changed to prevent stale
554  // library symbols in the schematic file.
555  screen->Remove( aSymbol );
556  frame->SaveCopyInUndoList( screen, aSymbol, UNDO_REDO::CHANGED, aAppendToUndo );
557 
558  if( aNewId != aSymbol->GetLibId() )
559  aSymbol->SetLibId( aNewId );
560 
561  aSymbol->SetLibSymbol( flattenedSymbol.release() );
562 
563  if( m_resetAttributes->GetValue() )
564  {
565  aSymbol->SetIncludeInBom( libSymbol->GetIncludeInBom() );
566  aSymbol->SetIncludeOnBoard( libSymbol->GetIncludeOnBoard() );
567  }
568 
569  bool removeExtras = m_removeExtraBox->GetValue();
570  bool resetVis = m_resetFieldVisibilities->GetValue();
571  bool resetEffects = m_resetFieldEffects->GetValue();
572  bool resetPositions = m_resetFieldPositions->GetValue();
573 
574  for( unsigned i = 0; i < aSymbol->GetFields().size(); ++i )
575  {
576  SCH_FIELD& field = aSymbol->GetFields()[i];
577  LIB_FIELD* libField = nullptr;
578 
579  if( !alg::contains( m_updateFields, field.GetName() ) )
580  continue;
581 
582  if( i < MANDATORY_FIELDS )
583  libField = libSymbol->GetFieldById( (int) i );
584  else
585  libField = libSymbol->FindField( field.GetName() );
586 
587  if( libField )
588  {
589  bool resetText = libField->GetText().IsEmpty() ? m_resetEmptyFields->GetValue()
590  : m_resetFieldText->GetValue();
591 
592  if( resetText )
593  {
594  if( i == REFERENCE_FIELD )
595  aSymbol->SetRef( aInstance, libField->GetText() );
596  else if( i == VALUE_FIELD )
597  aSymbol->SetValue( aInstance, libField->GetText() );
598  else if( i == FOOTPRINT_FIELD )
599  aSymbol->SetFootprint( aInstance, libField->GetText() );
600  else
601  field.SetText( libField->GetText() );
602  }
603 
604  if( resetVis )
605  field.SetVisible( libField->IsVisible() );
606 
607  if( resetEffects )
608  {
609  // Careful: the visible bit and position are also in Effects
610  bool visible = field.IsVisible();
611  wxPoint pos = field.GetPosition();
612 
613  field.SetEffects( *libField );
614 
615  field.SetVisible( visible );
616  field.SetPosition( pos );
617  }
618 
619  if( resetPositions )
620  field.SetTextPos( aSymbol->GetPosition() + libField->GetTextPos() );
621  }
622  else if( i >= MANDATORY_FIELDS && removeExtras )
623  {
624  aSymbol->RemoveField( field.GetName() );
625  i--;
626  }
627  }
628 
629  std::vector<LIB_FIELD*> libFields;
630  libSymbol->GetFields( libFields );
631 
632  for( unsigned i = MANDATORY_FIELDS; i < libFields.size(); ++i )
633  {
634  const LIB_FIELD& libField = *libFields[i];
635 
636  if( !alg::contains( m_updateFields, libField.GetName() ) )
637  continue;
638 
639  if( !aSymbol->FindField( libField.GetName(), false ) )
640  {
641  wxString fieldName = libField.GetCanonicalName();
642  SCH_FIELD newField( wxPoint( 0, 0), aSymbol->GetFieldCount(), aSymbol, fieldName );
643  SCH_FIELD* schField = aSymbol->AddField( newField );
644 
645  schField->SetEffects( libField );
646  schField->SetText( libField.GetText() );
647  schField->SetTextPos( aSymbol->GetPosition() + libField.GetTextPos() );
648  }
649  }
650 
651  aSymbol->SetSchSymbolLibraryName( wxEmptyString );
652  screen->Append( aSymbol );
653  frame->GetCanvas()->GetView()->Update( aSymbol );
654 
655  msg += ": OK";
657 
658  return true;
659 }
Field Reference of part, i.e. "IC21".
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true)
Search for a SCH_FIELD with aFieldName.
Definition: sch_symbol.cpp:756
bool Remove(SCH_ITEM *aItem)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:243
void SetLibSymbol(LIB_PART *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
Definition: sch_symbol.cpp:243
void SetLibId(const LIB_ID &aName)
Definition: sch_symbol.cpp:224
void SetIncludeInBom(bool aIncludeInBom)
Definition: sch_symbol.h:700
bool IsVisible() const
Definition: eda_text.h:193
void SetEffects(const EDA_TEXT &aSrc)
Set the text effects from another instance.
Definition: eda_text.cpp:137
wxPoint GetPosition() const override
Definition: sch_field.cpp:671
Field object used in symbol libraries.
Definition: lib_field.h:59
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
void SetVisible(bool aVisible)
Definition: eda_text.h:192
Schematic editor (Eeschema) main window.
void SetSchSymbolLibraryName(const wxString &aName)
The name of the symbol in the schematic library symbol list.
Definition: sch_symbol.h:202
void SetIncludeOnBoard(bool aIncludeOnBoard)
Definition: sch_symbol.h:703
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
wxString GetName(bool aUseDefaultName=true) const
Returns the field name.
Definition: lib_field.cpp:364
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:724
const char * c_str() const
Definition: utf8.h:102
std::set< wxString > m_updateFields
int GetUnit() const
Definition: sch_symbol.h:237
LIB_FIELD * FindField(const wxString &aFieldName)
Find a field within this part matching aFieldName and returns it or NULL if not found.
Definition: lib_symbol.cpp:953
Field Value of part, i.e. "3.3K".
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
Definition: lib_field.cpp:373
Define a library symbol object.
Definition: lib_symbol.h:93
SCH_FIELD * AddField(const SCH_FIELD &aField)
Add a field to the symbol.
Definition: sch_symbol.cpp:734
A simple container for schematic symbol instance information.
void GetFields(std::vector< LIB_FIELD * > &aList)
Return a list of fields within this part.
Definition: lib_symbol.cpp:905
std::unique_ptr< LIB_PART > Flatten() const
Return a flattened symbol inheritance to the caller.
Definition: lib_symbol.cpp:334
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
int GetFieldCount() const
Return the number of fields in this symbol.
Definition: sch_symbol.h:458
UTF8 Format() const
Definition: lib_id.cpp:233
void Report(const wxString &aText, SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
Reports the string.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
Definition: sch_symbol.cpp:477
SCH_SCREEN * LastScreen()
void Append(SCH_ITEM *aItem)
Definition: sch_screen.cpp:127
WX_HTML_REPORT_PANEL * m_messagePanel
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:505
wxPoint GetPosition() const override
Definition: sch_symbol.h:681
bool GetIncludeOnBoard() const
Definition: lib_symbol.h:587
void RemoveField(const wxString &aFieldName)
Removes a user field from the symbol.
Definition: sch_symbol.cpp:743
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
MODE m_mode
Set of field names that should have values updated.
void SetValue(const SCH_SHEET_PATH *sheet, const wxString &aValue)
Definition: sch_symbol.cpp:609
const std::vector< SYMBOL_INSTANCE_REFERENCE > & GetInstanceReferences()
Definition: sch_symbol.h:165
bool GetIncludeInBom() const
Definition: lib_symbol.h:579
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:189
void SetPosition(const wxPoint &aPosition) override
Definition: sch_field.cpp:650
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
void SetFootprint(const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
Definition: sch_symbol.cpp:659
Field Name Module PCB, i.e. "16DIP300".

References _, SCH_COMPONENT::AddField(), SCH_SCREEN::Append(), UTF8::c_str(), CHANGED, alg::contains(), LIB_PART::FindField(), SCH_COMPONENT::FindField(), LIB_PART::Flatten(), FOOTPRINT_FIELD, LIB_ID::Format(), LIB_FIELD::GetCanonicalName(), LIB_PART::GetFieldById(), SCH_COMPONENT::GetFieldCount(), LIB_PART::GetFields(), SCH_COMPONENT::GetFields(), LIB_PART::GetIncludeInBom(), LIB_PART::GetIncludeOnBoard(), SCH_COMPONENT::GetInstanceReferences(), SCH_COMPONENT::GetLibId(), SCH_FIELD::GetName(), LIB_FIELD::GetName(), SCH_FIELD::GetPosition(), SCH_COMPONENT::GetPosition(), EDA_TEXT::GetText(), EDA_TEXT::GetTextPos(), SCH_COMPONENT::GetUnit(), LIB_ID::IsValid(), EDA_TEXT::IsVisible(), SCH_SHEET_PATH::LastScreen(), DIALOG_CHANGE_SYMBOLS_BASE::m_messagePanel, m_mode, DIALOG_CHANGE_SYMBOLS_BASE::m_removeExtraBox, DIALOG_CHANGE_SYMBOLS_BASE::m_resetAttributes, DIALOG_CHANGE_SYMBOLS_BASE::m_resetEmptyFields, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldEffects, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldPositions, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldText, DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldVisibilities, m_updateFields, MANDATORY_FIELDS, REFERENCE_FIELD, SCH_SCREEN::Remove(), SCH_COMPONENT::RemoveField(), WX_HTML_REPORT_PANEL::Report(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, EDA_TEXT::SetEffects(), SCH_COMPONENT::SetFootprint(), SCH_COMPONENT::SetIncludeInBom(), SCH_COMPONENT::SetIncludeOnBoard(), SCH_COMPONENT::SetLibId(), SCH_COMPONENT::SetLibSymbol(), SCH_FIELD::SetPosition(), SCH_COMPONENT::SetRef(), SCH_COMPONENT::SetSchSymbolLibraryName(), EDA_TEXT::SetText(), EDA_TEXT::SetTextPos(), SCH_COMPONENT::SetValue(), EDA_TEXT::SetVisible(), UPDATE, and VALUE_FIELD.

Referenced by processMatchingSymbols().

◆ 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_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), 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_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(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::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:50

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_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().

◆ updateFieldsList()

void DIALOG_CHANGE_SYMBOLS::updateFieldsList ( )
private

Definition at line 256 of file dialog_change_symbols.cpp.

257 {
258  SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
259 
260  wxCHECK( frame, /* void */ );
261 
262  SCH_SHEET_LIST hierarchy = frame->Schematic().GetSheets();
263 
264  // Load non-mandatory fields from all matching symbols and their library parts
265  std::vector<SCH_FIELD*> fields;
266  std::vector<LIB_FIELD*> libFields;
267  std::set<wxString> fieldNames;
268 
269  for( SCH_SHEET_PATH& instance : hierarchy )
270  {
271  SCH_SCREEN* screen = instance.LastScreen();
272 
273  wxCHECK2( screen, continue );
274 
275  for( SCH_ITEM* item : screen->Items().OfType( SCH_COMPONENT_T ) )
276  {
277  SCH_COMPONENT* symbol = dynamic_cast<SCH_COMPONENT*>( item );
278 
279  wxCHECK2( symbol, continue );
280 
281  if( !isMatch( symbol, &instance ) )
282  continue;
283 
284  fields.clear();
285  symbol->GetFields( fields, false );
286 
287  for( unsigned i = MANDATORY_FIELDS; i < fields.size(); ++i )
288  fieldNames.insert( fields[i]->GetName() );
289 
290  if( m_mode == MODE::UPDATE && symbol->GetLibId().IsValid() )
291  {
292  LIB_PART* libSymbol = frame->GetLibPart( symbol->GetLibId() );
293 
294  if( libSymbol )
295  {
296  std::unique_ptr<LIB_PART> flattenedPart = libSymbol->Flatten();
297 
298  flattenedPart->GetFields( libFields );
299 
300  for( unsigned i = MANDATORY_FIELDS; i < libFields.size(); ++i )
301  fieldNames.insert( libFields[i]->GetName() );
302 
303  libFields.clear(); // flattenedPart is about to go out of scope...
304  }
305  }
306  }
307  }
308 
309  // Load non-mandatory fields from the change-to library part
310  if( m_mode == MODE::CHANGE )
311  {
312  LIB_ID newId;
313 
314  newId.Parse( m_newId->GetValue() );
315 
316  if( newId.IsValid() )
317  {
318  LIB_PART* libSymbol = frame->GetLibPart( newId );
319 
320  if( libSymbol )
321  {
322  std::unique_ptr<LIB_PART> flattenedPart = libSymbol->Flatten();
323 
324  flattenedPart->GetFields( libFields );
325 
326  for( unsigned i = MANDATORY_FIELDS; i < libFields.size(); ++i )
327  fieldNames.insert( libFields[i]->GetName() );
328 
329  libFields.clear(); // flattenedPart is about to go out of scope...
330  }
331  }
332  }
333 
334  // Update the listbox widget
335  for( unsigned i = m_fieldsBox->GetCount() - 1; i >= MANDATORY_FIELDS; --i )
336  m_fieldsBox->Delete( i );
337 
338  for( const wxString& fieldName : fieldNames )
339  m_fieldsBox->Append( fieldName );
340 
341  for( unsigned i = MANDATORY_FIELDS; i < m_fieldsBox->GetCount(); ++i )
342  m_fieldsBox->Check( i, true );
343 }
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:219
Schematic editor (Eeschema) main window.
LIB_PART * GetLibPart(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
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
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:724
SCHEMATIC & Schematic() const
Define a library symbol object.
Definition: lib_symbol.h:93
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
std::unique_ptr< LIB_PART > Flatten() const
Return a flattened symbol inheritance to the caller.
Definition: lib_symbol.cpp:334
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:111
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
bool isMatch(SCH_COMPONENT *aSymbol, SCH_SHEET_PATH *aInstance)
EE_RTREE & Items()
Definition: sch_screen.h:162
Schematic symbol object.
Definition: sch_symbol.h:79
MODE m_mode
Set of field names that should have values updated.
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:189
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:196

References CHANGE, LIB_PART::Flatten(), SCH_COMPONENT::GetFields(), SCH_COMPONENT::GetLibId(), SCH_BASE_FRAME::GetLibPart(), SCHEMATIC::GetSheets(), isMatch(), LIB_ID::IsValid(), SCH_SCREEN::Items(), DIALOG_CHANGE_SYMBOLS_BASE::m_fieldsBox, m_mode, DIALOG_CHANGE_SYMBOLS_BASE::m_newId, MANDATORY_FIELDS, EE_RTREE::OfType(), LIB_ID::Parse(), SCH_COMPONENT_T, SCH_EDIT_FRAME::Schematic(), and UPDATE.

Referenced by DIALOG_CHANGE_SYMBOLS(), launchMatchIdSymbolBrowser(), launchNewIdSymbolBrowser(), onMatchByAll(), onMatchById(), onMatchByReference(), onMatchBySelected(), onMatchByValue(), and onMatchTextKillFocus().

◆ 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().

Member Data Documentation

◆ m_fieldsBox

wxCheckListBox* DIALOG_CHANGE_SYMBOLS_BASE::m_fieldsBox
protectedinherited

◆ 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_CHANGE_SYMBOLS_BASE::m_mainSizer
protectedinherited

◆ m_matchAll

wxRadioButton* DIALOG_CHANGE_SYMBOLS_BASE::m_matchAll
protectedinherited

◆ m_matchById

wxRadioButton* DIALOG_CHANGE_SYMBOLS_BASE::m_matchById
protectedinherited

◆ m_matchByReference

wxRadioButton* DIALOG_CHANGE_SYMBOLS_BASE::m_matchByReference
protectedinherited

◆ m_matchBySelection

wxRadioButton* DIALOG_CHANGE_SYMBOLS_BASE::m_matchBySelection
protectedinherited

◆ m_matchByValue

wxRadioButton* DIALOG_CHANGE_SYMBOLS_BASE::m_matchByValue
protectedinherited

◆ m_matchIdBrowserButton

wxBitmapButton* DIALOG_CHANGE_SYMBOLS_BASE::m_matchIdBrowserButton
protectedinherited

◆ m_matchSizer

wxGridBagSizer* DIALOG_CHANGE_SYMBOLS_BASE::m_matchSizer
protectedinherited

◆ m_messagePanel

WX_HTML_REPORT_PANEL* DIALOG_CHANGE_SYMBOLS_BASE::m_messagePanel
protectedinherited

◆ m_mode

MODE DIALOG_CHANGE_SYMBOLS::m_mode
private

Set of field names that should have values updated.

Definition at line 79 of file dialog_change_symbols.h.

Referenced by DIALOG_CHANGE_SYMBOLS(), processMatchingSymbols(), processSymbol(), updateFieldsList(), and ~DIALOG_CHANGE_SYMBOLS().

◆ m_newId

wxTextCtrl* DIALOG_CHANGE_SYMBOLS_BASE::m_newId
protectedinherited

◆ m_newIdBrowserButton

wxBitmapButton* DIALOG_CHANGE_SYMBOLS_BASE::m_newIdBrowserButton
protectedinherited

◆ m_newIdSizer

wxBoxSizer* DIALOG_CHANGE_SYMBOLS_BASE::m_newIdSizer
protectedinherited

◆ 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_CHANGE_SYMBOLS_BASE::m_removeExtraBox
protectedinherited

◆ m_resetAttributes

wxCheckBox* DIALOG_CHANGE_SYMBOLS_BASE::m_resetAttributes
protectedinherited

◆ m_resetEmptyFields

wxCheckBox* DIALOG_CHANGE_SYMBOLS_BASE::m_resetEmptyFields
protectedinherited

◆ m_resetFieldEffects

wxCheckBox* DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldEffects
protectedinherited

◆ m_resetFieldPositions

wxCheckBox* DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldPositions
protectedinherited

◆ m_resetFieldText

wxCheckBox* DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldText
protectedinherited

◆ m_resetFieldVisibilities

wxCheckBox* DIALOG_CHANGE_SYMBOLS_BASE::m_resetFieldVisibilities
protectedinherited

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_CHANGE_SYMBOLS_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_CHANGE_SYMBOLS_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_CHANGE_SYMBOLS_BASE::m_sdbSizerOK
protectedinherited

◆ m_selAllBtn

wxButton* DIALOG_CHANGE_SYMBOLS_BASE::m_selAllBtn
protectedinherited

◆ m_selNoneBtn

wxButton* DIALOG_CHANGE_SYMBOLS_BASE::m_selNoneBtn
protectedinherited

◆ m_specifiedId

wxTextCtrl* DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedId
protectedinherited

◆ m_specifiedReference

wxTextCtrl* DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedReference
protectedinherited

◆ m_specifiedValue

wxTextCtrl* DIALOG_CHANGE_SYMBOLS_BASE::m_specifiedValue
protectedinherited

◆ m_staticline1

wxStaticLine* DIALOG_CHANGE_SYMBOLS_BASE::m_staticline1
protectedinherited

◆ m_symbol

SCH_COMPONENT* DIALOG_CHANGE_SYMBOLS::m_symbol
private

Definition at line 78 of file dialog_change_symbols.h.

Referenced by DIALOG_CHANGE_SYMBOLS(), and isMatch().

◆ m_tabOrder

◆ m_units

◆ m_updateFields

std::set<wxString> DIALOG_CHANGE_SYMBOLS::m_updateFields
private

Definition at line 82 of file dialog_change_symbols.h.

Referenced by onOkButtonClicked(), and processSymbol().

◆ m_updateFieldsSizer

wxStaticBoxSizer* DIALOG_CHANGE_SYMBOLS_BASE::m_updateFieldsSizer
protectedinherited

◆ m_updateOptionsSizer

wxStaticBoxSizer* DIALOG_CHANGE_SYMBOLS_BASE::m_updateOptionsSizer
protectedinherited

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

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