DIALOG_PCM Class Reference

Implementing pcm main dialog. More...

#include <dialog_pcm.h>

Inheritance diagram for DIALOG_PCM:

Classes
struct	PENDING_ACTION

Public Types
enum	HOLDER_TYPE { DIALOG, FRAME, PANEL }

Public Member Functions
	DIALOG_PCM (wxWindow *parent)
	Constructor. More...
	~DIALOG_PCM ()
	Closes the window, asks user confirmation if there are pending actions. More...
void	OnCloseClicked (wxCommandEvent &event) override
	Opens repository management dialog, saves changes to PCM. More...
void	OnManageRepositoriesClicked (wxCommandEvent &event) override
	Discards current repo cache, fetches it anew and displays. More...
void	OnRefreshClicked (wxCommandEvent &event) override
	Opens file selection dialog and installs selected package archive. More...
void	OnInstallFromFileClicked (wxCommandEvent &event) override
	Enqueues current pending actions in PCM_TASK_MANAGER and runs the queue. More...
void	OnApplyChangesClicked (wxCommandEvent &event) override
	Discards all pending changes. More...
void	OnDiscardChangesClicked (wxCommandEvent &event) override
	Switches to another repository. More...
void	OnRepositoryChoice (wxCommandEvent &event) override
	Selects the whole row in the grid if a cell is clicked. More...
void	OnPendingActionsCellClicked (wxGridEvent &event) override
	Discards selected pending actions. More...
void	OnDiscardActionClicked (wxCommandEvent &event) override
void	SetInitialFocus (wxWindow *aWindow)
	Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
int	ShowQuasiModal ()
void	EndQuasiModal (int retCode)
bool	IsQuasiModal () const
bool	Show (bool show) override
bool	Enable (bool enable) override
void	OnPaint (wxPaintEvent &event)
void	SetPosition (const wxPoint &aNewPosition)
	Force the position of the dialog to a new position. More...
