KiCad PCB EDA Suite
DIALOG_RESCUE_EACH Class Reference
Inheritance diagram for DIALOG_RESCUE_EACH:
DIALOG_RESCUE_EACH_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_RESCUE_EACH (wxWindow *aParent, RESCUER &aRescuer, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType, bool aAskShowAgain)
 This dialog asks the user which rescuable, cached parts he wants to rescue. More...
 
 ~DIALOG_RESCUE_EACH ()
 
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 ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS_T GetUserUnits () const override
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
VTBL_ENTRY TOOL_MANAGERGetToolManager () const
 Function GetToolManager Return the tool manager instance, if any. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Member Functions

virtual void OnDialogResize (wxSizeEvent &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)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 

Protected Attributes

wxHtmlWindow * m_htmlPrompt
 
wxStaticText * m_titleSymbols
 
wxDataViewListCtrl * m_ListOfConflicts
 
wxStaticText * m_titleInstances
 
wxDataViewListCtrl * m_ListOfInstances
 
wxStaticText * m_previewOldLabel
 
wxPanel * m_previewOldPanel
 
wxBoxSizer * m_SizerOldPanel
 
wxStaticText * m_previewNewLabel
 
wxPanel * m_previewNewPanel
 
wxBoxSizer * m_SizerNewPanel
 
wxButton * m_btnNeverShowAgain
 
wxStdDialogButtonSizer * m_stdButtons
 
wxButton * m_stdButtonsOK
 
wxButton * m_stdButtonsCancel
 
EDA_UNITS_T m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void PopulateConflictList ()
 
void PopulateInstanceList ()
 
void OnConflictSelect (wxDataViewEvent &aEvent) override
 
void OnNeverShowClick (wxCommandEvent &aEvent) override
 
void OnCancelClick (wxCommandEvent &aEvent) override
 
void displayItemsInConflict ()
 

Private Attributes

SYMBOL_PREVIEW_WIDGETm_previewNewWidget
 
SYMBOL_PREVIEW_WIDGETm_previewOldWidget
 
wxConfigBase * m_Config
 
RESCUERm_Rescuer
 
SCH_SHEET_PATHm_currentSheet
 
bool m_AskShowAgain
 

Detailed Description

Definition at line 39 of file dialog_rescue_each.cpp.

Constructor & Destructor Documentation

◆ DIALOG_RESCUE_EACH()

DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH ( wxWindow *  aParent,
RESCUER aRescuer,
SCH_SHEET_PATH aCurrentSheet,
EDA_DRAW_PANEL_GAL::GAL_TYPE  aGalBackEndType,
bool  aAskShowAgain 
)

This dialog asks the user which rescuable, cached parts he wants to rescue.

Any rejects will be pruned from aCandidates.

Parameters
aParent- the SCH_EDIT_FRAME calling this
aRescuer- the active RESCUER instance
aCurrentSheetthe current sheet in the schematic editor frame
aGalBackEndTypethe current GAL type used to render symbols
aAskShowAgain- if true, a "Never Show Again" button will be included

Definition at line 80 of file dialog_rescue_each.cpp.

