Inheritance diagram for DIALOG_RESCUE_EACH:

Public Member Functions
	DIALOG_RESCUE_EACH (SCH_EDIT_FRAME *aParent, RESCUER &aRescuer, bool aAskShowAgain)
	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

void	OnPaint (wxPaintEvent &event)

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
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_staticText2

wxPanel *	m_componentViewOld

wxStaticText *	m_staticText3

wxPanel *	m_componentViewNew

wxButton *	m_btnNeverShowAgain

wxStdDialogButtonSizer *	m_stdButtons

wxButton *	m_stdButtonsOK

wxButton *	m_stdButtonsCancel

bool	m_fixupsRun

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	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 36 of file dialog_rescue_each.cpp.

Constructor & Destructor Documentation

DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH	(	SCH_EDIT_FRAME *	aParent,
		RESCUER &	aRescuer,
		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
aAskShowAgain	- if true, a "Never Show Again" button will be included

Definition at line 71 of file dialog_rescue_each.cpp.

References PCAD2KICAD::Center, Kiface(), KIFACE_I::KifaceSettings(), DIALOG_RESCUE_EACH_BASE::m_componentViewNew, DIALOG_RESCUE_EACH_BASE::m_componentViewOld, 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_stdButtonsOK, and DIALOG_SHIM::SetSizeInDU().

     : 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 =
         _( "This schematic was made using older symbol libraries which may break the "
            "schematic.  Some symbols may need to be linked to a different symbol name.  "
            "Some symbols may need to be \"rescued\" (copied and renamed) into a new library.\n\n"
            "The following changes are recommended to update the project." );
     m_htmlPrompt->AppendToPage( info );
 
     // wxDataViewListCtrl seems to do a poor job of laying itself out so help it along here.
     wxString header = _( "Accept" );
     wxFont font = m_ListOfConflicts->GetFont();
 
     font.MakeBold();
 
     wxClientDC dc( this );
 
     dc.SetFont( font );
 
     int padding = 30;
     int width = dc.GetTextExtent( header ).GetWidth();
 
     m_ListOfConflicts->AppendToggleColumn( header, wxDATAVIEW_CELL_ACTIVATABLE, width,
                                            wxALIGN_CENTER );
 
     header = _( "Symbol Name" );
     width = dc.GetTextExtent( header ).GetWidth() + padding;
     m_ListOfConflicts->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
 
     header = _( "Action Taken" );
     width = dc.GetTextExtent( header ).GetWidth() + padding;
     m_ListOfConflicts->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
 
     header = _( "Reference" );
     width = dc.GetTextExtent( header ).GetWidth() + padding;
     m_ListOfInstances->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
 
     header = _( "Value" );
     width = dc.GetTextExtent( header ).GetWidth() + padding;
     m_ListOfInstances->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );
 
     m_componentViewOld->SetLayoutDirection( wxLayout_LeftToRight );
     m_componentViewNew->SetLayoutDirection( wxLayout_LeftToRight );
 
     Layout();
     SetSizeInDU( 280, 240 );
 
     // Make sure the HTML window is large enough. Some fun size juggling and
     // fudge factors here but it does seem to work pretty reliably.
     auto info_size = m_htmlPrompt->GetTextExtent( info );
     auto prompt_size = m_htmlPrompt->GetSize();
     auto font_size = m_htmlPrompt->GetTextExtent( "X" );
     auto approx_info_height = ( 2 * info_size.x / prompt_size.x ) * font_size.y;
     m_htmlPrompt->SetSizeHints( 2 * prompt_size.x / 3, approx_info_height );
     Layout();
     GetSizer()->SetSizeHints( this );
     SetSizeInDU( 280, 240 );
     Center();
 }

DIALOG_RESCUE_EACH::~DIALOG_RESCUE_EACH ( )

Definition at line 141 of file dialog_rescue_each.cpp.

142 {

143 }

Member Function Documentation

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 205 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues(), and DIALOG_SHIM::IsQuasiModal().

 {
     // 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 612 of file dialog_shim.cpp.

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

Referenced by 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_FOOTPRINTS::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;
     }
 
     if( m_qmodal_loop )
     {
         if( m_qmodal_loop->IsRunning() )
             m_qmodal_loop->Exit( 0 );
         else
             m_qmodal_loop->ScheduleExit( 0 );
 
         m_qmodal_loop = NULL;
     }
 
     delete m_qmodal_parent_disabler;
     m_qmodal_parent_disabler = 0;
 
     Show( false );
 }

void DIALOG_SHIM::FinishDialogSettings ( )

protectedinherited

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

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

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

Definition at line 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

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

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

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

 {
     wxSize sz( x, 0 );
     return ConvertDialogToPixels( sz ).x;
 }

bool DIALOG_SHIM::IsQuasiModal ( )

inlineinherited

Definition at line 103 of file dialog_shim.h.

References DIALOG_SHIM::Enable(), DIALOG_SHIM::FinishDialogSettings(), DIALOG_SHIM::HorizPixelsFromDU(), DIALOG_SHIM::m_qmodal_showing, DIALOG_SHIM::OnPaint(), DIALOG_SHIM::SetSizeInDU(), DIALOG_SHIM::Show(), and DIALOG_SHIM::VertPixelsFromDU().

