Inheritance diagram for DIALOG_RESCUE_EACH:

Public Member Functions
	DIALOG_RESCUE_EACH (SCH_EDIT_FRAME *aParent, RESCUER &aRescuer, bool aAskShowAgain)
	Constructor This dialog asks the user which rescuable, cached parts he wants to rescue. More...

	~DIALOG_RESCUE_EACH ()

int	ShowQuasiModal ()

void	EndQuasiModal (int retCode)

bool	IsQuasiModal ()

bool	Show (bool show) override

bool	Enable (bool enable) override

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

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

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

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

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

Protected Attributes
wxStaticText *	m_lblInfo

wxStaticText *	m_titleSymbols

wxDataViewListCtrl *	m_ListOfConflicts

wxStaticText *	m_titleInstances

wxDataViewListCtrl *	m_ListOfInstances

wxStaticText *	m_staticText2

wxPanel *	m_componentViewOld

wxStaticText *	m_staticText3

wxPanel *	m_componentViewNew

wxButton *	m_btnNeverShowAgain

wxStdDialogButtonSizer *	m_stdButtons

wxButton *	m_stdButtonsOK

wxButton *	m_stdButtonsCancel

std::string	m_hash_key

EVENT_LOOP *	m_qmodal_loop

bool	m_qmodal_showing

WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler

Private Member Functions
bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

void	PopulateConflictList ()

void	PopulateInstanceList ()

void	OnConflictSelect (wxDataViewEvent &event) override

void	OnNeverShowClick (wxCommandEvent &event) override

void	OnCancelClick (wxCommandEvent &event) override

void	OnHandleCachePreviewRepaint (wxPaintEvent &aRepaintEvent) override

void	OnHandleLibraryPreviewRepaint (wxPaintEvent &aRepaintEvent) override

void	OnDialogResize (wxSizeEvent &aSizeEvent) override

void	renderPreview (LIB_PART aComponent, int aUnit, wxPanel panel)

Private Attributes
SCH_EDIT_FRAME *	m_Parent

wxConfigBase *	m_Config

RESCUER *	m_Rescuer

bool	m_AskShowAgain

Detailed Description

Definition at line 37 of file dialog_rescue_each.cpp.

Constructor & Destructor Documentation

DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH	(	SCH_EDIT_FRAME *	aParent,
		RESCUER &	aRescuer,
		bool	aAskShowAgain
	)

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

Any rejects will be pruned from aCandidates.

Parameters

aCaller	- the SCH_EDIT_FRAME calling this
aRescuer	- the active RESCUER instance
aAskShowAgain	- if true, a "Never Show Again" button will be included

Definition at line 72 of file dialog_rescue_each.cpp.

References Kiface(), KIFACE_I::KifaceSettings(), DIALOG_RESCUE_EACH_BASE::m_componentViewNew, DIALOG_RESCUE_EACH_BASE::m_componentViewOld, m_Config, DIALOG_RESCUE_EACH_BASE::m_lblInfo, and DIALOG_RESCUE_EACH_BASE::m_stdButtonsOK.

     : DIALOG_RESCUE_EACH_BASE( aParent ),
       m_Parent( aParent ),
       m_Rescuer( &aRescuer ),
       m_AskShowAgain( aAskShowAgain )
 {
     m_Config = Kiface().KifaceSettings();
     m_stdButtonsOK->SetDefault();
 
     // Set the info message, customized to include the proper suffix.
     wxString info_message =
         _( "It looks like this project was made using older schematic component libraries.\n"
            "Some parts may need to be relinked to a different symbol name, and some symbols\n"
            "may need to be \"rescued\" (cloned and renamed) into a new library.\n"
            "\n"
            "The following changes are recommended to update the project." );
     m_lblInfo->SetLabel( info_message );
 
     m_componentViewOld->SetLayoutDirection( wxLayout_LeftToRight );
     m_componentViewNew->SetLayoutDirection( wxLayout_LeftToRight );
 }

DIALOG_RESCUE_EACH::~DIALOG_RESCUE_EACH ( )

Definition at line 96 of file dialog_rescue_each.cpp.

97 {

98 }

Member Function Documentation

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 182 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

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

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 540 of file dialog_shim.cpp.

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

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

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

void DIALOG_SHIM::FinishDialogSettings ( )

protectedinherited

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

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

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

Definition at line 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DESIGN_RULES::DIALOG_DESIGN_RULES(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), 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_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIBEDIT_OPTIONS::DIALOG_LIBEDIT_OPTIONS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_PRETTY_LIB::DIALOG_SELECT_PRETTY_LIB(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_EDIT_ONE_FIELD::init(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_LIB_EDIT_PIN::OnInitDialog(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog(), DIALOG_TRACK_VIA_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnInitDlg(), DialogEditModuleText::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_MODULE_MODULE_EDITOR::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_MODULE_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), and DIALOG_SIGNAL_LIST::TransferDataToWindow().

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

void DIALOG_SHIM::FixOSXCancelButtonIssue ( )

protectedinherited

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

Definition at line 117 of file dialog_shim.cpp.

Referenced by DIALOG_SHIM::Show().

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

bool DIALOG_SHIM::IsQuasiModal ( )

inlineinherited

Definition at line 93 of file dialog_shim.h.

References DIALOG_SHIM::m_qmodal_showing.

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

93 { return m_qmodal_showing; }

DIALOG_SHIM::m_qmodal_showing

bool m_qmodal_showing

Definition: dialog_shim.h:132

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway.

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

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

void DIALOG_RESCUE_EACH::OnCancelClick ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 307 of file dialog_rescue_each.cpp.

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

 {
     m_Rescuer->m_chosen_candidates.clear();
     DIALOG_RESCUE_EACH_BASE::OnCancelClick( aEvent );
 }

void DIALOG_RESCUE_EACH::OnConflictSelect ( wxDataViewEvent & event )

overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 255 of file dialog_rescue_each.cpp.

References DIALOG_RESCUE_EACH_BASE::m_componentViewNew, DIALOG_RESCUE_EACH_BASE::m_componentViewOld, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, and PopulateInstanceList().

 {
     // wxformbuilder connects this event to the _dialog_, not the data view.
     // Make sure the correct item triggered it, otherwise we trigger recursively
     // and get a stack overflow.
     if( aEvent.GetEventObject() != m_ListOfConflicts )
         return;
 
     PopulateInstanceList();
 
     m_componentViewOld->Refresh();
     m_componentViewNew->Refresh();
 }

void DIALOG_RESCUE_EACH::OnDialogResize ( wxSizeEvent & aSizeEvent )

overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 207 of file dialog_rescue_each.cpp.

References DIALOG_RESCUE_EACH_BASE::OnDialogResize().

 {
     // Placeholer - I was previously doing some extra reflow here.
     DIALOG_RESCUE_EACH_BASE::OnDialogResize( aSizeEvent );
 }

void DIALOG_RESCUE_EACH::OnHandleCachePreviewRepaint ( wxPaintEvent & aRepaintEvent )

overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 179 of file dialog_rescue_each.cpp.

References RESCUE_CANDIDATE::GetCacheCandidate(), RESCUER::m_all_candidates, DIALOG_RESCUE_EACH_BASE::m_componentViewOld, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, m_Rescuer, and renderPreview().

 {
     int row = m_ListOfConflicts->GetSelectedRow();
 
     if( row == wxNOT_FOUND )
         row = 0;
 
     RESCUE_CANDIDATE& selected_part = m_Rescuer->m_all_candidates[row];
 
     if( selected_part.GetCacheCandidate() )
         renderPreview( selected_part.GetCacheCandidate(), 0, m_componentViewOld );
 }

void DIALOG_RESCUE_EACH::OnHandleLibraryPreviewRepaint ( wxPaintEvent & aRepaintEvent )

overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 193 of file dialog_rescue_each.cpp.

References RESCUE_CANDIDATE::GetLibCandidate(), RESCUER::m_all_candidates, DIALOG_RESCUE_EACH_BASE::m_componentViewNew, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, m_Rescuer, and renderPreview().

 {
     int row = m_ListOfConflicts->GetSelectedRow();
 
     if( row == wxNOT_FOUND )
         row = 0;
 
     RESCUE_CANDIDATE& selected_part = m_Rescuer->m_all_candidates[row];
 
     if( selected_part.GetLibCandidate() )
         renderPreview( selected_part.GetLibCandidate(), 0, m_componentViewNew );
 }

void DIALOG_RESCUE_EACH::OnNeverShowClick ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 288 of file dialog_rescue_each.cpp.

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

 {
     wxMessageDialog dlg( m_Parent,
                 _(  "Stop showing this tool?\n"
                     "No changes will be made.\n\n"
                     "This setting can be changed from the \"Component Libraries\" dialog,\n"
                     "and the tool can be activated manually from the \"Tools\" menu." ),
             _( "Rescue Components" ), wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
     int resp = dlg.ShowModal ();
 
     if( resp == wxID_YES )
     {
         m_Config->Write( RescueNeverShowEntry, true );
         m_Rescuer->m_chosen_candidates.clear();
         Close();
     }
 }

void DIALOG_RESCUE_EACH::PopulateConflictList ( )

private

Definition at line 126 of file dialog_rescue_each.cpp.

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

Referenced by TransferDataToWindow().

 {
     wxVector<wxVariant> data;
     for( RESCUE_CANDIDATE& each_candidate : m_Rescuer->m_all_candidates )
     {
         data.clear();
         data.push_back( wxVariant( true ) );
         data.push_back( each_candidate.GetRequestedName() );
         data.push_back( each_candidate.GetActionDescription() );
 
         m_ListOfConflicts->AppendItem( data );
     }
 
     if( !m_Rescuer->m_all_candidates.empty() )
     {
         // Select the first choice
         m_ListOfConflicts->SelectRow( 0 );
     }
 }

void DIALOG_RESCUE_EACH::PopulateInstanceList ( )

private

Definition at line 147 of file dialog_rescue_each.cpp.

References Format(), RESCUER::GetComponents(), SCH_EDIT_FRAME::GetCurrentSheet(), RESCUE_CANDIDATE::GetRequestedName(), EDA_TEXT::GetText(), RESCUER::m_all_candidates, DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts, DIALOG_RESCUE_EACH_BASE::m_ListOfInstances, m_Parent, m_Rescuer, DIALOG_RESCUE_EACH_BASE::m_titleInstances, and TO_UTF8.

Referenced by OnConflictSelect(), and TransferDataToWindow().

 {
     m_ListOfInstances->DeleteAllItems();
 
     int row = m_ListOfConflicts->GetSelectedRow();
 
     if( row == wxNOT_FOUND )
         row = 0;
 
     RESCUE_CANDIDATE& selected_part = m_Rescuer->m_all_candidates[row];
 
     wxVector<wxVariant> data;
     int count = 0;
     for( SCH_COMPONENT* each_component : *m_Rescuer->GetComponents() )
     {
         if( each_component->GetLibId().Format() != TO_UTF8( selected_part.GetRequestedName() ) )
             continue;
 
         SCH_FIELD* valueField = each_component->GetField( 1 );
 
         data.clear();
         data.push_back( each_component->GetRef( & m_Parent->GetCurrentSheet() ) );
         data.push_back( valueField ? valueField->GetText() : wxT( "" ) );
         m_ListOfInstances->AppendItem( data );
         count++;
     }
 
     m_titleInstances->SetLabelText( wxString::Format(
                     _( "Instances of this symbol (%d items):" ), count ) );
 }

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

 {
     return Kiway().Prj();
 }

void DIALOG_RESCUE_EACH::renderPreview	(	LIB_PART *	aComponent,
		int	aUnit,
		wxPanel *	panel
	)

private

Definition at line 217 of file dialog_rescue_each.cpp.

References EDA_RECT::Centre(), PART_DRAW_OPTIONS::Default(), LIB_PART::Draw(), SCH_BASE_FRAME::GetDrawBgColor(), EDA_RECT::GetHeight(), LIB_PART::GetUnitBoundingBox(), EDA_RECT::GetWidth(), m_Parent, min, and scale.

Referenced by OnHandleCachePreviewRepaint(), and OnHandleLibraryPreviewRepaint().

 {
     wxPaintDC dc( aPanel );
     wxColour bgColor = m_Parent->GetDrawBgColor().ToColour();
 
     dc.SetBackground( wxBrush( bgColor ) );
     dc.Clear();
 
     if( aComponent == NULL )
         return;
 
     if( aUnit <= 0 )
         aUnit = 1;
 
     const wxSize dc_size = dc.GetSize();
     dc.SetDeviceOrigin( dc_size.x / 2, dc_size.y / 2 );
 
     // Find joint bounding box for everything we are about to draw.
     EDA_RECT bBox = aComponent->GetUnitBoundingBox( aUnit, /* deMorganConvert */ 1 );
     const double xscale = (double) dc_size.x / bBox.GetWidth();
     const double yscale = (double) dc_size.y / bBox.GetHeight();
     const double scale  = std::min( xscale, yscale ) * 0.85;
 
     dc.SetUserScale( scale, scale );
 
     wxPoint offset = - bBox.Centre();
 
     // Avoid rendering when either dimension is zero
     int width, height;
 
     dc.GetSize( &width, &height );
     if( !width || !height )
         return;
 
     aComponent->Draw( NULL, &dc, offset, aUnit, 1, PART_DRAW_OPTIONS::Default() );
 }

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

inherited

Function SetKiway.

Parameters

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

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

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

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

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 139 of file dialog_shim.cpp.

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

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_SCH_FIND::OnCancel(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_MODULE::OnQuit(), CVPCB_MAINFRAME::ReadNetListAndLinkFiles(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

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

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 495 of file dialog_shim.cpp.

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

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

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

bool DIALOG_RESCUE_EACH::TransferDataFromWindow ( )

overrideprivate

Definition at line 270 of file dialog_rescue_each.cpp.

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

 {
     if( !wxDialog::TransferDataFromWindow() )
         return false;
 
     for( size_t index = 0; index < m_Rescuer->GetCandidateCount(); ++index )
     {
         wxVariant val;
         m_ListOfConflicts->GetValue( val, index, 0 );
         bool rescue_part = val.GetBool();
 
         if( rescue_part )
             m_Rescuer->m_chosen_candidates.push_back( &m_Rescuer->m_all_candidates[index] );
     }
     return true;
 }

bool DIALOG_RESCUE_EACH::TransferDataToWindow ( )

overrideprivate

Definition at line 101 of file dialog_rescue_each.cpp.

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

 {
     if( !wxDialog::TransferDataToWindow() )
         return false;
 
     m_ListOfConflicts->AppendToggleColumn( _( "Accept" ) );
     m_ListOfConflicts->AppendTextColumn( _( "Symbol" ) );
     m_ListOfConflicts->AppendTextColumn( _( "Action" ) );
     m_ListOfInstances->AppendTextColumn( _( "Reference" ) );
     m_ListOfInstances->AppendTextColumn( _( "Value" ) );
     PopulateConflictList();
     PopulateInstanceList();
 
     if( !m_AskShowAgain )
         m_btnNeverShowAgain->Hide();
 
     GetSizer()->Layout();
     GetSizer()->Fit( this );
     GetSizer()->SetSizeHints( this );
     Centre();
 
     return true;
 }