EDA_UNITS	GetUserUnits () const
HOLDER_TYPE	GetType () const
KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...
PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...
void	SetKiway (wxWindow *aDest, KIWAY *aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

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

Protected Member Functions
void	finishDialogSettings ()
	In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
void	setSizeInDU (int x, int y)
	Set the dialog to the given dimensions in "dialog units". More...
int	horizPixelsFromDU (int x) const
	Convert an integer number of dialog units to pixels, horizontally. More...
int	vertPixelsFromDU (int y) const
	Convert an integer number of dialog units to pixels, vertically. More...
void	resetSize ()
	Clear the existing dialog size and position. More...
virtual void	OnCharHook (wxKeyEvent &aEvt)

Protected Attributes
wxNotebook *	m_dialogNotebook
wxPanel *	m_panelRepository
wxChoice *	m_choiceRepository
wxButton *	m_buttonManage
wxNotebook *	m_contentNotebook
wxPanel *	m_panelInstalledHolder
wxPanel *	m_panelPending
WX_GRID *	m_gridPendingActions
wxBitmapButton *	m_discardActionButton
wxButton *	m_refreshButton
wxButton *	m_installLocalButton
wxButton *	m_applyButton
wxButton *	m_discardButton
wxButton *	m_closeButton
EDA_UNITS	m_units
std::string	m_hash_key
bool	m_useCalculatedSize
bool	m_firstPaintEvent
wxWindow *	m_initialFocusTarget
WX_EVENT_LOOP *	m_qmodal_loop
bool	m_qmodal_showing
WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler
EDA_BASE_FRAME *	m_parentFrame
std::vector< wxWindow * >	m_tabOrder
wxSize	m_initialSize

Private Types
enum	PendingActionsGridColumns { PENDING_COL_ACTION = 0, PENDING_COL_NAME, PENDING_COL_VERSION, PENDING_COL_REPOSITORY }

Private Member Functions
void	setRepositoryData (const wxString &aRepositoryId)
	Gets package data from PCM and displays it on repository tab. More...
void	setRepositoryListFromPcm ()
	Updates pending actions tab caption and content-fits the grid. More...
void	updatePendingActionsTab ()
	Gets installed packages list from PCM and displays it on installed tab. More...
void	setInstalledPackages ()
	Discards specified pending action. More...
void	discardAction (int aIndex)

Private Attributes
std::shared_ptr< PLUGIN_CONTENT_MANAGER >	m_pcm
ActionCallback	m_callback
PANEL_PACKAGES_VIEW *	m_installedPanel
std::unordered_map< PCM_PACKAGE_TYPE, PANEL_PACKAGES_VIEW * >	m_repositoryContentPanels
wxString	m_selectedRepositoryId
std::unordered_map< wxString, wxBitmap >	m_packageBitmaps
std::unordered_map< wxString, wxBitmap >	m_installedBitmaps
wxBitmap	m_defaultBitmap
std::vector< PENDING_ACTION >	m_pendingActions

Detailed Description

Implementing pcm main dialog.

Definition at line 35 of file dialog_pcm.h.

Member Enumeration Documentation

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

{ DIALOG, FRAME, PANEL };

PendingActionsGridColumns

enum DIALOG_PCM::PendingActionsGridColumns

private

Enumerator
PENDING_COL_ACTION
PENDING_COL_NAME
PENDING_COL_VERSION
PENDING_COL_REPOSITORY

Definition at line 114 of file dialog_pcm.h.

    {
        PENDING_COL_ACTION = 0,
        PENDING_COL_NAME,
        PENDING_COL_VERSION,
        PENDING_COL_REPOSITORY
    };

Constructor & Destructor Documentation

DIALOG_PCM()

DIALOG_PCM::DIALOG_PCM

(

wxWindow *

parent

)

Constructor.

Definition at line 56 of file dialog_pcm.cpp.

                                         : DIALOG_PCM_BASE( parent )
{
    m_defaultBitmap = KiBitmap( BITMAPS::icon_pcm );

    m_pcm = std::make_shared<PLUGIN_CONTENT_MANAGER>( this );

    m_gridPendingActions->PushEventHandler( new GRID_TRICKS( m_gridPendingActions ) );

    m_discardActionButton->SetBitmap( KiBitmap( BITMAPS::small_trash ) );
    m_panelPending->Layout();

    m_installedPanel = new PANEL_PACKAGES_VIEW( m_panelInstalledHolder, m_pcm );
    m_panelInstalledHolder->GetSizer()->Add( m_installedPanel, 1, wxEXPAND );
    m_panelInstalledHolder->Layout();

    for( const auto& entry : PACKAGE_TYPE_LIST )
    {
        PANEL_PACKAGES_VIEW* panel = new PANEL_PACKAGES_VIEW( m_contentNotebook, m_pcm );
        wxString msg = wxGetTranslation( std::get<1>( entry ) );
        m_contentNotebook->AddPage( panel, wxString::Format( msg, 0 ) );
        m_repositoryContentPanels.insert( { std::get<0>( entry ), panel } );
    }

    m_dialogNotebook->SetPageText( 0, wxString::Format( _( "Repository (%d)" ), 0 ) );

    m_callback = [this]( const PACKAGE_VIEW_DATA& aData, PCM_PACKAGE_ACTION aAction,
                         const wxString& aVersion )
    {
        m_gridPendingActions->Freeze();

        PCM_PACKAGE_STATE new_state;

        m_gridPendingActions->AppendRows();
        int row = m_gridPendingActions->GetNumberRows() - 1;

        m_gridPendingActions->SetCellValue( row, PENDING_COL_NAME, aData.package.name );
        m_gridPendingActions->SetCellValue( row, PENDING_COL_REPOSITORY, aData.repository_name );

        if( aAction == PPA_INSTALL )
        {
            m_gridPendingActions->SetCellValue( row, PENDING_COL_ACTION, _( "Install" ) );
            m_gridPendingActions->SetCellValue( row, PENDING_COL_VERSION, aVersion );

            m_pendingActions.emplace_back( aAction, aData.repository_id, aData.package, aVersion );

            new_state = PPS_PENDING_INSTALL;
        }
        else
        {
            m_gridPendingActions->SetCellValue( row, PENDING_COL_ACTION, _( "Uninstall" ) );
            m_gridPendingActions->SetCellValue(
                    row, PENDING_COL_VERSION,
                    m_pcm->GetInstalledPackageVersion( aData.package.identifier ) );

            m_pendingActions.emplace_back( aAction, aData.repository_id, aData.package, aVersion );

            new_state = PPS_PENDING_UNINSTALL;
        }

        m_gridPendingActions->Thaw();

        updatePendingActionsTab();

        m_installedPanel->SetPackageState( aData.package.identifier, new_state );

        for( const auto& entry : m_repositoryContentPanels )
            entry.second->SetPackageState( aData.package.identifier, new_state );
    };

    setInstalledPackages();
    updatePendingActionsTab();

    m_dialogNotebook->SetSelection( 0 );


    SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
    KICAD_SETTINGS*   app_settings = mgr.GetAppSettings<KICAD_SETTINGS>();

    m_pcm->SetRepositoryList( app_settings->m_PcmRepositories );

    setRepositoryListFromPcm();

    SetDefaultItem( m_closeButton );

    for( int col = 0; col < m_gridPendingActions->GetNumberCols(); col++ )
    {
        const wxString& heading = m_gridPendingActions->GetColLabelValue( col );
        int             headingWidth = GetTextExtent( heading ).x + 2 * GRID_CELL_MARGIN;

        // Set the minimal width to the column label size.
        m_gridPendingActions->SetColMinimalWidth( col, headingWidth );
    }
}

References _, Format(), SETTINGS_MANAGER::GetAppSettings(), GRID_CELL_MARGIN, icon_pcm, PCM_PACKAGE::identifier, KiBitmap(), m_callback, DIALOG_PCM_BASE::m_closeButton, DIALOG_PCM_BASE::m_contentNotebook, m_defaultBitmap, DIALOG_PCM_BASE::m_dialogNotebook, DIALOG_PCM_BASE::m_discardActionButton, DIALOG_PCM_BASE::m_gridPendingActions, m_installedPanel, DIALOG_PCM_BASE::m_panelInstalledHolder, DIALOG_PCM_BASE::m_panelPending, m_pcm, m_pendingActions, m_repositoryContentPanels, PCM_PACKAGE::name, PACKAGE_VIEW_DATA::package, PACKAGE_TYPE_LIST, PENDING_COL_ACTION, PENDING_COL_NAME, PENDING_COL_REPOSITORY, PENDING_COL_VERSION, Pgm(), PPA_INSTALL, PPS_PENDING_INSTALL, PPS_PENDING_UNINSTALL, PACKAGE_VIEW_DATA::repository_id, PACKAGE_VIEW_DATA::repository_name, setInstalledPackages(), PANEL_PACKAGES_VIEW::SetPackageState(), setRepositoryListFromPcm(), small_trash, and updatePendingActionsTab().

~DIALOG_PCM()

DIALOG_PCM::~DIALOG_PCM

(

)

Closes the window, asks user confirmation if there are pending actions.

Definition at line 151 of file dialog_pcm.cpp.

{
    m_gridPendingActions->PopEventHandler( true );
}

References DIALOG_PCM_BASE::m_gridPendingActions.

Member Function Documentation

discardAction()

void DIALOG_PCM::discardAction ( int  aIndex )

private

Definition at line 427 of file dialog_pcm.cpp.

{
    m_gridPendingActions->DeleteRows( aIndex );

    PENDING_ACTION action = m_pendingActions[aIndex];

    PCM_PACKAGE_STATE state =
            m_pcm->GetPackageState( action.repository_id, action.package.identifier );

    m_installedPanel->SetPackageState( action.package.identifier, state );

    for( const auto& entry : m_repositoryContentPanels )
        entry.second->SetPackageState( action.package.identifier, state );

    m_pendingActions.erase( m_pendingActions.begin() + aIndex );
}

References PCM_PACKAGE::identifier, DIALOG_PCM_BASE::m_gridPendingActions, m_installedPanel, m_pcm, m_pendingActions, m_repositoryContentPanels, DIALOG_PCM::PENDING_ACTION::package, DIALOG_PCM::PENDING_ACTION::repository_id, and PANEL_PACKAGES_VIEW::SetPackageState().

Referenced by OnDiscardActionClicked(), and OnDiscardChangesClicked().

Enable()

bool DIALOG_SHIM::Enable ( bool  enable )

overrideinherited

Definition at line 312 of file dialog_shim.cpp.

{
    // so we can do logging of this state change:
    return wxDialog::Enable( enable );
}

EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode )

inherited

Definition at line 473 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( "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 = nullptr;
    }

    delete m_qmodal_parent_disabler;
    m_qmodal_parent_disabler = nullptr;

    Show( false );
}

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

Referenced by NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )

protectedinherited

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

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 151 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 );
}

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

{ return m_type; }

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

GetUserUnits()

EDA_UNITS DIALOG_SHIM::GetUserUnits ( ) const

inlineinherited

Definition at line 119 of file dialog_shim.h.

    {
        return m_units;
    }

References DIALOG_SHIM::m_units.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_NET_INSPECTOR::formatLength(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onCellChanging(), POSITION_RELATIVE_TOOL::PositionRelative(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), DIALOG_POSITION_RELATIVE::updateDialogControls(), DIALOG_MOVE_EXACT::updateDialogControls(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), DIALOG_BOARD_STATISTICS::updateWidets(), DIALOG_ERC::writeReport(), and DIALOG_DRC::writeReport().

horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x ) const

protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 169 of file dialog_shim.cpp.

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

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

IsCtrl()

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

inlinestaticinherited

Definition at line 124 of file dialog_shim.h.

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

IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( ) const

inlineinherited

Definition at line 106 of file dialog_shim.h.

{ return m_qmodal_showing; }

References DIALOG_SHIM::m_qmodal_showing.

Referenced by DIALOG_SHIM::EndQuasiModal(), EDA_BASE_FRAME::findQuasiModalDialog(), NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

IsShiftCtrl()

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

inlinestaticinherited

Definition at line 130 of file dialog_shim.h.

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

Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 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 PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

OnApplyChangesClicked()

void DIALOG_PCM::OnApplyChangesClicked ( wxCommandEvent &  event )

overridevirtual

Discards all pending changes.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 369 of file dialog_pcm.cpp.

{
    if( m_pendingActions.size() == 0 )
        return;

    PCM_TASK_MANAGER task_manager( m_pcm );

    for( const auto& action : m_pendingActions )
    {
        if( action.action == PPA_UNINSTALL )
            task_manager.Uninstall( action.package );
        else
            task_manager.DownloadAndInstall( action.package, action.version, action.repository_id );
    }

    task_manager.RunQueue( this );

    setInstalledPackages();
    wxCommandEvent dummy;
    OnDiscardChangesClicked( dummy );

    if( !m_selectedRepositoryId.IsEmpty() )
        setRepositoryData( m_selectedRepositoryId );
}

