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

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

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 GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
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 Member Functions

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

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...
 
void ResetSize ()
 Clear the existing dialog size and position. More...
 

Protected Attributes

wxStaticText * m_staticTextGeneratorTitle
 
wxListBox * m_lbGenerators
 
wxStaticText * m_staticTextName
 
wxTextCtrl * m_textCtrlName
 
wxTextCtrl * m_Messages
 
wxBitmapButton * m_buttonAddGenerator
 
wxBitmapButton * m_buttonEdit
 
wxBitmapButton * m_buttonDelGenerator
 
wxStaticText * m_staticTextCmd
 
wxTextCtrl * m_textCtrlCommand
 
wxCheckBox * m_checkBoxShowConsole
 
wxStaticLine * m_staticline
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
wxButton * m_sdbSizerHelp
 
EDA_UNITS 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
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

void OnGeneratorSelected (wxCommandEvent &event) override
 
void OnRunGenerator (wxCommandEvent &event) override
 
void OnHelp (wxCommandEvent &event) override
 
void OnAddGenerator (wxCommandEvent &event) override
 
void OnRemoveGenerator (wxCommandEvent &event) override
 
void OnEditGenerator (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 installGeneratorsList ()
 
BOM_GENERATOR_HANDLERaddGenerator (const wxString &aPath, const wxString &aName=wxEmptyString)
 
bool pluginExists (const wxString &aName)
 
BOM_GENERATOR_HANDLERselectedGenerator ()
 
wxString chooseGenerator ()
 

Private Attributes

SCH_EDIT_FRAMEm_parent
 
BOM_GENERATOR_ARRAY m_generators
 
wxConfigBase * m_config
 
bool m_initialized
 

Detailed Description

Definition at line 173 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.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_BOM()

DIALOG_BOM::DIALOG_BOM ( SCH_EDIT_FRAME parent)

Definition at line 224 of file dialog_bom.cpp.

224  :
225  DIALOG_BOM_BASE( parent )
226 {
227  m_parent = parent;
229  m_initialized = false;
230 
232  m_buttonDelGenerator->SetBitmap( KiBitmap( trash_xpm ) );
233  m_buttonEdit->SetBitmap( KiBitmap( small_edit_xpm ) );
234 
236 
237 #ifndef __WINDOWS__
238  m_checkBoxShowConsole->Show( false );
239 #endif
240 
241  m_sdbSizerOK->SetLabel( _( "Generate" ) );
242  m_sdbSizerCancel->SetLabel( _( "Close" ) );
243  m_sdbSizer->Layout();
244 
246  m_sdbSizerOK->SetDefault();
247 
248  // Now all widgets have the size fixed, call FinishDialogSettings
250 }
wxBitmapButton * m_buttonEdit
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:46
wxBitmapButton * m_buttonAddGenerator
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:115
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
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void installGeneratorsList()
Definition: dialog_bom.cpp:300
bool m_initialized
Definition: dialog_bom.cpp:179
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)
const BITMAP_OPAQUE small_edit_xpm[1]
Definition: small_edit.cpp:26
#define _(s)
Definition: 3d_actions.cpp:31
wxListBox * m_lbGenerators
wxButton * m_sdbSizerCancel
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:176
wxConfigBase * m_config
Definition: dialog_bom.cpp:178
wxBitmapButton * m_buttonDelGenerator
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20

References _, DIALOG_SHIM::FinishDialogSettings(), installGeneratorsList(), KiBitmap(), Kiface(), KIFACE_I::KifaceSettings(), DIALOG_BOM_BASE::m_buttonAddGenerator, DIALOG_BOM_BASE::m_buttonDelGenerator, DIALOG_BOM_BASE::m_buttonEdit, DIALOG_BOM_BASE::m_checkBoxShowConsole, m_config, m_initialized, DIALOG_BOM_BASE::m_lbGenerators, m_parent, DIALOG_BOM_BASE::m_sdbSizer, DIALOG_BOM_BASE::m_sdbSizerCancel, DIALOG_BOM_BASE::m_sdbSizerOK, DIALOG_SHIM::SetInitialFocus(), small_edit_xpm, small_plus_xpm, and trash_xpm.

