KiCad PCB EDA Suite
DIALOG_BOM Class Reference
Inheritance diagram for DIALOG_BOM:
DIALOG_BOM_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_BOM (SCH_EDIT_FRAME *parent)
 
 ~DIALOG_BOM ()
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS_T GetUserUnits () const override
 
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...
 
VTBL_ENTRY TOOL_MANAGERGetToolManager () const
 Function GetToolManager Return the tool manager instance, if any. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Types

enum  { IN_NAMELINE = 1000, ID_CMDLINE }
 

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

wxStaticText * m_staticTextPluginTitle
 
wxListBox * m_lbPlugins
 
wxStaticText * m_staticTextName
 
wxTextCtrl * m_textCtrlName
 
wxTextCtrl * m_Messages
 
wxBitmapButton * m_buttonAddPlugin
 
wxBitmapButton * m_buttonEdit
 
wxBitmapButton * m_buttonDelPlugin
 
wxStaticText * m_staticTextCmd
 
wxTextCtrl * m_textCtrlCommand
 
wxCheckBox * m_checkBoxShowConsole
 
wxStaticLine * m_staticline2
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
wxButton * m_sdbSizerHelp
 
EDA_UNITS_T m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

void OnPluginSelected (wxCommandEvent &event) override
 
void OnRunPlugin (wxCommandEvent &event) override
 
void OnHelp (wxCommandEvent &event) override
 
void OnAddPlugin (wxCommandEvent &event) override
 
void OnRemovePlugin (wxCommandEvent &event) override
 
void OnEditPlugin (wxCommandEvent &event) override
 
void OnCommandLineEdited (wxCommandEvent &event) override
 
void OnNameEdited (wxCommandEvent &event) override
 
void OnShowConsoleChanged (wxCommandEvent &event) override
 
void OnIdle (wxIdleEvent &event) override
 
void pluginInit ()
 
void installPluginsList ()
 
BOM_PLUGINaddPlugin (const wxString &aPath, const wxString &aName=wxEmptyString)
 
bool pluginExists (const wxString &aName)
 
BOM_PLUGINselectedPlugin ()
 
wxString choosePlugin ()
 

Private Attributes

SCH_EDIT_FRAMEm_parent
 
BOM_PLUGIN_ARRAY m_plugins
 
wxConfigBase * m_config
 
bool m_initialized
 

Detailed Description

Definition at line 171 of file dialog_bom.cpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
IN_NAMELINE 
ID_CMDLINE 

Definition at line 42 of file dialog_bom_base.h.

Constructor & Destructor Documentation

◆ DIALOG_BOM()

DIALOG_BOM::DIALOG_BOM ( SCH_EDIT_FRAME parent)

Definition at line 222 of file dialog_bom.cpp.

222  :
223  DIALOG_BOM_BASE( parent )
224 {
225  m_parent = parent;
227  m_initialized = false;
228 
229  m_buttonAddPlugin->SetBitmap( KiBitmap( small_plus_xpm ) );
230  m_buttonDelPlugin->SetBitmap( KiBitmap( trash_xpm ) );
231  m_buttonEdit->SetBitmap( KiBitmap( small_edit_xpm ) );
232 
234 
235 #ifndef __WINDOWS__
236  m_checkBoxShowConsole->Show( false );
237 #endif
238 
239  m_sdbSizerOK->SetLabel( _( "Generate" ) );
240  m_sdbSizerCancel->SetLabel( _( "Close" ) );
241  m_sdbSizer->Layout();
242 
244  m_sdbSizerOK->SetDefault();
245 
246  // Now all widgets have the size fixed, call FinishDialogSettings
248 }
wxBitmapButton * m_buttonEdit
wxBitmapButton * m_buttonAddPlugin
wxStdDialogButtonSizer * m_sdbSizer
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:116
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
wxListBox * m_lbPlugins
wxButton * m_sdbSizerOK
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
wxCheckBox * m_checkBoxShowConsole
wxBitmapButton * m_buttonDelPlugin
bool m_initialized
Definition: dialog_bom.cpp:177
DIALOG_BOM_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Bill of Material"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(617, 433), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
wxButton * m_sdbSizerCancel
void installPluginsList()
Definition: dialog_bom.cpp:298
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:174
wxConfigBase * m_config
Definition: dialog_bom.cpp:176

References DIALOG_SHIM::FinishDialogSettings(), installPluginsList(), KiBitmap(), Kiface(), KIFACE_I::KifaceSettings(), DIALOG_BOM_BASE::m_buttonAddPlugin, DIALOG_BOM_BASE::m_buttonDelPlugin, DIALOG_BOM_BASE::m_buttonEdit, DIALOG_BOM_BASE::m_checkBoxShowConsole, m_config, m_initialized, DIALOG_BOM_BASE::m_lbPlugins, m_parent, DIALOG_BOM_BASE::m_sdbSizer, DIALOG_BOM_BASE::m_sdbSizerCancel, DIALOG_BOM_BASE::m_sdbSizerOK, and DIALOG_SHIM::SetInitialFocus().

◆ ~DIALOG_BOM()

DIALOG_BOM::~DIALOG_BOM ( )

Definition at line 250 of file dialog_bom.cpp.

251 {
252  // Save the plugin descriptions in config.
253  // The config stores only one string, so we save the plugins inside a S-expr:
254  // ( plugins
255  // ( plugin "plugin name 1" (cmd "command line 1") )
256  // ( plugin "plugin name 2" (cmd "command line 2") (opts "option1") (opts "option2") )
257  // ....
258  // )
259 
260  STRING_FORMATTER writer;
261  writer.Print( 0, "(plugins" );
262 
263  for( auto& plugin : m_plugins )
264  {
265  writer.Print( 1, "(plugin %s (cmd %s)",
266  writer.Quotew( plugin->GetFile().GetFullPath() ).c_str(),
267  writer.Quotew( plugin->GetCommand() ).c_str() );
268 
269  for( unsigned jj = 0; jj < plugin->Options().GetCount(); jj++ )
270  {
271  writer.Print( 1, "(opts %s)",
272  writer.Quotew( plugin->Options().Item( jj ) ).c_str() );
273  }
274 
275  if( !plugin->GetName().IsEmpty() )
276  {
277  wxString option = wxString::Format( "nickname=%s", plugin->GetName() );
278 
279  writer.Print( 1, "(opts %s)",
280  writer.Quotew( option ).c_str() );
281  }
282 
283  writer.Print( 0, ")" );
284  }
285 
286  writer.Print( 0, ")" );
287 
288  wxString list( FROM_UTF8( writer.GetString().c_str() ) );
289 
290  m_config->Write( BOM_PLUGINS_KEY, list );
291 
292  wxString active_plugin_name = m_lbPlugins->GetStringSelection( );
293  m_config->Write( BOM_PLUGIN_SELECTED_KEY, active_plugin_name );
294 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:61
static constexpr wxChar BOM_PLUGINS_KEY[]
Definition: dialog_bom.cpp:49
wxListBox * m_lbPlugins
const std::string & GetString()
Definition: richio.h:475
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:472
static constexpr wxChar BOM_PLUGIN_SELECTED_KEY[]
Definition: dialog_bom.cpp:50
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:175
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
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
wxConfigBase * m_config
Definition: dialog_bom.cpp:176
Class STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:445

References BOM_PLUGIN_SELECTED_KEY, BOM_PLUGINS_KEY, Format(), FROM_UTF8(), STRING_FORMATTER::GetString(), m_config, DIALOG_BOM_BASE::m_lbPlugins, m_plugins, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Member Function Documentation

◆ addPlugin()

BOM_PLUGIN * DIALOG_BOM::addPlugin ( const wxString &  aPath,
const wxString &  aName = wxEmptyString 
)
private

Definition at line 383 of file dialog_bom.cpp.

384 {
385  BOM_PLUGIN* ret = nullptr;
386  auto plugin = std::make_unique<BOM_PLUGIN>( aPath );
387 
388  if( !plugin )
389  return nullptr;
390 
391  if( !aName.IsEmpty() )
392  {
393  plugin->SetName( aName );
394  m_lbPlugins->Append( aName );
395  }
396  else
397  {
398  m_lbPlugins->Append( plugin->GetName() );
399  }
400 
401  ret = plugin.get();
402  m_plugins.push_back( std::move( plugin ) );
403  return ret;
404 }
wxListBox * m_lbPlugins
Class representing a Bill of Material output plugin.
Definition: bom_plugins.h:37
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:175

References DIALOG_BOM_BASE::m_lbPlugins, and m_plugins.

Referenced by installPluginsList(), and OnAddPlugin().

◆ choosePlugin()

wxString DIALOG_BOM::choosePlugin ( )
private

Definition at line 542 of file dialog_bom.cpp.

543 {
544  static wxString lastPath;
545 
546  if( lastPath.IsEmpty() )
547  {
548 #ifndef __WXMAC__
549  lastPath = Pgm().GetExecutablePath();
550 #else
551  lastPath = GetOSXKicadDataDir() + "/plugins";
552 #endif
553  }
554 
555  wxString fullFileName = EDA_FILE_SELECTOR( _( "Plugin files:" ), lastPath, wxEmptyString,
556  wxEmptyString, wxFileSelectorDefaultWildcardStr,
557  this, wxFD_OPEN, true );
558 
559  return fullFileName;
560 }
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
wxString EDA_FILE_SELECTOR(const wxString &aTitle, const wxString &aPath, const wxString &aFileName, const wxString &aExtension, const wxString &aWildcard, wxWindow *aParent, int aStyle, const bool aKeepWorkingDirectory, const wxPoint &aPosition, wxString *aMruPath)
Function EDA_FILE_SELECTOR.
Definition: gestfich.cpp:82
VTBL_ENTRY const wxString & GetExecutablePath() const
Definition: pgm_base.h:218

References EDA_FILE_SELECTOR(), PGM_BASE::GetExecutablePath(), and Pgm().

Referenced by OnAddPlugin().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 237 of file dialog_shim.cpp.

238 {
239  // so we can do logging of this state change:
240 
241 #if 0 && defined(DEBUG)
242  const char* type_id = typeid( *this ).name();
243  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
244  fflush(0); //Needed on msys2 to immediately print the message
245 #endif
246 
247  return wxDialog::Enable( enable );
248 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 397 of file dialog_shim.cpp.

398 {
399  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
400  // handle validation in the same way as other dialogs.
401  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
402  return;
403 
404  SetReturnCode( retCode );
405 
406  if( !IsQuasiModal() )
407  {
408  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
409  return;
410  }
411 
412  if( m_qmodal_loop )
413  {
414  if( m_qmodal_loop->IsRunning() )
415  m_qmodal_loop->Exit( 0 );
416  else
417  m_qmodal_loop->ScheduleExit( 0 );
418 
419  m_qmodal_loop = NULL;
420  }
421 
424 
425  Show( false );
426 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:183
bool IsQuasiModal()
Definition: dialog_shim.h:125
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:185

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

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

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

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

Definition at line 136 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXIT::DIALOG_EXIT(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetToolManager()

TOOL_MANAGER * KIWAY_HOLDER::GetToolManager ( ) const
inherited

Function GetToolManager Return the tool manager instance, if any.

Definition at line 46 of file kiway_holder.cpp.

47 {
48  return nullptr;
49 }

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 157 of file dialog_shim.cpp.

158 {
159  wxSize sz( x, 0 );
160  return ConvertDialogToPixels( sz ).x;
161 }

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

◆ installPluginsList()

void DIALOG_BOM::installPluginsList ( )
private

Definition at line 298 of file dialog_bom.cpp.

299 {
300  wxString list, active_plugin_name;
301  m_config->Read( BOM_PLUGINS_KEY, &list );
302  m_config->Read( BOM_PLUGIN_SELECTED_KEY, &active_plugin_name );
303 
304  if( !list.IsEmpty() )
305  {
306  BOM_CFG_PARSER cfg_parser( &m_plugins, TO_UTF8( list ), wxT( "plugins" ) );
307 
308  try
309  {
310  cfg_parser.Parse();
311  }
312  catch( const IO_ERROR& )
313  {
314 // wxLogMessage( ioe.What() );
315  }
316  catch( std::runtime_error& e )
317  {
318  DisplayError( nullptr, e.what() );
319  }
320 
321  // Populate list box
322  for( unsigned ii = 0; ii < m_plugins.size(); ii++ )
323  {
324  m_lbPlugins->Append( m_plugins[ii]->GetName() );
325 
326  if( active_plugin_name == m_plugins[ii]->GetName() )
327  m_lbPlugins->SetSelection( ii );
328  }
329  }
330 
331  if( m_plugins.empty() ) // No plugins found?
332  {
333  // Load plugins from the default locations
334  std::vector<wxString> pluginPaths = {
335 #if defined(__WXGTK__)
336  "/usr/share/kicad/plugins",
337  "/usr/local/share/kicad/plugins",
338 #elif defined(__WXMSW__)
339  wxString::Format( "%s\\scripting\\plugins", Pgm().GetExecutablePath() ),
340 #elif defined(__WXMAC__)
341  wxString::Format( "%s/plugins", GetOSXKicadDataDir() ),
342 #endif
343  };
344 
345  wxFileName pluginPath;
346 
347  for( const auto& path : pluginPaths )
348  {
349  wxLogDebug( wxString::Format( "Searching directory %s for BOM plugins", path ) );
350  wxDir dir( path );
351 
352  if( !dir.IsOpened() )
353  continue;
354 
355  pluginPath.AssignDir( dir.GetName() );
356  wxString fileName;
357  bool cont = dir.GetFirst( &fileName, wxFileSelectorDefaultWildcardStr, wxDIR_FILES );
358 
359  while( cont )
360  {
361  try
362  {
363  wxLogTrace( BOM_TRACE, wxString::Format( "Checking if %s is a BOM plugin", fileName ) );
364 
365  if( BOM_PLUGIN::IsPlugin( fileName ) )
366  {
367  pluginPath.SetFullName( fileName );
368  addPlugin( pluginPath.GetFullPath() );
369  }
370  }
371  catch( ... ) { /* well, no big deal */ }
372 
373  cont = dir.GetNext( &fileName );
374  }
375  }
376  }
377 
378 
379  pluginInit();
380 }
static constexpr wxChar BOM_TRACE[]
Definition: dialog_bom.cpp:47
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
static constexpr wxChar BOM_PLUGINS_KEY[]
Definition: dialog_bom.cpp:49
wxListBox * m_lbPlugins
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:47
BOM_PLUGIN * addPlugin(const wxString &aPath, const wxString &aName=wxEmptyString)
Definition: dialog_bom.cpp:383
Holds data and functions pertinent to parsing a S-expression file.
Definition: dialog_bom.cpp:66
static constexpr wxChar BOM_PLUGIN_SELECTED_KEY[]
Definition: dialog_bom.cpp:50
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:175
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
static bool IsPlugin(const wxString &aFile)
Returns true if a file name matches a recognized plugin format.
Definition: bom_plugins.cpp:78
wxConfigBase * m_config
Definition: dialog_bom.cpp:176
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:244
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
void pluginInit()
Definition: dialog_bom.cpp:425

References addPlugin(), BOM_PLUGIN_SELECTED_KEY, BOM_PLUGINS_KEY, BOM_TRACE, DisplayError(), Format(), BOM_PLUGIN::IsPlugin(), m_config, DIALOG_BOM_BASE::m_lbPlugins, m_plugins, BOM_CFG_PARSER::Parse(), Pgm(), pluginInit(), and TO_UTF8.

Referenced by DIALOG_BOM().

◆ IsQuasiModal()

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 61 of file kiway_player.h.

62  {
63  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
64  return *m_kiway;
65  }
KIWAY * m_kiway
Definition: kiway_player.h:101

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), 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(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAddPlugin()

void DIALOG_BOM::OnAddPlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 502 of file dialog_bom.cpp.

503 {
504  wxString filename = choosePlugin();
505 
506  if( filename.IsEmpty() )
507  return;
508 
509  // Creates a new plugin entry
510  wxFileName fn( filename );
511  wxString name = wxGetTextFromUser( _( "Plugin nickname:" ), _( "Add Plugin" ),
512  fn.GetName(), this );
513 
514  if( name.IsEmpty() )
515  return;
516 
517  // Verify if it does not exists
518  if( pluginExists( name ) )
519  {
520  wxMessageBox( wxString::Format( _( "Nickname \"%s\" already in use." ), name ) );
521  return;
522  }
523 
524  try
525  {
526  auto plugin = addPlugin( fn.GetFullPath(), name );
527 
528  if( plugin )
529  {
530  m_lbPlugins->SetSelection( m_lbPlugins->GetCount() - 1 );
531  m_textCtrlCommand->SetValue( plugin->GetCommand() );
532  pluginInit();
533  }
534  }
535  catch( const std::runtime_error& e )
536  {
537  DisplayError( this, e.what() );
538  }
539 }
bool pluginExists(const wxString &aName)
Definition: dialog_bom.cpp:407
wxListBox * m_lbPlugins
BOM_PLUGIN * addPlugin(const wxString &aPath, const wxString &aName=wxEmptyString)
Definition: dialog_bom.cpp:383
wxTextCtrl * m_textCtrlCommand
wxString choosePlugin()
Definition: dialog_bom.cpp:542
const char * name
Definition: DXF_plotter.cpp:61
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
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:244
void pluginInit()
Definition: dialog_bom.cpp:425

References addPlugin(), choosePlugin(), DisplayError(), Format(), DIALOG_BOM_BASE::m_lbPlugins, DIALOG_BOM_BASE::m_textCtrlCommand, name, pluginExists(), and pluginInit().

◆ OnCommandLineEdited()

void DIALOG_BOM::OnCommandLineEdited ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 599 of file dialog_bom.cpp.

600 {
601  auto plugin = selectedPlugin();
602 
603  if( plugin )
604  plugin->SetCommand( m_textCtrlCommand->GetValue() );
605 }
wxTextCtrl * m_textCtrlCommand
BOM_PLUGIN * selectedPlugin()
Definition: dialog_bom.cpp:200

References DIALOG_BOM_BASE::m_textCtrlCommand, and selectedPlugin().

◆ OnEditPlugin()

void DIALOG_BOM::OnEditPlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 563 of file dialog_bom.cpp.

564 {
565  auto plugin = selectedPlugin();
566 
567  if( !plugin )
568  return;
569 
570  wxString pluginFile = plugin->GetFile().GetFullPath();
571 
572  if( pluginFile.Length() <= 2 ) // if name != ""
573  {
574  wxMessageBox( _( "Plugin file name not found." ) );
575  return;
576  }
577 
578  AddDelimiterString( pluginFile );
579  wxString editorname = Pgm().GetEditorName();
580 
581  if( !editorname.IsEmpty() )
582  ExecuteFile( this, editorname, pluginFile );
583  else
584  wxMessageBox( _( "No text editor selected in KiCad. Please choose one." ) );
585 }
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
void AddDelimiterString(wxString &string)
Function AddDelimiterString Add un " to the start and the end of string (if not already done).
Definition: gestfich.cpp:44
VTBL_ENTRY const wxString & GetEditorName(bool aCanShowFileChooser=true)
Return the preferred editor name.
Definition: pgm_base.cpp:200
BOM_PLUGIN * selectedPlugin()
Definition: dialog_bom.cpp:200
int ExecuteFile(wxWindow *frame, const wxString &ExecFile, const wxString &param, wxProcess *callback)
Function ExecuteFile calls the executable file ExecFile with the command line parameters param.
Definition: gestfich.cpp:208

References AddDelimiterString(), ExecuteFile(), PGM_BASE::GetEditorName(), Pgm(), and selectedPlugin().

◆ OnHelp()

void DIALOG_BOM::OnHelp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 588 of file dialog_bom.cpp.

589 {
590  HTML_MESSAGE_BOX help_Dlg( this, _( "Bill of Material Generation Help" ) );
591  help_Dlg.SetDialogSizeInDU( 500, 350 );
592 
593  wxString msg = FROM_UTF8( s_bomHelpInfo );
594  help_Dlg.m_htmlWindow->AppendToPage( msg );
595  help_Dlg.ShowModal();
596 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:61
static const char * s_bomHelpInfo
Definition: dialog_bom.cpp:52
Class HTML_MESSAGE_BOX.

References FROM_UTF8(), DIALOG_DISPLAY_HTML_TEXT_BASE::m_htmlWindow, s_bomHelpInfo, and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ OnIdle()

void DIALOG_BOM::OnIdle ( wxIdleEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 643 of file dialog_bom.cpp.

644 {
645  // On some platforms we initialize wxTextCtrls to all-selected, but we don't want that
646  // for the messages text box.
647  if( !m_initialized )
648  {
649  m_Messages->SetSelection( 0, 0 );
650  m_initialized = true;
651  }
652 }
wxTextCtrl * m_Messages
bool m_initialized
Definition: dialog_bom.cpp:177

References m_initialized, and DIALOG_BOM_BASE::m_Messages.

◆ OnNameEdited()

void DIALOG_BOM::OnNameEdited ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 608 of file dialog_bom.cpp.

609 {
610  int ii = m_lbPlugins->GetSelection();
611 
612  if( ii < 0 )
613  return;
614 
615  m_plugins[ii]->SetName( m_textCtrlName->GetValue() );
616  m_lbPlugins->SetString( ii, m_plugins[ii]->GetName() );
617 }
wxListBox * m_lbPlugins
wxTextCtrl * m_textCtrlName
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:175

References DIALOG_BOM_BASE::m_lbPlugins, m_plugins, and DIALOG_BOM_BASE::m_textCtrlName.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 298 of file dialog_shim.cpp.

299 {
300  if( m_firstPaintEvent )
301  {
302 #ifdef __WXMAC__
303  fixOSXCancelButtonIssue( this );
304 #endif
305 
306  selectAllInTextCtrls( GetChildren() );
307 
309  m_initialFocusTarget->SetFocus();
310  else
311  SetFocus(); // Focus the dialog itself
312 
313  m_firstPaintEvent = false;
314  }
315 
316  event.Skip();
317 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180
bool m_firstPaintEvent
Definition: dialog_shim.h:179
static void selectAllInTextCtrls(wxWindowList &children)

References DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnPluginSelected()

void DIALOG_BOM::OnPluginSelected ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 419 of file dialog_bom.cpp.

420 {
421  pluginInit();
422 }
void pluginInit()
Definition: dialog_bom.cpp:425

References pluginInit().

◆ OnRemovePlugin()

void DIALOG_BOM::OnRemovePlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 484 of file dialog_bom.cpp.

485 {
486  int ii = m_lbPlugins->GetSelection();
487 
488  if( ii < 0 )
489  return;
490 
491  m_lbPlugins->Delete( ii );
492  m_plugins.erase( m_plugins.begin() + ii );
493 
494  // Select the next item, if exists
495  if( m_lbPlugins->GetCount() )
496  m_lbPlugins->SetSelection( std::min( ii, (int) m_lbPlugins->GetCount() - 1 ) );
497 
498  pluginInit();
499 }
wxListBox * m_lbPlugins
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:175
void pluginInit()
Definition: dialog_bom.cpp:425
#define min(a, b)
Definition: auxiliary.h:85

References DIALOG_BOM_BASE::m_lbPlugins, m_plugins, min, and pluginInit().

◆ OnRunPlugin()

void DIALOG_BOM::OnRunPlugin ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 455 of file dialog_bom.cpp.

456 {
457  // Calculate the xml netlist filename
458  wxFileName fn = g_RootSheet->GetScreen()->GetFileName();
459 
460  fn.SetPath( wxPathOnly( Prj().GetProjectFullName() ) );
461  fn.ClearExt();
462 
463  wxString fullfilename = fn.GetFullPath();
465 
466  wxString reportmsg;
467  WX_STRING_REPORTER reporter( &reportmsg );
469 
470 #ifdef __WINDOWS__
471  if( m_checkBoxShowConsole->IsChecked() )
472  m_parent->SetExecFlags( wxEXEC_SHOW_CONSOLE );
473 #endif
474 
475  auto netlist = m_parent->CreateNetlist( false, false );
476 
477  m_parent->WriteNetListFile( netlist, -1,
478  fullfilename, 0, &reporter );
479 
480  m_Messages->SetValue( reportmsg );
481 }
const wxString & GetFileName() const
Definition: sch_screen.h:124
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:268
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:56
wxCheckBox * m_checkBoxShowConsole
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxTextCtrl * m_textCtrlCommand
virtual void ClearMsgPanel()
Clear all messages from the message panel.
wxTextCtrl * m_Messages
Class WX_STRING_REPORTER is a wrapper for reporting to a wxString object.
Definition: reporter.h:165
NETLIST_OBJECT_LIST * CreateNetlist(bool aSilent=false, bool aSilentAnnotate=false)
Create a netlist for the current schematic.
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:174
bool WriteNetListFile(NETLIST_OBJECT_LIST *aConnectedItemsList, int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=NULL)
Create a netlist file.
void SetExecFlags(const int aFlags)
Set (adds) specified flags for next execution of external generator of the netlist or bom.
void SetNetListerCommand(const wxString &aCommand)

References EDA_DRAW_FRAME::ClearMsgPanel(), SCH_EDIT_FRAME::CreateNetlist(), g_RootSheet, SCH_SCREEN::GetFileName(), SCH_SHEET::GetScreen(), DIALOG_BOM_BASE::m_checkBoxShowConsole, DIALOG_BOM_BASE::m_Messages, m_parent, DIALOG_BOM_BASE::m_textCtrlCommand, KIWAY_HOLDER::Prj(), SCH_EDIT_FRAME::SetExecFlags(), SCH_EDIT_FRAME::SetNetListerCommand(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ OnShowConsoleChanged()

void DIALOG_BOM::OnShowConsoleChanged ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 620 of file dialog_bom.cpp.

621 {
622 #ifdef __WINDOWS__
623  static constexpr wxChar OPT_SHOW_CONSOLE[] = wxT( "show_console" );
624 
625  auto plugin = selectedPlugin();
626 
627  if( !plugin )
628  return;
629 
630  if( m_checkBoxShowConsole->IsChecked() )
631  {
632  if( plugin->Options().Index( OPT_SHOW_CONSOLE ) == wxNOT_FOUND )
633  plugin->Options().Add( OPT_SHOW_CONSOLE );
634  }
635  else
636  {
637  plugin->Options().Remove( OPT_SHOW_CONSOLE );
638  }
639 #endif
640 }
wxCheckBox * m_checkBoxShowConsole
BOM_PLUGIN * selectedPlugin()
Definition: dialog_bom.cpp:200

References DIALOG_BOM_BASE::m_checkBoxShowConsole, and selectedPlugin().

◆ pluginExists()

bool DIALOG_BOM::pluginExists ( const wxString &  aName)
private

Definition at line 407 of file dialog_bom.cpp.

408 {
409  for( unsigned ii = 0; ii < m_plugins.size(); ii++ )
410  {
411  if( aName == m_plugins[ii]->GetName() )
412  return true;
413  }
414 
415  return false;
416 }
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:175

References m_plugins.

Referenced by OnAddPlugin().

◆ pluginInit()

void DIALOG_BOM::pluginInit ( )
private

Definition at line 425 of file dialog_bom.cpp.

426 {
427  auto plugin = selectedPlugin();
428 
429  if( !plugin )
430  {
431  m_textCtrlName->SetValue( wxEmptyString );
432  m_textCtrlCommand->SetValue( wxEmptyString );
433  m_Messages->SetValue( wxEmptyString );
434  return;
435  }
436 
437  m_textCtrlName->SetValue( plugin->GetName() );
438  m_textCtrlCommand->SetValue( plugin->GetCommand() );
439  m_Messages->SetValue( plugin->GetInfo() );
440  m_Messages->SetSelection( 0, 0 );
441 
442 #ifdef __WINDOWS__
443  if( plugin->Options().Index( wxT( "show_console" ) ) == wxNOT_FOUND )
444  m_checkBoxShowConsole->SetValue( false );
445  else
446  m_checkBoxShowConsole->SetValue( true );
447 #endif
448 
449  // A plugin can be not working, so do not left the OK button enabled if
450  // the plugin is not ready to use
451  m_sdbSizerOK->Enable( plugin->IsOk() );
452 }
wxButton * m_sdbSizerOK
wxTextCtrl * m_textCtrlName
wxCheckBox * m_checkBoxShowConsole
wxTextCtrl * m_textCtrlCommand
wxTextCtrl * m_Messages
BOM_PLUGIN * selectedPlugin()
Definition: dialog_bom.cpp:200

References DIALOG_BOM_BASE::m_checkBoxShowConsole, DIALOG_BOM_BASE::m_Messages, DIALOG_BOM_BASE::m_sdbSizerOK, DIALOG_BOM_BASE::m_textCtrlCommand, DIALOG_BOM_BASE::m_textCtrlName, and selectedPlugin().

Referenced by installPluginsList(), OnAddPlugin(), OnPluginSelected(), and OnRemovePlugin().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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:61
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:163

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), PCB_EDIT_FRAME::doAutoSave(), SCH_DRAWING_TOOLS::doPlaceComponent(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLoadProject(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnPrint(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunGerbview(), OnRunPlugin(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), KICAD_MANAGER_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::Process_Config(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::saveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ selectedPlugin()

BOM_PLUGIN* DIALOG_BOM::selectedPlugin ( )
inlineprivate

Definition at line 200 of file dialog_bom.cpp.

201  {
202  int idx = m_lbPlugins->GetSelection();
203 
204  if( idx < 0 || idx >= (int)m_plugins.size() )
205  return nullptr;
206 
207  return m_plugins[idx].get();
208  }
wxListBox * m_lbPlugins
BOM_PLUGIN_ARRAY m_plugins
Definition: dialog_bom.cpp:175

References DIALOG_BOM_BASE::m_lbPlugins, and m_plugins.

Referenced by OnCommandLineEdited(), OnEditPlugin(), OnShowConsoleChanged(), and pluginInit().

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

117  {
118  m_initialFocusTarget = aWindow;
119  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

Parameters
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 53 of file kiway_holder.cpp.

54 {
55 #if defined(DEBUG)
56  // offer a trap point for debugging most any window
57  wxASSERT( aDest );
58  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
59  {
60  int breakhere=1;
61  (void) breakhere;
62  }
63 #endif
64 
65  (void) aDest;
66 
67  m_kiway = aKiway;
68 }
KIWAY * m_kiway
Definition: kiway_player.h:101
const char * name
Definition: DXF_plotter.cpp:61

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetSizeInDU()

void DIALOG_SHIM::SetSizeInDU ( int  x,
int  y 
)
protectedinherited

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

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

Definition at line 150 of file dialog_shim.cpp.

151 {
152  wxSize sz( x, y );
153  SetSize( ConvertDialogToPixels( sz ) );
154 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), 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 178 of file dialog_shim.cpp.

179 {
180  bool ret;
181  const char* hash_key;
182 
183  if( m_hash_key.size() )
184  {
185  // a special case like EDA_LIST_DIALOG, which has multiple uses.
186  hash_key = m_hash_key.c_str();
187  }
188  else
189  {
190  hash_key = typeid(*this).name();
191  }
192 
193  // Show or hide the window. If hiding, save current position and size.
194  // If showing, use previous position and size.
195  if( show )
196  {
197 #ifndef __WINDOWS__
198  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
199 #endif
200  ret = wxDialog::Show( show );
201 
202  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
203  EDA_RECT savedDialogRect = class_map[ hash_key ];
204 
205  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
206  {
207  SetSize( savedDialogRect.GetPosition().x,
208  savedDialogRect.GetPosition().y,
209  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
210  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
211  0 );
212  }
213 
214  // Be sure that the dialog appears in a visible area
215  // (the dialog position might have been stored at the time when it was
216  // shown on another display)
217  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
218  Centre();
219  }
220  else
221  {
222  // Save the dialog's position & size before hiding, using classname as key
223  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
224 
225 #ifdef __WXMAC__
226  if ( m_eventLoop )
227  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
228 #endif
229 
230  ret = wxDialog::Show( show );
231  }
232 
233  return ret;
234 }
std::string m_hash_key
Definition: dialog_shim.h:174
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
const wxSize GetSize() const
Definition: eda_rect.h:101

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_SCH_FIND::OnCancel(), SCH_EDIT_FRAME::OnFindItems(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickFootprints(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 343 of file dialog_shim.cpp.

344 {
345  // This is an exception safe way to zero a pointer before returning.
346  // Yes, even though DismissModal() clears this first normally, this is
347  // here in case there's an exception before the dialog is dismissed.
348  struct NULLER
349  {
350  void*& m_what;
351  NULLER( void*& aPtr ) : m_what( aPtr ) {}
352  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
353  } clear_this( (void*&) m_qmodal_loop );
354 
355  // release the mouse if it's currently captured as the window having it
356  // will be disabled when this dialog is shown -- but will still keep the
357  // capture making it impossible to do anything in the modal dialog itself
358  wxWindow* win = wxWindow::GetCapture();
359  if( win )
360  win->ReleaseMouse();
361 
362  // Get the optimal parent
363  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
364 
365  // Show the optimal parent
366  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
367 
368  wxASSERT_MSG( !m_qmodal_parent_disabler,
369  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
370 
371  // quasi-modal: disable only my "optimal" parent
373 
374 #ifdef __WXMAC__
375  // Apple in its infinite wisdom will raise a disabled window before even passing
376  // us the event, so we have no way to stop it. Instead, we must set an order on
377  // the windows so that the quasi-modal will be pushed in front of the disabled
378  // window when it is raised.
379  ReparentQuasiModal();
380 #endif
381  Show( true );
382 
383  m_qmodal_showing = true;
384 
385  WX_EVENT_LOOP event_loop;
386 
387  m_qmodal_loop = &event_loop;
388 
389  event_loop.Run();
390 
391  m_qmodal_showing = false;
392 
393  return GetReturnCode();
394 }
bool m_qmodal_showing
Definition: dialog_shim.h:184
#define WX_EVENT_LOOP
Definition: kiway_player.h:107
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:183
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:185
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
#define DBG(x)
Definition: fctsys.h:33

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

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editSymbolProperties(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDITOR_CONTROL::NavigateHierarchy(), PCB_EDIT_FRAME::OnEditTracksAndVias(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 164 of file dialog_shim.cpp.

165 {
166  wxSize sz( 0, y );
167  return ConvertDialogToPixels( sz ).y;
168 }

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

Member Data Documentation

◆ m_buttonAddPlugin

wxBitmapButton* DIALOG_BOM_BASE::m_buttonAddPlugin
protectedinherited

◆ m_buttonDelPlugin

wxBitmapButton* DIALOG_BOM_BASE::m_buttonDelPlugin
protectedinherited

◆ m_buttonEdit

wxBitmapButton* DIALOG_BOM_BASE::m_buttonEdit
protectedinherited

◆ m_checkBoxShowConsole

wxCheckBox* DIALOG_BOM_BASE::m_checkBoxShowConsole
protectedinherited

◆ m_config

wxConfigBase* DIALOG_BOM::m_config
private

Definition at line 176 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), installPluginsList(), and ~DIALOG_BOM().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 179 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 180 of file dialog_shim.h.

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

◆ m_initialized

bool DIALOG_BOM::m_initialized
private

Definition at line 177 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), and OnIdle().

◆ m_lbPlugins

◆ m_Messages

wxTextCtrl* DIALOG_BOM_BASE::m_Messages
protectedinherited

◆ m_parent

SCH_EDIT_FRAME* DIALOG_BOM::m_parent
private

Definition at line 174 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), and OnRunPlugin().

◆ m_plugins

BOM_PLUGIN_ARRAY DIALOG_BOM::m_plugins
private

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 183 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

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 184 of file dialog_shim.h.

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

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_BOM_BASE::m_sdbSizer
protectedinherited

Definition at line 60 of file dialog_bom_base.h.

Referenced by DIALOG_BOM(), and DIALOG_BOM_BASE::DIALOG_BOM_BASE().

◆ m_sdbSizerCancel

wxButton* DIALOG_BOM_BASE::m_sdbSizerCancel
protectedinherited

Definition at line 62 of file dialog_bom_base.h.

Referenced by DIALOG_BOM(), and DIALOG_BOM_BASE::DIALOG_BOM_BASE().

◆ m_sdbSizerHelp

wxButton* DIALOG_BOM_BASE::m_sdbSizerHelp
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_BOM_BASE::m_sdbSizerOK
protectedinherited

◆ m_staticline2

wxStaticLine* DIALOG_BOM_BASE::m_staticline2
protectedinherited

Definition at line 59 of file dialog_bom_base.h.

Referenced by DIALOG_BOM_BASE::DIALOG_BOM_BASE().

◆ m_staticTextCmd

wxStaticText* DIALOG_BOM_BASE::m_staticTextCmd
protectedinherited

Definition at line 56 of file dialog_bom_base.h.

Referenced by DIALOG_BOM_BASE::DIALOG_BOM_BASE().

◆ m_staticTextName

wxStaticText* DIALOG_BOM_BASE::m_staticTextName
protectedinherited

Definition at line 50 of file dialog_bom_base.h.

Referenced by DIALOG_BOM_BASE::DIALOG_BOM_BASE().

◆ m_staticTextPluginTitle

wxStaticText* DIALOG_BOM_BASE::m_staticTextPluginTitle
protectedinherited

Definition at line 48 of file dialog_bom_base.h.

Referenced by DIALOG_BOM_BASE::DIALOG_BOM_BASE().

◆ m_textCtrlCommand

wxTextCtrl* DIALOG_BOM_BASE::m_textCtrlCommand
protectedinherited

◆ m_textCtrlName

wxTextCtrl* DIALOG_BOM_BASE::m_textCtrlName
protectedinherited

◆ m_units


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