KiCad PCB EDA Suite
DIALOG_CHOOSE_COMPONENT Class Reference

Dialog class to select a component from the libraries. More...

#include <dialog_choose_component.h>

Inheritance diagram for DIALOG_CHOOSE_COMPONENT:
DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_CHOOSE_COMPONENT (SCH_BASE_FRAME *aParent, const wxString &aTitle, CMP_TREE_MODEL_ADAPTER::PTR &aAdapter, int aDeMorganConvert, bool aAllowFieldEdits, bool aShowFootprints)
 Create dialog to choose component. More...
 
 ~DIALOG_CHOOSE_COMPONENT ()
 
LIB_ID GetSelectedLibId (int *aUnit=nullptr) const
 To be called after this dialog returns from ShowModal(). More...
 
std::vector< std::pair< int, wxString > > GetFields () const
 Get a list of fields edited by the user. More...
 
bool IsExternalBrowserSelected () const
 Function IsExternalBrowserSelected. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Attributes

static std::mutex g_Mutex
 

Protected Member Functions

wxPanel * ConstructRightPanel (wxWindow *aParent)
 
void OnInitDialog (wxInitDialogEvent &aEvent)
 
void OnCloseTimer (wxTimerEvent &aEvent)
 
void OnIdle (wxIdleEvent &aEvent)
 
void OnSchViewDClick (wxMouseEvent &aEvent)
 
void OnSchViewPaint (wxPaintEvent &aEvent)
 
void OnFootprintSelected (wxCommandEvent &aEvent)
 
void OnComponentPreselected (wxCommandEvent &aEvent)
 
void OnComponentSelected (wxCommandEvent &aEvent)
 Handle the selection of an item. More...
 
void ShowFootprintFor (LIB_ID const &aLibId)
 Look up the footprint for a given symbol specified in the LIB_ID and display it. More...
 
void ShowFootprint (wxString const &aFootprint)
 Display the given footprint by name. More...
 
void PopulateFootprintSelector (LIB_ID const &aLibId)
 Populate the footprint selector for a given alias. More...
 
void RenderPreview (LIB_PART *aComponent, int aUnit)
 Display a given symbol into the schematic symbol preview. More...
 
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

wxTimer * m_dbl_click_timer
 
wxPanel * m_sch_view_ctrl
 
wxSplitterWindow * m_splitter_tree_canvas
 
wxPanel * m_symbol_view_panel
 
FOOTPRINT_SELECT_WIDGETm_fp_sel_ctrl
 
FOOTPRINT_PREVIEW_WIDGETm_fp_view_ctrl
 
COMPONENT_TREEm_tree
 
SCH_BASE_FRAMEm_parent
 
int m_deMorganConvert
 
bool m_allow_field_edits
 
bool m_show_footprints
 
bool m_load_footprints
 
bool m_external_browser_requested
 
wxString m_fp_override
 
FOOTPRINT_LISTm_fp_list
 
std::vector< std::pair< int, wxString > > m_field_edits
 
bool m_fixupsRun
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Static Protected Attributes

static constexpr int DblClickDelay = 100
 
static int m_tree_canvas_sash_position = 0
 
static wxSize m_last_dlg_size
 

Detailed Description

Dialog class to select a component from the libraries.

This is the master View class in a Model-View-Adapter (mediated MVC) architecture. The other pieces are in:

Because everything is tied together in the adapter class, see that file for thorough documentation. A simple example usage follows:

// Create the adapter class
auto adapter( CMP_TREE_MODEL_ADAPTER::Create( Prj().SchSymbolLibTable() ) );

// Perform any configuration of adapter properties here
adapter->SetPreselectNode( "LIB_NICKNAME", "SYMBO_NAME", 2 );

// Initialize model from #SYMBOL_LIB_TABLE
libNicknames = libs->GetLogicalLibs();

for( auto nickname : libNicknames )
{
    adapter->AddLibrary( nickname );
}

// Create and display dialog
DIALOG_CHOOSE_COMPONENT dlg( this, title, adapter, 1 );
bool selected = ( dlg.ShowModal() != wxID_CANCEL );

// Receive part
if( selected )
{
    int unit;
    #LIB_ID id = dlg.GetSelectedAlias( &unit );
    do_something( id, unit );
}

Definition at line 88 of file dialog_choose_component.h.

Constructor & Destructor Documentation

DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT ( SCH_BASE_FRAME aParent,
const wxString &  aTitle,
CMP_TREE_MODEL_ADAPTER::PTR aAdapter,
int  aDeMorganConvert,
bool  aAllowFieldEdits,
bool  aShowFootprints 
)

Create dialog to choose component.

Parameters
aParenta SCH_BASE_FRAME parent window.
aTitleDialog title.
aAdapterCMP_TREE_MODEL_ADAPTER::PTR. See CMP_TREE_MODEL_ADAPTER for documentation.
aDeMorganConvertpreferred deMorgan conversion (TODO: should happen in dialog)
aAllowFieldEditsif false, all functions that allow the user to edit fields (currently just footprint selection) will not be available.
aShowFootprintsif false, all footprint preview and selection features are disabled. This forces aAllowFieldEdits false too.

Definition at line 54 of file dialog_choose_component.cpp.

References ALL, ConstructRightPanel(), FOOTPRINT_LIST::GetInstance(), DIALOG_SHIM::HorizPixelsFromDU(), KIWAY_HOLDER::Kiway(), m_dbl_click_timer, m_fp_list, m_fp_sel_ctrl, m_last_dlg_size, m_sch_view_ctrl, m_splitter_tree_canvas, m_symbol_view_panel, m_tree, m_tree_canvas_sash_position, OnCloseTimer(), OnComponentPreselected(), OnComponentSelected(), OnFootprintSelected(), OnIdle(), OnInitDialog(), OnSchViewDClick(), OnSchViewPaint(), KIWAY_HOLDER::Prj(), DIALOG_SHIM::SetSizeInDU(), and DIALOG_SHIM::VertPixelsFromDU().

57  : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
58  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
59  m_fp_sel_ctrl( nullptr ),
60  m_fp_view_ctrl( nullptr ),
61  m_parent( aParent ),
62  m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
63  m_allow_field_edits( aAllowFieldEdits ),
64  m_show_footprints( aShowFootprints ),
65  m_load_footprints( aShowFootprints ),
67 {
69 
70  auto sizer = new wxBoxSizer( wxVERTICAL );
71 
72  // Use a slightly different layout, with a details pane spanning the entire window,
73  // if we're not showing footprints.
74  auto vsplitter = aShowFootprints ? nullptr : new wxSplitterWindow(
75  this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_LIVE_UPDATE | wxSP_3DSASH );
76 
77  m_splitter_tree_canvas = new wxSplitterWindow(
78  vsplitter ? static_cast<wxWindow *>( vsplitter ) : static_cast<wxWindow *>( this ),
79  wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_LIVE_UPDATE | wxSP_3DSASH );
80 
81  auto details = aShowFootprints ? nullptr : new wxHtmlWindow(
82  vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxHW_SCROLLBAR_AUTO );
83 
84  m_tree = new COMPONENT_TREE( m_splitter_tree_canvas, Prj().SchSymbolLibTable(),
85  aAdapter, COMPONENT_TREE::WIDGETS::ALL, details );
87  auto buttons = new wxStdDialogButtonSizer();
88  m_dbl_click_timer = new wxTimer( this );
89 
90  if( vsplitter )
91  sizer->Add( vsplitter, 1, wxEXPAND | wxALL, 5 );
92  else
93  sizer->Add( m_splitter_tree_canvas, 1, wxEXPAND | wxALL, 5 );
94 
95  buttons->AddButton( new wxButton( this, wxID_OK ) );
96  buttons->AddButton( new wxButton( this, wxID_CANCEL ) );
97  buttons->Realize();
98 
99  sizer->Add( buttons, 0, wxEXPAND | wxBOTTOM, 10 );
100  SetSizer( sizer );
101 
102  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
103  Bind( wxEVT_IDLE, &DIALOG_CHOOSE_COMPONENT::OnIdle, this );
104  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this, m_dbl_click_timer->GetId() );
105  Bind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
106  Bind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
107 
108  m_sch_view_ctrl->Bind( wxEVT_LEFT_DCLICK, &DIALOG_CHOOSE_COMPONENT::OnSchViewDClick, this );
109  m_sch_view_ctrl->Bind( wxEVT_PAINT, &DIALOG_CHOOSE_COMPONENT::OnSchViewPaint, this );
110 
111  if( m_fp_sel_ctrl )
112  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnFootprintSelected, this );
113 
114  Layout();
115 
116  if( m_last_dlg_size == wxSize( -1, -1 ) )
117  SetSizeInDU( 320, 256 );
118  else
119  SetSize( m_last_dlg_size );
120 
121  m_splitter_tree_canvas->SetSashGravity( 0.8 );
122  m_splitter_tree_canvas->SetMinimumPaneSize( 20 );
123  // We specify the width of the right window (m_symbol_view_panel), because specify
124  // the width of the left window does not work as expected when SetSashGravity() is called
127  : HorizPixelsFromDU( -100 ) );
128 
129  if( vsplitter )
130  {
131  vsplitter->SetSashGravity( 0.5 );
132  vsplitter->SetMinimumPaneSize( 20 );
133  vsplitter->SplitHorizontally( m_splitter_tree_canvas, details, VertPixelsFromDU( -80 ) );
134  }
135 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
void OnFootprintSelected(wxCommandEvent &aEvent)
void OnIdle(wxIdleEvent &aEvent)
void OnComponentPreselected(wxCommandEvent &aEvent)
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
void OnInitDialog(wxInitDialogEvent &aEvent)
void SetSizeInDU(int x, int y)
Set the dialog to the given dimensions in "dialog units".
void OnCloseTimer(wxTimerEvent &aEvent)
wxPanel * ConstructRightPanel(wxWindow *aParent)
Definition: hash_eda.h:46
Widget displaying a tree of components with optional search text control and description panel...
int VertPixelsFromDU(int y)
Convert an integer number of dialog units to pixels, vertically.
DIALOG_SHIM(wxWindow *aParent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const wxString &name=wxDialogNameStr)
Definition: dialog_shim.cpp:57
wxSplitterWindow * m_splitter_tree_canvas
void OnSchViewDClick(wxMouseEvent &aEvent)
int HorizPixelsFromDU(int x)
Convert an integer number of dialog units to pixels, horizontally.
FOOTPRINT_PREVIEW_WIDGET * m_fp_view_ctrl
void OnSchViewPaint(wxPaintEvent &aEvent)
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.
DIALOG_CHOOSE_COMPONENT::~DIALOG_CHOOSE_COMPONENT ( )

Definition at line 138 of file dialog_choose_component.cpp.

References m_dbl_click_timer, m_last_dlg_size, m_splitter_tree_canvas, m_tree_canvas_sash_position, and OnCloseTimer().

139 {
140  // I am not sure the following two lines are necessary,
141  // but they will not hurt anyone
142  m_dbl_click_timer->Stop();
143  Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this );
144 
145  delete m_dbl_click_timer;
146 
147  m_last_dlg_size = GetSize();
149  - m_splitter_tree_canvas->GetSashPosition();
150 }
void OnCloseTimer(wxTimerEvent &aEvent)
wxSplitterWindow * m_splitter_tree_canvas

Member Function Documentation

wxPanel * DIALOG_CHOOSE_COMPONENT::ConstructRightPanel ( wxWindow *  aParent)
protected

Definition at line 153 of file dialog_choose_component.cpp.

References KIWAY_HOLDER::Kiway(), m_allow_field_edits, m_fp_list, m_fp_sel_ctrl, m_fp_view_ctrl, m_sch_view_ctrl, and m_show_footprints.

Referenced by DIALOG_CHOOSE_COMPONENT().

154 {
155  auto panel = new wxPanel( aParent );
156  auto sizer = new wxBoxSizer( wxVERTICAL );
157 
158  m_sch_view_ctrl = new wxPanel( panel, wxID_ANY, wxDefaultPosition, wxSize( -1, -1 ),
159  wxFULL_REPAINT_ON_RESIZE | wxTAB_TRAVERSAL );
160  m_sch_view_ctrl->SetLayoutDirection( wxLayout_LeftToRight );
161 
162  if( m_show_footprints )
163  {
164  if( m_allow_field_edits )
165  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( panel, m_fp_list, true );
166 
168 
169 
170  sizer->Add( m_sch_view_ctrl, 1, wxEXPAND | wxALL, 5 );
171 
172  if( m_fp_sel_ctrl )
173  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxALL, 5 );
174 
175  sizer->Add( m_fp_view_ctrl, 1, wxEXPAND | wxALL, 5 );
176  }
177  else
178  {
179  sizer->Add( m_sch_view_ctrl, 1, wxEXPAND | wxALL, 5 );
180  }
181 
182  panel->SetSizer( sizer );
183  panel->Layout();
184  sizer->Fit( panel );
185 
186  return panel;
187 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
FOOTPRINT_PREVIEW_WIDGET * m_fp_view_ctrl
bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 205 of file dialog_shim.cpp.

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

206 {
207  // so we can do logging of this state change:
208 
209 #if defined(DEBUG)
210  const char* type_id = typeid( *this ).name();
211  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
212 #endif
213 
214  return wxDialog::Enable( enable );
215 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 610 of file dialog_shim.cpp.

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

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

611 {
612  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
613  // handle validation in the same way as other dialogs.
614  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
615  return;
616 
617  SetReturnCode( retCode );
618 
619  if( !IsQuasiModal() )
620  {
621  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
622  return;
623  }
624 
625  m_qmodal_showing = false;
626 
627  if( m_qmodal_loop )
628  {
629  if( m_qmodal_loop->IsRunning() )
630  m_qmodal_loop->Exit( 0 );
631  else
632  m_qmodal_loop->ScheduleExit( 0 );
633 
634  m_qmodal_loop = NULL;
635  }
636 
639 
640  Show( false );
641 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool IsQuasiModal()
Definition: dialog_shim.h:103
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

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

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

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

Definition at line 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by COLOR4D_PICKER_DLG::COLOR4D_PICKER_DLG(), DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DESIGN_RULES::DIALOG_DESIGN_RULES(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), 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_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIBEDIT_OPTIONS::DIALOG_LIBEDIT_OPTIONS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PADS_MASK_CLEARANCE::DIALOG_PADS_MASK_CLEARANCE(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_PRETTY_LIB::DIALOG_SELECT_PRETTY_LIB(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_SHIM::IsQuasiModal(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_LIB_EDIT_PIN::OnInitDialog(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog(), DIALOG_TRACK_VIA_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnInitDlg(), DIALOG_EDIT_FPTEXT::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_FOOTPRINT_FP_EDITOR::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), and DIALOG_UPDATE_FIELDS::TransferDataToWindow().

105 {
106  // must be called from the constructor of derived classes,
107  // when all widgets are initialized, and therefore their size fixed
108 
109  // SetSizeHints fixes the minimal size of sizers in the dialog
110  // (SetSizeHints calls Fit(), so no need to call it)
111  GetSizer()->SetSizeHints( this );
112 
113  // the default position, when calling the first time the dlg
114  Center();
115 }
std::vector<std::pair<int, wxString> > DIALOG_CHOOSE_COMPONENT::GetFields ( ) const
inline

Get a list of fields edited by the user.

Returns
vector of pairs; each.first = field ID, each.second = new value

Definition at line 128 of file dialog_choose_component.h.

References m_field_edits.

Referenced by SCH_BASE_FRAME::SelectComponentFromLibrary().

129  {
130  return m_field_edits;
131  }
std::vector< std::pair< int, wxString > > m_field_edits
LIB_ID DIALOG_CHOOSE_COMPONENT::GetSelectedLibId ( int *  aUnit = nullptr) const

To be called after this dialog returns from ShowModal().

For multi-unit components, if the user selects the component itself rather than picking an individual unit, 0 will be returned in aUnit. Beware that this is an invalid unit number - this should be replaced with whatever default is desired (usually 1).

Parameters
aUnitif not NULL, the selected unit is filled in here.
Returns
the LIB_ID of the symbol that has been selected.

Definition at line 211 of file dialog_choose_component.cpp.

References COMPONENT_TREE::GetSelectedLibId(), and m_tree.

Referenced by LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

212 {
213  return m_tree->GetSelectedLibId( aUnit );
214 }
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 125 of file dialog_shim.cpp.

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

126 {
127  wxSize sz( x, 0 );
128  return ConvertDialogToPixels( sz ).x;
129 }
bool DIALOG_CHOOSE_COMPONENT::IsExternalBrowserSelected ( ) const
inline

Function IsExternalBrowserSelected.

Returns
true, iff the user pressed the thumbnail view of the component to launch the component browser.

Definition at line 138 of file dialog_choose_component.h.

References m_external_browser_requested.

Referenced by SCH_BASE_FRAME::SelectComponentFromLibrary().

139  {
141  }
KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway, KIWAY_HOLDER::Prj(), and KIWAY_HOLDER::SetKiway().

Referenced by SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_CHOOSE_COMPONENT(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), FOOTPRINT_EDIT_FRAME::GetIconScale(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), SCH_EDIT_FRAME::KiwayMailIn(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), OnIdle(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_WIZARD_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:85
void DIALOG_CHOOSE_COMPONENT::OnCloseTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 217 of file dialog_choose_component.cpp.

References DblClickDelay, DIALOG_SHIM::EndQuasiModal(), and m_dbl_click_timer.

Referenced by DIALOG_CHOOSE_COMPONENT(), and ~DIALOG_CHOOSE_COMPONENT().

218 {
219  // Hack handler because of eaten MouseUp event. See
220  // DIALOG_CHOOSE_COMPONENT::OnDoubleClickTreeActivation for the beginning
221  // of this spaghetti noodle.
222 
223  auto state = wxGetMouseState();
224 
225  if( state.LeftIsDown() )
226  {
227  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
228  // purpose of this timer is defeated.
230  }
231  else
232  {
233  EndQuasiModal( wxID_OK );
234  }
235 }
void EndQuasiModal(int retCode)
static constexpr int DblClickDelay
void DIALOG_CHOOSE_COMPONENT::OnComponentPreselected ( wxCommandEvent &  aEvent)
protected

Definition at line 426 of file dialog_choose_component.cpp.

References COMPONENT_TREE::GetSelectedLibId(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), m_fp_view_ctrl, m_sch_view_ctrl, m_tree, PopulateFootprintSelector(), FOOTPRINT_PREVIEW_WIDGET::SetStatusText(), and ShowFootprintFor().

Referenced by DIALOG_CHOOSE_COMPONENT().

427 {
428  int unit = 0;
429 
430  LIB_ID id = m_tree->GetSelectedLibId( &unit );
431 
432  m_sch_view_ctrl->Refresh();
433 
434  if( id.IsValid() )
435  {
436  ShowFootprintFor( id );
438  }
439  else
440  {
442  m_fp_view_ctrl->SetStatusText( wxEmptyString );
443 
445  }
446 }
void PopulateFootprintSelector(LIB_ID const &aLibId)
Populate the footprint selector for a given alias.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
bool IsInitialized() const
Return whether the widget initialized properly.
void ShowFootprintFor(LIB_ID const &aLibId)
Look up the footprint for a given symbol specified in the LIB_ID and display it.
FOOTPRINT_PREVIEW_WIDGET * m_fp_view_ctrl
void DIALOG_CHOOSE_COMPONENT::OnComponentSelected ( wxCommandEvent &  aEvent)
protected

Handle the selection of an item.

This is called when either the search box or the tree receive an Enter, or the tree receives a double click. If the item selected is a category, it is expanded or collapsed; if it is a component, the component is picked.

Definition at line 449 of file dialog_choose_component.cpp.

References DblClickDelay, COMPONENT_TREE::GetSelectedLibId(), LIB_ID::IsValid(), m_dbl_click_timer, and m_tree.

Referenced by DIALOG_CHOOSE_COMPONENT().

450 {
451  if( m_tree->GetSelectedLibId().IsValid() )
452  {
453  // Got a selection. We can't just end the modal dialog here, because
454  // wx leaks some events back to the parent window (in particular, the
455  // MouseUp following a double click).
456  //
457  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
458  // This isn't really feasible to bypass without a fully custom
459  // wxDataViewCtrl implementation, and even then might not be fully
460  // possible (docs are vague). To get around this, we use a one-shot
461  // timer to schedule the dialog close.
462  //
463  // See DIALOG_CHOOSE_COMPONENT::OnCloseTimer for the other end of this
464  // spaghetti noodle.
466  }
467 }
bool IsValid() const
Definition: lib_id.h:158
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
static constexpr int DblClickDelay
void DIALOG_CHOOSE_COMPONENT::OnFootprintSelected ( wxCommandEvent &  aEvent)
protected

Definition at line 411 of file dialog_choose_component.cpp.

References FOOTPRINT, i, m_field_edits, m_fp_override, and ShowFootprint().

Referenced by DIALOG_CHOOSE_COMPONENT().

412 {
413  m_fp_override = aEvent.GetString();
414 
415  m_field_edits.erase(
416  std::remove_if( m_field_edits.begin(), m_field_edits.end(),
417  []( std::pair<int, wxString> const& i ) { return i.first == FOOTPRINT; } ),
418  m_field_edits.end() );
419 
420  m_field_edits.push_back( std::make_pair( FOOTPRINT, m_fp_override ) );
421 
423 }
std::vector< std::pair< int, wxString > > m_field_edits
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
Field Name Module PCB, i.e. "16DIP300".
size_t i
Definition: json11.cpp:597
void DIALOG_CHOOSE_COMPONENT::OnIdle ( wxIdleEvent &  aEvent)
protected

Definition at line 201 of file dialog_choose_component.cpp.

References KIWAY_HOLDER::Kiway(), FOOTPRINT_SELECT_WIDGET::Load(), m_fp_sel_ctrl, m_load_footprints, and KIWAY_HOLDER::Prj().

Referenced by DIALOG_CHOOSE_COMPONENT().

202 {
204  {
205  m_load_footprints = false;
206  m_fp_sel_ctrl->Load( Kiway(), Prj() );
207  }
208 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
void Load(KIWAY &aKiway, PROJECT &aProject)
Start loading.
void DIALOG_CHOOSE_COMPONENT::OnInitDialog ( wxInitDialogEvent &  aEvent)
protected

Definition at line 190 of file dialog_choose_component.cpp.

References FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), m_fp_view_ctrl, and FOOTPRINT_PREVIEW_WIDGET::SetStatusText().

Referenced by DIALOG_CHOOSE_COMPONENT().

191 {
193  {
194  // This hides the GAL panel and shows the status label
195  m_fp_view_ctrl->SetStatusText( wxEmptyString );
196  }
197 }
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
bool IsInitialized() const
Return whether the widget initialized properly.
FOOTPRINT_PREVIEW_WIDGET * m_fp_view_ctrl
void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 271 of file dialog_shim.cpp.

References DIALOG_SHIM::m_fixupsRun, and recursiveDescent().

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

272 {
273  if( !m_fixupsRun )
274  {
275 #if DLGSHIM_SELECT_ALL_IN_TEXT_CONTROLS
276  const bool selectAllInTextCtrls = true;
277 #else
278  const bool selectAllInTextCtrls = false;
279 #endif
280  wxWindow* firstTextCtrl = NULL;
281  wxWindow* windowWithFocus = NULL;
282 
283  recursiveDescent( GetChildren(), selectAllInTextCtrls, firstTextCtrl,
284  windowWithFocus );
285 
286 #if DLGSHIM_USE_SETFOCUS
287  // While it would be nice to honour any focus already set (which was
288  // recorded in windowWithFocus), the reality is that it's currently wrong
289  // far more often than it's right.
290  // So just focus on the first text control if we have one; otherwise the
291  // focus on the dialog itself, which will at least allow esc, return, etc.
292  // to function.
293  if( firstTextCtrl )
294  firstTextCtrl->SetFocus();
295  else
296  SetFocus();
297 #endif
298 
299 #ifdef __WXMAC__
300  fixOSXCancelButtonIssue( this );
301 #endif
302 
303  m_fixupsRun = true;
304  }
305 
306  event.Skip();
307 }
static void recursiveDescent(wxWindowList &children, const bool selectTextInTextCtrls, wxWindow *&firstTextCtrl, wxWindow *&windowWithFocus)
bool m_fixupsRun
Definition: dialog_shim.h:149
void DIALOG_CHOOSE_COMPONENT::OnSchViewDClick ( wxMouseEvent &  aEvent)
protected

Definition at line 238 of file dialog_choose_component.cpp.

References DIALOG_SHIM::EndQuasiModal(), and m_external_browser_requested.

Referenced by DIALOG_CHOOSE_COMPONENT().

239 {
241  EndQuasiModal( wxID_OK );
242 }
void EndQuasiModal(int retCode)
void DIALOG_CHOOSE_COMPONENT::OnSchViewPaint ( wxPaintEvent &  aEvent)
protected

Definition at line 353 of file dialog_choose_component.cpp.

References Format(), LIB_ALIAS::GetName(), LIB_PART::GetName(), LIB_ALIAS::GetPart(), COMPONENT_TREE::GetSelectedLibId(), LIB_ALIAS::IsRoot(), m_tree, KIWAY_HOLDER::Prj(), RenderPreview(), LIB_PART::SetName(), and IO_ERROR::What().

Referenced by DIALOG_CHOOSE_COMPONENT().

354 {
355  int unit = 0;
356  LIB_ID id = m_tree->GetSelectedLibId( &unit );
357 
358  if( !id.IsValid() )
359  {
360  // No symbol to show, display a tooltip
361  RenderPreview( nullptr, unit );
362  return;
363  }
364 
365  LIB_ALIAS* alias = nullptr;
366 
367  try
368  {
369  alias = Prj().SchSymbolLibTable()->LoadSymbol( id );
370  }
371  catch( const IO_ERROR& ioe )
372  {
373  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
374  "\n\n%s" ),
375  id.GetLibItemName().wx_str(),
376  id.GetLibNickname().wx_str(),
377  ioe.What() ) );
378  }
379 
380  if( alias == nullptr )
381  return;
382 
383  LIB_PART* part = alias ? alias->GetPart() : nullptr;
384 
385  // Don't draw if we don't have a part to show
386  // just display a tooltip
387  if( !part )
388  {
389  RenderPreview( nullptr, unit );
390  return;
391  }
392 
393  if( alias->IsRoot() )
394  {
395  // just show the part directly
396  RenderPreview( part, unit );
397  }
398  else
399  {
400  // switch out the name temporarily for the alias name
401  wxString tmp( part->GetName() );
402  part->SetName( alias->GetName() );
403 
404  RenderPreview( part, unit );
405 
406  part->SetName( tmp );
407  }
408 }
Part library alias object definition.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool IsRoot() const
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Define a library symbol object.
LIB_PART * GetPart() const
Get the shared LIB_PART.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
const wxString & GetName() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
const wxString & GetName() const
virtual void SetName(const wxString &aName)
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47
void RenderPreview(LIB_PART *aComponent, int aUnit)
Display a given symbol into the schematic symbol preview.
void DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector ( LIB_ID const &  aLibId)
protected

Populate the footprint selector for a given alias.

Parameters
aLibIdthe LIB_ID of the selection or invalid to clear

Definition at line 306 of file dialog_choose_component.cpp.

References FOOTPRINT_SELECT_WIDGET::ClearFilters(), FOOTPRINT_SELECT_WIDGET::Enable(), FOOTPRINT_SELECT_WIDGET::FilterByFootprintFilters(), FOOTPRINT_SELECT_WIDGET::FilterByPinCount(), FOOTPRINT, Format(), LIB_PART::GetField(), LIB_PART::GetFootprints(), LIB_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), LIB_PART::GetPins(), LIB_ID::IsValid(), m_fp_sel_ctrl, KIWAY_HOLDER::Prj(), FOOTPRINT_SELECT_WIDGET::SetDefaultFootprint(), FOOTPRINT_SELECT_WIDGET::UpdateList(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by OnComponentPreselected().

307 {
308  if( !m_fp_sel_ctrl )
309  return;
310 
312 
313  LIB_ALIAS* alias = nullptr;
314 
315  if( aLibId.IsValid() )
316  {
317  try
318  {
319  alias = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
320  }
321  catch( const IO_ERROR& ioe )
322  {
323  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
324  "\n\n%s" ),
325  aLibId.GetLibItemName().wx_str(),
326  aLibId.GetLibNickname().wx_str(),
327  ioe.What() ) );
328  }
329  }
330 
331  if( alias != nullptr )
332  {
333  LIB_PINS temp_pins;
334  LIB_FIELD* fp_field = alias->GetPart()->GetField( FOOTPRINT );
335  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
336 
337  alias->GetPart()->GetPins( temp_pins );
338 
339  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
344  }
345  else
346  {
348  m_fp_sel_ctrl->Disable();
349  }
350 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Part library alias object definition.
void FilterByFootprintFilters(wxArrayString const &aFilters, bool aZeroFilters)
Filter by footprint filter list.
Field object used in symbol libraries.
Definition: lib_field.h:59
void SetDefaultFootprint(wxString const &aFp)
Set the default footprint for a part.
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:356
Field Name Module PCB, i.e. "16DIP300".
void ClearFilters()
Clear all filters.
bool UpdateList()
Update the contents of the list to match the filters.
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
wxArrayString & GetFootprints()
LIB_PART * GetPart() const
Get the shared LIB_PART.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:60
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47
void FilterByPinCount(int aPinCount)
Filter by pin count.
PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

Referenced by SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), DIALOG_FOOTPRINT_FP_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkNewAlias(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), DIALOG_CHOOSE_COMPONENT(), 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_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_FOOTPRINT_FP_EDITOR::Edit3DShapeFileName(), DIALOG_FOOTPRINT_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::Files_io_from_id(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), FOOTPRINT_EDIT_FRAME::getLibPath(), LIB_EDIT_FRAME::getLibraryFileName(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), DIALOG_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), KIWAY_HOLDER::Kiway(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), OnIdle(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_NETLIST::OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), SCH_EDIT_FRAME::OnSaveProject(), OnSchViewPaint(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), PopulateFootprintSelector(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), ShowFootprintFor(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), EDA_3D_VIEWER::takeScreenshot(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), and DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR().

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:142
void DIALOG_CHOOSE_COMPONENT::RenderPreview ( LIB_PART aComponent,
int  aUnit 
)
protected

Display a given symbol into the schematic symbol preview.

when no symbol selected, display a tooltip

Definition at line 470 of file dialog_choose_component.cpp.

References EDA_RECT::Centre(), PART_DRAW_OPTIONS::Default(), LIB_PART::Draw(), SCH_BASE_FRAME::GetDrawBgColor(), EDA_RECT::GetHeight(), LIB_PART::GetUnitBoundingBox(), EDA_RECT::GetWidth(), GRDrawWrappedText(), GRResetPenAndBrush(), m_deMorganConvert, m_parent, m_sch_view_ctrl, min, and scale.

Referenced by OnSchViewPaint().

471 {
472  wxPaintDC dc( m_sch_view_ctrl );
473 
474  const wxSize dc_size = dc.GetSize();
475 
476  // Avoid rendering when either dimension is zero
477  if( dc_size.x == 0 || dc_size.y == 0 )
478  return;
479 
480  if( !aComponent ) // display a tooltip
481  {
482  wxString tooltip = _( "Double-click here to select a symbol from the library browser" );
483  GRDrawWrappedText( dc, tooltip );
484  return;
485  }
486 
487  GRResetPenAndBrush( &dc );
488 
489  COLOR4D bgColor = m_parent->GetDrawBgColor();
490 
491  dc.SetBackground( wxBrush( bgColor.ToColour() ) );
492  dc.Clear();
493 
494  int unit = aUnit > 0 ? aUnit : 1;
495  int convert = m_deMorganConvert > 0 ? m_deMorganConvert : 1;
496 
497  dc.SetDeviceOrigin( dc_size.x / 2, dc_size.y / 2 );
498 
499  // Find joint bounding box for everything we are about to draw.
500  EDA_RECT bBox = aComponent->GetUnitBoundingBox( unit, convert );
501  const double xscale = (double) dc_size.x / bBox.GetWidth();
502  const double yscale = (double) dc_size.y / bBox.GetHeight();
503  const double scale = std::min( xscale, yscale ) * 0.85;
504 
505  dc.SetUserScale( scale, scale );
506 
507  wxPoint offset = -bBox.Centre();
508 
509  auto opts = PART_DRAW_OPTIONS::Default();
510  opts.draw_hidden_fields = false;
511  aComponent->Draw( nullptr, &dc, offset, unit, convert, opts );
512 }
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:218
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDc, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
Draw part.
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
void GRDrawWrappedText(wxDC &aDC, wxString const &aText)
Draw text centered on a wxDC with wrapping.
Definition: gr_basic.cpp:1302
int GetHeight() const
Definition: eda_rect.h:118
wxPoint Centre() const
Definition: eda_rect.h:60
static PART_DRAW_OPTIONS Default()
COLOR4D GetDrawBgColor() const override
const int scale
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetWidth() const
Definition: eda_rect.h:117
#define min(a, b)
Definition: auxiliary.h:85
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

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

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

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

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_player.h:85
const char * name
Definition: DXF_plotter.cpp:61
void DIALOG_SHIM::SetSizeInDU ( int  x,
int  y 
)
protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 118 of file dialog_shim.cpp.

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

119 {
120  wxSize sz( x, y );
121  SetSize( ConvertDialogToPixels( sz ) );
122 }
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 146 of file dialog_shim.cpp.

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

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_SHIM::IsQuasiModal(), DIALOG_SCH_FIND::OnCancel(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_FOOTPRINTS::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), SCH_COMPONENT::SetPosition(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

147 {
148  bool ret;
149  const char* hash_key;
150 
151  if( m_hash_key.size() )
152  {
153  // a special case like EDA_LIST_DIALOG, which has multiple uses.
154  hash_key = m_hash_key.c_str();
155  }
156  else
157  {
158  hash_key = typeid(*this).name();
159  }
160 
161  // Show or hide the window. If hiding, save current position and size.
162  // If showing, use previous position and size.
163  if( show )
164  {
165 #ifndef __WINDOWS__
166  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
167 #endif
168  ret = wxDialog::Show( show );
169 
170  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
171  EDA_RECT savedDialogRect = class_map[ hash_key ];
172 
173  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
174  {
175  SetSize( savedDialogRect.GetPosition().x,
176  savedDialogRect.GetPosition().y,
177  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
178  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
179  0 );
180  }
181 
182  // Be sure that the dialog appears in a visible area
183  // (the dialog position might have been stored at the time when it was
184  // shown on another display)
185  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
186  Centre();
187  }
188  else
189  {
190  // Save the dialog's position & size before hiding, using classname as key
191  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
192 
193 #ifdef __WXMAC__
194  if ( m_eventLoop )
195  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
196 #endif
197 
198  ret = wxDialog::Show( show );
199  }
200 
201  return ret;
202 }
const wxSize GetSize() const
Definition: eda_rect.h:101
std::string m_hash_key
Definition: dialog_shim.h:151
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:113
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void DIALOG_CHOOSE_COMPONENT::ShowFootprint ( wxString const &  aFootprint)
protected

Display the given footprint by name.

Definition at line 277 of file dialog_choose_component.cpp.

References FOOTPRINT_PREVIEW_WIDGET::CacheFootprint(), FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint(), LIB_ID::IsValid(), m_fp_view_ctrl, LIB_ID::Parse(), and FOOTPRINT_PREVIEW_WIDGET::SetStatusText().

Referenced by OnFootprintSelected(), and ShowFootprintFor().

278 {
279  if( !m_fp_view_ctrl )
280  {
281  return;
282  }
283 
284  if( aName == wxEmptyString )
285  {
286  m_fp_view_ctrl->SetStatusText( _( "No footprint specified" ) );
287  }
288  else
289  {
290  LIB_ID lib_id;
291 
292  if( lib_id.Parse( aName ) == -1 && lib_id.IsValid() )
293  {
295  m_fp_view_ctrl->CacheFootprint( lib_id );
296  m_fp_view_ctrl->DisplayFootprint( lib_id );
297  }
298  else
299  {
300  m_fp_view_ctrl->SetStatusText( _( "Invalid footprint specified" ) );
301  }
302  }
303 }
bool IsValid() const
Definition: lib_id.h:158
int Parse(const UTF8 &aId)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void ClearStatus()
Clear the contents of the status label and hide it.
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
void CacheFootprint(const LIB_ID &aFPID)
Preload a footprint into the cache.
void DisplayFootprint(const LIB_ID &aFPID)
Set the currently displayed footprint.
FOOTPRINT_PREVIEW_WIDGET * m_fp_view_ctrl
void DIALOG_CHOOSE_COMPONENT::ShowFootprintFor ( LIB_ID const &  aLibId)
protected

Look up the footprint for a given symbol specified in the LIB_ID and display it.

Definition at line 245 of file dialog_choose_component.cpp.

References FOOTPRINT, Format(), LIB_PART::GetField(), LIB_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), m_fp_view_ctrl, KIWAY_HOLDER::Prj(), ShowFootprint(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by OnComponentPreselected().

246 {
248  return;
249 
250  LIB_ALIAS* alias = nullptr;
251 
252  try
253  {
254  alias = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
255  }
256  catch( const IO_ERROR& ioe )
257  {
258  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
259  "\n\n%s" ),
260  aLibId.GetLibItemName().wx_str(),
261  aLibId.GetLibNickname().wx_str(),
262  ioe.What() ) );
263  }
264 
265  if( alias == nullptr )
266  {
267  return;
268  }
269 
270  LIB_FIELD* fp_field = alias->GetPart()->GetField( FOOTPRINT );
271  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
272 
273  ShowFootprint( fp_name );
274 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Part library alias object definition.
Field object used in symbol libraries.
Definition: lib_field.h:59
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:356
Field Name Module PCB, i.e. "16DIP300".
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
LIB_PART * GetPart() const
Get the shared LIB_PART.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool IsInitialized() const
Return whether the widget initialized properly.
FOOTPRINT_PREVIEW_WIDGET * m_fp_view_ctrl
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 558 of file dialog_shim.cpp.

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

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), SCH_EDIT_FRAME::InstallHierarchyFrame(), InvokeDialogCreateBOMEditor(), InvokeDialogEditComponentsLibId(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

559 {
560  // This is an exception safe way to zero a pointer before returning.
561  // Yes, even though DismissModal() clears this first normally, this is
562  // here in case there's an exception before the dialog is dismissed.
563  struct NULLER
564  {
565  void*& m_what;
566  NULLER( void*& aPtr ) : m_what( aPtr ) {}
567  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
568  } clear_this( (void*&) m_qmodal_loop );
569 
570  // release the mouse if it's currently captured as the window having it
571  // will be disabled when this dialog is shown -- but will still keep the
572  // capture making it impossible to do anything in the modal dialog itself
573  wxWindow* win = wxWindow::GetCapture();
574  if( win )
575  win->ReleaseMouse();
576 
577  // Get the optimal parent
578  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
579 
580  // Show the optimal parent
581  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
582 
583  wxASSERT_MSG( !m_qmodal_parent_disabler,
584  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
585 
586  // quasi-modal: disable only my "optimal" parent
588 
589 #ifdef __WXMAC__
590  // Apple in its infinite wisdom will raise a disabled window before even passing
591  // us the event, so we have no way to stop it. Instead, we must set an order on
592  // the windows so that the quasi-modal will be pushed in front of the disabled
593  // window when it is raised.
594  ReparentQuasiModal();
595 #endif
596  Show( true );
597 
598  m_qmodal_showing = true;
599 
600  EVENT_LOOP event_loop;
601 
602  m_qmodal_loop = &event_loop;
603 
604  event_loop.Run();
605 
606  return GetReturnCode();
607 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
Toggle a window&#39;s "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:33
#define DBG(x)
Definition: fctsys.h:33
int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 132 of file dialog_shim.cpp.

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

133 {
134  wxSize sz( 0, y );
135  return ConvertDialogToPixels( sz ).y;
136 }

Member Data Documentation

constexpr int DIALOG_CHOOSE_COMPONENT::DblClickDelay = 100
staticprotected

Definition at line 146 of file dialog_choose_component.h.

Referenced by OnCloseTimer(), and OnComponentSelected().

std::mutex DIALOG_CHOOSE_COMPONENT::g_Mutex
static
bool DIALOG_CHOOSE_COMPONENT::m_allow_field_edits
protected

Definition at line 208 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

wxTimer* DIALOG_CHOOSE_COMPONENT::m_dbl_click_timer
protected
int DIALOG_CHOOSE_COMPONENT::m_deMorganConvert
protected

Definition at line 207 of file dialog_choose_component.h.

Referenced by RenderPreview().

bool DIALOG_CHOOSE_COMPONENT::m_external_browser_requested
protected

Definition at line 211 of file dialog_choose_component.h.

Referenced by IsExternalBrowserSelected(), and OnSchViewDClick().

std::vector<std::pair<int, wxString> > DIALOG_CHOOSE_COMPONENT::m_field_edits
protected

Definition at line 215 of file dialog_choose_component.h.

Referenced by GetFields(), and OnFootprintSelected().

bool DIALOG_SHIM::m_fixupsRun
protectedinherited

Definition at line 149 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

FOOTPRINT_LIST* DIALOG_CHOOSE_COMPONENT::m_fp_list
protected

Definition at line 214 of file dialog_choose_component.h.

Referenced by ConstructRightPanel(), and DIALOG_CHOOSE_COMPONENT().

wxString DIALOG_CHOOSE_COMPONENT::m_fp_override
protected

Definition at line 212 of file dialog_choose_component.h.

Referenced by OnFootprintSelected().

FOOTPRINT_SELECT_WIDGET* DIALOG_CHOOSE_COMPONENT::m_fp_sel_ctrl
protected
FOOTPRINT_PREVIEW_WIDGET* DIALOG_CHOOSE_COMPONENT::m_fp_view_ctrl
protected
std::string DIALOG_SHIM::m_hash_key
protectedinherited
wxSize DIALOG_CHOOSE_COMPONENT::m_last_dlg_size
staticprotected

Definition at line 218 of file dialog_choose_component.h.

Referenced by DIALOG_CHOOSE_COMPONENT(), and ~DIALOG_CHOOSE_COMPONENT().

bool DIALOG_CHOOSE_COMPONENT::m_load_footprints
protected

Definition at line 210 of file dialog_choose_component.h.

Referenced by OnIdle().

SCH_BASE_FRAME* DIALOG_CHOOSE_COMPONENT::m_parent
protected

Definition at line 206 of file dialog_choose_component.h.

Referenced by RenderPreview().

EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 154 of file dialog_shim.h.

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

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited
bool DIALOG_SHIM::m_qmodal_showing
protectedinherited
wxPanel* DIALOG_CHOOSE_COMPONENT::m_sch_view_ctrl
protected
bool DIALOG_CHOOSE_COMPONENT::m_show_footprints
protected

Definition at line 209 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

wxSplitterWindow* DIALOG_CHOOSE_COMPONENT::m_splitter_tree_canvas
protected

Definition at line 195 of file dialog_choose_component.h.

Referenced by DIALOG_CHOOSE_COMPONENT(), and ~DIALOG_CHOOSE_COMPONENT().

wxPanel* DIALOG_CHOOSE_COMPONENT::m_symbol_view_panel
protected

Definition at line 197 of file dialog_choose_component.h.

Referenced by DIALOG_CHOOSE_COMPONENT().

COMPONENT_TREE* DIALOG_CHOOSE_COMPONENT::m_tree
protected
int DIALOG_CHOOSE_COMPONENT::m_tree_canvas_sash_position = 0
staticprotected

Definition at line 200 of file dialog_choose_component.h.

Referenced by DIALOG_CHOOSE_COMPONENT(), and ~DIALOG_CHOOSE_COMPONENT().


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