DIALOG_RESCUE_EACH Class Reference

Inheritance diagram for DIALOG_RESCUE_EACH:

Public Types
enum	HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }

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
HOLDER_TYPE	GetType ()
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...

Static Public Member Functions
static bool	IsCtrl (int aChar, const wxKeyEvent &e)
static bool	IsShiftCtrl (int aChar, const wxKeyEvent &e)

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_LOOP *	m_qmodal_loop
bool	m_qmodal_showing
WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler
std::vector< wxWindow * >	m_tabOrder

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_WIDGET *	m_previewNewWidget
SYMBOL_PREVIEW_WIDGET *	m_previewOldWidget
wxConfigBase *	m_Config
RESCUER *	m_Rescuer
SCH_SHEET_PATH *	m_currentSheet
bool	m_AskShowAgain

Detailed Description

Definition at line 39 of file dialog_rescue_each.cpp.

Member Enumeration Documentation

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL
SCREEN

Definition at line 42 of file kiway_holder.h.

{ DIALOG, FRAME, PANEL, SCREEN };

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
aCurrentSheet	the current sheet in the schematic editor frame
aGalBackEndType	the 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.

    : DIALOG_RESCUE_EACH_BASE( aParent ),
      m_Rescuer( &aRescuer ),
      m_currentSheet( aCurrentSheet ),
      m_AskShowAgain( aAskShowAgain )
{
    wxASSERT( aCurrentSheet );

    m_previewOldWidget = new SYMBOL_PREVIEW_WIDGET( m_previewOldPanel,  Kiway(), aGalBackEndType );
    m_SizerOldPanel->Add( m_previewOldWidget, 1, wxEXPAND | wxALL, 5 );

    m_previewNewWidget = new SYMBOL_PREVIEW_WIDGET( m_previewNewPanel,  Kiway(), aGalBackEndType );
    m_SizerNewPanel->Add( m_previewNewWidget, 1, wxEXPAND | wxALL, 5 );

    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 width = dc.GetTextExtent( header ).GetWidth();

    m_ListOfConflicts->AppendToggleColumn( header, wxDATAVIEW_CELL_ACTIVATABLE, width,
                                           wxALIGN_CENTER );

    header = _( "Symbol Name" );
    width = dc.GetTextExtent( header ).GetWidth() * 2;
    m_ListOfConflicts->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );

    header = _( "Action Taken" );
    width = dc.GetTextExtent( header ).GetWidth() * 10;
    m_ListOfConflicts->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );

    header = _( "Reference" );
    width = dc.GetTextExtent( header ).GetWidth() * 2;
    m_ListOfInstances->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );

    header = _( "Value" );
    width = dc.GetTextExtent( header ).GetWidth() * 10;
    m_ListOfInstances->AppendTextColumn( header, wxDATAVIEW_CELL_INERT, width );

    m_previewOldWidget->SetLayoutDirection( wxLayout_LeftToRight );
    m_previewNewWidget->SetLayoutDirection( wxLayout_LeftToRight );

    Layout();
    SetSizeInDU( 480, 360 );

    // 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( 480, 360 );
    Center();
}

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.

{
}

Member Function Documentation

displayItemsInConflict()

void DIALOG_RESCUE_EACH::displayItemsInConflict ( )

private

Definition at line 236 of file dialog_rescue_each.cpp.

{
    int row = m_ListOfConflicts->GetSelectedRow();

    if( row < 0 )
    {
        m_previewOldWidget->DisplayPart( nullptr, 0 );
        m_previewNewWidget->DisplayPart( nullptr, 0 );
    }
    else
    {
        RESCUE_CANDIDATE& selected_part = m_Rescuer->m_all_candidates[row];
        m_previewOldWidget->DisplayPart( selected_part.GetCacheCandidate(), 0 );
        m_previewNewWidget->DisplayPart( selected_part.GetLibCandidate(), 0 );
    }
}

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

{
    // so we can do logging of this state change:

#if 0 && defined(DEBUG)
    const char* type_id = typeid( *this ).name();
    printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
    fflush(0);  //Needed on msys2 to immediately print the message
#endif

    return wxDialog::Enable( enable );
}

EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode )

inherited

Definition at line 398 of file dialog_shim.cpp.

{
    // 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 );
}

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(), HTML_MESSAGE_BOX::OnOKButtonClick(), 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 138 of file dialog_shim.cpp.

{
    // 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();
}

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_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_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_INSPECTOR::DIALOG_INSPECTOR(), 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_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), 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_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(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )

inlineinherited

Definition at line 49 of file kiway_holder.h.

{ return m_type; }

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

GetUserUnits()

EDA_UNITS_T DIALOG_SHIM::GetUserUnits ( ) const

inlineinherited

Definition at line 135 of file dialog_shim.h.

{ return m_units; }

References DIALOG_SHIM::m_units.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_ERC::DisplayERC_MarkersList(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onCellChanging(), DIALOG_NETLIST::OnTestFootprintsClick(), DIALOG_PAD_PROPERTIES::padValuesOK(), DRC::RunTests(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_ERC::TestErc(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), DIALOG_POSITION_RELATIVE::updateDialogControls(), DIALOG_MOVE_EXACT::updateDialogControls(), DIALOG_BOARD_STATISTICS::updateWidets(), and DIALOG_DRC_CONTROL::writeReport().

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

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

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

IsCtrl()

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

inlinestaticinherited

Definition at line 137 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( )

inlineinherited

Definition at line 127 of file dialog_shim.h.

{ return m_qmodal_showing; }

References DIALOG_SHIM::m_qmodal_showing.

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::EndQuasiModal(), EDA_BASE_FRAME::findQuasiModalDialog(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_SHIM::OnCloseWindow(), HTML_MESSAGE_BOX::OnOKButtonClick(), FOOTPRINT_SELECT_WIDGET::ShowPicker(), and DIALOG_SHIM::~DIALOG_SHIM().

IsShiftCtrl()

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

inlinestaticinherited

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

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

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), 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(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), 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(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), 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.

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

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.

{
    // 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();
    displayItemsInConflict();
}

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

OnDialogResize()

virtual void DIALOG_RESCUE_EACH_BASE::OnDialogResize ( wxSizeEvent &  event )

inlineprotectedvirtualinherited

Definition at line 58 of file dialog_rescue_each_base.h.

{ event.Skip(); }

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

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.

{
    wxMessageDialog dlg( GetParent(),
                _(  "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();
    }
}

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

OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event )

inherited

Definition at line 299 of file dialog_shim.cpp.

{
    if( m_firstPaintEvent )
    {
#ifdef __WXMAC__
        fixOSXCancelButtonIssue( this );
#endif

        selectAllInTextCtrls( GetChildren() );

        if( m_initialFocusTarget )
            m_initialFocusTarget->SetFocus();
        else
            SetFocus();     // Focus the dialog itself

        m_firstPaintEvent = false;
    }

    event.Skip();
}

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.

{
    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 );
        // Ensure this choice is displayed:
        displayItemsInConflict();
    }
}

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.

{
    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_currentSheet ) );
        data.push_back( valueField ? valueField->GetText() : wxT( "" ) );
        m_ListOfInstances->AppendItem( data );
        count++;
    }

    wxString msg = wxString::Format( _( "Instances of this symbol (%d items):" ), count );
    m_titleInstances->SetLabelText( msg );
}

References _, Format(), RESCUER::GetComponents(), RESCUE_CANDIDATE::GetRequestedName(), EDA_TEXT::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.

{
    return Kiway().Prj();
}

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), 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_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), 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(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), 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(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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(), DIALOG_SCH_SHEET_PROPS::OnBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), 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(), DIALOG_BOARD_STATISTICS::saveReportClicked(), 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(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), 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 118 of file dialog_shim.h.

    {
        m_initialFocusTarget = aWindow;
    }

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_FIND::DIALOG_FIND(), 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_FIND::DIALOG_SCH_FIND(), 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

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.

{
#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;
}

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

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

Referenced by 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 179 of file dialog_shim.cpp.

{
    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;
}

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_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(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 344 of file dialog_shim.cpp.

{
    // 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;

    WX_EVENT_LOOP event_loop;

    m_qmodal_loop = &event_loop;

    event_loop.Run();

    m_qmodal_showing = false;

    return GetReturnCode();
}

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 LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDITOR_CONTROL::NavigateHierarchy(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), 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.

{
    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;
}

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.

{
    if( !wxDialog::TransferDataToWindow() )
        return false;

    PopulateConflictList();
    PopulateInstanceList();

    if( !m_AskShowAgain )
        m_btnNeverShowAgain->Hide();

    return true;
}

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

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

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

Definition at line 52 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().

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

Referenced by DIALOG_SHIM::OnPaint().

m_hash_key

std::string DIALOG_SHIM::m_hash_key

protectedinherited

Definition at line 186 of file dialog_shim.h.

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

m_htmlPrompt

wxHtmlWindow* DIALOG_RESCUE_EACH_BASE::m_htmlPrompt

protectedinherited

Definition at line 41 of file dialog_rescue_each_base.h.

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

m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget

protectedinherited

Definition at line 192 of file dialog_shim.h.

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

m_ListOfConflicts

wxDataViewListCtrl* DIALOG_RESCUE_EACH_BASE::m_ListOfConflicts

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(), displayItemsInConflict(), OnConflictSelect(), PopulateConflictList(), PopulateInstanceList(), TransferDataFromWindow(), and DIALOG_RESCUE_EACH_BASE::~DIALOG_RESCUE_EACH_BASE().

m_ListOfInstances

wxDataViewListCtrl* DIALOG_RESCUE_EACH_BASE::m_ListOfInstances

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(), and PopulateInstanceList().

m_previewNewLabel

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_previewNewLabel

protectedinherited

Definition at line 49 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

m_previewNewPanel

wxPanel* DIALOG_RESCUE_EACH_BASE::m_previewNewPanel

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

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

Definition at line 46 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

m_previewOldPanel

wxPanel* DIALOG_RESCUE_EACH_BASE::m_previewOldPanel

protectedinherited

Definition at line 47 of file dialog_rescue_each_base.h.

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

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

Definition at line 197 of file dialog_shim.h.

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

m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing

protectedinherited

Definition at line 196 of file dialog_shim.h.

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

m_Rescuer

RESCUER* DIALOG_RESCUE_EACH::m_Rescuer

private

Definition at line 62 of file dialog_rescue_each.cpp.

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

m_SizerNewPanel

wxBoxSizer* DIALOG_RESCUE_EACH_BASE::m_SizerNewPanel

protectedinherited

Definition at line 51 of file dialog_rescue_each_base.h.

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

m_SizerOldPanel

wxBoxSizer* DIALOG_RESCUE_EACH_BASE::m_SizerOldPanel

protectedinherited

Definition at line 48 of file dialog_rescue_each_base.h.

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

m_stdButtons

wxStdDialogButtonSizer* DIALOG_RESCUE_EACH_BASE::m_stdButtons

protectedinherited

Definition at line 53 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

m_stdButtonsCancel

wxButton* DIALOG_RESCUE_EACH_BASE::m_stdButtonsCancel

protectedinherited

Definition at line 55 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().

m_stdButtonsOK

wxButton* DIALOG_RESCUE_EACH_BASE::m_stdButtonsOK

protectedinherited

Definition at line 54 of file dialog_rescue_each_base.h.

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

m_tabOrder

std::vector<wxWindow*> DIALOG_SHIM::m_tabOrder

protectedinherited

Definition at line 199 of file dialog_shim.h.

Referenced by DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_SHIM::OnCharHook().

m_titleInstances

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_titleInstances

protectedinherited

Definition at line 44 of file dialog_rescue_each_base.h.

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

m_titleSymbols

wxStaticText* DIALOG_RESCUE_EACH_BASE::m_titleSymbols

protectedinherited

Definition at line 42 of file dialog_rescue_each_base.h.

Referenced by DIALOG_RESCUE_EACH_BASE::DIALOG_RESCUE_EACH_BASE().

m_units

EDA_UNITS_T DIALOG_SHIM::m_units

protectedinherited

Definition at line 185 of file dialog_shim.h.

Referenced by DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_PAD_PROPERTIES::displayPrimitivesList(), and DIALOG_SHIM::GetUserUnits().

---

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

• dialog_rescue_each.cpp