KiCad PCB EDA Suite
DIALOG_EXPORT_STEP Class Reference
Inheritance diagram for DIALOG_EXPORT_STEP:
DIALOG_EXPORT_STEP_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  STEP_ORG_OPT {
  STEP_ORG_0, STEP_ORG_PLOT_AXIS, STEP_ORG_GRID_AXIS, STEP_ORG_BOARD_CENTER,
  STEP_ORG_USER
}
 

Public Member Functions

 DIALOG_EXPORT_STEP (PCB_EDIT_FRAME *aParent, const wxString &aBoardPath)
 
 ~DIALOG_EXPORT_STEP ()
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Member Functions

void onUpdateUnits (wxUpdateUIEvent &aEvent) override
 
void onUpdateXPos (wxUpdateUIEvent &aEvent) override
 
void onUpdateYPos (wxUpdateUIEvent &aEvent) override
 
void onExportButton (wxCommandEvent &aEvent) override
 
int GetOrgUnitsChoice () const
 
double GetXOrg () const
 
double GetYOrg ()
 
STEP_ORG_OPT GetOriginOption ()
 
bool GetNoVirtOption ()
 
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_txtBrdFile
 
wxFilePickerCtrl * m_filePickerSTEP
 
wxStaticLine * m_staticline2
 
wxStaticText * m_staticText6
 
wxRadioButton * m_rbDrillAndPlotOrigin
 
wxRadioButton * m_rbGridOrigin
 
wxRadioButton * m_rbUserDefinedOrigin
 
wxRadioButton * m_rbBoardCenterOrigin
 
wxStaticText * m_staticText2
 
wxStaticText * m_staticText5
 
wxChoice * m_STEP_OrgUnitChoice
 
wxStaticText * m_staticText3
 
TEXT_CTRL_EVALm_STEP_Xorg
 
wxStaticText * m_staticText4
 
TEXT_CTRL_EVALm_STEP_Yorg
 
wxStaticText * m_staticText7
 
wxCheckBox * m_cbRemoveVirtual
 
WX_HTML_REPORT_PANELm_messagesPanel
 
wxStaticLine * m_staticline
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
bool m_fixupsRun
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Attributes

PCB_EDIT_FRAMEm_parent
 
wxConfigBase * m_config
 
STEP_ORG_OPT m_STEP_org_opt
 
bool m_noVirtual
 
int m_OrgUnits
 
double m_XOrg
 
double m_YOrg
 
wxString m_boardPath
 

Detailed Description

Definition at line 50 of file dialog_export_step.cpp.

Member Enumeration Documentation

Enumerator
STEP_ORG_0 
STEP_ORG_PLOT_AXIS 
STEP_ORG_GRID_AXIS 
STEP_ORG_BOARD_CENTER 
STEP_ORG_USER 

Definition at line 53 of file dialog_export_step.cpp.

Constructor & Destructor Documentation

DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP ( PCB_EDIT_FRAME aParent,
const wxString &  aBoardPath 
)

Definition at line 116 of file dialog_export_step.cpp.

References DIALOG_SHIM::FinishDialogSettings(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), Kiface(), KIFACE_I::KifaceSettings(), m_boardPath, DIALOG_EXPORT_STEP_BASE::m_cbRemoveVirtual, m_config, DIALOG_EXPORT_STEP_BASE::m_filePickerSTEP, m_noVirtual, m_OrgUnits, m_parent, DIALOG_EXPORT_STEP_BASE::m_rbBoardCenterOrigin, DIALOG_EXPORT_STEP_BASE::m_rbDrillAndPlotOrigin, DIALOG_EXPORT_STEP_BASE::m_rbGridOrigin, DIALOG_EXPORT_STEP_BASE::m_rbUserDefinedOrigin, DIALOG_EXPORT_STEP_BASE::m_sdbSizer, DIALOG_EXPORT_STEP_BASE::m_sdbSizerCancel, m_STEP_org_opt, DIALOG_EXPORT_STEP_BASE::m_STEP_OrgUnitChoice, DIALOG_EXPORT_STEP_BASE::m_STEP_Xorg, DIALOG_EXPORT_STEP_BASE::m_STEP_Yorg, m_XOrg, m_YOrg, OPTKEY_STEP_NOVIRT, OPTKEY_STEP_ORIGIN_OPT, OPTKEY_STEP_UORG_UNITS, OPTKEY_STEP_UORG_X, OPTKEY_STEP_UORG_Y, TEXT_CTRL_EVAL::SetValue(), STEP_ORG_0, STEP_ORG_BOARD_CENTER, STEP_ORG_GRID_AXIS, STEP_ORG_PLOT_AXIS, and STEP_ORG_USER.

Referenced by GetNoVirtOption().

116  :
117  DIALOG_EXPORT_STEP_BASE( aParent )
118 {
119  m_parent = aParent;
120  m_boardPath = aBoardPath;
122  m_sdbSizerCancel->SetLabel( _( "Close" ) );
123  m_sdbSizer->Layout();
124 
125  // Build default output file name
126  wxFileName brdFile = m_parent->GetBoard()->GetFileName();
127  brdFile.SetExt( "step" );
128  m_filePickerSTEP->SetPath( brdFile.GetFullPath() );
129 
130  SetFocus();
131 
133  int tmp = STEP_ORG_0;
134 
135  if( m_config->Read( OPTKEY_STEP_ORIGIN_OPT, &tmp ) )
137 
138  switch( m_STEP_org_opt )
139  {
140  default: break;
141  case STEP_ORG_PLOT_AXIS: m_rbDrillAndPlotOrigin->SetValue( true ); break;
142  case STEP_ORG_GRID_AXIS: m_rbGridOrigin->SetValue( true ); break;
143  case STEP_ORG_USER: m_rbUserDefinedOrigin->SetValue( true ); break;
144  case STEP_ORG_BOARD_CENTER: m_rbBoardCenterOrigin->SetValue( true ); break;
145  }
146 
148  m_config->Read( OPTKEY_STEP_UORG_X, &m_XOrg, 0.0 );
149  m_config->Read( OPTKEY_STEP_UORG_Y, &m_YOrg, 0.0 );
151  m_cbRemoveVirtual->SetValue( m_noVirtual );
152 
153  m_STEP_OrgUnitChoice->SetSelection( m_OrgUnits );
154  wxString tmpStr;
155  tmpStr << m_XOrg;
156  m_STEP_Xorg->SetValue( tmpStr );
157  tmpStr = "";
158  tmpStr << m_YOrg;
159  m_STEP_Yorg->SetValue( tmpStr );
160 
161  // Now all widgets have the size fixed, call FinishDialogSettings
163 }
#define OPTKEY_STEP_UORG_X
#define OPTKEY_STEP_NOVIRT
wxRadioButton * m_rbDrillAndPlotOrigin
PCB_EDIT_FRAME * m_parent
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
#define OPTKEY_STEP_UORG_UNITS
BOARD * GetBoard() const
#define OPTKEY_STEP_ORIGIN_OPT
void SetValue(const wxString &aValue) override
Set a new value in evaluator buffer, and display it in the wxTextCtrl.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
wxFilePickerCtrl * m_filePickerSTEP
const wxString & GetFileName() const
Definition: class_board.h:236
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
wxStdDialogButtonSizer * m_sdbSizer
#define OPTKEY_STEP_UORG_Y
DIALOG_EXPORT_STEP_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Export STEP"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(552, 361), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
DIALOG_EXPORT_STEP::~DIALOG_EXPORT_STEP ( )
inline

Definition at line 104 of file dialog_export_step.cpp.

References GetOriginOption(), DIALOG_EXPORT_STEP_BASE::m_cbRemoveVirtual, DIALOG_EXPORT_STEP_BASE::m_STEP_OrgUnitChoice, DIALOG_EXPORT_STEP_BASE::m_STEP_Xorg, DIALOG_EXPORT_STEP_BASE::m_STEP_Yorg, OPTKEY_STEP_NOVIRT, OPTKEY_STEP_ORIGIN_OPT, OPTKEY_STEP_UORG_UNITS, OPTKEY_STEP_UORG_X, and OPTKEY_STEP_UORG_Y.

105  {
106  GetOriginOption(); // Update m_STEP_org_opt member.
108  m_config->Write( OPTKEY_STEP_NOVIRT, m_cbRemoveVirtual->GetValue() );
109  m_config->Write( OPTKEY_STEP_UORG_UNITS, m_STEP_OrgUnitChoice->GetSelection() );
110  m_config->Write( OPTKEY_STEP_UORG_X, m_STEP_Xorg->GetValue() );
111  m_config->Write( OPTKEY_STEP_UORG_Y, m_STEP_Yorg->GetValue() );
112  }
#define OPTKEY_STEP_UORG_X
#define OPTKEY_STEP_NOVIRT
#define OPTKEY_STEP_UORG_UNITS
#define OPTKEY_STEP_ORIGIN_OPT
STEP_ORG_OPT GetOriginOption()
#define OPTKEY_STEP_UORG_Y

Member Function Documentation

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 205 of file dialog_shim.cpp.

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

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

Definition at line 612 of file dialog_shim.cpp.

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

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

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

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

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

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

Definition at line 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

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

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

Definition at line 96 of file dialog_export_step.cpp.

References DIALOG_EXPORT_STEP(), and DIALOG_EXPORT_STEP_BASE::m_cbRemoveVirtual.

Referenced by onExportButton().

97  {
98  return m_cbRemoveVirtual->GetValue();
99  }
int DIALOG_EXPORT_STEP::GetOrgUnitsChoice ( ) const
inlineprotected

Definition at line 79 of file dialog_export_step.cpp.

References DIALOG_EXPORT_STEP_BASE::m_STEP_OrgUnitChoice.

Referenced by onExportButton().

80  {
81  return m_STEP_OrgUnitChoice->GetSelection();
82  }
DIALOG_EXPORT_STEP::STEP_ORG_OPT DIALOG_EXPORT_STEP::GetOriginOption ( )
protected

Definition at line 166 of file dialog_export_step.cpp.

References DIALOG_EXPORT_STEP_BASE::m_rbBoardCenterOrigin, DIALOG_EXPORT_STEP_BASE::m_rbDrillAndPlotOrigin, DIALOG_EXPORT_STEP_BASE::m_rbGridOrigin, DIALOG_EXPORT_STEP_BASE::m_rbUserDefinedOrigin, m_STEP_org_opt, STEP_ORG_0, STEP_ORG_BOARD_CENTER, STEP_ORG_GRID_AXIS, STEP_ORG_PLOT_AXIS, and STEP_ORG_USER.

Referenced by GetYOrg(), onExportButton(), and ~DIALOG_EXPORT_STEP().

double DIALOG_EXPORT_STEP::GetXOrg ( ) const
inlineprotected

Definition at line 84 of file dialog_export_step.cpp.

References DoubleValueFromString(), DIALOG_EXPORT_STEP_BASE::m_STEP_Xorg, and UNSCALED_UNITS.

Referenced by onExportButton().

85  {
86  return DoubleValueFromString( UNSCALED_UNITS, m_STEP_Xorg->GetValue() );
87  }
double DoubleValueFromString(EDA_UNITS_T aUnits, const wxString &aTextValue)
Function DoubleValueFromString converts aTextValue to a double.
Definition: base_units.cpp:303
double DIALOG_EXPORT_STEP::GetYOrg ( )
inlineprotected

Definition at line 89 of file dialog_export_step.cpp.

References DoubleValueFromString(), GetOriginOption(), DIALOG_EXPORT_STEP_BASE::m_STEP_Yorg, and UNSCALED_UNITS.

Referenced by onExportButton().

90  {
91  return DoubleValueFromString( UNSCALED_UNITS, m_STEP_Yorg->GetValue() );
92  }
double DoubleValueFromString(EDA_UNITS_T aUnits, const wxString &aTextValue)
Function DoubleValueFromString converts aTextValue to a double.
Definition: base_units.cpp:303
int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 125 of file dialog_shim.cpp.

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

126 {
127  wxSize sz( x, 0 );
128  return ConvertDialogToPixels( sz ).x;
129 }
KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

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

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

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

Reimplemented from DIALOG_EXPORT_STEP_BASE.

Definition at line 225 of file dialog_export_step.cpp.

References BuildBoardPolygonOutlines(), BOARD::ComputeBoundingBox(), DisplayErrorMessage(), dummy(), err, Format(), PCB_BASE_FRAME::GetBoard(), EDA_RECT::GetCenter(), GetNoVirtOption(), GetOrgUnitsChoice(), GetOriginOption(), GetXOrg(), GetYOrg(), m_boardPath, DIALOG_EXPORT_STEP_BASE::m_filePickerSTEP, DIALOG_EXPORT_STEP_BASE::m_messagesPanel, m_parent, REPORTER::Report(), WX_HTML_REPORT_PANEL::Reporter(), REPORTER::ReportHead(), REPORTER::ReportTail(), REPORTER::RPT_ACTION, REPORTER::RPT_ERROR, REPORTER::RPT_INFO, REPORTER::RPT_WARNING, STEP_ORG_0, STEP_ORG_BOARD_CENTER, STEP_ORG_GRID_AXIS, STEP_ORG_PLOT_AXIS, STEP_ORG_USER, wxPoint::x, and wxPoint::y.

226 {
227  SHAPE_POLY_SET outline;
228  wxString msg;
229 
230  // Check if the board outline is continuous
231  if( !BuildBoardPolygonOutlines( m_parent->GetBoard(), outline, &msg, Millimeter2iu( 0.01 ) ) )
232  {
233  DisplayErrorMessage( this, _( "Cannot determine the board outline." ), msg );
234  return;
235  }
236 
237  wxFileName fn = m_filePickerSTEP->GetFileName();
238 
239  if( fn.FileExists() )
240  {
241  msg.Printf( _( "File '%s' already exists. Do you want overwrite this file?" ),
242  fn.GetFullPath().GetData() );
243 
244  if( wxMessageBox( msg, _( "STEP Export" ), wxYES_NO | wxICON_QUESTION, this ) == wxNO )
245  return;
246  }
247 
249  double xOrg = 0.0;
250  double yOrg = 0.0;
251 
252  wxFileName appK2S( wxStandardPaths::Get().GetExecutablePath() );
253 
254 #ifdef __WXMAC__
255  // On macOS, we have standalone applications inside the main bundle, so we handle that here:
256  if( appK2S.GetPath().find( "/Contents/Applications/pcbnew.app/Contents/MacOS" ) != wxNOT_FOUND )
257  {
258  appK2S.AppendDir( ".." );
259  appK2S.AppendDir( ".." );
260  appK2S.AppendDir( ".." );
261  appK2S.AppendDir( ".." );
262  appK2S.AppendDir( "MacOS" );
263  }
264 #endif
265 
266  appK2S.SetName( "kicad2step" );
267 
268  wxString cmdK2S = "\"";
269  cmdK2S.Append( appK2S.GetFullPath() );
270  cmdK2S.Append( "\"" );
271 
272  if( GetNoVirtOption() )
273  cmdK2S.Append( " --no-virtual" );
274 
275  switch( orgOpt )
276  {
278  break;
279 
281  cmdK2S.Append( " --drill-origin" );
282  break;
283 
285  cmdK2S.Append( " --grid-origin" );
286  break;
287 
289  {
290  xOrg = GetXOrg();
291  yOrg = GetYOrg();
292 
293  if( GetOrgUnitsChoice() == 1 )
294  {
295  // selected reference unit is in inches, and STEP units are mm
296  xOrg *= 25.4;
297  yOrg *= 25.4;
298  }
299 
301  cmdK2S.Append( wxString::Format( " --user-origin %.6fx%.6f", xOrg, yOrg ) );
302  }
303  break;
304 
306  {
307  EDA_RECT bbox = m_parent->GetBoard()->ComputeBoundingBox( true );
308  xOrg = Iu2Millimeter( bbox.GetCenter().x );
309  yOrg = Iu2Millimeter( bbox.GetCenter().y );
311  cmdK2S.Append( wxString::Format( " --user-origin %.6fx%.6f", xOrg, yOrg ) );
312  }
313  break;
314  }
315 
316  cmdK2S.Append( " -f -o " );
317  cmdK2S.Append( wxString::Format("\"%s\"", m_filePickerSTEP->GetPath() ) ); // input file path
318 
319  cmdK2S.Append( " " );
320  cmdK2S.Append( wxString::Format("\"%s\"", m_boardPath ) ); // output file path
321 
322  int result = 0;
323  bool success = false;
324  wxArrayString output, errors;
325  REPORTER& reporter = m_messagesPanel->Reporter();
326  reporter.ReportHead( wxString::Format( _( "Executing '%s'" ), cmdK2S ), REPORTER::RPT_ACTION );
327 
328  {
329  wxBusyCursor dummy;
330  result = wxExecute( cmdK2S, output, errors, wxEXEC_SYNC | wxEXEC_HIDE_CONSOLE );
331  }
332 
333  // Check the output log for an indication of success,
334  // the value returned by wxExecute is not conclusive
335  for( auto& l : output )
336  {
337  if( l.Contains( "Done" ) )
338  {
339  success = true;
340  break;
341  }
342  }
343 
344  for( auto& err : errors )
345  reporter.Report( err, REPORTER::RPT_WARNING );
346 
347  if( result ) // Any troubles?
348  {
349  if( !success )
350  {
351  reporter.ReportTail( _( "Unable to create STEP file. Check that the board has a "
352  "valid outline and models." ), REPORTER::RPT_ERROR );
353  }
354  else
355  {
356  reporter.ReportTail( _( "STEP file has been created, but there are warnings." ),
358  }
359  }
360  else
361  {
362  reporter.ReportTail( _( "STEP file has been created successfully." ), REPORTER::RPT_INFO );
363  }
364 }
double GetXOrg() const
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Function DisplayErrorMessage displays an error message with aMessage.
Definition: confirm.cpp:199
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown...
Definition: common.h:167
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge seg...
bool BuildBoardPolygonOutlines(BOARD *aBoard, SHAPE_POLY_SET &aOutlines, wxString *aErrorText, unsigned int aTolerance)
PCB_EDIT_FRAME * m_parent
BOARD * GetBoard() const
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
STEP_ORG_OPT GetOriginOption()
wxFilePickerCtrl * m_filePickerSTEP
virtual REPORTER & ReportHead(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
Function ReportHead Places the report at the beginning of the list for objects that support ordering...
Definition: reporter.h:118
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
Function ReportTail Places the report at the end of the list, for objects that support report orderin...
Definition: reporter.h:109
Class SHAPE_POLY_SET.
REPORTER & Reporter()
returns the reporter object that reports to this panel
string & err
Definition: json11.cpp:598
WX_HTML_REPORT_PANEL * m_messagesPanel
int GetOrgUnitsChoice() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
const wxPoint GetCenter() const
Definition: eda_rect.h:115
void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 271 of file dialog_shim.cpp.

References DIALOG_SHIM::m_fixupsRun, and recursiveDescent().

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

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

Reimplemented from DIALOG_EXPORT_STEP_BASE.

Definition at line 205 of file dialog_export_step.cpp.

References DIALOG_EXPORT_STEP_BASE::m_rbUserDefinedOrigin.

206 {
207  aEvent.Enable( m_rbUserDefinedOrigin->GetValue() );
208 }
void DIALOG_EXPORT_STEP::onUpdateXPos ( wxUpdateUIEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_EXPORT_STEP_BASE.

Definition at line 211 of file dialog_export_step.cpp.

References DIALOG_EXPORT_STEP_BASE::m_rbUserDefinedOrigin.

212 {
213  aEvent.Enable( m_rbUserDefinedOrigin->GetValue() );
214 }
void DIALOG_EXPORT_STEP::onUpdateYPos ( wxUpdateUIEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from DIALOG_EXPORT_STEP_BASE.

Definition at line 217 of file dialog_export_step.cpp.

References BuildBoardPolygonOutlines(), and DIALOG_EXPORT_STEP_BASE::m_rbUserDefinedOrigin.

218 {
219  aEvent.Enable( m_rbUserDefinedOrigin->GetValue() );
220 }
PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:142
void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

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

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

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

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

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

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

Definition at line 118 of file dialog_shim.cpp.

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

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

Definition at line 146 of file dialog_shim.cpp.

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

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

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

Definition at line 558 of file dialog_shim.cpp.

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

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

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

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 132 of file dialog_shim.cpp.

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

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

Member Data Documentation

wxString DIALOG_EXPORT_STEP::m_boardPath
private

Definition at line 71 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP(), and onExportButton().

wxCheckBox* DIALOG_EXPORT_STEP_BASE::m_cbRemoveVirtual
protectedinherited
wxConfigBase* DIALOG_EXPORT_STEP::m_config
private

Definition at line 64 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP().

wxFilePickerCtrl* DIALOG_EXPORT_STEP_BASE::m_filePickerSTEP
protectedinherited
bool DIALOG_SHIM::m_fixupsRun
protectedinherited

Definition at line 149 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

std::string DIALOG_SHIM::m_hash_key
protectedinherited
WX_HTML_REPORT_PANEL* DIALOG_EXPORT_STEP_BASE::m_messagesPanel
protectedinherited
bool DIALOG_EXPORT_STEP::m_noVirtual
private

Definition at line 67 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP().

int DIALOG_EXPORT_STEP::m_OrgUnits
private

Definition at line 68 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP().

PCB_EDIT_FRAME* DIALOG_EXPORT_STEP::m_parent
private

Definition at line 63 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP(), and onExportButton().

EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 154 of file dialog_shim.h.

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

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited
bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 155 of file dialog_shim.h.

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

wxRadioButton* DIALOG_EXPORT_STEP_BASE::m_rbBoardCenterOrigin
protectedinherited
wxRadioButton* DIALOG_EXPORT_STEP_BASE::m_rbDrillAndPlotOrigin
protectedinherited
wxRadioButton* DIALOG_EXPORT_STEP_BASE::m_rbGridOrigin
protectedinherited
wxRadioButton* DIALOG_EXPORT_STEP_BASE::m_rbUserDefinedOrigin
protectedinherited
wxStdDialogButtonSizer* DIALOG_EXPORT_STEP_BASE::m_sdbSizer
protectedinherited
wxButton* DIALOG_EXPORT_STEP_BASE::m_sdbSizerCancel
protectedinherited
wxButton* DIALOG_EXPORT_STEP_BASE::m_sdbSizerOK
protectedinherited
wxStaticLine* DIALOG_EXPORT_STEP_BASE::m_staticline
protectedinherited
wxStaticLine* DIALOG_EXPORT_STEP_BASE::m_staticline2
protectedinherited
wxStaticText* DIALOG_EXPORT_STEP_BASE::m_staticText2
protectedinherited
wxStaticText* DIALOG_EXPORT_STEP_BASE::m_staticText3
protectedinherited
wxStaticText* DIALOG_EXPORT_STEP_BASE::m_staticText4
protectedinherited
wxStaticText* DIALOG_EXPORT_STEP_BASE::m_staticText5
protectedinherited
wxStaticText* DIALOG_EXPORT_STEP_BASE::m_staticText6
protectedinherited
wxStaticText* DIALOG_EXPORT_STEP_BASE::m_staticText7
protectedinherited
STEP_ORG_OPT DIALOG_EXPORT_STEP::m_STEP_org_opt
private

Definition at line 66 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP(), and GetOriginOption().

wxChoice* DIALOG_EXPORT_STEP_BASE::m_STEP_OrgUnitChoice
protectedinherited
wxStaticText* DIALOG_EXPORT_STEP_BASE::m_txtBrdFile
protectedinherited
double DIALOG_EXPORT_STEP::m_XOrg
private

Definition at line 69 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP().

double DIALOG_EXPORT_STEP::m_YOrg
private

Definition at line 70 of file dialog_export_step.cpp.

Referenced by DIALOG_EXPORT_STEP().


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