85  : DIALOG_RESCUE_EACH_BASE( aParent ),
86  m_Rescuer( &aRescuer ),
87  m_currentSheet( aCurrentSheet ),
88  m_AskShowAgain( aAskShowAgain )
89 {
90  wxASSERT( aCurrentSheet );
91 
93  m_SizerOldPanel->Add( m_previewOldWidget, 1, wxEXPAND | wxALL, 5 );
94 
96  m_SizerNewPanel->Add( m_previewNewWidget, 1, wxEXPAND | wxALL, 5 );
97 
99  m_stdButtonsOK->SetDefault();
100 
101  // Set the info message, customized to include the proper suffix.
102  wxString info =
103  _( "This schematic was made using older symbol libraries which may break the "
104  "schematic. Some symbols may need to be linked to a different symbol name. "
105  "Some symbols may need to be \"rescued\" (copied and renamed) into a new library.\n\n"
106  "The following changes are recommended to update the project." );
107  m_htmlPrompt->AppendToPage( info );
108 
109  // wxDataViewListCtrl seems to do a poor job of laying itself out so help it along here.
110  wxString header = _( "Accept" );
111  wxFont font = m_ListOfConflicts->GetFont();
112 
113  font.MakeBold();
114 
115  wxClientDC dc( this );
116 
117  dc.SetFont( font );
118 
119  int width = dc.GetTextExtent( header ).GetWidth();
120 
121  m_ListOfConflicts->AppendToggleColumn( header, wxDATAVIEW_CELL_ACTIVATABLE, width,
122  wxALIGN_CENTER );
123 
124  header = _( "Symbol Name" );
125  width = dc.GetTextExtent( header ).GetWidth() * 2;
126  m_ListOfConflicts->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
127 
128  header = _( "Action Taken" );
129  width = dc.GetTextExtent( header ).GetWidth() * 10;
130  m_ListOfConflicts->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
131 
132  header = _( "Reference" );
133  width = dc.GetTextExtent( header ).GetWidth() * 2;
134  m_ListOfInstances->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
135 
136  header = _( "Value" );
137  width = dc.GetTextExtent( header ).GetWidth() * 10;
138  m_ListOfInstances->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
139 
140  m_previewOldWidget->SetLayoutDirection( wxLayout_LeftToRight );
141  m_previewNewWidget->SetLayoutDirection( wxLayout_LeftToRight );
142 
143  Layout();
144  SetSizeInDU( 480, 360 );
145 
146  // Make sure the HTML window is large enough. Some fun size juggling and
147  // fudge factors here but it does seem to work pretty reliably.
148  auto info_size = m_htmlPrompt->GetTextExtent( info );
149  auto prompt_size = m_htmlPrompt->GetSize();
150  auto font_size = m_htmlPrompt->GetTextExtent( "X" );
151  auto approx_info_height = ( 2 * info_size.x / prompt_size.x ) * font_size.y;
152  m_htmlPrompt->SetSizeHints( 2 * prompt_size.x / 3, approx_info_height );
153  Layout();
154  GetSizer()->SetSizeHints( this );
155  SetSizeInDU( 480, 360 );
156  Center();
157 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:61
DIALOG_RESCUE_EACH_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Project Rescue Helper"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
SCH_SHEET_PATH * m_currentSheet
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
SYMBOL_PREVIEW_WIDGET * m_previewOldWidget
void SetSizeInDU(int x, int y)
Set the dialog to the given dimensions in "dialog units".
wxDataViewListCtrl * m_ListOfConflicts
SYMBOL_PREVIEW_WIDGET * m_previewNewWidget
wxDataViewListCtrl * m_ListOfInstances

References PCAD2KICAD::Center, Kiface(), KIFACE_I::KifaceSettings(), KIWAY_HOLDER::Kiway(), m_Config, DIALOG_RESCUE_EACH_BASE::m_htmlPrompt, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, DIALOG_RESCUE_EACH_BASE::m_ListOfInstances, DIALOG_RESCUE_EACH_BASE::m_previewNewPanel, m_previewNewWidget, DIALOG_RESCUE_EACH_BASE::m_previewOldPanel, m_previewOldWidget, DIALOG_RESCUE_EACH_BASE::m_SizerNewPanel, DIALOG_RESCUE_EACH_BASE::m_SizerOldPanel, DIALOG_RESCUE_EACH_BASE::m_stdButtonsOK, and DIALOG_SHIM::SetSizeInDU().

◆ ~DIALOG_RESCUE_EACH()

DIALOG_RESCUE_EACH::~DIALOG_RESCUE_EACH ( )

Definition at line 160 of file dialog_rescue_each.cpp.

161 {
162 }

Member Function Documentation

◆ displayItemsInConflict()

void DIALOG_RESCUE_EACH::displayItemsInConflict ( )
private

Definition at line 236 of file dialog_rescue_each.cpp.

237 {
238  int row = m_ListOfConflicts->GetSelectedRow();
239 
240  if( row < 0 )
241  {
242  m_previewOldWidget->DisplayPart( nullptr, 0 );
243  m_previewNewWidget->DisplayPart( nullptr, 0 );
244  }
245  else
246  {
247  RESCUE_CANDIDATE& selected_part = m_Rescuer->m_all_candidates[row];
248  m_previewOldWidget->DisplayPart( selected_part.GetCacheCandidate(), 0 );
249  m_previewNewWidget->DisplayPart( selected_part.GetLibCandidate(), 0 );
250  }
251 }
virtual LIB_PART * GetLibCandidate() const
Get the part the would be loaded from the libraries, if possible, or else NULL.
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
SYMBOL_PREVIEW_WIDGET * m_previewOldWidget
void DisplayPart(LIB_PART *aPart, int aUnit)
virtual LIB_PART * GetCacheCandidate() const
Get the part that can be loaded from the project cache, if possible, or else NULL.
wxDataViewListCtrl * m_ListOfConflicts
SYMBOL_PREVIEW_WIDGET * m_previewNewWidget

References SYMBOL_PREVIEW_WIDGET::DisplayPart(), RESCUE_CANDIDATE::GetCacheCandidate(), RESCUE_CANDIDATE::GetLibCandidate(), RESCUER::m_all_candidates, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, m_previewNewWidget, m_previewOldWidget, and m_Rescuer.

Referenced by OnConflictSelect(), and PopulateConflictList().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 237 of file dialog_shim.cpp.

238 {
239  // so we can do logging of this state change:
240 
241 #if 0 && defined(DEBUG)
242  const char* type_id = typeid( *this ).name();
243  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
244  fflush(0); //Needed on msys2 to immediately print the message
245 #endif
246 
247  return wxDialog::Enable( enable );
248 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 397 of file dialog_shim.cpp.

398 {
399  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
400  // handle validation in the same way as other dialogs.
401  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
402  return;
403 
404  SetReturnCode( retCode );
405 
406  if( !IsQuasiModal() )
407  {
408  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
409  return;
410  }
411 
412  if( m_qmodal_loop )
413  {
414  if( m_qmodal_loop->IsRunning() )
415  m_qmodal_loop->Exit( 0 );
416  else
417  m_qmodal_loop->ScheduleExit( 0 );
418 
419  m_qmodal_loop = NULL;
420  }
421 
424 
425  Show( false );
426 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:183
bool IsQuasiModal()
Definition: dialog_shim.h:125
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:185

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::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, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

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

Definition at line 136 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXIT::DIALOG_EXIT(), 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_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_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_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), 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_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_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), 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_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetToolManager()

TOOL_MANAGER * KIWAY_HOLDER::GetToolManager ( ) const
inherited

Function GetToolManager Return the tool manager instance, if any.

Definition at line 46 of file kiway_holder.cpp.

47 {
48  return nullptr;
49 }

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 157 of file dialog_shim.cpp.

158 {
159  wxSize sz( x, 0 );
160  return ConvertDialogToPixels( sz ).x;
161 }

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

◆ IsQuasiModal()

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 61 of file kiway_player.h.

62  {
63  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
64  return *m_kiway;
65  }
KIWAY * m_kiway
Definition: kiway_player.h:101

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), 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(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnCancelClick()

void DIALOG_RESCUE_EACH::OnCancelClick ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 304 of file dialog_rescue_each.cpp.

305 {
308 }
virtual void OnCancelClick(wxCommandEvent &event)
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates

References RESCUER::m_chosen_candidates, m_Rescuer, and DIALOG_RESCUE_EACH_BASE::OnCancelClick().

◆ OnConflictSelect()

void DIALOG_RESCUE_EACH::OnConflictSelect ( wxDataViewEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 254 of file dialog_rescue_each.cpp.

255 {
256  // wxformbuilder connects this event to the _dialog_, not the data view.
257  // Make sure the correct item triggered it, otherwise we trigger recursively
258  // and get a stack overflow.
259  if( aEvent.GetEventObject() != m_ListOfConflicts )
260  return;
261 
264 }
wxDataViewListCtrl * m_ListOfConflicts

References displayItemsInConflict(), DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, and PopulateInstanceList().

◆ OnDialogResize()

virtual void DIALOG_RESCUE_EACH_BASE::OnDialogResize ( wxSizeEvent &  event)
inlineprotectedvirtualinherited

◆ OnNeverShowClick()

void DIALOG_RESCUE_EACH::OnNeverShowClick ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 285 of file dialog_rescue_each.cpp.

286 {
287  wxMessageDialog dlg( GetParent(),
288  _( "Stop showing this tool?\n"
289  "No changes will be made.\n\n"
290  "This setting can be changed from the \"Symbol Libraries\" dialog,\n"
291  "and the tool can be activated manually from the \"Tools\" menu." ),
292  _( "Rescue Symbols" ), wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
293  int resp = dlg.ShowModal ();
294 
295  if( resp == wxID_YES )
296  {
297  m_Config->Write( RescueNeverShowEntry, true );
299  Close();
300  }
301 }
const wxChar RescueNeverShowEntry[]
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates

References RESCUER::m_chosen_candidates, m_Config, m_Rescuer, and RescueNeverShowEntry.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 298 of file dialog_shim.cpp.

299 {
300  if( m_firstPaintEvent )
301  {
302 #ifdef __WXMAC__
303  fixOSXCancelButtonIssue( this );
304 #endif
305 
306  selectAllInTextCtrls( GetChildren() );
307 
309  m_initialFocusTarget->SetFocus();
310  else
311  SetFocus(); // Focus the dialog itself
312 
313  m_firstPaintEvent = false;
314  }
315 
316  event.Skip();
317 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180
bool m_firstPaintEvent
Definition: dialog_shim.h:179
static void selectAllInTextCtrls(wxWindowList &children)

References DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ PopulateConflictList()

void DIALOG_RESCUE_EACH::PopulateConflictList ( )
private

Definition at line 180 of file dialog_rescue_each.cpp.

181 {
182  wxVector<wxVariant> data;
183  for( RESCUE_CANDIDATE& each_candidate : m_Rescuer->m_all_candidates )
184  {
185  data.clear();
186  data.push_back( wxVariant( true ) );
187  data.push_back( each_candidate.GetRequestedName() );
188  data.push_back( each_candidate.GetActionDescription() );
189 
190  m_ListOfConflicts->AppendItem( data );
191  }
192 
193  if( !m_Rescuer->m_all_candidates.empty() )
194  {
195  // Select the first choice
196  m_ListOfConflicts->SelectRow( 0 );
197  // Ensure this choice is displayed:
199  }
200 }
virtual wxString GetActionDescription() const =0
Get a description of the action proposed, for displaying in the UI.
virtual wxString GetRequestedName() const
Get the name that was originally requested in the schematic.
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
wxDataViewListCtrl * m_ListOfConflicts

References displayItemsInConflict(), RESCUE_CANDIDATE::GetActionDescription(), RESCUE_CANDIDATE::GetRequestedName(), RESCUER::m_all_candidates, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, and m_Rescuer.

Referenced by TransferDataToWindow().

◆ PopulateInstanceList()

void DIALOG_RESCUE_EACH::PopulateInstanceList ( )
private

Definition at line 203 of file dialog_rescue_each.cpp.

204 {
205  m_ListOfInstances->DeleteAllItems();
206 
207  int row = m_ListOfConflicts->GetSelectedRow();
208 
209  if( row == wxNOT_FOUND )
210  row = 0;
211 
212  RESCUE_CANDIDATE& selected_part = m_Rescuer->m_all_candidates[row];
213 
214  wxVector<wxVariant> data;
215  int count = 0;
216 
217  for( SCH_COMPONENT* each_component : *m_Rescuer->GetComponents() )
218  {
219  if( each_component->GetLibId().Format() != UTF8( selected_part.GetRequestedName() ) )
220  continue;
221 
222  SCH_FIELD* valueField = each_component->GetField( 1 );
223 
224  data.clear();
225  data.push_back( each_component->GetRef( m_currentSheet ) );
226  data.push_back( valueField ? valueField->GetText() : wxT( "" ) );
227  m_ListOfInstances->AppendItem( data );
228  count++;
229  }
230 
231  wxString msg = wxString::Format( _( "Instances of this symbol (%d items):" ), count );
232  m_titleInstances->SetLabelText( msg );
233 }
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
Definition: utf8.h:73
Class SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
const wxString GetText() const override
Function GetText returns the string associated with the text object.
Definition: sch_field.cpp:105
virtual wxString GetRequestedName() const
Get the name that was originally requested in the schematic.
SCH_SHEET_PATH * m_currentSheet
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
std::vector< SCH_COMPONENT * > * GetComponents()
Get the list of symbols that need rescued.
wxDataViewListCtrl * m_ListOfConflicts
wxDataViewListCtrl * m_ListOfInstances

References Format(), RESCUER::GetComponents(), RESCUE_CANDIDATE::GetRequestedName(), SCH_FIELD::GetText(), RESCUER::m_all_candidates, m_currentSheet, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, DIALOG_RESCUE_EACH_BASE::m_ListOfInstances, m_Rescuer, and DIALOG_RESCUE_EACH_BASE::m_titleInstances.

Referenced by OnConflictSelect(), and TransferDataToWindow().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:61
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:163

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), PCB_EDIT_FRAME::doAutoSave(), SCH_DRAWING_TOOLS::doPlaceComponent(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLoadProject(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnPrint(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunGerbview(), DIALOG_BOM::OnRunPlugin(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), KICAD_MANAGER_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::Process_Config(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::saveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ 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 116 of file dialog_shim.h.

117  {
118  m_initialFocusTarget = aWindow;
119  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), 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(), LIB_EDIT_FRAME::savePartAs(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 53 of file kiway_holder.cpp.

54 {
55 #if defined(DEBUG)
56  // offer a trap point for debugging most any window
57  wxASSERT( aDest );
58  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
59  {
60  int breakhere=1;
61  (void) breakhere;
62  }
63 #endif
64 
65  (void) aDest;
66 
67  m_kiway = aKiway;
68 }
KIWAY * m_kiway
Definition: kiway_player.h:101
const char * name
Definition: DXF_plotter.cpp:61

References KIWAY_HOLDER::m_kiway, and name.

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

◆ 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 150 of file dialog_shim.cpp.

151 {
152  wxSize sz( x, y );
153  SetSize( ConvertDialogToPixels( sz ) );
154 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), 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 178 of file dialog_shim.cpp.

179 {
180  bool ret;
181  const char* hash_key;
182 
183  if( m_hash_key.size() )
184  {
185  // a special case like EDA_LIST_DIALOG, which has multiple uses.
186  hash_key = m_hash_key.c_str();
187  }
188  else
189  {
190  hash_key = typeid(*this).name();
191  }
192 
193  // Show or hide the window. If hiding, save current position and size.
194  // If showing, use previous position and size.
195  if( show )
196  {
197 #ifndef __WINDOWS__
198  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
199 #endif
200  ret = wxDialog::Show( show );
201 
202  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
203  EDA_RECT savedDialogRect = class_map[ hash_key ];
204 
205  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
206  {
207  SetSize( savedDialogRect.GetPosition().x,
208  savedDialogRect.GetPosition().y,
209  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
210  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
211  0 );
212  }
213 
214  // Be sure that the dialog appears in a visible area
215  // (the dialog position might have been stored at the time when it was
216  // shown on another display)
217  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
218  Centre();
219  }
220  else
221  {
222  // Save the dialog's position & size before hiding, using classname as key
223  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
224 
225 #ifdef __WXMAC__
226  if ( m_eventLoop )
227  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
228 #endif
229 
230  ret = wxDialog::Show( show );
231  }
232 
233  return ret;
234 }
std::string m_hash_key
Definition: dialog_shim.h:174
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:113
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxSize GetSize() const
Definition: eda_rect.h:101

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_SCH_FIND::OnCancel(), SCH_EDIT_FRAME::OnFindItems(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickFootprints(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 343 of file dialog_shim.cpp.

344 {
345  // This is an exception safe way to zero a pointer before returning.
346  // Yes, even though DismissModal() clears this first normally, this is
347  // here in case there's an exception before the dialog is dismissed.
348  struct NULLER
349  {
350  void*& m_what;
351  NULLER( void*& aPtr ) : m_what( aPtr ) {}
352  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
353  } clear_this( (void*&) m_qmodal_loop );
354 
355  // release the mouse if it's currently captured as the window having it
356  // will be disabled when this dialog is shown -- but will still keep the
357  // capture making it impossible to do anything in the modal dialog itself
358  wxWindow* win = wxWindow::GetCapture();
359  if( win )
360  win->ReleaseMouse();
361 
362  // Get the optimal parent
363  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
364 
365  // Show the optimal parent
366  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
367 
368  wxASSERT_MSG( !m_qmodal_parent_disabler,
369  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
370 
371  // quasi-modal: disable only my "optimal" parent
373 
374 #ifdef __WXMAC__
375  // Apple in its infinite wisdom will raise a disabled window before even passing
376  // us the event, so we have no way to stop it. Instead, we must set an order on
377  // the windows so that the quasi-modal will be pushed in front of the disabled
378  // window when it is raised.
379  ReparentQuasiModal();
380 #endif
381  Show( true );
382 
383  m_qmodal_showing = true;
384 
385  WX_EVENT_LOOP event_loop;
386 
387  m_qmodal_loop = &event_loop;
388 
389  event_loop.Run();
390 
391  m_qmodal_showing = false;
392 
393  return GetReturnCode();
394 }
bool m_qmodal_showing
Definition: dialog_shim.h:184
#define WX_EVENT_LOOP
Definition: kiway_player.h:107
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:183
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:185
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
#define DBG(x)
Definition: fctsys.h:33

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

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editSymbolProperties(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDITOR_CONTROL::NavigateHierarchy(), PCB_EDIT_FRAME::OnEditTracksAndVias(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ TransferDataFromWindow()

bool DIALOG_RESCUE_EACH::TransferDataFromWindow ( )
overrideprivate

Definition at line 267 of file dialog_rescue_each.cpp.

268 {
269  if( !wxDialog::TransferDataFromWindow() )
270  return false;
271 
272  for( size_t index = 0; index < m_Rescuer->GetCandidateCount(); ++index )
273  {
274  wxVariant val;
275  m_ListOfConflicts->GetValue( val, index, 0 );
276  bool rescue_part = val.GetBool();
277 
278  if( rescue_part )
280  }
281  return true;
282 }
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
size_t GetCandidateCount()
Returen the number of rescue candidates found.
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates
wxDataViewListCtrl * m_ListOfConflicts

References RESCUER::GetCandidateCount(), RESCUER::m_all_candidates, RESCUER::m_chosen_candidates, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, and m_Rescuer.

◆ TransferDataToWindow()

bool DIALOG_RESCUE_EACH::TransferDataToWindow ( )
overrideprivate

Definition at line 165 of file dialog_rescue_each.cpp.

166 {
167  if( !wxDialog::TransferDataToWindow() )
168  return false;
169 
172 
173  if( !m_AskShowAgain )
174  m_btnNeverShowAgain->Hide();
175 
176  return true;
177 }

References m_AskShowAgain, DIALOG_RESCUE_EACH_BASE::m_btnNeverShowAgain, PopulateConflictList(), and PopulateInstanceList().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 164 of file dialog_shim.cpp.

165 {
166  wxSize sz( 0, y );
167  return ConvertDialogToPixels( sz ).y;
168 }

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

Member Data Documentation

◆ m_AskShowAgain

bool DIALOG_RESCUE_EACH::m_AskShowAgain
private

Definition at line 64 of file dialog_rescue_each.cpp.

Referenced by TransferDataToWindow().

◆ m_btnNeverShowAgain

wxButton* DIALOG_RESCUE_EACH_BASE::m_btnNeverShowAgain
protectedinherited

◆ m_Config

wxConfigBase* DIALOG_RESCUE_EACH::m_Config
private

Definition at line 61 of file dialog_rescue_each.cpp.

Referenced by DIALOG_RESCUE_EACH(), and OnNeverShowClick().

◆ m_currentSheet

SCH_SHEET_PATH* DIALOG_RESCUE_EACH::m_currentSheet
private

Definition at line 63 of file dialog_rescue_each.cpp.

Referenced by PopulateInstanceList().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 179 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_htmlPrompt

wxHtmlWindow* DIALOG_RESCUE_EACH_BASE::m_htmlPrompt
protectedinherited

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 180 of file dialog_shim.h.

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

◆ m_ListOfConflicts

◆ m_ListOfInstances

wxDataViewListCtrl* DIALOG_RESCUE_EACH_BASE::m_ListOfInstances
protectedinherited

◆ m_previewNewLabel

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_previewNewLabel
protectedinherited

◆ m_previewNewPanel

wxPanel* DIALOG_RESCUE_EACH_BASE::m_previewNewPanel
protectedinherited

◆ m_previewNewWidget

SYMBOL_PREVIEW_WIDGET* DIALOG_RESCUE_EACH::m_previewNewWidget
private

Definition at line 59 of file dialog_rescue_each.cpp.

Referenced by DIALOG_RESCUE_EACH(), and displayItemsInConflict().

◆ m_previewOldLabel

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_previewOldLabel
protectedinherited

◆ m_previewOldPanel

wxPanel* DIALOG_RESCUE_EACH_BASE::m_previewOldPanel
protectedinherited

◆ m_previewOldWidget

SYMBOL_PREVIEW_WIDGET* DIALOG_RESCUE_EACH::m_previewOldWidget
private

Definition at line 60 of file dialog_rescue_each.cpp.

Referenced by DIALOG_RESCUE_EACH(), and displayItemsInConflict().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 183 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 184 of file dialog_shim.h.

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

◆ m_Rescuer

◆ m_SizerNewPanel

wxBoxSizer* DIALOG_RESCUE_EACH_BASE::m_SizerNewPanel
protectedinherited

◆ m_SizerOldPanel

wxBoxSizer* DIALOG_RESCUE_EACH_BASE::m_SizerOldPanel
protectedinherited

◆ m_stdButtons

wxStdDialogButtonSizer* DIALOG_RESCUE_EACH_BASE::m_stdButtons
protectedinherited

◆ m_stdButtonsCancel

wxButton* DIALOG_RESCUE_EACH_BASE::m_stdButtonsCancel
protectedinherited

◆ m_stdButtonsOK

wxButton* DIALOG_RESCUE_EACH_BASE::m_stdButtonsOK
protectedinherited

◆ m_titleInstances

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_titleInstances
protectedinherited

◆ m_titleSymbols

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_titleSymbols
protectedinherited

◆ m_units


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