◆ ~DIALOG_BOM()

DIALOG_BOM::~DIALOG_BOM ( )

Definition at line 252 of file dialog_bom.cpp.

253 {
254  // Save the plugin descriptions in config.
255  // The config stores only one string, so we save the plugins inside a S-expr:
256  // ( plugins
257  // ( plugin "plugin name 1" (cmd "command line 1") )
258  // ( plugin "plugin name 2" (cmd "command line 2") (opts "option1") (opts "option2") )
259  // ....
260  // )
261 
262  STRING_FORMATTER writer;
263  writer.Print( 0, "(plugins" );
264 
265  for( auto& plugin : m_generators )
266  {
267  writer.Print( 1, "(plugin %s (cmd %s)",
268  writer.Quotew( plugin->GetFile().GetFullPath() ).c_str(),
269  writer.Quotew( plugin->GetCommand() ).c_str() );
270 
271  for( unsigned jj = 0; jj < plugin->Options().GetCount(); jj++ )
272  {
273  writer.Print( 1, "(opts %s)",
274  writer.Quotew( plugin->Options().Item( jj ) ).c_str() );
275  }
276 
277  if( !plugin->GetName().IsEmpty() )
278  {
279  wxString option = wxString::Format( "nickname=%s", plugin->GetName() );
280 
281  writer.Print( 1, "(opts %s)",
282  writer.Quotew( option ).c_str() );
283  }
284 
285  writer.Print( 0, ")" );
286  }
287 
288  writer.Print( 0, ")" );
289 
290  wxString list( FROM_UTF8( writer.GetString().c_str() ) );
291 
292  m_config->Write( BOM_GENERATORS_KEY, list );
293 
294  wxString active_plugin_name = m_lbGenerators->GetStringSelection( );
295  m_config->Write( BOM_GENERATOR_SELECTED_KEY, active_plugin_name );
296 }
static constexpr wxChar BOM_GENERATOR_SELECTED_KEY[]
Definition: dialog_bom.cpp:52
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:62
const std::string & GetString()
Definition: richio.h:475
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:472
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:177
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
wxListBox * m_lbGenerators
static constexpr wxChar BOM_GENERATORS_KEY[]
Definition: dialog_bom.cpp:51
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:178
STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:445

References BOM_GENERATOR_SELECTED_KEY, BOM_GENERATORS_KEY, Format(), FROM_UTF8(), STRING_FORMATTER::GetString(), m_config, m_generators, DIALOG_BOM_BASE::m_lbGenerators, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Member Function Documentation

◆ addGenerator()

BOM_GENERATOR_HANDLER * DIALOG_BOM::addGenerator ( const wxString &  aPath,
const wxString &  aName = wxEmptyString 
)
private

Definition at line 385 of file dialog_bom.cpp.

386 {
387  BOM_GENERATOR_HANDLER* ret = nullptr;
388  auto plugin = std::make_unique<BOM_GENERATOR_HANDLER>( aPath );
389 
390  if( !plugin )
391  return nullptr;
392 
393  if( !aName.IsEmpty() )
394  {
395  plugin->SetName( aName );
396  m_lbGenerators->Append( aName );
397  }
398  else
399  {
400  m_lbGenerators->Append( plugin->GetName() );
401  }
402 
403  ret = plugin.get();
404  m_generators.push_back( std::move( plugin ) );
405  return ret;
406 }
Class handling a Bill of Material output generator.
Definition: bom_plugins.h:41
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:177
wxListBox * m_lbGenerators

References m_generators, and DIALOG_BOM_BASE::m_lbGenerators.

Referenced by installGeneratorsList(), and OnAddGenerator().

◆ chooseGenerator()

wxString DIALOG_BOM::chooseGenerator ( )
private

Definition at line 547 of file dialog_bom.cpp.

548 {
549  static wxString lastPath;
550 
551  if( lastPath.IsEmpty() )
552  {
553 #ifndef __WXMAC__
554  lastPath = Pgm().GetExecutablePath();
555 #else
556  lastPath = GetOSXKicadDataDir() + "/plugins";
557 #endif
558  }
559 
560  wxString fullFileName = EDA_FILE_SELECTOR( _( "Generator files:" ), lastPath, wxEmptyString,
561  wxEmptyString, wxFileSelectorDefaultWildcardStr,
562  this, wxFD_OPEN, true );
563 
564  return fullFileName;
565 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:98
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:52
#define _(s)
Definition: 3d_actions.cpp:31

References _, EDA_FILE_SELECTOR(), and Pgm().

Referenced by OnAddGenerator().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 262 of file dialog_shim.cpp.

263 {
264  // so we can do logging of this state change:
265 
266 #if 0 && defined(DEBUG)
267  const char* type_id = typeid( *this ).name();
268  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
269  fflush(0); //Needed on msys2 to immediately print the message
270 #endif
271 
272  return wxDialog::Enable( enable );
273 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 419 of file dialog_shim.cpp.

420 {
421  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
422  // handle validation in the same way as other dialogs.
423  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
424  return;
425 
426  SetReturnCode( retCode );
427 
428  if( !IsQuasiModal() )
429  {
430  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
431  "wasn't called" );
432  return;
433  }
434 
435  if( m_qmodal_loop )
436  {
437  if( m_qmodal_loop->IsRunning() )
438  m_qmodal_loop->Exit( 0 );
439  else
440  m_qmodal_loop->ScheduleExit( 0 );
441 
443  }
444 
447 
448  Show( false );
449 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
#define NULL
bool IsQuasiModal()
Definition: dialog_shim.h:124
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208

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

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

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

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

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

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

Definition at line 137 of file dialog_shim.cpp.

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

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_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_EDITOR_DATA::DIALOG_EDITOR_DATA(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_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_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

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

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

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

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

◆ installGeneratorsList()

void DIALOG_BOM::installGeneratorsList ( )
private

Definition at line 300 of file dialog_bom.cpp.

301 {
302  wxString list, active_plugin_name;
303  m_config->Read( BOM_GENERATORS_KEY, &list );
304  m_config->Read( BOM_GENERATOR_SELECTED_KEY, &active_plugin_name );
305 
306  if( !list.IsEmpty() )
307  {
308  BOM_CFG_PARSER cfg_parser( &m_generators, TO_UTF8( list ), wxT( "plugins" ) );
309 
310  try
311  {
312  cfg_parser.Parse();
313  }
314  catch( const IO_ERROR& )
315  {
316 // wxLogMessage( ioe.What() );
317  }
318  catch( std::runtime_error& e )
319  {
320  DisplayError( nullptr, e.what() );
321  }
322 
323  // Populate list box
324  for( unsigned ii = 0; ii < m_generators.size(); ii++ )
325  {
326  m_lbGenerators->Append( m_generators[ii]->GetName() );
327 
328  if( active_plugin_name == m_generators[ii]->GetName() )
329  m_lbGenerators->SetSelection( ii );
330  }
331  }
332 
333  if( m_generators.empty() ) // No plugins found?
334  {
335  // Load plugins from the default locations
336  std::vector<wxString> pluginPaths = {
337 #if defined(__WXGTK__)
338  "/usr/share/kicad/plugins",
339  "/usr/local/share/kicad/plugins",
340 #elif defined(__WXMSW__)
341  wxString::Format( "%s\\scripting\\plugins", Pgm().GetExecutablePath() ),
342 #elif defined(__WXMAC__)
343  wxString::Format( "%s/plugins", GetOSXKicadDataDir() ),
344 #endif
345  };
346 
347  wxFileName pluginPath;
348 
349  for( const auto& path : pluginPaths )
350  {
351  wxLogDebug( wxString::Format( "Searching directory %s for BOM generators", path ) );
352  wxDir dir( path );
353 
354  if( !dir.IsOpened() )
355  continue;
356 
357  pluginPath.AssignDir( dir.GetName() );
358  wxString fileName;
359  bool cont = dir.GetFirst( &fileName, wxFileSelectorDefaultWildcardStr, wxDIR_FILES );
360 
361  while( cont )
362  {
363  try
364  {
365  wxLogTrace( BOM_TRACE, wxString::Format( "Checking if %s is a BOM generator", fileName ) );
366 
368  {
369  pluginPath.SetFullName( fileName );
370  addGenerator( pluginPath.GetFullPath() );
371  }
372  }
373  catch( ... ) { /* well, no big deal */ }
374 
375  cont = dir.GetNext( &fileName );
376  }
377  }
378  }
379 
380 
381  pluginInit();
382 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
static constexpr wxChar BOM_GENERATOR_SELECTED_KEY[]
Definition: dialog_bom.cpp:52
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:98
static constexpr wxChar BOM_TRACE[]
Definition: dialog_bom.cpp:49
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
static bool IsValidGenerator(const wxString &aFile)
Returns true if a file name matches a recognized plugin format.
Definition: bom_plugins.cpp:78
Holds data and functions pertinent to parsing a S-expression file.
Definition: dialog_bom.cpp:68
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:177
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
wxListBox * m_lbGenerators
static constexpr wxChar BOM_GENERATORS_KEY[]
Definition: dialog_bom.cpp:51
wxConfigBase * m_config
Definition: dialog_bom.cpp:178
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
BOM_GENERATOR_HANDLER * addGenerator(const wxString &aPath, const wxString &aName=wxEmptyString)
Definition: dialog_bom.cpp:385
void pluginInit()
Definition: dialog_bom.cpp:427

References addGenerator(), BOM_GENERATOR_SELECTED_KEY, BOM_GENERATORS_KEY, BOM_TRACE, DisplayError(), Format(), BOM_GENERATOR_HANDLER::IsValidGenerator(), m_config, m_generators, DIALOG_BOM_BASE::m_lbGenerators, BOM_CFG_PARSER::Parse(), Pgm(), pluginInit(), and TO_UTF8.

Referenced by DIALOG_BOM().

◆ IsCtrl()

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

Definition at line 137 of file dialog_shim.h.

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

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

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 143 of file dialog_shim.h.

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

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAddGenerator()

void DIALOG_BOM::OnAddGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 507 of file dialog_bom.cpp.

508 {
509  wxString filename = chooseGenerator();
510 
511  if( filename.IsEmpty() )
512  return;
513 
514  // Creates a new plugin entry
515  wxFileName fn( filename );
516  wxString name = wxGetTextFromUser( _( "Generator nickname:" ), _( "Add Generator" ),
517  fn.GetName(), this );
518 
519  if( name.IsEmpty() )
520  return;
521 
522  // Verify if it does not exists
523  if( pluginExists( name ) )
524  {
525  wxMessageBox( wxString::Format( _( "Nickname \"%s\" already in use." ), name ) );
526  return;
527  }
528 
529  try
530  {
531  auto plugin = addGenerator( fn.GetFullPath(), name );
532 
533  if( plugin )
534  {
535  m_lbGenerators->SetSelection( m_lbGenerators->GetCount() - 1 );
536  m_textCtrlCommand->SetValue( plugin->GetCommand() );
537  pluginInit();
538  }
539  }
540  catch( const std::runtime_error& e )
541  {
542  DisplayError( this, e.what() );
543  }
544 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
bool pluginExists(const wxString &aName)
Definition: dialog_bom.cpp:409
wxTextCtrl * m_textCtrlCommand
wxString chooseGenerator()
Definition: dialog_bom.cpp:547
const char * name
Definition: DXF_plotter.cpp: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
#define _(s)
Definition: 3d_actions.cpp:31
wxListBox * m_lbGenerators
BOM_GENERATOR_HANDLER * addGenerator(const wxString &aPath, const wxString &aName=wxEmptyString)
Definition: dialog_bom.cpp:385
void pluginInit()
Definition: dialog_bom.cpp:427

References _, addGenerator(), chooseGenerator(), DisplayError(), Format(), DIALOG_BOM_BASE::m_lbGenerators, 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 605 of file dialog_bom.cpp.

606 {
607  auto generator = selectedGenerator();
608 
609  if( generator )
610  generator->SetCommand( m_textCtrlCommand->GetValue() );
611 }
wxTextCtrl * m_textCtrlCommand
BOM_GENERATOR_HANDLER * selectedGenerator()
Definition: dialog_bom.cpp:202

References DIALOG_BOM_BASE::m_textCtrlCommand, and selectedGenerator().

◆ OnEditGenerator()

void DIALOG_BOM::OnEditGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 568 of file dialog_bom.cpp.

569 {
570  auto plugin = selectedGenerator();
571 
572  if( !plugin )
573  return;
574 
575  wxString pluginFile = plugin->GetFile().GetFullPath();
576 
577  if( pluginFile.Length() <= 2 ) // if name != ""
578  {
579  wxMessageBox( _( "Generator file name not found." ) );
580  return;
581  }
582 
583  AddDelimiterString( pluginFile );
584  wxString editorname = Pgm().GetEditorName();
585 
586  if( !editorname.IsEmpty() )
587  ExecuteFile( this, editorname, pluginFile );
588  else
589  wxMessageBox( _( "No text editor selected in KiCad. Please choose one." ) );
590 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:98
void AddDelimiterString(wxString &string)
Function AddDelimiterString Add un " to the start and the end of string (if not already done).
Definition: gestfich.cpp:42
#define _(s)
Definition: 3d_actions.cpp:31
BOM_GENERATOR_HANDLER * selectedGenerator()
Definition: dialog_bom.cpp:202
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:174

References _, AddDelimiterString(), ExecuteFile(), Pgm(), and selectedGenerator().

◆ OnGeneratorSelected()

void DIALOG_BOM::OnGeneratorSelected ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 421 of file dialog_bom.cpp.

422 {
423  pluginInit();
424 }
void pluginInit()
Definition: dialog_bom.cpp:427

References pluginInit().

◆ OnHelp()

void DIALOG_BOM::OnHelp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 593 of file dialog_bom.cpp.

594 {
595  HTML_MESSAGE_BOX help_Dlg( this, _( "Bill of Material Generation Help" ) );
596  help_Dlg.SetDialogSizeInDU( 500, 350 );
597 
598  wxString html_txt;
599  ConvertMarkdown2Html( wxGetTranslation( s_bomHelpInfo ), html_txt );
600  help_Dlg.m_htmlWindow->AppendToPage( html_txt );
601  help_Dlg.ShowModal();
602 }
void ConvertMarkdown2Html(const wxString &aMarkdownInput, wxString &aHtmlOutput)
HTML_MESSAGE_BOX.
#define _(s)
Definition: 3d_actions.cpp:31
wxString s_bomHelpInfo
Definition: dialog_bom.cpp:54

References _, ConvertMarkdown2Html(), 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 649 of file dialog_bom.cpp.

650 {
651  // On some platforms we initialize wxTextCtrls to all-selected, but we don't want that
652  // for the messages text box.
653  if( !m_initialized )
654  {
655  m_Messages->SetSelection( 0, 0 );
656  m_initialized = true;
657  }
658 }
wxTextCtrl * m_Messages
bool m_initialized
Definition: dialog_bom.cpp:179

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 614 of file dialog_bom.cpp.

615 {
616  int ii = m_lbGenerators->GetSelection();
617 
618  if( ii < 0 )
619  return;
620 
621  m_generators[ii]->SetName( m_textCtrlName->GetValue() );
622  m_lbGenerators->SetString( ii, m_generators[ii]->GetName() );
623 }
wxTextCtrl * m_textCtrlName
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:177
wxListBox * m_lbGenerators

References m_generators, DIALOG_BOM_BASE::m_lbGenerators, and DIALOG_BOM_BASE::m_textCtrlName.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 320 of file dialog_shim.cpp.

321 {
322  if( m_firstPaintEvent )
323  {
324 #ifdef __WXMAC__
325  fixOSXCancelButtonIssue( this );
326 #endif
327 
328  selectAllInTextCtrls( GetChildren() );
329 
331  m_initialFocusTarget->SetFocus();
332  else
333  SetFocus(); // Focus the dialog itself
334 
335  m_firstPaintEvent = false;
336  }
337 
338  event.Skip();
339 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203
bool m_firstPaintEvent
Definition: dialog_shim.h:202
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnRemoveGenerator()

void DIALOG_BOM::OnRemoveGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 489 of file dialog_bom.cpp.

490 {
491  int ii = m_lbGenerators->GetSelection();
492 
493  if( ii < 0 )
494  return;
495 
496  m_lbGenerators->Delete( ii );
497  m_generators.erase( m_generators.begin() + ii );
498 
499  // Select the next item, if exists
500  if( m_lbGenerators->GetCount() )
501  m_lbGenerators->SetSelection( std::min( ii, (int) m_lbGenerators->GetCount() - 1 ) );
502 
503  pluginInit();
504 }
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:177
wxListBox * m_lbGenerators
void pluginInit()
Definition: dialog_bom.cpp:427

References m_generators, DIALOG_BOM_BASE::m_lbGenerators, and pluginInit().

◆ OnRunGenerator()

void DIALOG_BOM::OnRunGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 457 of file dialog_bom.cpp.

458 {
459  // Calculate the xml netlist filename
460  wxFileName fn = g_RootSheet->GetScreen()->GetFileName();
461 
462  fn.SetPath( wxPathOnly( Prj().GetProjectFullName() ) );
463  fn.ClearExt();
464 
465  wxString fullfilename = fn.GetFullPath();
467 
468  wxString reportmsg;
469  WX_STRING_REPORTER reporter( &reportmsg );
471 
472 #ifdef __WINDOWS__
473  if( m_checkBoxShowConsole->IsChecked() )
474  m_parent->SetExecFlags( wxEXEC_SHOW_CONSOLE );
475 #endif
476 
477  auto netlist = m_parent->CreateNetlist( false, false );
478 
479  m_parent->WriteNetListFile( netlist, -1,
480  fullfilename, 0, &reporter );
481 
482  m_Messages->SetValue( reportmsg );
483 
484  // Force focus back on the dialog
485  SetFocus();
486 }
const wxString & GetFileName() const
Definition: sch_screen.h:157
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:278
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
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:176
SCH_SHEET * g_RootSheet
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 626 of file dialog_bom.cpp.

627 {
628 #ifdef __WINDOWS__
629  static constexpr wxChar OPT_SHOW_CONSOLE[] = wxT( "show_console" );
630 
631  auto plugin = selectedGenerator();
632 
633  if( !plugin )
634  return;
635 
636  if( m_checkBoxShowConsole->IsChecked() )
637  {
638  if( plugin->Options().Index( OPT_SHOW_CONSOLE ) == wxNOT_FOUND )
639  plugin->Options().Add( OPT_SHOW_CONSOLE );
640  }
641  else
642  {
643  plugin->Options().Remove( OPT_SHOW_CONSOLE );
644  }
645 #endif
646 }
wxCheckBox * m_checkBoxShowConsole
BOM_GENERATOR_HANDLER * selectedGenerator()
Definition: dialog_bom.cpp:202

References DIALOG_BOM_BASE::m_checkBoxShowConsole, and selectedGenerator().

◆ pluginExists()

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

Definition at line 409 of file dialog_bom.cpp.

410 {
411  for( unsigned ii = 0; ii < m_generators.size(); ii++ )
412  {
413  if( aName == m_generators[ii]->GetName() )
414  return true;
415  }
416 
417  return false;
418 }
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:177

References m_generators.

Referenced by OnAddGenerator().

◆ pluginInit()

void DIALOG_BOM::pluginInit ( )
private

Definition at line 427 of file dialog_bom.cpp.

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

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

Referenced by installGeneratorsList(), OnAddGenerator(), OnGeneratorSelected(), and OnRemoveGenerator().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:171

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_SCH_SHEET_PROPS::OnBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ ResetSize()

void DIALOG_SHIM::ResetSize ( )
protectedinherited

Clear the existing dialog size and position.

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

Definition at line 237 of file dialog_shim.cpp.

238 {
239  const char* hash_key;
240 
241  if( m_hash_key.size() )
242  {
243  // a special case like EDA_LIST_DIALOG, which has multiple uses.
244  hash_key = m_hash_key.c_str();
245  }
246  else
247  {
248  hash_key = typeid(*this).name();
249  }
250 
251  RECT_MAP::iterator it = class_map.find( hash_key );
252 
253  if( it == class_map.end() )
254  return;
255 
256  EDA_RECT rect = it->second;
257  rect.SetSize( 0, 0 );
258  class_map[ hash_key ] = rect;
259 }
std::string m_hash_key
Definition: dialog_shim.h:197
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

◆ selectedGenerator()

BOM_GENERATOR_HANDLER* DIALOG_BOM::selectedGenerator ( )
inlineprivate

Definition at line 202 of file dialog_bom.cpp.

203  {
204  int idx = m_lbGenerators->GetSelection();
205 
206  if( idx < 0 || idx >= (int)m_generators.size() )
207  return nullptr;
208 
209  return m_generators[idx].get();
210  }
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:177
wxListBox * m_lbGenerators

References m_generators, and DIALOG_BOM_BASE::m_lbGenerators.

Referenced by OnCommandLineEdited(), OnEditGenerator(), 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 115 of file dialog_shim.h.

116  {
117  m_initialFocusTarget = aWindow;
118  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203

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_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_AREA_PROPERTIES::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 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), 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 151 of file dialog_shim.cpp.

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

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 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:197
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:115
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxSize GetSize() const
Definition: eda_rect.h:103

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

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 365 of file dialog_shim.cpp.

366 {
367  // This is an exception safe way to zero a pointer before returning.
368  // Yes, even though DismissModal() clears this first normally, this is
369  // here in case there's an exception before the dialog is dismissed.
370  struct NULLER
371  {
372  void*& m_what;
373  NULLER( void*& aPtr ) : m_what( aPtr ) {}
374  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
375  } clear_this( (void*&) m_qmodal_loop );
376 
377  // release the mouse if it's currently captured as the window having it
378  // will be disabled when this dialog is shown -- but will still keep the
379  // capture making it impossible to do anything in the modal dialog itself
380  wxWindow* win = wxWindow::GetCapture();
381  if( win )
382  win->ReleaseMouse();
383 
384  // Get the optimal parent
385  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
386 
387  // Show the optimal parent
388  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
389 
390  wxASSERT_MSG( !m_qmodal_parent_disabler,
391  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
392 
393  // quasi-modal: disable only my "optimal" parent
395 
396 #ifdef __WXMAC__
397  // Apple in its infinite wisdom will raise a disabled window before even passing
398  // us the event, so we have no way to stop it. Instead, we must set an order on
399  // the windows so that the quasi-modal will be pushed in front of the disabled
400  // window when it is raised.
401  ReparentQuasiModal();
402 #endif
403  Show( true );
404 
405  m_qmodal_showing = true;
406 
407  WX_EVENT_LOOP event_loop;
408 
409  m_qmodal_loop = &event_loop;
410 
411  event_loop.Run();
412 
413  m_qmodal_showing = false;
414 
415  return GetReturnCode();
416 }
bool m_qmodal_showing
Definition: dialog_shim.h:207
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208
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 LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

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

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

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

Member Data Documentation

◆ m_buttonAddGenerator

wxBitmapButton* DIALOG_BOM_BASE::m_buttonAddGenerator
protectedinherited

◆ m_buttonDelGenerator

wxBitmapButton* DIALOG_BOM_BASE::m_buttonDelGenerator
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 178 of file dialog_bom.cpp.

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

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 202 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_generators

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 203 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 179 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), and OnIdle().

◆ m_lbGenerators

◆ m_Messages

wxTextCtrl* DIALOG_BOM_BASE::m_Messages
protectedinherited

◆ m_parent

SCH_EDIT_FRAME* DIALOG_BOM::m_parent
private

Definition at line 176 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), and OnRunGenerator().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 205 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 207 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_staticline

wxStaticLine* DIALOG_BOM_BASE::m_staticline
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_staticTextGeneratorTitle

wxStaticText* DIALOG_BOM_BASE::m_staticTextGeneratorTitle
protectedinherited

Definition at line 48 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_tabOrder

◆ 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: