KiCad PCB EDA Suite
DIALOG_EXPORT_SVG Class Reference
Inheritance diagram for DIALOG_EXPORT_SVG:
DIALOG_EXPORT_SVG_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_EXPORT_SVG (PCB_EDIT_FRAME *aParent, BOARD *aBoard)
 
 ~DIALOG_EXPORT_SVG () override
 
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 () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

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

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) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

wxStaticText * m_staticTextDir
 
wxTextCtrl * m_outputDirectoryName
 
wxBitmapButton * m_browseButton
 
wxStaticText * m_staticTextCopperLayers
 
wxCheckListBox * m_CopperLayersList
 
wxStaticText * m_staticTextTechLayers
 
wxCheckListBox * m_TechnicalLayersList
 
wxStaticText * m_penWidthLabel
 
wxTextCtrl * m_penWidthCtrl
 
wxStaticText * m_penWidthUnits
 
wxRadioBox * m_ModeColorOption
 
wxRadioBox * m_rbSvgPageSizeOpt
 
wxCheckBox * m_PrintBoardEdgesCtrl
 
wxCheckBox * m_printMirrorOpt
 
wxRadioBox * m_rbFileOpt
 
WX_HTML_REPORT_PANELm_messagesPanel
 
wxStdDialogButtonSizer * m_sdbSizer1
 
wxButton * m_sdbSizer1OK
 
wxButton * m_sdbSizer1Cancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

void initDialog ()
 
void OnButtonPlot (wxCommandEvent &event) override
 
void OnOutputDirectoryBrowseClicked (wxCommandEvent &event) override
 
void ExportSVGFile (bool aOnlyOneFile)
 
bool CreateSVGFile (const wxString &FullFileName)
 
LSET getCheckBoxSelectedLayers () const
 

Private Attributes

BOARDm_board
 
PCB_EDIT_FRAMEm_parent
 
LSET m_printMaskLayer
 
std::pair< wxCheckListBox *, int > m_boxSelectLayer [PCB_LAYER_ID_COUNT]
 
bool m_printBW
 
wxString m_outputDirectory
 
bool m_printMirror
 
bool m_oneFileOnly
 
UNIT_BINDER m_lineWidth
 

Detailed Description

Definition at line 42 of file dialog_export_svg.cpp.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_EXPORT_SVG()

DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG ( PCB_EDIT_FRAME aParent,
BOARD aBoard 
)

Definition at line 77 of file dialog_export_svg.cpp.

77  :
78  DIALOG_EXPORT_SVG_BASE( aParent ),
79  m_board( aBoard ),
80  m_parent( aParent ),
81  m_printBW( false ),
82  m_printMirror( false ),
83  m_oneFileOnly( false ),
85 {
86  m_browseButton->SetBitmap( KiBitmap( small_folder_xpm ) );
87 
88  initDialog();
89 
90  // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
91  // that requires us to correct the button labels here.
92  m_sdbSizer1OK->SetLabel( _( "Export" ) );
93  m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
94  m_sdbSizer1->Layout();
95 
97 }
const BITMAP_OPAQUE small_folder_xpm[1]
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:82
DIALOG_EXPORT_SVG_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Export SVG File"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
wxStdDialogButtonSizer * m_sdbSizer1
#define _(s)
Definition: 3d_actions.cpp:33
PCB_EDIT_FRAME * m_parent

References _, DIALOG_SHIM::finishDialogSettings(), initDialog(), KiBitmap(), DIALOG_EXPORT_SVG_BASE::m_browseButton, DIALOG_EXPORT_SVG_BASE::m_sdbSizer1, DIALOG_EXPORT_SVG_BASE::m_sdbSizer1Cancel, DIALOG_EXPORT_SVG_BASE::m_sdbSizer1OK, and small_folder_xpm.

◆ ~DIALOG_EXPORT_SVG()

DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG ( )
override

Definition at line 100 of file dialog_export_svg.cpp.

101 {
103  m_printBW = m_ModeColorOption->GetSelection();
104  m_oneFileOnly = m_rbFileOpt->GetSelection() == 1;
106  m_outputDirectory.Replace( wxT( "\\" ), wxT( "/" ) );
107 
108  auto cfg = m_parent->GetPcbNewSettings();
109 
111  cfg->m_ExportSvg.mirror = m_printMirror;
112  cfg->m_ExportSvg.one_file = m_oneFileOnly;
113  cfg->m_ExportSvg.plot_board_edges = m_PrintBoardEdgesCtrl->GetValue();
114  cfg->m_ExportSvg.page_size = m_rbSvgPageSizeOpt->GetSelection();
115  cfg->m_ExportSvg.output_dir = m_outputDirectory.ToStdString();
116 
117  cfg->m_ExportSvg.layers.clear();
118 
119  for( unsigned layer = 0; layer < arrayDim( m_boxSelectLayer ); ++layer )
120  {
121  if( !m_boxSelectLayer[layer].first )
122  continue;
123 
124  if( m_boxSelectLayer[layer].first->IsChecked( m_boxSelectLayer[layer].second ) )
125  cfg->m_ExportSvg.layers.push_back( m_boxSelectLayer[layer].second );
126  }
127 }
DIALOG_EXPORT_SVG m_ExportSvg
int g_DrawDefaultLineThickness
Default line thickness in internal units used to draw or plot items using a default thickness line va...
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual long long int GetValue()
Return the current value in Internal Units.
PCB_EDIT_FRAME * m_parent
std::pair< wxCheckListBox *, int > m_boxSelectLayer[PCB_LAYER_ID_COUNT]

References arrayDim(), PCBNEW_SETTINGS::DIALOG_EXPORT_SVG::black_and_white, g_DrawDefaultLineThickness, PCB_BASE_FRAME::GetPcbNewSettings(), UNIT_BINDER::GetValue(), m_boxSelectLayer, PCBNEW_SETTINGS::m_ExportSvg, m_lineWidth, DIALOG_EXPORT_SVG_BASE::m_ModeColorOption, m_oneFileOnly, m_outputDirectory, DIALOG_EXPORT_SVG_BASE::m_outputDirectoryName, m_parent, DIALOG_EXPORT_SVG_BASE::m_PrintBoardEdgesCtrl, m_printBW, m_printMirror, DIALOG_EXPORT_SVG_BASE::m_rbFileOpt, and DIALOG_EXPORT_SVG_BASE::m_rbSvgPageSizeOpt.

Member Function Documentation

◆ CreateSVGFile()

bool DIALOG_EXPORT_SVG::CreateSVGFile ( const wxString &  FullFileName)
private

Definition at line 278 of file dialog_export_svg.cpp.

279 {
280  PCB_PLOT_PARAMS plot_opts;
281 
282  plot_opts.SetPlotFrameRef( m_rbSvgPageSizeOpt->GetSelection() == 0 );
283 
284  // Adding drill marks, for copper layers
285  if( ( m_printMaskLayer & LSET::AllCuMask() ).any() )
287  else
289 
290  plot_opts.SetSkipPlotNPTH_Pads( false );
291 
292  plot_opts.SetMirror( m_printMirror );
293  plot_opts.SetFormat( PLOT_FORMAT::SVG );
294 
295  PAGE_INFO savedPageInfo = m_board->GetPageSettings();
296  wxPoint savedAuxOrigin = m_board->GetDesignSettings().m_AuxOrigin;
297 
298  if( m_rbSvgPageSizeOpt->GetSelection() == 2 ) // Page is board boundary size
299  {
301  PAGE_INFO currpageInfo = m_board->GetPageSettings();
302 
303  currpageInfo.SetWidthMils( bbox.GetWidth() / IU_PER_MILS );
304  currpageInfo.SetHeightMils( bbox.GetHeight() / IU_PER_MILS );
305  m_board->SetPageSettings( currpageInfo );
306  plot_opts.SetUseAuxOrigin( true );
307  wxPoint origin = bbox.GetOrigin();
309  }
310 
311  SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
313 
314  plot_opts.SetColorSettings( mgr.GetColorSettings( cfg->m_ColorTheme ) );
315 
316  LOCALE_IO toggle;
317 
318  SVG_PLOTTER* plotter = (SVG_PLOTTER*) StartPlotBoard( m_board, &plot_opts, UNDEFINED_LAYER,
319  aFullFileName, wxEmptyString );
320 
321  if( plotter )
322  {
323  plotter->SetColorMode( !m_printBW );
324 
325  for( LSEQ seq = m_printMaskLayer.SeqStackupBottom2Top(); seq; ++seq )
326  PlotOneBoardLayer( m_board, plotter, *seq, plot_opts );
327 
328  plotter->EndPlot();
329  }
330 
331  delete plotter;
332 
333  // reset to the values saved earlier
334  m_board->GetDesignSettings().m_AuxOrigin = savedAuxOrigin;
335  m_board->SetPageSettings( savedPageInfo );
336 
337  return true;
338 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
const PAGE_INFO & GetPageSettings() const
Definition: board.h:589
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
void SetUseAuxOrigin(bool aAux)
void PlotOneBoardLayer(BOARD *aBoard, PLOTTER *aPlotter, PCB_LAYER_ID aLayer, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotOneBoardLayer main function to plot one copper or technical layer.
virtual void SetColorMode(bool aColorMode)
Plot in B/W or color.
Definition: plotter.h:161
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: board.h:590
int GetWidth() const
Definition: eda_rect.h:114
void SetMirror(bool aFlag)
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:574
LSEQ SeqStackupBottom2Top() const
Return the sequence that is typical for a bottom-to-top stack-up.
Definition: lset.cpp:461
void SetDrillMarksType(DrillMarksType aVal)
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
virtual bool EndPlot() override
void SetPlotFrameRef(bool aFlag)
void SetColorSettings(COLOR_SETTINGS *aSettings)
const wxPoint GetOrigin() const
Definition: eda_rect.h:106
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
void SetSkipPlotNPTH_Pads(bool aSkip)
AppSettings * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
void SetFormat(PLOT_FORMAT aFormat)
PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:257
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
int GetHeight() const
Definition: eda_rect.h:115
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:243
Handle the component boundary box.
Definition: eda_rect.h:42
#define IU_PER_MILS
Definition: plotter.cpp:137
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition: board.cpp:1023
PLOTTER * StartPlotBoard(BOARD *aBoard, PCB_PLOT_PARAMS *aPlotOpts, int aLayer, const wxString &aFullFileName, const wxString &aSheetDesc)
Open a new plotfile using the options (and especially the format) specified in the options and prepar...
wxPoint m_AuxOrigin
origin for plot exports
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:176

References LSET::AllCuMask(), BOARD::ComputeBoundingBox(), SVG_PLOTTER::EndPlot(), PCB_PLOT_PARAMS::FULL_DRILL_SHAPE, SETTINGS_MANAGER::GetAppSettings(), SETTINGS_MANAGER::GetColorSettings(), BOARD::GetDesignSettings(), EDA_RECT::GetHeight(), EDA_RECT::GetOrigin(), BOARD::GetPageSettings(), EDA_RECT::GetWidth(), IU_PER_MILS, BOARD_DESIGN_SETTINGS::m_AuxOrigin, m_board, APP_SETTINGS_BASE::m_ColorTheme, m_printBW, m_printMaskLayer, m_printMirror, DIALOG_EXPORT_SVG_BASE::m_rbSvgPageSizeOpt, PCB_PLOT_PARAMS::NO_DRILL_SHAPE, Pgm(), PlotOneBoardLayer(), LSET::SeqStackupBottom2Top(), PLOTTER::SetColorMode(), PCB_PLOT_PARAMS::SetColorSettings(), PCB_PLOT_PARAMS::SetDrillMarksType(), PCB_PLOT_PARAMS::SetFormat(), PAGE_INFO::SetHeightMils(), PCB_PLOT_PARAMS::SetMirror(), BOARD::SetPageSettings(), PCB_PLOT_PARAMS::SetPlotFrameRef(), PCB_PLOT_PARAMS::SetSkipPlotNPTH_Pads(), PCB_PLOT_PARAMS::SetUseAuxOrigin(), PAGE_INFO::SetWidthMils(), StartPlotBoard(), SVG, and UNDEFINED_LAYER.

Referenced by ExportSVGFile().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 277 of file dialog_shim.cpp.

278 {
279  // so we can do logging of this state change:
280  return wxDialog::Enable( enable );
281 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 415 of file dialog_shim.cpp.

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

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_SYMBOL::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_SYMBOL::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ ExportSVGFile()

void DIALOG_EXPORT_SVG::ExportSVGFile ( bool  aOnlyOneFile)
private

Definition at line 221 of file dialog_export_svg.cpp.

222 {
224 
225  // Create output directory if it does not exist (also transform it in
226  // absolute form). Bail if it fails
227  wxString path = ExpandEnvVarSubstitutions( m_outputDirectory, &Prj() );
228  wxFileName outputDir = wxFileName::DirName( path );
229  wxString boardFilename = m_board->GetFileName();
230 
231  REPORTER& reporter = m_messagesPanel->Reporter();
232 
233  if( !EnsureFileDirectoryExists( &outputDir, boardFilename, &reporter ) )
234  {
235  wxString msg = wxString::Format( _( "Could not write plot files to folder \"%s\"." ),
236  outputDir.GetPath() );
237  DisplayError( this, msg );
238  return;
239  }
240 
241  m_printMirror = m_printMirrorOpt->GetValue();
242  m_printBW = m_ModeColorOption->GetSelection();
244 
245  LSET all_selected = getCheckBoxSelectedLayers();
246 
247  for( LSEQ seq = all_selected.Seq(); seq; ++seq )
248  {
249  PCB_LAYER_ID layer = *seq;
250  wxFileName fn( boardFilename );
251  wxString suffix = aOnlyOneFile ? wxT( "brd" ) : m_board->GetStandardLayerName( layer );
252 
253  BuildPlotFileName( &fn, outputDir.GetPath(), suffix, SVGFileExtension );
254  wxString svgPath = fn.GetFullPath();
255 
256  m_printMaskLayer = aOnlyOneFile ? all_selected : LSET( layer );
257 
258  if( m_PrintBoardEdgesCtrl->IsChecked() )
260 
261  if( CreateSVGFile( svgPath ) )
262  {
263  reporter.Report( wxString::Format( _( "Exported \"%s\"." ), svgPath ), RPT_SEVERITY_ACTION );
264  }
265  else // Error
266  {
267  reporter.Report( wxString::Format( _( "Unable to create file \"%s\"." ), svgPath ),
269  }
270 
271  if( aOnlyOneFile )
272  break;
273  }
274 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:253
bool CreateSVGFile(const wxString &FullFileName)
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:261
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:411
const wxString & GetFileName() const
Definition: board.h:281
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
PCB_LAYER_ID
A quick note on layer IDs:
LSET is a set of PCB_LAYER_IDs.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
Definition: common.cpp:289
int g_DrawDefaultLineThickness
Default line thickness in internal units used to draw or plot items using a default thickness line va...
LSET getCheckBoxSelectedLayers() const
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void BuildPlotFileName(wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
Function BuildPlotFileName (helper function) Complete a plot filename: forces the output directory,...
Definition: pcbplot.cpp:369
#define _(s)
Definition: 3d_actions.cpp:33
WX_HTML_REPORT_PANEL * m_messagesPanel
const std::string SVGFileExtension
virtual long long int GetValue()
Return the current value in Internal Units.

References _, BuildPlotFileName(), CreateSVGFile(), DisplayError(), Edge_Cuts, EnsureFileDirectoryExists(), ExpandEnvVarSubstitutions(), Format(), g_DrawDefaultLineThickness, getCheckBoxSelectedLayers(), BOARD::GetFileName(), BOARD::GetStandardLayerName(), UNIT_BINDER::GetValue(), m_board, m_lineWidth, DIALOG_EXPORT_SVG_BASE::m_messagesPanel, DIALOG_EXPORT_SVG_BASE::m_ModeColorOption, m_outputDirectory, DIALOG_EXPORT_SVG_BASE::m_outputDirectoryName, DIALOG_EXPORT_SVG_BASE::m_PrintBoardEdgesCtrl, m_printBW, m_printMaskLayer, m_printMirror, DIALOG_EXPORT_SVG_BASE::m_printMirrorOpt, KIWAY_HOLDER::Prj(), REPORTER::Report(), WX_HTML_REPORT_PANEL::Reporter(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, LSET::Seq(), and SVGFileExtension.

Referenced by OnButtonPlot().

◆ 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 after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 148 of file dialog_shim.cpp.

149 {
150  // must be called from the constructor of derived classes,
151  // when all widgets are initialized, and therefore their size fixed
152 
153  // SetSizeHints fixes the minimal size of sizers in the dialog
154  // (SetSizeHints calls Fit(), so no need to call it)
155  GetSizer()->SetSizeHints( this );
156 }

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), 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_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), 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_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ getCheckBoxSelectedLayers()

LSET DIALOG_EXPORT_SVG::getCheckBoxSelectedLayers ( ) const
private

Definition at line 172 of file dialog_export_svg.cpp.

173 {
174  LSET ret;
175 
176  for( unsigned layer = 0; layer < arrayDim(m_boxSelectLayer); ++layer )
177  {
178  if( !m_boxSelectLayer[layer].first )
179  continue;
180 
181  if( m_boxSelectLayer[layer].first->IsChecked( m_boxSelectLayer[layer].second ) )
182  ret.set( layer );
183  }
184 
185  return ret;
186 }
LSET is a set of PCB_LAYER_IDs.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
std::pair< wxCheckListBox *, int > m_boxSelectLayer[PCB_LAYER_ID_COUNT]

References arrayDim(), and m_boxSelectLayer.

Referenced by ExportSVGFile().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

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

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

◆ initDialog()

void DIALOG_EXPORT_SVG::initDialog ( )
private

Definition at line 130 of file dialog_export_svg.cpp.

131 {
132  auto cfg = m_parent->GetPcbNewSettings();
133 
134  m_printBW = cfg->m_ExportSvg.black_and_white;
135  m_printMirror = cfg->m_ExportSvg.mirror;
136  m_oneFileOnly = cfg->m_ExportSvg.one_file;
137  m_outputDirectory = cfg->m_ExportSvg.output_dir;
138 
139  m_rbSvgPageSizeOpt->SetSelection( cfg->m_ExportSvg.page_size );
140  m_PrintBoardEdgesCtrl->SetValue( cfg->m_ExportSvg.plot_board_edges );
141 
143 
144  m_ModeColorOption->SetSelection( m_printBW ? 1 : 0 );
145  m_printMirrorOpt->SetValue( m_printMirror );
146  m_rbFileOpt->SetSelection( m_oneFileOnly ? 1 : 0 );
147 
149 
150  for( LSEQ seq = m_board->GetEnabledLayers().UIOrder(); seq; ++seq )
151  {
152  PCB_LAYER_ID layer = *seq;
153  int checkIndex;
154 
155  if( IsCopperLayer( layer ) )
156  {
157  checkIndex = m_CopperLayersList->Append( m_board->GetLayerName( layer ) );
158  m_boxSelectLayer[layer] = std::make_pair( m_CopperLayersList, checkIndex );
159  }
160  else
161  {
162  checkIndex = m_TechnicalLayersList->Append( m_board->GetLayerName( layer ) );
163  m_boxSelectLayer[layer] = std::make_pair( m_TechnicalLayersList, checkIndex );
164  }
165 
166  if( alg::contains( cfg->m_ExportSvg.layers, layer ) )
167  m_boxSelectLayer[layer].first->Check( checkIndex, true );
168  }
169 }
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:343
wxCheckListBox * m_CopperLayersList
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings Returns a bit-mask of all t...
Definition: board.cpp:448
PCB_LAYER_ID
A quick note on layer IDs:
wxCheckListBox * m_TechnicalLayersList
int g_DrawDefaultLineThickness
Default line thickness in internal units used to draw or plot items using a default thickness line va...
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
PCBNEW_SETTINGS * GetPcbNewSettings() const
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
PCB_EDIT_FRAME * m_parent
LSEQ UIOrder() const
Definition: lset.cpp:888
std::pair< wxCheckListBox *, int > m_boxSelectLayer[PCB_LAYER_ID_COUNT]

References alg::contains(), g_DrawDefaultLineThickness, BOARD::GetEnabledLayers(), BOARD::GetLayerName(), PCB_BASE_FRAME::GetPcbNewSettings(), IsCopperLayer(), m_board, m_boxSelectLayer, DIALOG_EXPORT_SVG_BASE::m_CopperLayersList, m_lineWidth, DIALOG_EXPORT_SVG_BASE::m_ModeColorOption, m_oneFileOnly, m_outputDirectory, DIALOG_EXPORT_SVG_BASE::m_outputDirectoryName, m_parent, DIALOG_EXPORT_SVG_BASE::m_PrintBoardEdgesCtrl, m_printBW, m_printMirror, DIALOG_EXPORT_SVG_BASE::m_printMirrorOpt, DIALOG_EXPORT_SVG_BASE::m_rbFileOpt, DIALOG_EXPORT_SVG_BASE::m_rbSvgPageSizeOpt, DIALOG_EXPORT_SVG_BASE::m_TechnicalLayersList, UNIT_BINDER::SetValue(), and LSET::UIOrder().

Referenced by DIALOG_EXPORT_SVG().

◆ IsCtrl()

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

Definition at line 120 of file dialog_shim.h.

121  {
122  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
123  !e.ShiftDown() && !e.MetaDown();
124  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 126 of file dialog_shim.h.

127  {
128  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
129  e.ShiftDown() && !e.MetaDown();
130  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return 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:78

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), 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(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), SYMBOL_EDITOR_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnButtonPlot()

void DIALOG_EXPORT_SVG::OnButtonPlot ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXPORT_SVG_BASE.

Definition at line 341 of file dialog_export_svg.cpp.

342 {
343  m_oneFileOnly = m_rbFileOpt->GetSelection() == 1;
345 }
void ExportSVGFile(bool aOnlyOneFile)

References ExportSVGFile(), m_oneFileOnly, and DIALOG_EXPORT_SVG_BASE::m_rbFileOpt.

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 506 of file dialog_shim.cpp.

507 {
508  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
509  {
510  if( m_parentFrame )
511  {
513  return;
514  }
515  }
516  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
517  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
518  {
519  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
520  return;
521  }
522  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
523  {
524  wxWindow* currentWindow = wxWindow::FindFocus();
525  int currentIdx = -1;
526  int delta = aEvt.ShiftDown() ? -1 : 1;
527 
528  auto advance = [&]( int& idx )
529  {
530  // Wrap-around modulus
531  int size = m_tabOrder.size();
532  idx = ( ( idx + delta ) % size + size ) % size;
533  };
534 
535  for( size_t i = 0; i < m_tabOrder.size(); ++i )
536  {
537  if( m_tabOrder[i] == currentWindow )
538  {
539  currentIdx = (int) i;
540  break;
541  }
542  }
543 
544  if( currentIdx >= 0 )
545  {
546  advance( currentIdx );
547 
548  //todo: We don't currently have non-textentry dialog boxes but this will break if
549  // we add them.
550 #ifdef __APPLE__
551  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
552  advance( currentIdx );
553 #endif
554 
555  m_tabOrder[ currentIdx ]->SetFocus();
556  return;
557  }
558  }
559 
560  aEvt.Skip();
561 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:214
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:212
virtual void ToggleUserUnits()

References DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

◆ OnOutputDirectoryBrowseClicked()

void DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EXPORT_SVG_BASE.

Definition at line 189 of file dialog_export_svg.cpp.

190 {
191  // Build the absolute path of current output directory to preselect it in the file browser.
192  wxString path = ExpandEnvVarSubstitutions( m_outputDirectoryName->GetValue(), &Prj() );
193  path = Prj().AbsolutePath( path );
194 
195  wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
196 
197  if( dirDialog.ShowModal() == wxID_CANCEL )
198  return;
199 
200  wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
201 
202  wxMessageDialog dialog( this, _( "Use a relative path?" ), _( "Plot Output Directory" ),
203  wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
204 
205  if( dialog.ShowModal() == wxID_YES )
206  {
207  wxString boardFilePath = Prj().AbsolutePath( m_board->GetFileName() );
208 
209  boardFilePath = wxPathOnly( boardFilePath );
210 
211  if( !dirName.MakeRelativeTo( boardFilePath ) )
212  wxMessageBox( _( "Cannot make path relative (target volume different from board file volume)!" ),
213  _( "Plot Output Directory" ), wxOK | wxICON_ERROR );
214  }
215 
216  m_outputDirectoryName->SetValue( dirName.GetFullPath() );
218 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:261
const wxString & GetFileName() const
Definition: board.h:281
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
Definition: 3d_actions.cpp:33

References _, PROJECT::AbsolutePath(), ExpandEnvVarSubstitutions(), BOARD::GetFileName(), m_board, m_outputDirectory, DIALOG_EXPORT_SVG_BASE::m_outputDirectoryName, and KIWAY_HOLDER::Prj().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 322 of file dialog_shim.cpp.

323 {
324  if( m_firstPaintEvent )
325  {
327 
328  selectAllInTextCtrls( GetChildren() );
329 
332  else
333  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
334 
335  m_firstPaintEvent = false;
336  }
337 
338  event.Skip();
339 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:205
bool m_firstPaintEvent
Definition: dialog_shim.h:204
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:56
static void selectAllInTextCtrls(wxWindowList &children)

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ resetSize()

void DIALOG_SHIM::resetSize ( )
protectedinherited

Clear the existing dialog size and position.

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

Definition at line 252 of file dialog_shim.cpp.

253 {
254  const char* hash_key;
255 
256  if( m_hash_key.size() )
257  {
258  // a special case like EDA_LIST_DIALOG, which has multiple uses.
259  hash_key = m_hash_key.c_str();
260  }
261  else
262  {
263  hash_key = typeid(*this).name();
264  }
265 
266  RECT_MAP::iterator it = class_map.find( hash_key );
267 
268  if( it == class_map.end() )
269  return;
270 
271  EDA_RECT rect = it->second;
272  rect.SetSize( 0, 0 );
273  class_map[ hash_key ] = rect;
274 }
std::string m_hash_key
Definition: dialog_shim.h:195
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:139
Handle the component boundary box.
Definition: eda_rect.h:42

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

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

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

99  {
100  m_initialFocusTarget = aWindow;
101  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:205

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), 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_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), 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(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ setSizeInDU()

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

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

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

Definition at line 159 of file dialog_shim.cpp.

160 {
161  wxSize sz( x, y );
162  SetSize( ConvertDialogToPixels( sz ) );
163 }

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

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

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

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 365 of file dialog_shim.cpp.

366 {
367  // This is an exception safe way to zero a pointer before returning.
368  // Yes, even though DismissModal() clears this first normally, this is
369  // here in case there's an exception before the dialog is dismissed.
370  struct NULLER
371  {
372  void*& m_what;
373  NULLER( void*& aPtr ) : m_what( aPtr ) {}
374  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
375  } clear_this( (void*&) m_qmodal_loop );
376 
377  // release the mouse if it's currently captured as the window having it
378  // will be disabled when this dialog is shown -- but will still keep the
379  // capture making it impossible to do anything in the modal dialog itself
380  wxWindow* win = wxWindow::GetCapture();
381  if( win )
382  win->ReleaseMouse();
383 
384  // Get the optimal parent
385  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
386 
387  wxASSERT_MSG( !m_qmodal_parent_disabler,
388  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
389 
390  // quasi-modal: disable only my "optimal" parent
392 
393  // Apple in its infinite wisdom will raise a disabled window before even passing
394  // us the event, so we have no way to stop it. Instead, we must set an order on
395  // the windows so that the quasi-modal will be pushed in front of the disabled
396  // window when it is raised.
398 
399  Show( true );
400 
401  m_qmodal_showing = true;
402 
403  WX_EVENT_LOOP event_loop;
404 
405  m_qmodal_loop = &event_loop;
406 
407  event_loop.Run();
408 
409  m_qmodal_showing = false;
410 
411  return GetReturnCode();
412 }
bool m_qmodal_showing
Definition: dialog_shim.h:209
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:207
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:210
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:42
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:50

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

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 173 of file dialog_shim.cpp.

174 {
175  wxSize sz( 0, y );
176  return ConvertDialogToPixels( sz ).y;
177 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_board

BOARD* DIALOG_EXPORT_SVG::m_board
private

◆ m_boxSelectLayer

std::pair<wxCheckListBox*, int> DIALOG_EXPORT_SVG::m_boxSelectLayer[PCB_LAYER_ID_COUNT]
private

Definition at line 54 of file dialog_export_svg.cpp.

Referenced by getCheckBoxSelectedLayers(), initDialog(), and ~DIALOG_EXPORT_SVG().

◆ m_browseButton

wxBitmapButton* DIALOG_EXPORT_SVG_BASE::m_browseButton
protectedinherited

◆ m_CopperLayersList

wxCheckListBox* DIALOG_EXPORT_SVG_BASE::m_CopperLayersList
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 204 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 205 of file dialog_shim.h.

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

◆ m_lineWidth

UNIT_BINDER DIALOG_EXPORT_SVG::m_lineWidth
private

Definition at line 59 of file dialog_export_svg.cpp.

Referenced by ExportSVGFile(), initDialog(), and ~DIALOG_EXPORT_SVG().

◆ m_messagesPanel

WX_HTML_REPORT_PANEL* DIALOG_EXPORT_SVG_BASE::m_messagesPanel
protectedinherited

◆ m_ModeColorOption

wxRadioBox* DIALOG_EXPORT_SVG_BASE::m_ModeColorOption
protectedinherited

◆ m_oneFileOnly

bool DIALOG_EXPORT_SVG::m_oneFileOnly
private

Definition at line 58 of file dialog_export_svg.cpp.

Referenced by initDialog(), OnButtonPlot(), and ~DIALOG_EXPORT_SVG().

◆ m_outputDirectory

wxString DIALOG_EXPORT_SVG::m_outputDirectory
private

◆ m_outputDirectoryName

wxTextCtrl* DIALOG_EXPORT_SVG_BASE::m_outputDirectoryName
protectedinherited

◆ m_parent

PCB_EDIT_FRAME* DIALOG_EXPORT_SVG::m_parent
private

Definition at line 50 of file dialog_export_svg.cpp.

Referenced by initDialog(), and ~DIALOG_EXPORT_SVG().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 212 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_penWidthCtrl

wxTextCtrl* DIALOG_EXPORT_SVG_BASE::m_penWidthCtrl
protectedinherited

◆ m_penWidthLabel

wxStaticText* DIALOG_EXPORT_SVG_BASE::m_penWidthLabel
protectedinherited

◆ m_penWidthUnits

wxStaticText* DIALOG_EXPORT_SVG_BASE::m_penWidthUnits
protectedinherited

◆ m_PrintBoardEdgesCtrl

wxCheckBox* DIALOG_EXPORT_SVG_BASE::m_PrintBoardEdgesCtrl
protectedinherited

◆ m_printBW

bool DIALOG_EXPORT_SVG::m_printBW
private

Definition at line 55 of file dialog_export_svg.cpp.

Referenced by CreateSVGFile(), ExportSVGFile(), initDialog(), and ~DIALOG_EXPORT_SVG().

◆ m_printMaskLayer

LSET DIALOG_EXPORT_SVG::m_printMaskLayer
private

Definition at line 51 of file dialog_export_svg.cpp.

Referenced by CreateSVGFile(), and ExportSVGFile().

◆ m_printMirror

bool DIALOG_EXPORT_SVG::m_printMirror
private

Definition at line 57 of file dialog_export_svg.cpp.

Referenced by CreateSVGFile(), ExportSVGFile(), initDialog(), and ~DIALOG_EXPORT_SVG().

◆ m_printMirrorOpt

wxCheckBox* DIALOG_EXPORT_SVG_BASE::m_printMirrorOpt
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 207 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 209 of file dialog_shim.h.

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

◆ m_rbFileOpt

wxRadioBox* DIALOG_EXPORT_SVG_BASE::m_rbFileOpt
protectedinherited

◆ m_rbSvgPageSizeOpt

wxRadioBox* DIALOG_EXPORT_SVG_BASE::m_rbSvgPageSizeOpt
protectedinherited

◆ m_sdbSizer1

wxStdDialogButtonSizer* DIALOG_EXPORT_SVG_BASE::m_sdbSizer1
protectedinherited

◆ m_sdbSizer1Cancel

wxButton* DIALOG_EXPORT_SVG_BASE::m_sdbSizer1Cancel
protectedinherited

◆ m_sdbSizer1OK

wxButton* DIALOG_EXPORT_SVG_BASE::m_sdbSizer1OK
protectedinherited

◆ m_staticTextCopperLayers

wxStaticText* DIALOG_EXPORT_SVG_BASE::m_staticTextCopperLayers
protectedinherited

◆ m_staticTextDir

wxStaticText* DIALOG_EXPORT_SVG_BASE::m_staticTextDir
protectedinherited

◆ m_staticTextTechLayers

wxStaticText* DIALOG_EXPORT_SVG_BASE::m_staticTextTechLayers
protectedinherited

◆ m_tabOrder

◆ m_TechnicalLayersList

wxCheckListBox* DIALOG_EXPORT_SVG_BASE::m_TechnicalLayersList
protectedinherited

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

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