References PCM_TASK_MANAGER::DownloadAndInstall(), dummy(), m_pcm, m_pendingActions, m_selectedRepositoryId, OnDiscardChangesClicked(), PPA_UNINSTALL, PCM_TASK_MANAGER::RunQueue(), setInstalledPackages(), setRepositoryData(), and PCM_TASK_MANAGER::Uninstall().

OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt )

protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, and HTML_MESSAGE_BOX.

Definition at line 563 of file dialog_shim.cpp.

{
    if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
    {
        if( m_parentFrame )
        {
            m_parentFrame->ToggleUserUnits();
            return;
        }
    }
    // shift-return (Mac default) or Ctrl-Return (GTK) for OK
    else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
    {
        wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
        return;
    }
    else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
    {
        wxWindow* currentWindow = wxWindow::FindFocus();
        int       currentIdx = -1;
        int       delta = aEvt.ShiftDown() ? -1 : 1;

        auto advance = [&]( int& idx )
        {
            // Wrap-around modulus
            int size = m_tabOrder.size();
            idx = ( ( idx + delta ) % size + size ) % size;
        };

        for( size_t i = 0; i < m_tabOrder.size(); ++i )
        {
            if( m_tabOrder[i] == currentWindow )
            {
                currentIdx = (int) i;
                break;
            }
        }

        if( currentIdx >= 0 )
        {
            advance( currentIdx );

            //todo: We don't currently have non-textentry dialog boxes but this will break if
            // we add them.
#ifdef __APPLE__
            while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
                advance( currentIdx );
#endif

            m_tabOrder[ currentIdx ]->SetFocus();
            return;
        }
    }

    aEvt.Skip();
}

References delta, DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

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

OnCloseClicked()

void DIALOG_PCM::OnCloseClicked ( wxCommandEvent &  event )

overridevirtual

Opens repository management dialog, saves changes to PCM.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 157 of file dialog_pcm.cpp.

{
    if( m_pendingActions.size() == 0
        || wxMessageBox( _( "Are you sure you want to close the package manager "
                            "and discard pending changes?" ),
                         _( "Plugin and Content Manager" ), wxICON_QUESTION | wxYES_NO, this )
                   == wxYES )
    {
        EndModal( wxID_OK );
    }
}

References _, and m_pendingActions.

OnDiscardActionClicked()

void DIALOG_PCM::OnDiscardActionClicked ( wxCommandEvent &  event )

overridevirtual

Reimplemented from DIALOG_PCM_BASE.

Definition at line 407 of file dialog_pcm.cpp.

{
    wxArrayInt rows = m_gridPendingActions->GetSelectedRows();

    std::sort( rows.begin(), rows.end(),
               []( const int& a, const int& b )
               {
                   return a > b;
               } );

    m_gridPendingActions->Freeze();

    for( int row : rows )
        discardAction( row );

    updatePendingActionsTab();
    m_gridPendingActions->Thaw();
}

References discardAction(), DIALOG_PCM_BASE::m_gridPendingActions, and updatePendingActionsTab().

OnDiscardChangesClicked()

void DIALOG_PCM::OnDiscardChangesClicked ( wxCommandEvent &  event )

overridevirtual

Switches to another repository.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 395 of file dialog_pcm.cpp.

{
    m_gridPendingActions->Freeze();

    for( int i = m_pendingActions.size() - 1; i >= 0; i-- )
        discardAction( i );

    updatePendingActionsTab();
    m_gridPendingActions->Thaw();
}

References discardAction(), DIALOG_PCM_BASE::m_gridPendingActions, m_pendingActions, and updatePendingActionsTab().

Referenced by OnApplyChangesClicked().

OnInstallFromFileClicked()

void DIALOG_PCM::OnInstallFromFileClicked ( wxCommandEvent &  event )

overridevirtual

Enqueues current pending actions in PCM_TASK_MANAGER and runs the queue.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 233 of file dialog_pcm.cpp.

{
    wxFileDialog open_file_dialog( this, _( "Choose package file" ), wxEmptyString, wxEmptyString,
                                   "Zip files (*.zip)|*.zip", wxFD_OPEN | wxFD_FILE_MUST_EXIST );

    if( open_file_dialog.ShowModal() == wxID_CANCEL )
        return;

    PCM_TASK_MANAGER task_manager( m_pcm );
    task_manager.InstallFromFile( this, open_file_dialog.GetPath() );

    setInstalledPackages();

    if( !m_selectedRepositoryId.IsEmpty() )
        setRepositoryData( m_selectedRepositoryId );
}

References _, PCM_TASK_MANAGER::InstallFromFile(), m_pcm, m_selectedRepositoryId, setInstalledPackages(), and setRepositoryData().

OnManageRepositoriesClicked()

void DIALOG_PCM::OnManageRepositoriesClicked ( wxCommandEvent &  event )

overridevirtual

Discards current repo cache, fetches it anew and displays.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 170 of file dialog_pcm.cpp.

{
    DIALOG_MANAGE_REPOSITORIES* dialog = new DIALOG_MANAGE_REPOSITORIES( this, m_pcm );

    STRING_PAIR_LIST  dialog_data;
    STRING_TUPLE_LIST repo_list = m_pcm->GetRepositoryList();

    for( const auto& repo : repo_list )
    {
        dialog_data.push_back( std::make_pair( std::get<1>( repo ), std::get<2>( repo ) ) );
    }

    dialog->SetData( dialog_data );

    if( dialog->ShowModal() == wxID_SAVE )
    {
        dialog_data = dialog->GetData();
        m_pcm->SetRepositoryList( dialog_data );

        SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
        KICAD_SETTINGS*   app_settings = mgr.GetAppSettings<KICAD_SETTINGS>();

        app_settings->m_PcmRepositories = std::move( dialog_data );

        setRepositoryListFromPcm();
    }

    dialog->Destroy();
}

References SETTINGS_MANAGER::GetAppSettings(), DIALOG_MANAGE_REPOSITORIES::GetData(), m_pcm, Pgm(), DIALOG_MANAGE_REPOSITORIES::SetData(), and setRepositoryListFromPcm().

OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event )

inherited

Definition at line 380 of file dialog_shim.cpp.

{
    if( m_firstPaintEvent )
    {
        KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision( this );

        selectAllInTextCtrls( GetChildren() );

        if( m_initialFocusTarget )
            KIPLATFORM::UI::ForceFocus( m_initialFocusTarget );
        else
            KIPLATFORM::UI::ForceFocus( this );     // Focus the dialog itself

        m_firstPaintEvent = false;
    }

    event.Skip();
}

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

OnPendingActionsCellClicked()

void DIALOG_PCM::OnPendingActionsCellClicked ( wxGridEvent &  event )

overridevirtual

Discards selected pending actions.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 320 of file dialog_pcm.cpp.

{
    m_gridPendingActions->ClearSelection();
    m_gridPendingActions->SelectRow( event.GetRow() );
}

References DIALOG_PCM_BASE::m_gridPendingActions.

OnRefreshClicked()

void DIALOG_PCM::OnRefreshClicked ( wxCommandEvent &  event )

overridevirtual

Opens file selection dialog and installs selected package archive.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 226 of file dialog_pcm.cpp.

{
    m_pcm->DiscardRepositoryCache( m_selectedRepositoryId );
    setRepositoryData( m_selectedRepositoryId );
}

References m_pcm, m_selectedRepositoryId, and setRepositoryData().

OnRepositoryChoice()

void DIALOG_PCM::OnRepositoryChoice ( wxCommandEvent &  event )

overridevirtual

Selects the whole row in the grid if a cell is clicked.

Reimplemented from DIALOG_PCM_BASE.

Definition at line 251 of file dialog_pcm.cpp.

{
    wxStringClientData* data = static_cast<wxStringClientData*>(
            m_choiceRepository->GetClientObject( m_choiceRepository->GetSelection() ) );

    m_selectedRepositoryId = data->GetData();

    setRepositoryData( m_selectedRepositoryId );
}

References DIALOG_PCM_BASE::m_choiceRepository, m_selectedRepositoryId, and setRepositoryData().

Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

{
    return Kiway().Prj();
}

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SIM_PLOT_FRAME::getDefaultFilename(), SIM_PLOT_FRAME::getDefaultPath(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::loadWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChange(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_EDIT_FRAME::saveSchematicFile(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

resetSize()

void DIALOG_SHIM::resetSize ( )

protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 287 of file dialog_shim.cpp.

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

    std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );

    if( it == class_map.end() )
        return;

    wxRect rect = it->second;
    rect.SetSize( wxSize( 0, 0 ) );
    class_map[ hash_key ] = rect;
}

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow )

inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 97 of file dialog_shim.h.

    {
        m_initialFocusTarget = aWindow;
    }

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

setInstalledPackages()

void DIALOG_PCM::setInstalledPackages ( )

private

Discards specified pending action.

Definition at line 341 of file dialog_pcm.cpp.

{
    m_installedPanel->ClearData();

    const std::vector<PCM_INSTALLATION_ENTRY> installed = m_pcm->GetInstalledPackages();
    std::vector<PACKAGE_VIEW_DATA>            package_list;

    m_installedBitmaps = m_pcm->GetInstalledPackageBitmaps();

    for( const auto& entry : installed )
    {
        PACKAGE_VIEW_DATA package_data( entry );

        if( m_installedBitmaps.count( package_data.package.identifier ) > 0 )
            package_data.bitmap = &m_installedBitmaps.at( package_data.package.identifier );
        else
            package_data.bitmap = &m_defaultBitmap;

        package_list.emplace_back( package_data );
    }

    m_installedPanel->SetData( package_list, m_callback );

    m_dialogNotebook->SetPageText(
            1, wxString::Format( _( "Installed (%d)" ), (int) package_list.size() ) );
}

References _, PACKAGE_VIEW_DATA::bitmap, PANEL_PACKAGES_VIEW::ClearData(), Format(), PCM_PACKAGE::identifier, m_callback, m_defaultBitmap, DIALOG_PCM_BASE::m_dialogNotebook, m_installedBitmaps, m_installedPanel, m_pcm, PACKAGE_VIEW_DATA::package, and PANEL_PACKAGES_VIEW::SetData().

Referenced by DIALOG_PCM(), OnApplyChangesClicked(), and OnInstallFromFileClicked().

SetKiway()

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

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateWindow().

Definition at line 43 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;
        ignore_unused( breakhere );
    }
#endif

    ignore_unused( aDest );

    m_kiway = aKiway;
}

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition )

inherited

Force the position of the dialog to a new position.

Parameters

aNewPosition

is the new forced position

Definition at line 190 of file dialog_shim.cpp.

{
    wxDialog::SetPosition( aNewPosition );

    // Now update the stored position:
    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();
    }

    std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );

    if( it == class_map.end() )
        return;

    wxRect rect = it->second;
    rect.SetPosition( aNewPosition );

    class_map[ hash_key ] = rect;
}

References class_map, DIALOG_SHIM::m_hash_key, and PCAD2KICAD::SetPosition().

Referenced by PCB_BASE_FRAME::SelectOneLayer().

setRepositoryData()

void DIALOG_PCM::setRepositoryData ( const wxString &  aRepositoryId )

private

Gets package data from PCM and displays it on repository tab.

Parameters

aRepositoryId

id of the repositorySets repository choice list values

Definition at line 262 of file dialog_pcm.cpp.

{
    if( m_pcm->CacheRepository( aRepositoryId ) )
    {
        for( const auto& entry : m_repositoryContentPanels )
            entry.second->ClearData();

        m_packageBitmaps = m_pcm->GetRepositoryPackageBitmaps( aRepositoryId );

        const std::vector<PCM_PACKAGE> packages = m_pcm->GetRepositoryPackages( aRepositoryId );

        std::unordered_map<PCM_PACKAGE_TYPE, std::vector<PACKAGE_VIEW_DATA>> data;

        for( const PCM_PACKAGE& pkg : packages )
        {
            PACKAGE_VIEW_DATA package_data( pkg );

            if( m_packageBitmaps.count( package_data.package.identifier ) > 0 )
                package_data.bitmap = &m_packageBitmaps.at( package_data.package.identifier );
            else
                package_data.bitmap = &m_defaultBitmap;

            package_data.state = m_pcm->GetPackageState( aRepositoryId, pkg.identifier );

            for( const auto& action : m_pendingActions )
            {
                if( action.package.identifier != pkg.identifier )
                    continue;

                if( action.action == PPA_INSTALL )
                    package_data.state = PPS_PENDING_INSTALL;
                else
                    package_data.state = PPS_PENDING_UNINSTALL;

                break;
            }

            package_data.repository_id = aRepositoryId;
            package_data.repository_name = m_choiceRepository->GetStringSelection();

            data[pkg.type].emplace_back( package_data );
        }

        for( size_t i = 0; i < PACKAGE_TYPE_LIST.size(); i++ )
        {
            PCM_PACKAGE_TYPE type = PACKAGE_TYPE_LIST[i].first;
            m_repositoryContentPanels[type]->SetData( data[type], m_callback );
            m_contentNotebook->SetPageText(
                    i, wxString::Format( wxGetTranslation( PACKAGE_TYPE_LIST[i].second ),
                                         (int) data[type].size() ) );
        }

        m_dialogNotebook->SetPageText(
                0, wxString::Format( _( "Repository (%d)" ), (int) packages.size() ) );
    }
}

References _, PACKAGE_VIEW_DATA::bitmap, Format(), PCM_PACKAGE::identifier, m_callback, DIALOG_PCM_BASE::m_choiceRepository, DIALOG_PCM_BASE::m_contentNotebook, m_defaultBitmap, DIALOG_PCM_BASE::m_dialogNotebook, m_packageBitmaps, m_pcm, m_pendingActions, m_repositoryContentPanels, PACKAGE_VIEW_DATA::package, PACKAGE_TYPE_LIST, PPA_INSTALL, PPS_PENDING_INSTALL, PPS_PENDING_UNINSTALL, PACKAGE_VIEW_DATA::repository_id, PACKAGE_VIEW_DATA::repository_name, and PACKAGE_VIEW_DATA::state.

Referenced by OnApplyChangesClicked(), OnInstallFromFileClicked(), OnRefreshClicked(), OnRepositoryChoice(), and setRepositoryListFromPcm().

setRepositoryListFromPcm()

void DIALOG_PCM::setRepositoryListFromPcm ( )

private

Updates pending actions tab caption and content-fits the grid.

Definition at line 201 of file dialog_pcm.cpp.

{
    STRING_TUPLE_LIST repositories = m_pcm->GetRepositoryList();

    m_choiceRepository->Clear();

    for( const auto& entry : repositories )
    {
        m_choiceRepository->Append( std::get<1>( entry ),
                                    new wxStringClientData( std::get<0>( entry ) ) );
    }

    if( repositories.size() > 0 )
    {
        m_choiceRepository->SetSelection( 0 );
        m_selectedRepositoryId = std::get<0>( repositories[0] );
        setRepositoryData( m_selectedRepositoryId );
    }
    else
    {
        m_selectedRepositoryId = "";
    }
}

References DIALOG_PCM_BASE::m_choiceRepository, m_pcm, m_selectedRepositoryId, and setRepositoryData().

Referenced by DIALOG_PCM(), and OnManageRepositoriesClicked().

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

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

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

Show()

bool DIALOG_SHIM::Show ( bool  show )

overrideinherited

Definition at line 219 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.
        wxRect savedDialogRect = class_map[ hash_key ];

        if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
        {
            if( m_useCalculatedSize )
            {
                SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
                         wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
            }
            else
            {
                SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
                         std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
                         std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
                         0 );
            }
        }
        else if( m_initialSize != wxDefaultSize )
            SetSize( m_initialSize );

        // 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 ] = wxRect( 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, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DRC_TOOL::CrossProbe(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 423 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 = nullptr; }   // 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() );

    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 );

    // 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.
    KIPLATFORM::UI::ReparentQuasiModal( this );

    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 DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

updatePendingActionsTab()

void DIALOG_PCM::updatePendingActionsTab ( )

private

Gets installed packages list from PCM and displays it on installed tab.

Definition at line 327 of file dialog_pcm.cpp.

{
    m_dialogNotebook->SetPageText(
            2, wxString::Format( _( "Pending (%d)" ), (int) m_pendingActions.size() ) );

    for( int col = 0; col < m_gridPendingActions->GetNumberCols(); col++ )
    {
        // Set the width to see the full contents
        m_gridPendingActions->SetColSize(
                col, m_gridPendingActions->GetVisibleWidth( col, true, true, false ) );
    }
}

References _, Format(), WX_GRID::GetVisibleWidth(), DIALOG_PCM_BASE::m_dialogNotebook, DIALOG_PCM_BASE::m_gridPendingActions, and m_pendingActions.

Referenced by DIALOG_PCM(), OnDiscardActionClicked(), and OnDiscardChangesClicked().

vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y ) const

protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 176 of file dialog_shim.cpp.

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

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

m_applyButton

wxButton* DIALOG_PCM_BASE::m_applyButton

protectedinherited

Definition at line 55 of file dialog_pcm_base.h.

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

m_buttonManage

wxButton* DIALOG_PCM_BASE::m_buttonManage

protectedinherited

Definition at line 47 of file dialog_pcm_base.h.

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

m_callback

ActionCallback DIALOG_PCM::m_callback

private

Definition at line 90 of file dialog_pcm.h.

Referenced by DIALOG_PCM(), setInstalledPackages(), and setRepositoryData().

m_choiceRepository

wxChoice* DIALOG_PCM_BASE::m_choiceRepository

protectedinherited

Definition at line 46 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM_BASE::DIALOG_PCM_BASE(), OnRepositoryChoice(), setRepositoryData(), setRepositoryListFromPcm(), and DIALOG_PCM_BASE::~DIALOG_PCM_BASE().

m_closeButton

wxButton* DIALOG_PCM_BASE::m_closeButton

protectedinherited

Definition at line 57 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM(), DIALOG_PCM_BASE::DIALOG_PCM_BASE(), and DIALOG_PCM_BASE::~DIALOG_PCM_BASE().

m_contentNotebook

wxNotebook* DIALOG_PCM_BASE::m_contentNotebook

protectedinherited

Definition at line 48 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM(), DIALOG_PCM_BASE::DIALOG_PCM_BASE(), and setRepositoryData().

m_defaultBitmap

wxBitmap DIALOG_PCM::m_defaultBitmap

private

Definition at line 96 of file dialog_pcm.h.

Referenced by DIALOG_PCM(), setInstalledPackages(), and setRepositoryData().

m_dialogNotebook

wxNotebook* DIALOG_PCM_BASE::m_dialogNotebook

protectedinherited

Definition at line 44 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM(), DIALOG_PCM_BASE::DIALOG_PCM_BASE(), setInstalledPackages(), setRepositoryData(), and updatePendingActionsTab().

m_discardActionButton

wxBitmapButton* DIALOG_PCM_BASE::m_discardActionButton

protectedinherited

Definition at line 52 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM(), DIALOG_PCM_BASE::DIALOG_PCM_BASE(), and DIALOG_PCM_BASE::~DIALOG_PCM_BASE().

m_discardButton

wxButton* DIALOG_PCM_BASE::m_discardButton

protectedinherited

Definition at line 56 of file dialog_pcm_base.h.

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

m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent

protectedinherited

Definition at line 208 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

m_gridPendingActions

WX_GRID* DIALOG_PCM_BASE::m_gridPendingActions

protectedinherited

Definition at line 51 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM(), DIALOG_PCM_BASE::DIALOG_PCM_BASE(), discardAction(), OnDiscardActionClicked(), OnDiscardChangesClicked(), OnPendingActionsCellClicked(), updatePendingActionsTab(), ~DIALOG_PCM(), and DIALOG_PCM_BASE::~DIALOG_PCM_BASE().

m_hash_key

std::string DIALOG_SHIM::m_hash_key

protectedinherited

Definition at line 199 of file dialog_shim.h.

Referenced by DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), PAGED_DIALOG::PAGED_DIALOG(), DIALOG_SHIM::resetSize(), DIALOG_SHIM::SetPosition(), DIALOG_TEXT_AND_LABEL_PROPERTIES::SetTitle(), and DIALOG_SHIM::Show().

m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget

protectedinherited

Definition at line 209 of file dialog_shim.h.

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

m_initialSize

wxSize DIALOG_SHIM::m_initialSize

protectedinherited

Definition at line 221 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

m_installedBitmaps

std::unordered_map<wxString, wxBitmap> DIALOG_PCM::m_installedBitmaps

private

Definition at line 95 of file dialog_pcm.h.

Referenced by setInstalledPackages().

m_installedPanel

PANEL_PACKAGES_VIEW* DIALOG_PCM::m_installedPanel

private

Definition at line 91 of file dialog_pcm.h.

Referenced by DIALOG_PCM(), discardAction(), and setInstalledPackages().

m_installLocalButton

wxButton* DIALOG_PCM_BASE::m_installLocalButton

protectedinherited

Definition at line 54 of file dialog_pcm_base.h.

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

m_packageBitmaps

std::unordered_map<wxString, wxBitmap> DIALOG_PCM::m_packageBitmaps

private

Definition at line 94 of file dialog_pcm.h.

Referenced by setRepositoryData().

m_panelInstalledHolder

wxPanel* DIALOG_PCM_BASE::m_panelInstalledHolder

protectedinherited

Definition at line 49 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM(), and DIALOG_PCM_BASE::DIALOG_PCM_BASE().

m_panelPending

wxPanel* DIALOG_PCM_BASE::m_panelPending

protectedinherited

Definition at line 50 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM(), and DIALOG_PCM_BASE::DIALOG_PCM_BASE().

m_panelRepository

wxPanel* DIALOG_PCM_BASE::m_panelRepository

protectedinherited

Definition at line 45 of file dialog_pcm_base.h.

Referenced by DIALOG_PCM_BASE::DIALOG_PCM_BASE().

m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame

protectedinherited

Definition at line 216 of file dialog_shim.h.

Referenced by DIALOG_ANNOTATE::InitValues(), DIALOG_SHIM::OnCharHook(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

m_pcm

std::shared_ptr<PLUGIN_CONTENT_MANAGER> DIALOG_PCM::m_pcm

private

Definition at line 89 of file dialog_pcm.h.

Referenced by DIALOG_PCM(), discardAction(), OnApplyChangesClicked(), OnInstallFromFileClicked(), OnManageRepositoriesClicked(), OnRefreshClicked(), setInstalledPackages(), setRepositoryData(), and setRepositoryListFromPcm().

m_pendingActions

std::vector<PENDING_ACTION> DIALOG_PCM::m_pendingActions

private

Definition at line 112 of file dialog_pcm.h.

Referenced by DIALOG_PCM(), discardAction(), OnApplyChangesClicked(), OnCloseClicked(), OnDiscardChangesClicked(), setRepositoryData(), and updatePendingActionsTab().

m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop

protectedinherited

Definition at line 211 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 214 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 213 of file dialog_shim.h.

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

m_refreshButton

wxButton* DIALOG_PCM_BASE::m_refreshButton

protectedinherited

Definition at line 53 of file dialog_pcm_base.h.

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

m_repositoryContentPanels

std::unordered_map<PCM_PACKAGE_TYPE, PANEL_PACKAGES_VIEW*> DIALOG_PCM::m_repositoryContentPanels

private

Definition at line 92 of file dialog_pcm.h.

Referenced by DIALOG_PCM(), discardAction(), and setRepositoryData().

m_selectedRepositoryId

wxString DIALOG_PCM::m_selectedRepositoryId

private

Definition at line 93 of file dialog_pcm.h.

Referenced by OnApplyChangesClicked(), OnInstallFromFileClicked(), OnRefreshClicked(), OnRepositoryChoice(), and setRepositoryListFromPcm().

m_tabOrder

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

protectedinherited

Definition at line 218 of file dialog_shim.h.

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

m_units

EDA_UNITS DIALOG_SHIM::m_units

protectedinherited

Definition at line 198 of file dialog_shim.h.

Referenced by DIALOG_BOARD_REANNOTATE::CoordTowxString(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_PAD_PROPERTIES::displayPrimitivesList(), DIALOG_SHIM::GetUserUnits(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), and DIALOG_NET_INSPECTOR::onUnitsChanged().

m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize

protectedinherited

Definition at line 203 of file dialog_shim.h.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_ONE_LAYER_SELECTOR::PCB_ONE_LAYER_SELECTOR(), and DIALOG_SHIM::Show().

---

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

• dialog_pcm.h
• dialog_pcm.cpp