Referenced by DIALOG_SHIM::EndQuasiModal(), EDA_BASE_FRAME::findQuasiModalDialog(), 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(), and DIALOG_SHIM::~DIALOG_SHIM().

103 { return m_qmodal_showing; }

DIALOG_SHIM::m_qmodal_showing

bool m_qmodal_showing

Definition: dialog_shim.h:155

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, KIWAY_HOLDER::Prj(), and KIWAY_HOLDER::SetKiway().

Referenced by SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), SCH_EDIT_FRAME::KiwayMailIn(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_WIZARD_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_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(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::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 336 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 284 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();
 }

virtual void DIALOG_RESCUE_EACH_BASE::OnDialogResize ( wxSizeEvent & event )

inlineprotectedvirtualinherited

Definition at line 54 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), and DIALOG_RESCUE_EACH_BASE::~DIALOG_RESCUE_EACH_BASE().

54 { event.Skip(); }

void DIALOG_RESCUE_EACH::OnHandleCachePreviewRepaint ( wxPaintEvent & aRepaintEvent )

overrideprivatevirtual

Reimplemented from DIALOG_RESCUE_EACH_BASE.

Definition at line 215 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 229 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 317 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 \"Symbol Libraries\" dialog,\n"
                     "and the tool can be activated manually from the \"Tools\" menu." ),
             _( "Rescue Symbols" ), 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_SHIM::OnPaint ( wxPaintEvent & event )

inherited

Definition at line 271 of file dialog_shim.cpp.

References DIALOG_SHIM::m_fixupsRun, and recursiveDescent().

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

 {
     if( !m_fixupsRun )
     {
 #if DLGSHIM_SELECT_ALL_IN_TEXT_CONTROLS
         const bool selectAllInTextCtrls = true;
 #else
         const bool selectAllInTextCtrls = false;
 #endif
         wxWindow* firstTextCtrl = NULL;
         wxWindow* windowWithFocus = NULL;
 
         recursiveDescent( GetChildren(), selectAllInTextCtrls, firstTextCtrl,
                           windowWithFocus );
 
 #if DLGSHIM_USE_SETFOCUS
         // While it would be nice to honour any focus already set (which was
         // recorded in windowWithFocus), the reality is that it's currently wrong
         // far more often than it's right.
         // So just focus on the first text control if we have one; otherwise the
         // focus on the dialog itself, which will at least allow esc, return, etc.
         // to function.
         if( firstTextCtrl )
             firstTextCtrl->SetFocus();
         else
             SetFocus();
 #endif
 
 #ifdef  __WXMAC__
         fixOSXCancelButtonIssue( this );
 #endif
 
         m_fixupsRun = true;
     }
 
     event.Skip();
 }

void DIALOG_RESCUE_EACH::PopulateConflictList ( )

private

Definition at line 161 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 182 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, and DIALOG_RESCUE_EACH_BASE::m_titleInstances.

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() != 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 246 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(), KIWAY_HOLDER::Kiway(), 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;
 }

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

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_RESCUE_EACH(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), HOTKEYS_EDITOR_DIALOG::HOTKEYS_EDITOR_DIALOG(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_SHIM::IsQuasiModal(), DIALOG_LAYERS_SETUP::OnInitDialog(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

 {
     wxSize sz( x, y );
     SetSize( ConvertDialogToPixels( sz ) );
 }

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 146 of file dialog_shim.cpp.

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

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_SHIM::IsQuasiModal(), DIALOG_SCH_FIND::OnCancel(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_FOOTPRINTS::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), SCH_COMPONENT::SetPosition(), 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 )
     {
 #ifndef __WINDOWS__
         wxDialog::Raise();  // Needed on OS X and some other window managers (i.e. Unity)
 #endif
         ret = wxDialog::Show( show );
 
         // classname is key, returns a zeroed out default EDA_RECT if none existed before.
         EDA_RECT savedDialogRect = class_map[ hash_key ];
 
         if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
         {
             SetSize( savedDialogRect.GetPosition().x,
                      savedDialogRect.GetPosition().y,
                      std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
                      std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
                      0 );
         }
 
         // Be sure that the dialog appears in a visible area
         // (the dialog position might have been stored at the time when it was
         // shown on another display)
         if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
             Centre();
     }
     else
     {
         // Save the dialog's position & size before hiding, using classname as key
         class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
 
 #ifdef __WXMAC__
         if ( m_eventLoop )
             m_eventLoop->Exit( GetReturnCode() );   // Needed for APP-MODAL dlgs on OSX
 #endif
 
         ret = wxDialog::Show( show );
     }
 
     return ret;
 }

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 558 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 SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), SCH_EDIT_FRAME::InstallHierarchyFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), 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 );
 
 #ifdef  __WXMAC__
     // Apple in its infinite wisdom will raise a disabled window before even passing
     // us the event, so we have no way to stop it.  Instead, we must set an order on
     // the windows so that the quasi-modal will be pushed in front of the disabled
     // window when it is raised.
     ReparentQuasiModal();
 #endif
     Show( true );
 
     m_qmodal_showing = true;
 
     EVENT_LOOP event_loop;
 
     m_qmodal_loop = &event_loop;
 
     event_loop.Run();
 
     m_qmodal_showing = false;
 
     return GetReturnCode();
 }

bool DIALOG_RESCUE_EACH::TransferDataFromWindow ( )

overrideprivate

Definition at line 299 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 146 of file dialog_rescue_each.cpp.

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

 {
     if( !wxDialog::TransferDataToWindow() )
         return false;
 
     PopulateConflictList();
     PopulateInstanceList();
 
     if( !m_AskShowAgain )
         m_btnNeverShowAgain->Hide();
 
     return true;
 }

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

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_SHIM::IsQuasiModal(), and DIALOG_LAYERS_SETUP::OnInitDialog().

 {
     wxSize sz( 0, y );
     return ConvertDialogToPixels( sz ).y;
 }

Member Data Documentation

bool DIALOG_RESCUE_EACH::m_AskShowAgain

private

Definition at line 56 of file dialog_rescue_each.cpp.

Referenced by TransferDataToWindow().

wxButton* DIALOG_RESCUE_EACH_BASE::m_btnNeverShowAgain

protectedinherited

Definition at line 48 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), TransferDataToWindow(), and DIALOG_RESCUE_EACH_BASE::~DIALOG_RESCUE_EACH_BASE().

wxPanel* DIALOG_RESCUE_EACH_BASE::m_componentViewNew

protectedinherited

Definition at line 47 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH(), DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), OnConflictSelect(), OnHandleLibraryPreviewRepaint(), and DIALOG_RESCUE_EACH_BASE::~DIALOG_RESCUE_EACH_BASE().

wxPanel* DIALOG_RESCUE_EACH_BASE::m_componentViewOld

protectedinherited

Definition at line 45 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH(), DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), OnConflictSelect(), OnHandleCachePreviewRepaint(), and DIALOG_RESCUE_EACH_BASE::~DIALOG_RESCUE_EACH_BASE().

wxConfigBase* DIALOG_RESCUE_EACH::m_Config

private

Definition at line 54 of file dialog_rescue_each.cpp.

Referenced by DIALOG_RESCUE_EACH(), and OnNeverShowClick().

bool DIALOG_SHIM::m_fixupsRun

protectedinherited

Definition at line 149 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

std::string DIALOG_SHIM::m_hash_key

protectedinherited

Definition at line 151 of file dialog_shim.h.

Referenced by DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), DIALOG_LABEL_EDITOR::SetTitle(), and DIALOG_SHIM::Show().

wxHtmlWindow* DIALOG_RESCUE_EACH_BASE::m_htmlPrompt

protectedinherited

Definition at line 39 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH(), and DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

wxDataViewListCtrl* DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts

protectedinherited

Definition at line 41 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH(), DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), OnConflictSelect(), OnHandleCachePreviewRepaint(), OnHandleLibraryPreviewRepaint(), PopulateConflictList(), PopulateInstanceList(), TransferDataFromWindow(), and DIALOG_RESCUE_EACH_BASE::~DIALOG_RESCUE_EACH_BASE().

wxDataViewListCtrl* DIALOG_RESCUE_EACH_BASE::m_ListOfInstances

protectedinherited

Definition at line 43 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH(), DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), and PopulateInstanceList().

SCH_EDIT_FRAME* DIALOG_RESCUE_EACH::m_Parent

private

Definition at line 53 of file dialog_rescue_each.cpp.

Referenced by OnNeverShowClick(), PopulateInstanceList(), and renderPreview().

EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop

protectedinherited

Definition at line 154 of file dialog_shim.h.

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

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler

protectedinherited

Definition at line 156 of file dialog_shim.h.

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

bool DIALOG_SHIM::m_qmodal_showing

protectedinherited

Definition at line 155 of file dialog_shim.h.

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

RESCUER* DIALOG_RESCUE_EACH::m_Rescuer

private

Definition at line 55 of file dialog_rescue_each.cpp.

Referenced by OnCancelClick(), OnHandleCachePreviewRepaint(), OnHandleLibraryPreviewRepaint(), OnNeverShowClick(), PopulateConflictList(), PopulateInstanceList(), and TransferDataFromWindow().

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_staticText2

protectedinherited

Definition at line 44 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_staticText3

protectedinherited

Definition at line 46 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

wxStdDialogButtonSizer* DIALOG_RESCUE_EACH_BASE::m_stdButtons

protectedinherited

Definition at line 49 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

wxButton* DIALOG_RESCUE_EACH_BASE::m_stdButtonsCancel

protectedinherited

Definition at line 51 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), and DIALOG_RESCUE_EACH_BASE::~DIALOG_RESCUE_EACH_BASE().

wxButton* DIALOG_RESCUE_EACH_BASE::m_stdButtonsOK

protectedinherited

Definition at line 50 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH(), and DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_titleInstances

protectedinherited

Definition at line 42 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE(), and PopulateInstanceList().

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_titleSymbols

protectedinherited

Definition at line 40 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

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

dialog_rescue_each.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation