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 }
 

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)
 
static void FixOSXCancelButtonIssue (wxWindow *aWindow)
 

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
 
EDA_BASE_FRAMEm_parentFrame
 
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
 
bool m_initialized
 

Detailed Description

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

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

222  :
223  DIALOG_BOM_BASE( parent )
224 {
225  m_parent = parent;
226  m_initialized = false;
227 
229  m_buttonDelGenerator->SetBitmap( KiBitmap( trash_xpm ) );
230  m_buttonEdit->SetBitmap( KiBitmap( small_edit_xpm ) );
231 
233 
234 #ifndef __WINDOWS__
235  m_checkBoxShowConsole->Show( false );
236 #endif
237 
238  m_sdbSizerOK->SetLabel( _( "Generate" ) );
239  m_sdbSizerCancel->SetLabel( _( "Close" ) );
240  m_sdbSizer->Layout();
241 
243  m_sdbSizerOK->SetDefault();
244 
245  // Now all widgets have the size fixed, call FinishDialogSettings
247 }
wxBitmapButton * m_buttonEdit
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:46
wxBitmapButton * m_buttonAddGenerator
wxStdDialogButtonSizer * m_sdbSizer
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:114
wxButton * m_sdbSizerOK
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
wxCheckBox * m_checkBoxShowConsole
void installGeneratorsList()
Definition: dialog_bom.cpp:299
bool m_initialized
Definition: dialog_bom.cpp:177
const BITMAP_OPAQUE small_edit_xpm[1]
Definition: small_edit.cpp:26
#define _(s)
Definition: 3d_actions.cpp:33
wxListBox * m_lbGenerators
wxButton * m_sdbSizerCancel
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:175
DIALOG_BOM_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Bill of Material"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
wxBitmapButton * m_buttonDelGenerator
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20

References _, DIALOG_SHIM::FinishDialogSettings(), installGeneratorsList(), KiBitmap(), DIALOG_BOM_BASE::m_buttonAddGenerator, DIALOG_BOM_BASE::m_buttonDelGenerator, DIALOG_BOM_BASE::m_buttonEdit, DIALOG_BOM_BASE::m_checkBoxShowConsole, 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 249 of file dialog_bom.cpp.

250 {
251  // TODO(JE) maybe unpack this into JSON instead of sexpr
252 
253  // Save the plugin descriptions in config.
254  // The config stores only one string, so we save the plugins inside a S-expr:
255  // ( plugins
256  // ( plugin "plugin name 1" (cmd "command line 1") )
257  // ( plugin "plugin name 2" (cmd "command line 2") (opts "option1") (opts "option2") )
258  // ....
259  // )
260 
261  STRING_FORMATTER writer;
262  writer.Print( 0, "(plugins" );
263 
264  for( auto& plugin : m_generators )
265  {
266  writer.Print( 1, "(plugin %s (cmd %s)",
267  writer.Quotew( plugin->GetFile().GetFullPath() ).c_str(),
268  writer.Quotew( plugin->GetCommand() ).c_str() );
269 
270  for( unsigned jj = 0; jj < plugin->Options().GetCount(); jj++ )
271  {
272  writer.Print( 1, "(opts %s)",
273  writer.Quotew( plugin->Options().Item( jj ) ).c_str() );
274  }
275 
276  if( !plugin->GetName().IsEmpty() )
277  {
278  wxString option = wxString::Format( "nickname=%s", plugin->GetName() );
279 
280  writer.Print( 1, "(opts %s)",
281  writer.Quotew( option ).c_str() );
282  }
283 
284  writer.Print( 0, ")" );
285  }
286 
287  writer.Print( 0, ")" );
288 
289  wxString list( FROM_UTF8( writer.GetString().c_str() ) );
290 
291  auto cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
292 
293  cfg->m_BomPanel.plugins = list.ToStdString();
294  cfg->m_BomPanel.selected_plugin = m_lbGenerators->GetStringSelection().ToStdString();
295 }
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:114
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
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:176
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
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:445

References Format(), FROM_UTF8(), STRING_FORMATTER::GetString(), Kiface(), 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:176
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 545 of file dialog_bom.cpp.

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

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

Referenced by OnAddGenerator().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 267 of file dialog_shim.cpp.

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

◆ 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( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
409  "wasn't called" );
410  return;
411  }
412 
413  if( m_qmodal_loop )
414  {
415  if( m_qmodal_loop->IsRunning() )
416  m_qmodal_loop->Exit( 0 );
417  else
418  m_qmodal_loop->ScheduleExit( 0 );
419 
421  }
422 
425 
426  Show( false );
427 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:206
#define NULL
bool IsQuasiModal()
Definition: dialog_shim.h:123
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:209

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

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC::DIALOG_DRC(), 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_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_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_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), 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_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), 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_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SCH_SHEET_PROPS::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().

◆ FixOSXCancelButtonIssue()

static void DIALOG_SHIM::FixOSXCancelButtonIssue ( wxWindow *  aWindow)
staticinherited

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

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

164 {
165  wxSize sz( x, 0 );
166  return ConvertDialogToPixels( sz ).x;
167 }

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

◆ installGeneratorsList()

void DIALOG_BOM::installGeneratorsList ( )
private

Definition at line 299 of file dialog_bom.cpp.

300 {
301  auto cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
302 
303  wxString list = cfg->m_BomPanel.plugins;
304  wxString active_plugin_name = cfg->m_BomPanel.selected_plugin;
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:239
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
static constexpr wxChar BOM_TRACE[]
Definition: dialog_bom.cpp:51
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
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:67
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:176
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
#define TO_UTF8(wxstring)
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_TRACE, DisplayError(), Format(), BOM_GENERATOR_HANDLER::IsValidGenerator(), Kiface(), 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 136 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::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(), 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(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), 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(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), 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(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAddGenerator()

void DIALOG_BOM::OnAddGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 505 of file dialog_bom.cpp.

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

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

References DIALOG_BOM_BASE::m_textCtrlCommand, and selectedGenerator().

◆ OnEditGenerator()

void DIALOG_BOM::OnEditGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 566 of file dialog_bom.cpp.

567 {
568  auto plugin = selectedGenerator();
569 
570  if( !plugin )
571  return;
572 
573  wxString pluginFile = plugin->GetFile().GetFullPath();
574 
575  if( pluginFile.Length() <= 2 ) // if name != ""
576  {
577  wxMessageBox( _( "Generator file name not found." ) );
578  return;
579  }
580 
581  AddDelimiterString( pluginFile );
582  wxString editorname = Pgm().GetEditorName();
583 
584  if( !editorname.IsEmpty() )
585  ExecuteFile( this, editorname, pluginFile );
586  else
587  wxMessageBox( _( "No text editor selected in KiCad. Please choose one." ) );
588 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
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:33
BOM_GENERATOR_HANDLER * selectedGenerator()
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: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 591 of file dialog_bom.cpp.

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

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

648 {
649  // On some platforms we initialize wxTextCtrls to all-selected, but we don't want that
650  // for the messages text box.
651  if( !m_initialized )
652  {
653  m_Messages->SetSelection( 0, 0 );
654  m_initialized = true;
655  }
656 }
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 612 of file dialog_bom.cpp.

613 {
614  int ii = m_lbGenerators->GetSelection();
615 
616  if( ii < 0 )
617  return;
618 
619  m_generators[ii]->SetName( m_textCtrlName->GetValue() );
620  m_lbGenerators->SetString( ii, m_generators[ii]->GetName() );
621 }
wxTextCtrl * m_textCtrlName
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:176
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 300 of file dialog_shim.cpp.

301 {
302  if( m_firstPaintEvent )
303  {
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:204
bool m_firstPaintEvent
Definition: dialog_shim.h:203
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:38
static void selectAllInTextCtrls(wxWindowList &children)

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), 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 487 of file dialog_bom.cpp.

488 {
489  int ii = m_lbGenerators->GetSelection();
490 
491  if( ii < 0 )
492  return;
493 
494  m_lbGenerators->Delete( ii );
495  m_generators.erase( m_generators.begin() + ii );
496 
497  // Select the next item, if exists
498  if( m_lbGenerators->GetCount() )
499  m_lbGenerators->SetSelection( std::min( ii, (int) m_lbGenerators->GetCount() - 1 ) );
500 
501  pluginInit();
502 }
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:176
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 = m_parent->Schematic().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  if( m_parent->ReadyToNetlist( false, false ) )
478  m_parent->WriteNetListFile( -1, fullfilename, GNL_OPT_BOM, &reporter );
479 
480  m_Messages->SetValue( reportmsg );
481 
482  // Force focus back on the dialog
483  SetFocus();
484 }
bool WriteNetListFile(int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=NULL)
Create a netlist file.
bool ReadyToNetlist(bool aSilent=false, bool aSilentAnnotate=false)
Checks if we are ready to write a netlist file for the current schematic.
wxString GetFileName() const
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:131
wxCheckBox * m_checkBoxShowConsole
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxTextCtrl * m_textCtrlCommand
SCHEMATIC & Schematic() const
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:156
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:175
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(), SCHEMATIC::GetFileName(), GNL_OPT_BOM, DIALOG_BOM_BASE::m_checkBoxShowConsole, DIALOG_BOM_BASE::m_Messages, m_parent, DIALOG_BOM_BASE::m_textCtrlCommand, KIWAY_HOLDER::Prj(), SCH_EDIT_FRAME::ReadyToNetlist(), SCH_EDIT_FRAME::Schematic(), 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 624 of file dialog_bom.cpp.

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

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

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

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(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), 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_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), 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::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), DRC::LoadRules(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), 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_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), 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(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), 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_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), 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(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), 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(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), 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(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), 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 242 of file dialog_shim.cpp.

243 {
244  const char* hash_key;
245 
246  if( m_hash_key.size() )
247  {
248  // a special case like EDA_LIST_DIALOG, which has multiple uses.
249  hash_key = m_hash_key.c_str();
250  }
251  else
252  {
253  hash_key = typeid(*this).name();
254  }
255 
256  RECT_MAP::iterator it = class_map.find( hash_key );
257 
258  if( it == class_map.end() )
259  return;
260 
261  EDA_RECT rect = it->second;
262  rect.SetSize( 0, 0 );
263  class_map[ hash_key ] = rect;
264 }
std::string m_hash_key
Definition: dialog_shim.h:198
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 200 of file dialog_bom.cpp.

201  {
202  int idx = m_lbGenerators->GetSelection();
203 
204  if( idx < 0 || idx >= (int)m_generators.size() )
205  return nullptr;
206 
207  return m_generators[idx].get();
208  }
BOM_GENERATOR_ARRAY m_generators
Definition: dialog_bom.cpp:176
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 114 of file dialog_shim.h.

115  {
116  m_initialFocusTarget = aWindow;
117  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:204

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_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), 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_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), 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_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(), PCB::IFACE::CreateWindow(), 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 156 of file dialog_shim.cpp.

157 {
158  wxSize sz( x, y );
159  SetSize( ConvertDialogToPixels( sz ) );
160 }

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

184 {
185  bool ret;
186  const char* hash_key;
187 
188  if( m_hash_key.size() )
189  {
190  // a special case like EDA_LIST_DIALOG, which has multiple uses.
191  hash_key = m_hash_key.c_str();
192  }
193  else
194  {
195  hash_key = typeid(*this).name();
196  }
197 
198  // Show or hide the window. If hiding, save current position and size.
199  // If showing, use previous position and size.
200  if( show )
201  {
202 #ifndef __WINDOWS__
203  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
204 #endif
205  ret = wxDialog::Show( show );
206 
207  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
208  EDA_RECT savedDialogRect = class_map[ hash_key ];
209 
210  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
211  {
212  SetSize( savedDialogRect.GetPosition().x,
213  savedDialogRect.GetPosition().y,
214  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
215  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
216  0 );
217  }
218 
219  // Be sure that the dialog appears in a visible area
220  // (the dialog position might have been stored at the time when it was
221  // shown on another display)
222  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
223  Centre();
224  }
225  else
226  {
227  // Save the dialog's position & size before hiding, using classname as key
228  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
229 
230 #ifdef __WXMAC__
231  if ( m_eventLoop )
232  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
233 #endif
234 
235  ret = wxDialog::Show( show );
236  }
237 
238  return ret;
239 }
std::string m_hash_key
Definition: dialog_shim.h:198
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::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), 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 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 
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.
380 
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:208
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:206
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:209
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:38
#define DBG(x)
Definition: fctsys.h:33
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:32

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

Referenced by 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(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

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

171 {
172  wxSize sz( 0, y );
173  return ConvertDialogToPixels( sz ).y;
174 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

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_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 203 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 204 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_lbGenerators

◆ m_Messages

wxTextCtrl* DIALOG_BOM_BASE::m_Messages
protectedinherited

◆ m_parent

SCH_EDIT_FRAME* DIALOG_BOM::m_parent
private

Definition at line 175 of file dialog_bom.cpp.

Referenced by DIALOG_BOM(), and OnRunGenerator().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 211 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook(), and DIALOG_DRC::OnDRCItemRClick().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 206 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 208 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: