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_T 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...
 

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_T m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
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 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 
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 223 of file dialog_bom.cpp.

223  :
224  DIALOG_BOM_BASE( parent )
225 {
226  m_parent = parent;
228  m_initialized = false;
229 
230  m_buttonAddGenerator->SetBitmap( KiBitmap( small_plus_xpm ) );
231  m_buttonDelGenerator->SetBitmap( KiBitmap( trash_xpm ) );
232  m_buttonEdit->SetBitmap( KiBitmap( small_edit_xpm ) );
233 
235 
236 #ifndef __WINDOWS__
237  m_checkBoxShowConsole->Show( false );
238 #endif
239 
240  m_sdbSizerOK->SetLabel( _( "Generate" ) );
241  m_sdbSizerCancel->SetLabel( _( "Close" ) );
242  m_sdbSizer->Layout();
243 
245  m_sdbSizerOK->SetDefault();
246 
247  // Now all widgets have the size fixed, call FinishDialogSettings
249 }
wxBitmapButton * m_buttonEdit
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:118
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
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
void installGeneratorsList()
Definition: dialog_bom.cpp:299
bool m_initialized
Definition: dialog_bom.cpp:178
#define _(s)
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)
wxListBox * m_lbGenerators
wxButton * m_sdbSizerCancel
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:175
wxConfigBase * m_config
Definition: dialog_bom.cpp:177
wxBitmapButton * m_buttonDelGenerator

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, and DIALOG_SHIM::SetInitialFocus().

◆ ~DIALOG_BOM()

DIALOG_BOM::~DIALOG_BOM ( )

Definition at line 251 of file dialog_bom.cpp.

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  m_config->Write( BOM_GENERATORS_KEY, list );
292 
293  wxString active_plugin_name = m_lbGenerators->GetStringSelection( );
294  m_config->Write( BOM_GENERATOR_SELECTED_KEY, active_plugin_name );
295 }
static constexpr wxChar BOM_GENERATOR_SELECTED_KEY[]
Definition: dialog_bom.cpp:51
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: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
static constexpr wxChar BOM_GENERATORS_KEY[]
Definition: dialog_bom.cpp:50
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:177
Class 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 384 of file dialog_bom.cpp.

385 {
386  BOM_GENERATOR_HANDLER* ret = nullptr;
387  auto plugin = std::make_unique<BOM_GENERATOR_HANDLER>( aPath );
388 
389  if( !plugin )
390  return nullptr;
391 
392  if( !aName.IsEmpty() )
393  {
394  plugin->SetName( aName );
395  m_lbGenerators->Append( aName );
396  }
397  else
398  {
399  m_lbGenerators->Append( plugin->GetName() );
400  }
401 
402  ret = plugin.get();
403  m_generators.push_back( std::move( plugin ) );
404  return ret;
405 }
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 546 of file dialog_bom.cpp.

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

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

Referenced by OnAddGenerator().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 238 of file dialog_shim.cpp.

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 398 of file dialog_shim.cpp.

399 {
400  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
401  // handle validation in the same way as other dialogs.
402  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
403  return;
404 
405  SetReturnCode( retCode );
406 
407  if( !IsQuasiModal() )
408  {
409  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal 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 
420  m_qmodal_loop = NULL;
421  }
422 
425 
426  Show( false );
427 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:194
bool IsQuasiModal()
Definition: dialog_shim.h:127
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:197

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), 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 138 of file dialog_shim.cpp.

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

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_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_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_INSPECTOR::DIALOG_INSPECTOR(), 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_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::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(), PL_EDITOR_FRAME::SaveSettings(), 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 159 of file dialog_shim.cpp.

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

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  wxString list, active_plugin_name;
302  m_config->Read( BOM_GENERATORS_KEY, &list );
303  m_config->Read( BOM_GENERATOR_SELECTED_KEY, &active_plugin_name );
304 
305  if( !list.IsEmpty() )
306  {
307  BOM_CFG_PARSER cfg_parser( &m_generators, TO_UTF8( list ), wxT( "plugins" ) );
308 
309  try
310  {
311  cfg_parser.Parse();
312  }
313  catch( const IO_ERROR& )
314  {
315 // wxLogMessage( ioe.What() );
316  }
317  catch( std::runtime_error& e )
318  {
319  DisplayError( nullptr, e.what() );
320  }
321 
322  // Populate list box
323  for( unsigned ii = 0; ii < m_generators.size(); ii++ )
324  {
325  m_lbGenerators->Append( m_generators[ii]->GetName() );
326 
327  if( active_plugin_name == m_generators[ii]->GetName() )
328  m_lbGenerators->SetSelection( ii );
329  }
330  }
331 
332  if( m_generators.empty() ) // No plugins found?
333  {
334  // Load plugins from the default locations
335  std::vector<wxString> pluginPaths = {
336 #if defined(__WXGTK__)
337  "/usr/share/kicad/plugins",
338  "/usr/local/share/kicad/plugins",
339 #elif defined(__WXMSW__)
340  wxString::Format( "%s\\scripting\\plugins", Pgm().GetExecutablePath() ),
341 #elif defined(__WXMAC__)
342  wxString::Format( "%s/plugins", GetOSXKicadDataDir() ),
343 #endif
344  };
345 
346  wxFileName pluginPath;
347 
348  for( const auto& path : pluginPaths )
349  {
350  wxLogDebug( wxString::Format( "Searching directory %s for BOM generators", path ) );
351  wxDir dir( path );
352 
353  if( !dir.IsOpened() )
354  continue;
355 
356  pluginPath.AssignDir( dir.GetName() );
357  wxString fileName;
358  bool cont = dir.GetFirst( &fileName, wxFileSelectorDefaultWildcardStr, wxDIR_FILES );
359 
360  while( cont )
361  {
362  try
363  {
364  wxLogTrace( BOM_TRACE, wxString::Format( "Checking if %s is a BOM generator", fileName ) );
365 
367  {
368  pluginPath.SetFullName( fileName );
369  addGenerator( pluginPath.GetFullPath() );
370  }
371  }
372  catch( ... ) { /* well, no big deal */ }
373 
374  cont = dir.GetNext( &fileName );
375  }
376  }
377  }
378 
379 
380  pluginInit();
381 }
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:51
static constexpr wxChar BOM_TRACE[]
Definition: dialog_bom.cpp:48
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
#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: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
static constexpr wxChar BOM_GENERATORS_KEY[]
Definition: dialog_bom.cpp:50
wxConfigBase * m_config
Definition: dialog_bom.cpp:177
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:384
void pluginInit()
Definition: dialog_bom.cpp:426

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() && !e.ShiftDown() && !e.MetaDown();
140  }

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

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

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(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), 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(), 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 506 of file dialog_bom.cpp.

507 {
508  wxString filename = chooseGenerator();
509 
510  if( filename.IsEmpty() )
511  return;
512 
513  // Creates a new plugin entry
514  wxFileName fn( filename );
515  wxString name = wxGetTextFromUser( _( "Generator nickname:" ), _( "Add Generator" ),
516  fn.GetName(), this );
517 
518  if( name.IsEmpty() )
519  return;
520 
521  // Verify if it does not exists
522  if( pluginExists( name ) )
523  {
524  wxMessageBox( wxString::Format( _( "Nickname \"%s\" already in use." ), name ) );
525  return;
526  }
527 
528  try
529  {
530  auto plugin = addGenerator( fn.GetFullPath(), name );
531 
532  if( plugin )
533  {
534  m_lbGenerators->SetSelection( m_lbGenerators->GetCount() - 1 );
535  m_textCtrlCommand->SetValue( plugin->GetCommand() );
536  pluginInit();
537  }
538  }
539  catch( const std::runtime_error& e )
540  {
541  DisplayError( this, e.what() );
542  }
543 }
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:408
wxTextCtrl * m_textCtrlCommand
#define _(s)
wxString chooseGenerator()
Definition: dialog_bom.cpp:546
const char * name
Definition: DXF_plotter.cpp:61
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
wxListBox * m_lbGenerators
BOM_GENERATOR_HANDLER * addGenerator(const wxString &aPath, const wxString &aName=wxEmptyString)
Definition: dialog_bom.cpp:384
void pluginInit()
Definition: dialog_bom.cpp:426

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

References DIALOG_BOM_BASE::m_textCtrlCommand, and selectedGenerator().

◆ OnEditGenerator()

void DIALOG_BOM::OnEditGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 567 of file dialog_bom.cpp.

568 {
569  auto plugin = selectedGenerator();
570 
571  if( !plugin )
572  return;
573 
574  wxString pluginFile = plugin->GetFile().GetFullPath();
575 
576  if( pluginFile.Length() <= 2 ) // if name != ""
577  {
578  wxMessageBox( _( "Generator file name not found." ) );
579  return;
580  }
581 
582  AddDelimiterString( pluginFile );
583  wxString editorname = Pgm().GetEditorName();
584 
585  if( !editorname.IsEmpty() )
586  ExecuteFile( this, editorname, pluginFile );
587  else
588  wxMessageBox( _( "No text editor selected in KiCad. Please choose one." ) );
589 }
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
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)
VTBL_ENTRY const wxString & GetEditorName(bool aCanShowFileChooser=true)
Return the preferred editor name.
Definition: pgm_base.cpp:179
BOM_GENERATOR_HANDLER * selectedGenerator()
Definition: dialog_bom.cpp:201
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:178

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

◆ OnGeneratorSelected()

void DIALOG_BOM::OnGeneratorSelected ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 420 of file dialog_bom.cpp.

421 {
422  pluginInit();
423 }
void pluginInit()
Definition: dialog_bom.cpp:426

References pluginInit().

◆ OnHelp()

void DIALOG_BOM::OnHelp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 592 of file dialog_bom.cpp.

593 {
594  HTML_MESSAGE_BOX help_Dlg( this, _( "Bill of Material Generation Help" ) );
595  help_Dlg.SetDialogSizeInDU( 500, 350 );
596 
597  wxString msg = FROM_UTF8( s_bomHelpInfo );
598  help_Dlg.m_htmlWindow->AppendToPage( msg );
599  help_Dlg.ShowModal();
600 }
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
static const char * s_bomHelpInfo
Definition: dialog_bom.cpp:53
Class HTML_MESSAGE_BOX.
#define _(s)

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

◆ OnIdle()

void DIALOG_BOM::OnIdle ( wxIdleEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

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

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

300 {
301  if( m_firstPaintEvent )
302  {
303 #ifdef __WXMAC__
304  fixOSXCancelButtonIssue( this );
305 #endif
306 
307  selectAllInTextCtrls( GetChildren() );
308 
310  m_initialFocusTarget->SetFocus();
311  else
312  SetFocus(); // Focus the dialog itself
313 
314  m_firstPaintEvent = false;
315  }
316 
317  event.Skip();
318 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:192
bool m_firstPaintEvent
Definition: dialog_shim.h:191
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 488 of file dialog_bom.cpp.

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

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

◆ OnRunGenerator()

void DIALOG_BOM::OnRunGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOM_BASE.

Definition at line 456 of file dialog_bom.cpp.

457 {
458  // Calculate the xml netlist filename
459  wxFileName fn = g_RootSheet->GetScreen()->GetFileName();
460 
461  fn.SetPath( wxPathOnly( Prj().GetProjectFullName() ) );
462  fn.ClearExt();
463 
464  wxString fullfilename = fn.GetFullPath();
466 
467  wxString reportmsg;
468  WX_STRING_REPORTER reporter( &reportmsg );
470 
471 #ifdef __WINDOWS__
472  if( m_checkBoxShowConsole->IsChecked() )
473  m_parent->SetExecFlags( wxEXEC_SHOW_CONSOLE );
474 #endif
475 
476  auto netlist = m_parent->CreateNetlist( false, false );
477 
478  m_parent->WriteNetListFile( netlist, -1,
479  fullfilename, 0, &reporter );
480 
481  m_Messages->SetValue( reportmsg );
482 
483  // Force focus back on the dialog
484  SetFocus();
485 }
const wxString & GetFileName() const
Definition: sch_screen.h:123
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:281
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:47
wxCheckBox * m_checkBoxShowConsole
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxTextCtrl * m_textCtrlCommand
virtual void ClearMsgPanel()
Clear all messages from the message panel.
wxTextCtrl * m_Messages
Class WX_STRING_REPORTER is a wrapper for reporting to a wxString object.
Definition: reporter.h:165
NETLIST_OBJECT_LIST * CreateNetlist(bool aSilent=false, bool aSilentAnnotate=false)
Create a netlist for the current schematic.
SCH_EDIT_FRAME * m_parent
Definition: dialog_bom.cpp:175
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 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:201

References DIALOG_BOM_BASE::m_checkBoxShowConsole, and selectedGenerator().

◆ pluginExists()

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

Definition at line 408 of file dialog_bom.cpp.

409 {
410  for( unsigned ii = 0; ii < m_generators.size(); ii++ )
411  {
412  if( aName == m_generators[ii]->GetName() )
413  return true;
414  }
415 
416  return false;
417 }
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 426 of file dialog_bom.cpp.

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

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

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), 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(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_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::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), 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().

◆ selectedGenerator()

BOM_GENERATOR_HANDLER* DIALOG_BOM::selectedGenerator ( )
inlineprivate

Definition at line 201 of file dialog_bom.cpp.

202  {
203  int idx = m_lbGenerators->GetSelection();
204 
205  if( idx < 0 || idx >= (int)m_generators.size() )
206  return nullptr;
207 
208  return m_generators[idx].get();
209  }
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 118 of file dialog_shim.h.

119  {
120  m_initialFocusTarget = aWindow;
121  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:192

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_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 41 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetSizeInDU()

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

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

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

Definition at line 152 of file dialog_shim.cpp.

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

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

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

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_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(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 344 of file dialog_shim.cpp.

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

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

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

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

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 191 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 192 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 178 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_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 194 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 196 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: