KiCad PCB EDA Suite
DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR Class Reference

#include <dialog_footprint_properties_fp_editor.h>

Inheritance diagram for DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR:
DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR (FOOTPRINT_EDIT_FRAME *aParent, FOOTPRINT *aFootprint)
 
 ~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR () override
 
bool Validate () override
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () 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)
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
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

virtual void OnInitDlg (wxInitDialogEvent &event)
 
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

wxNotebook * m_NoteBook
 
wxPanel * m_PanelGeneral
 
WX_GRIDm_itemsGrid
 
wxBitmapButton * m_bpAdd
 
wxBitmapButton * m_bpDelete
 
wxTextCtrl * m_FootprintNameCtrl
 
wxTextCtrl * m_DocCtrl
 
wxStaticText * staticKeywordsLabel
 
wxTextCtrl * m_KeywordCtrl
 
wxStaticBoxSizer * m_sizerAP
 
wxBoxSizer * m_sizerAllow90
 
wxStaticText * m_allow90Label
 
wxSlider * m_CostRot90Ctrl
 
wxBoxSizer * m_sizerAllow180
 
wxStaticText * m_allow180Label
 
wxSlider * m_CostRot180Ctrl
 
wxStaticText * m_componentTypeLabel
 
wxChoice * m_componentType
 
wxCheckBox * m_boardOnly
 
wxCheckBox * m_excludeFromPosFiles
 
wxCheckBox * m_excludeFromBOM
 
wxPanel * m_PanelClearances
 
wxStaticText * m_staticTextInfo
 
wxStaticText * m_staticTextInfoValPos
 
wxStaticText * m_staticTextInfoValNeg
 
wxStaticText * m_NetClearanceLabel
 
wxTextCtrl * m_NetClearanceCtrl
 
wxStaticText * m_NetClearanceUnits
 
wxStaticText * m_SolderMaskMarginLabel
 
wxTextCtrl * m_SolderMaskMarginCtrl
 
wxStaticText * m_SolderMaskMarginUnits
 
wxStaticText * m_SolderPasteMarginLabel
 
wxTextCtrl * m_SolderPasteMarginCtrl
 
wxStaticText * m_SolderPasteMarginUnits
 
wxStaticText * m_staticTextRatio
 
TEXT_CTRL_EVALm_SolderPasteMarginRatioCtrl
 
wxStaticText * m_SolderPasteRatioMarginUnits
 
wxStaticText * m_staticTextInfoCopper
 
wxStaticText * m_staticTextInfoPaste
 
wxStaticText * m_staticText16
 
wxChoice * m_ZoneConnectionChoice
 
wxPanel * m_Panel3D
 
wxBoxSizer * bSizerMain3D
 
WX_GRIDm_modelsGrid
 
wxBitmapButton * m_button3DShapeAdd
 
wxBitmapButton * m_button3DShapeBrowse
 
wxBitmapButton * m_button3DShapeRemove
 
wxButton * m_buttonConfig3DPaths
 
wxBoxSizer * bLowerSizer3D
 
wxStdDialogButtonSizer * m_sdbSizerStdButtons
 
wxButton * m_sdbSizerStdButtonsOK
 
wxButton * m_sdbSizerStdButtonsCancel
 
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 On3DModelSelected (wxGridEvent &) override
 
void On3DModelCellChanged (wxGridEvent &aEvent) override
 
void OnRemove3DModel (wxCommandEvent &event) override
 
void OnAdd3DModel (wxCommandEvent &event) override
 
void OnAdd3DRow (wxCommandEvent &event) override
 
void Cfg3DPath (wxCommandEvent &event) override
 
void OnGridSize (wxSizeEvent &event) override
 
void OnFootprintNameText (wxCommandEvent &event) override
 
void OnGridCellChanging (wxGridEvent &event)
 
void OnAddField (wxCommandEvent &event) override
 
void OnDeleteField (wxCommandEvent &event) override
 
void OnUpdateUI (wxUpdateUIEvent &event) override
 
bool checkFootprintName (const wxString &aFootprintName)
 
void select3DModel (int aModelIdx)
 
void adjustGridColumns (int aWidth)
 

Private Attributes

FOOTPRINT_EDIT_FRAMEm_frame
 
FOOTPRINTm_footprint
 
FP_TEXT_GRID_TABLEm_texts
 
UNIT_BINDER m_netClearance
 
UNIT_BINDER m_solderMask
 
UNIT_BINDER m_solderPaste
 
std::vector< FP_3DMODELm_shapes3D_list
 
PANEL_PREVIEW_3D_MODELm_previewPane
 
wxControl * m_delayedFocusCtrl
 
int m_delayedFocusPage
 
WX_GRIDm_delayedFocusGrid
 
int m_delayedFocusRow
 
int m_delayedFocusColumn
 
wxString m_delayedErrorMessage
 
bool m_inSelect
 

Static Private Attributes

static int m_page = 0
 

Detailed Description

Definition at line 39 of file dialog_footprint_properties_fp_editor.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR()

DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR ( FOOTPRINT_EDIT_FRAME aParent,
FOOTPRINT aFootprint 
)

Definition at line 55 of file dialog_footprint_properties_fp_editor.cpp.

56  :
61  m_inSelect( false )
62 {
63  m_frame = aParent;
64  m_footprint = aFootprint;
65 
67 
68  m_delayedErrorMessage = wxEmptyString;
69  m_delayedFocusCtrl = nullptr;
70  m_delayedFocusGrid = nullptr;
71  m_delayedFocusRow = -1;
73  m_delayedFocusPage = -1;
74 
75  // Give an icon
76  wxIcon icon;
77  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit ) );
78  SetIcon( icon );
79 
80  // Give a bit more room for combobox editors
81  m_itemsGrid->SetDefaultRowSize( m_itemsGrid->GetDefaultRowSize() + 4 );
82  m_modelsGrid->SetDefaultRowSize( m_modelsGrid->GetDefaultRowSize() + 4 );
83 
85  m_itemsGrid->PushEventHandler( new GRID_TRICKS( m_itemsGrid ) );
86  m_modelsGrid->PushEventHandler( new GRID_TRICKS( m_modelsGrid ) );
87 
88  // Show/hide columns according to the user's preference
90 
91  PCBNEW_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
92  if( cfg->m_lastFootprint3dDir.IsEmpty() )
93  {
94  wxGetEnv( KICAD6_3DMODEL_DIR, &cfg->m_lastFootprint3dDir );
95  }
96 
97  wxGridCellAttr* attr = new wxGridCellAttr;
98  attr->SetEditor( new GRID_CELL_PATH_EDITOR( this, m_modelsGrid, &cfg->m_lastFootprint3dDir,
99  "*.*", true, Prj().GetProjectPath() ) );
100  m_modelsGrid->SetColAttr( 0, attr );
101 
102  // Show checkbox
103  attr = new wxGridCellAttr;
104  attr->SetRenderer( new wxGridCellBoolRenderer() );
105  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
106  attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
107  m_modelsGrid->SetColAttr( 1, attr );
108  m_modelsGrid->SetWindowStyleFlag( m_modelsGrid->GetWindowStyle() & ~wxHSCROLL );
109 
110  aParent->Prj().Get3DCacheManager()->GetResolver()->SetProgramBase( &Pgm() );
111 
113 
114  bLowerSizer3D->Add( m_previewPane, 1, wxEXPAND, 5 );
115 
117 
118  // Set font sizes
119  wxFont infoFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
120  infoFont.SetSymbolicSize( wxFONTSIZE_SMALL );
121 #if __WXMAC__
122  m_allow90Label->SetFont( infoFont );
123  m_allow180Label->SetFont( infoFont );
124 #endif
125  m_staticTextInfoCopper->SetFont( infoFont );
126  m_staticTextInfoPaste->SetFont( infoFont );
127 
128  infoFont.SetStyle( wxFONTSTYLE_ITALIC );
129  m_staticTextInfoValNeg->SetFont( infoFont );
130  m_staticTextInfoValPos->SetFont( infoFont );
131 
132  if( m_page >= 0 )
133  m_NoteBook->SetSelection( (unsigned) m_page );
134 
135  if( m_page == 0 )
136  {
138  m_delayedFocusRow = 0;
140  m_delayedFocusPage = 0;
141  }
142  else if ( m_page == 1 )
144  else
145  {
147  m_delayedFocusRow = 0;
149  m_delayedFocusPage = 2;
150  }
151 
152  m_sdbSizerStdButtonsOK->SetDefault();
153 
154  // Configure button logos
155  m_bpAdd->SetBitmap( KiBitmap( BITMAPS::small_plus ) );
156  m_bpDelete->SetBitmap( KiBitmap( BITMAPS::small_trash ) );
160 
161  // wxFormBuilder doesn't include this event...
162  m_itemsGrid->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnGridCellChanging ), NULL, this );
163 
165 }
#define KICAD6_3DMODEL_DIR
A variable name whose value holds the path of 3D shape files.
Definition: eda_3d_viewer.h:45
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:129
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:52
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:65
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:97
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
wxString m_lastFootprint3dDir
#define NULL
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Footprint Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
Editor for wxGrid cells that adds a file/folder browser to the grid input field.
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
EDA_UNITS m_units
Definition: dialog_shim.h:198
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::bLowerSizer3D, DIALOG_SHIM::finishDialogSettings(), FOOTPRINT_EDIT_FRAME::GetSettings(), icon_modedit, KiBitmap(), KICAD6_3DMODEL_DIR, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_allow180Label, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_allow90Label, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_bpAdd, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_bpDelete, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_button3DShapeAdd, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_button3DShapeBrowse, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_button3DShapeRemove, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, m_footprint, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_FootprintNameCtrl, FOOTPRINT_EDITOR_SETTINGS::m_FootprintTextShownColumns, m_frame, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, PCBNEW_SETTINGS::m_lastFootprint3dDir, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NetClearanceCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NoteBook, m_page, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_Panel3D, m_previewPane, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_sdbSizerStdButtonsOK, m_shapes3D_list, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoCopper, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoPaste, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoValNeg, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoValPos, m_texts, DIALOG_SHIM::m_units, NULL, OnGridCellChanging(), Pgm(), KIWAY_HOLDER::Prj(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), WX_GRID::ShowHideColumns(), small_folder, small_plus, and small_trash.

◆ ~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR()

DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR ( )
override

Definition at line 168 of file dialog_footprint_properties_fp_editor.cpp.

169 {
171  m_itemsGrid->GetShownColumns().ToStdString();
172 
173  // Prevents crash bug in wxGrid's d'tor
175 
176  m_itemsGrid->Disconnect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnGridCellChanging ), NULL, this );
177 
178  // Delete the GRID_TRICKS.
179  m_itemsGrid->PopEventHandler( true );
180  m_modelsGrid->PopEventHandler( true );
181 
182  // free the memory used by all models, otherwise models which were
183  // browsed but not used would consume memory
184  Prj().Get3DCacheManager()->FlushCache( false );
185 
186  // the GL canvas has to be visible before it is destroyed
187  m_page = m_NoteBook->GetSelection();
188  m_NoteBook->SetSelection( 1 );
189 
190  delete m_previewPane;
191 }
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:97
#define NULL
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:110
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References WX_GRID::DestroyTable(), FOOTPRINT_EDIT_FRAME::GetSettings(), WX_GRID::GetShownColumns(), FOOTPRINT_EDITOR_SETTINGS::m_FootprintTextShownColumns, m_frame, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NoteBook, m_page, m_previewPane, m_texts, NULL, OnGridCellChanging(), and KIWAY_HOLDER::Prj().

Member Function Documentation

◆ adjustGridColumns()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::adjustGridColumns ( int  aWidth)
private

Definition at line 810 of file dialog_footprint_properties_fp_editor.cpp.

811 {
812  // Account for scroll bars
813  int itemsWidth = aWidth - ( m_itemsGrid->GetSize().x - m_itemsGrid->GetClientSize().x );
814  int modelsWidth = aWidth - ( m_modelsGrid->GetSize().x - m_modelsGrid->GetClientSize().x );
815 
816  itemsWidth -= m_itemsGrid->GetRowLabelSize();
817 
818  for( int i = 1; i < m_itemsGrid->GetNumberCols(); i++ )
819  itemsWidth -= m_itemsGrid->GetColSize( i );
820 
821  if( itemsWidth > 0 )
822  m_itemsGrid->SetColSize( 0, std::max( itemsWidth,
823  m_itemsGrid->GetVisibleWidth( 0, true, false, false ) ) );
824 
825  m_modelsGrid->SetColSize( 0, modelsWidth - m_modelsGrid->GetColSize( 1 ) - 5 );
826 }
int GetVisibleWidth(int aCol, bool aHeader=true, bool aContents=false, bool aKeep=true)
Calculates the specified column based on the actual size of the text on screen.
Definition: wx_grid.cpp:238

References WX_GRID::GetVisibleWidth(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid.

Referenced by OnGridSize(), OnUpdateUI(), and TransferDataToWindow().

◆ Cfg3DPath()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 803 of file dialog_footprint_properties_fp_editor.cpp.

804 {
805  if( S3D::Configure3DPaths( this, Prj().Get3DCacheManager()->GetResolver() ) )
807 }
void UpdateDummyFootprint(bool aRelaodRequired=true)
Copy shapes from the current shape list which are flagged for preview to the copy of footprint that i...
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool Configure3DPaths(wxWindow *aParent, FILENAME_RESOLVER *aResolver)

References S3D::Configure3DPaths(), m_previewPane, KIWAY_HOLDER::Prj(), and PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint().

◆ checkFootprintName()

bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::checkFootprintName ( const wxString &  aFootprintName)
private

Definition at line 528 of file dialog_footprint_properties_fp_editor.cpp.

529 {
530  if( aFootprintName.IsEmpty() )
531  {
532  m_delayedErrorMessage = _( "Footprint must have a name." );
533  return false;
534  }
535  else if( !FOOTPRINT::IsLibNameValid( aFootprintName ) )
536  {
537  m_delayedErrorMessage.Printf( _( "Footprint name may not contain '%s'." ),
539  return false;
540  }
541 
542  return true;
543 }
#define _(s)
static bool IsLibNameValid(const wxString &aName)
Test for validity of a name of a footprint to be used in a footprint library ( no spaces,...
Definition: footprint.cpp:1323
static const wxChar * StringLibNameInvalidChars(bool aUserReadable)
Test for validity of the name in a library of the footprint ( no spaces, dir separators ....
Definition: footprint.cpp:1334

References _, FOOTPRINT::IsLibNameValid(), m_delayedErrorMessage, and FOOTPRINT::StringLibNameInvalidChars().

Referenced by Validate().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 307 of file dialog_shim.cpp.

308 {
309  // so we can do logging of this state change:
310  return wxDialog::Enable( enable );
311 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 447 of file dialog_shim.cpp.

448 {
449  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
450  // handle validation in the same way as other dialogs.
451  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
452  return;
453 
454  SetReturnCode( retCode );
455 
456  if( !IsQuasiModal() )
457  {
458  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
459  "wasn't called" );
460  return;
461  }
462 
463  if( m_qmodal_loop )
464  {
465  if( m_qmodal_loop->IsRunning() )
466  m_qmodal_loop->Exit( 0 );
467  else
468  m_qmodal_loop->ScheduleExit( 0 );
469 
470  m_qmodal_loop = nullptr;
471  }
472 
474  m_qmodal_parent_disabler = nullptr;
475 
476  Show( false );
477 }
bool IsQuasiModal() const
Definition: dialog_shim.h:106
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:211
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:214

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_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().

◆ 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_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_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_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_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), 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_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), 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(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), 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().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:76

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

◆ IsCtrl()

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

Definition at line 124 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 130 of file dialog_shim.h.

131  {
132  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
133  e.ShiftDown() && !e.MetaDown();
134  }

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 53 of file kiway_holder.h.

54  {
55  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56  return *m_kiway;
57  }
KIWAY * m_kiway
Definition: kiway_holder.h:75

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::BuildLibrariesListBox(), 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(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), 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(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), 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(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), 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::SetCurSymbol(), 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(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ On3DModelCellChanged()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged ( wxGridEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 373 of file dialog_footprint_properties_fp_editor.cpp.

374 {
375  if( aEvent.GetCol() == 0 )
376  {
377  bool hasAlias = false;
378  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
379  wxString filename = m_modelsGrid->GetCellValue( aEvent.GetRow(), 0 );
380 
381  filename.Replace( "\n", "" );
382  filename.Replace( "\r", "" );
383  filename.Replace( "\t", "" );
384 
385  if( filename.empty() || !res->ValidateFileName( filename, hasAlias ) )
386  {
387  m_delayedErrorMessage = wxString::Format( _( "Invalid filename: %s" ), filename );
389  m_delayedFocusRow = aEvent.GetRow();
390  m_delayedFocusColumn = aEvent.GetCol();
391  m_delayedFocusPage = 2;
392  aEvent.Veto();
393  }
394 
395  // if the user has specified an alias in the name then prepend ':'
396  if( hasAlias )
397  filename.insert( 0, wxT( ":" ) );
398 
399 #ifdef __WINDOWS__
400  // In Kicad files, filenames and paths are stored using Unix notation
401  filename.Replace( wxT( "\\" ), wxT( "/" ) );
402 #endif
403 
404  m_shapes3D_list[ aEvent.GetRow() ].m_Filename = filename;
405  m_modelsGrid->SetCellValue( aEvent.GetRow(), 0, filename );
406  }
407  else if( aEvent.GetCol() == 1 )
408  {
409  wxString showValue = m_modelsGrid->GetCellValue( aEvent.GetRow(), 1 );
410 
411  m_shapes3D_list[ aEvent.GetRow() ].m_Show = ( showValue == wxT( "1" ) );
412  }
413 
415 }
void UpdateDummyFootprint(bool aRelaodRequired=true)
Copy shapes from the current shape list which are flagged for preview to the copy of footprint that i...
bool ValidateFileName(const wxString &aFileName, bool &hasAlias) const
Returns true if the given path is a valid aliased relative path.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
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
Provide an extensible class to resolve 3D model paths.

References _, Format(), m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, m_previewPane, m_shapes3D_list, KIWAY_HOLDER::Prj(), PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint(), and FILENAME_RESOLVER::ValidateFileName().

◆ On3DModelSelected()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelSelected ( wxGridEvent &  aEvent)
overrideprivatevirtual

◆ OnAdd3DModel()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAdd3DModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 436 of file dialog_footprint_properties_fp_editor.cpp.

437 {
439  return;
440 
441  int selected = m_modelsGrid->GetGridCursorRow();
442 
443  PROJECT& prj = Prj();
444  FP_3DMODEL model;
445 
446  wxString initialpath = prj.GetRString( PROJECT::VIEWER_3D_PATH );
447  wxString sidx = prj.GetRString( PROJECT::VIEWER_3D_FILTER_INDEX );
448  int filter = 0;
449 
450  // If the PROJECT::VIEWER_3D_PATH hasn't been set yet, use the KICAD6_3DMODEL_DIR environment
451  // variable and fall back to the project path if necessary.
452  if( initialpath.IsEmpty() )
453  {
454  if( !wxGetEnv( "KICAD6_3DMODEL_DIR", &initialpath ) || initialpath.IsEmpty() )
455  initialpath = prj.GetProjectPath();
456  }
457 
458  if( !sidx.empty() )
459  {
460  long tmp;
461  sidx.ToLong( &tmp );
462 
463  if( tmp > 0 && tmp <= INT_MAX )
464  filter = (int) tmp;
465  }
466 
467  if( !S3D::Select3DModel( this, Prj().Get3DCacheManager(), initialpath, filter, &model )
468  || model.m_Filename.empty() )
469  {
470  select3DModel( selected );
471  return;
472  }
473 
474  prj.SetRString( PROJECT::VIEWER_3D_PATH, initialpath );
475  sidx = wxString::Format( wxT( "%i" ), filter );
477  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
478  wxString alias;
479  wxString shortPath;
480  wxString filename = model.m_Filename;
481 
482  if( res && res->SplitAlias( filename, alias, shortPath ) )
483  filename = alias + wxT( ":" ) + shortPath;
484 
485 #ifdef __WINDOWS__
486  // In Kicad files, filenames and paths are stored using Unix notation
487  model.m_Filename.Replace( "\\", "/" );
488 #endif
489 
490  model.m_Show = true;
491  m_shapes3D_list.push_back( model );
492 
493  int idx = m_modelsGrid->GetNumberRows();
494  m_modelsGrid->AppendRows( 1 );
495  m_modelsGrid->SetCellValue( idx, 0, filename );
496  m_modelsGrid->SetCellValue( idx, 1, wxT( "1" ) );
497 
498  select3DModel( idx );
500 }
Container for project specific data.
Definition: project.h:62
void UpdateDummyFootprint(bool aRelaodRequired=true)
Copy shapes from the current shape list which are flagged for preview to the copy of footprint that i...
bool SplitAlias(const wxString &aFileName, wxString &anAlias, wxString &aRelPath) const
Return true if the given name contains an alias and populates the string anAlias with the alias and a...
bool Select3DModel(wxWindow *aParent, S3D_CACHE *aCache, wxString &prevModelSelectDir, int &prevModelWildcard, FP_3DMODEL *aModel)
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
bool m_Show
Include model in rendering.
Definition: footprint.h:98
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
virtual void SetRString(RSTRING_T aStringId, const wxString &aString)
Store a "retained string", which is any session and project specific string identified in enum RSTRIN...
Definition: project.cpp:213
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
wxString m_Filename
The 3D shape filename in 3D library.
Definition: footprint.h:97
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
Definition: project.cpp:228
Provide an extensible class to resolve 3D model paths.

References WX_GRID::CommitPendingChanges(), filter, Format(), PROJECT::GetProjectPath(), PROJECT::GetRString(), FP_3DMODEL::m_Filename, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, m_previewPane, m_shapes3D_list, FP_3DMODEL::m_Show, KIWAY_HOLDER::Prj(), S3D::Select3DModel(), select3DModel(), PROJECT::SetRString(), FILENAME_RESOLVER::SplitAlias(), PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint(), PROJECT::VIEWER_3D_FILTER_INDEX, and PROJECT::VIEWER_3D_PATH.

◆ OnAdd3DRow()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAdd3DRow ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 503 of file dialog_footprint_properties_fp_editor.cpp.

504 {
506  return;
507 
508  FP_3DMODEL model;
509 
510  model.m_Show = true;
511  m_shapes3D_list.push_back( model );
512 
513  int row = m_modelsGrid->GetNumberRows();
514  m_modelsGrid->AppendRows( 1 );
515  m_modelsGrid->SetCellValue( row, 1, wxT( "1" ) );
516 
517  select3DModel( row );
518 
519  m_modelsGrid->SetFocus();
520  m_modelsGrid->MakeCellVisible( row, 0 );
521  m_modelsGrid->SetGridCursor( row, 0 );
522 
523  m_modelsGrid->EnableCellEditControl( true );
524  m_modelsGrid->ShowCellEditControl();
525 }
bool m_Show
Include model in rendering.
Definition: footprint.h:98
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182

References WX_GRID::CommitPendingChanges(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, m_shapes3D_list, FP_3DMODEL::m_Show, and select3DModel().

◆ OnAddField()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 741 of file dialog_footprint_properties_fp_editor.cpp.

742 {
744  return;
745 
746  const BOARD_DESIGN_SETTINGS& dsnSettings = m_frame->GetDesignSettings();
747  FP_TEXT textItem( m_footprint );
748 
749  // Set active layer if legal; otherwise copy layer from previous text item
751  textItem.SetLayer( m_frame->GetActiveLayer() );
752  else
753  textItem.SetLayer( m_texts->at( m_texts->size() - 1 ).GetLayer() );
754 
755  textItem.SetTextSize( dsnSettings.GetTextSize( textItem.GetLayer() ) );
756  textItem.SetTextThickness( dsnSettings.GetTextThickness( textItem.GetLayer() ) );
757  textItem.SetItalic( dsnSettings.GetTextItalic( textItem.GetLayer() ) );
758 
759  m_texts->push_back( textItem );
760 
761  // notify the grid
762  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
763  m_itemsGrid->ProcessTableMessage( msg );
764 
765  m_itemsGrid->SetFocus();
766  m_itemsGrid->MakeCellVisible( m_texts->size() - 1, 0 );
767  m_itemsGrid->SetGridCursor( m_texts->size() - 1, 0 );
768 
769  m_itemsGrid->EnableCellEditControl( true );
770  m_itemsGrid->ShowCellEditControl();
771 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Returns the BOARD_DESIGN_SETTINGS for the open project.
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:820
bool GetTextItalic(PCB_LAYER_ID aLayer) const
virtual PCB_LAYER_ID GetActiveLayer() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
Container for design settings for a BOARD object.

References LSET::AllTechMask(), WX_GRID::CommitPendingChanges(), PCB_BASE_FRAME::GetActiveLayer(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), BOARD_ITEM::GetLayer(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), m_footprint, m_frame, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, m_texts, EDA_TEXT::SetItalic(), BOARD_ITEM::SetLayer(), EDA_TEXT::SetTextSize(), and EDA_TEXT::SetTextThickness().

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

539 {
540  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
541  {
542  if( m_parentFrame )
543  {
545  return;
546  }
547  }
548  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
549  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
550  {
551  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
552  return;
553  }
554  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
555  {
556  wxWindow* currentWindow = wxWindow::FindFocus();
557  int currentIdx = -1;
558  int delta = aEvt.ShiftDown() ? -1 : 1;
559 
560  auto advance = [&]( int& idx )
561  {
562  // Wrap-around modulus
563  int size = m_tabOrder.size();
564  idx = ( ( idx + delta ) % size + size ) % size;
565  };
566 
567  for( size_t i = 0; i < m_tabOrder.size(); ++i )
568  {
569  if( m_tabOrder[i] == currentWindow )
570  {
571  currentIdx = (int) i;
572  break;
573  }
574  }
575 
576  if( currentIdx >= 0 )
577  {
578  advance( currentIdx );
579 
580  //todo: We don't currently have non-textentry dialog boxes but this will break if
581  // we add them.
582 #ifdef __APPLE__
583  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
584  advance( currentIdx );
585 #endif
586 
587  m_tabOrder[ currentIdx ]->SetFocus();
588  return;
589  }
590  }
591 
592  aEvt.Skip();
593 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:218
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:216
virtual void ToggleUserUnits()

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

◆ OnDeleteField()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 774 of file dialog_footprint_properties_fp_editor.cpp.

775 {
777  return;
778 
779  int curRow = m_itemsGrid->GetGridCursorRow();
780 
781  if( curRow < 0 )
782  return;
783  else if( curRow < 2 )
784  {
785  DisplayError( nullptr, _( "Reference and value are mandatory." ) );
786  return;
787  }
788 
789  m_texts->erase( m_texts->begin() + curRow );
790 
791  // notify the grid
792  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_DELETED, curRow, 1 );
793  m_itemsGrid->ProcessTableMessage( msg );
794 
795  if( m_itemsGrid->GetNumberRows() > 0 )
796  {
797  m_itemsGrid->MakeCellVisible( std::max( 0, curRow-1 ), m_itemsGrid->GetGridCursorCol() );
798  m_itemsGrid->SetGridCursor( std::max( 0, curRow-1 ), m_itemsGrid->GetGridCursorCol() );
799  }
800 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
#define _(s)
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182

References _, WX_GRID::CommitPendingChanges(), DisplayError(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, and m_texts.

◆ OnFootprintNameText()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnFootprintNameText ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 732 of file dialog_footprint_properties_fp_editor.cpp.

733 {
735  {
736  // Currently: nothing to do
737  }
738 }
static bool footprintIsFromBoard(FOOTPRINT *aFootprint)

References footprintIsFromBoard(), and m_footprint.

◆ OnGridCellChanging()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnGridCellChanging ( wxGridEvent &  event)
private

Definition at line 726 of file dialog_footprint_properties_fp_editor.cpp.

727 {
728  // Currently: nothing to do
729 }

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), and ~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR().

◆ OnGridSize()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnGridSize ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 890 of file dialog_footprint_properties_fp_editor.cpp.

891 {
892  adjustGridColumns( event.GetSize().GetX() );
893 
894  event.Skip();
895 }

References adjustGridColumns().

◆ OnInitDlg()

virtual void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::OnInitDlg ( wxInitDialogEvent &  event)
inlineprotectedvirtualinherited

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 354 of file dialog_shim.cpp.

355 {
356  if( m_firstPaintEvent )
357  {
359 
360  selectAllInTextCtrls( GetChildren() );
361 
364  else
365  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
366 
367  m_firstPaintEvent = false;
368  }
369 
370  event.Skip();
371 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:209
bool m_firstPaintEvent
Definition: dialog_shim.h:208
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
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().

◆ OnRemove3DModel()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnRemove3DModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 418 of file dialog_footprint_properties_fp_editor.cpp.

419 {
421  return;
422 
423  int idx = m_modelsGrid->GetGridCursorRow();
424 
425  if( idx >= 0 && m_modelsGrid->GetNumberRows() && !m_shapes3D_list.empty() )
426  {
427  m_shapes3D_list.erase( m_shapes3D_list.begin() + idx );
428  m_modelsGrid->DeleteRows( idx );
429 
430  select3DModel( idx ); // will clamp idx within bounds
432  }
433 }
void UpdateDummyFootprint(bool aRelaodRequired=true)
Copy shapes from the current shape list which are flagged for preview to the copy of footprint that i...
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182

References WX_GRID::CommitPendingChanges(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, m_previewPane, m_shapes3D_list, select3DModel(), and PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint().

◆ OnUpdateUI()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 829 of file dialog_footprint_properties_fp_editor.cpp.

830 {
831  if( !m_itemsGrid->IsCellEditControlShown() && !m_modelsGrid->IsCellEditControlShown() )
832  adjustGridColumns( m_itemsGrid->GetRect().GetWidth() );
833 
834  if( m_itemsGrid->IsCellEditControlShown() )
835  {
836  // Currently: nonthing to do
837  }
838 
839  // Handle a delayed focus. The delay allows us to:
840  // a) change focus when the error was triggered from within a killFocus handler
841  // b) show the correct notebook page in the background before the error dialog comes up
842  // when triggered from an OK or a notebook page change
843 
844  if( m_delayedFocusPage >= 0 )
845  {
846  if( m_NoteBook->GetSelection() != m_delayedFocusPage )
847  m_NoteBook->SetSelection( (unsigned) m_delayedFocusPage );
848 
849  m_delayedFocusPage = -1;
850  }
851 
852  if( !m_delayedErrorMessage.IsEmpty() )
853  {
854  // We will re-enter this routine when the error dialog is displayed, so make
855  // sure we don't keep putting up more dialogs.
856  wxString msg = m_delayedErrorMessage;
857  m_delayedErrorMessage = wxEmptyString;
858 
859  // Do not use DisplayErrorMessage(); it screws up window order on Mac
860  DisplayError( nullptr, msg );
861  }
862 
863  if( m_delayedFocusCtrl )
864  {
865  m_delayedFocusCtrl->SetFocus();
866 
867  if( auto textEntry = dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl ) )
868  textEntry->SelectAll();
869 
870  m_delayedFocusCtrl = nullptr;
871  }
872  else if( m_delayedFocusGrid )
873  {
874  m_delayedFocusGrid->SetFocus();
877 
878  m_delayedFocusGrid->EnableCellEditControl( true );
879  m_delayedFocusGrid->ShowCellEditControl();
880 
881  m_delayedFocusGrid = nullptr;
882  m_delayedFocusRow = -1;
884  }
885 
886  m_button3DShapeRemove->Enable( m_modelsGrid->GetNumberRows() > 0 );
887 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252

References adjustGridColumns(), DisplayError(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_button3DShapeRemove, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NoteBook.

◆ 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:53
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:186

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::BuildLibrariesListBox(), SIM_PLOT_FRAME::canCloseWindow(), Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), SCH_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(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::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(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SIM_PLOT_FRAME::initWorkbook(), 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(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), 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(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), 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(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDxf(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), 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_FRAME::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(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), 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_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), TransferDataToWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), ~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), 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 282 of file dialog_shim.cpp.

283 {
284  const char* hash_key;
285 
286  if( m_hash_key.size() )
287  {
288  // a special case like EDA_LIST_DIALOG, which has multiple uses.
289  hash_key = m_hash_key.c_str();
290  }
291  else
292  {
293  hash_key = typeid(*this).name();
294  }
295 
296  std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
297 
298  if( it == class_map.end() )
299  return;
300 
301  wxRect rect = it->second;
302  rect.SetSize( wxSize( 0, 0 ) );
303  class_map[ hash_key ] = rect;
304 }
std::string m_hash_key
Definition: dialog_shim.h:199
static std::unordered_map< std::string, wxRect > class_map

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ select3DModel()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::select3DModel ( int  aModelIdx)
private

Definition at line 347 of file dialog_footprint_properties_fp_editor.cpp.

348 {
349  m_inSelect = true;
350 
351  aModelIdx = std::max( 0, aModelIdx );
352  aModelIdx = std::min( aModelIdx, m_modelsGrid->GetNumberRows() - 1 );
353 
354  if( m_modelsGrid->GetNumberRows() )
355  {
356  m_modelsGrid->SelectRow( aModelIdx );
357  m_modelsGrid->SetGridCursor( aModelIdx, 0 );
358  }
359 
360  m_previewPane->SetSelectedModel( aModelIdx );
361 
362  m_inSelect = false;
363 }
void SetSelectedModel(int idx)
Set the currently selected index in the model list so that the scale/rotation/offset controls can be ...

References m_inSelect, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, m_previewPane, and PANEL_PREVIEW_3D_MODEL::SetSelectedModel().

Referenced by On3DModelSelected(), OnAdd3DModel(), OnAdd3DRow(), OnRemove3DModel(), and TransferDataToWindow().

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

98  {
99  m_initialFocusTarget = aWindow;
100  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:209

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_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_INSPECTION_REPORTER::DIALOG_INSPECTION_REPORTER(), 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::saveSymbolAs(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::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:75
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(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 187 of file dialog_shim.cpp.

188 {
189  wxDialog::SetPosition( aNewPosition );
190 
191  // Now update the stored position:
192  const char* hash_key;
193 
194  if( m_hash_key.size() )
195  {
196  // a special case like EDA_LIST_DIALOG, which has multiple uses.
197  hash_key = m_hash_key.c_str();
198  }
199  else
200  {
201  hash_key = typeid(*this).name();
202  }
203 
204  std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
205 
206  if( it == class_map.end() )
207  return;
208 
209  wxRect rect = it->second;
210  rect.SetPosition( aNewPosition );
211 
212  class_map[ hash_key ] = rect;
213 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
std::string m_hash_key
Definition: dialog_shim.h:199
static std::unordered_map< std::string, wxRect > class_map

References class_map, DIALOG_SHIM::m_hash_key, and PCAD2KICAD::SetPosition().

Referenced by DIALOG_SCH_FIND::DIALOG_SCH_FIND(), and PCB_BASE_FRAME::SelectOneLayer().

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

217 {
218  bool ret;
219  const char* hash_key;
220 
221  if( m_hash_key.size() )
222  {
223  // a special case like EDA_LIST_DIALOG, which has multiple uses.
224  hash_key = m_hash_key.c_str();
225  }
226  else
227  {
228  hash_key = typeid(*this).name();
229  }
230 
231  // Show or hide the window. If hiding, save current position and size.
232  // If showing, use previous position and size.
233  if( show )
234  {
235 #ifndef __WINDOWS__
236  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
237 #endif
238  ret = wxDialog::Show( show );
239 
240  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
241  wxRect savedDialogRect = class_map[ hash_key ];
242 
243  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
244  {
245  if( m_useCalculatedSize )
246  {
247  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
248  wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
249  }
250  else
251  {
252  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
253  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
254  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
255  0 );
256  }
257  }
258 
259  // Be sure that the dialog appears in a visible area
260  // (the dialog position might have been stored at the time when it was
261  // shown on another display)
262  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
263  Centre();
264  }
265  else
266  {
267  // Save the dialog's position & size before hiding, using classname as key
268  class_map[ hash_key ] = wxRect( wxDialog::GetPosition(), wxDialog::GetSize() );
269 
270 #ifdef __WXMAC__
271  if ( m_eventLoop )
272  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
273 #endif
274 
275  ret = wxDialog::Show( show );
276  }
277 
278  return ret;
279 }
std::string m_hash_key
Definition: dialog_shim.h:199
static std::unordered_map< std::string, wxRect > class_map
bool m_useCalculatedSize
Definition: dialog_shim.h:203

References class_map, 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 397 of file dialog_shim.cpp.

398 {
399  // This is an exception safe way to zero a pointer before returning.
400  // Yes, even though DismissModal() clears this first normally, this is
401  // here in case there's an exception before the dialog is dismissed.
402  struct NULLER
403  {
404  void*& m_what;
405  NULLER( void*& aPtr ) : m_what( aPtr ) {}
406  ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
407  } clear_this( (void*&) m_qmodal_loop );
408 
409  // release the mouse if it's currently captured as the window having it
410  // will be disabled when this dialog is shown -- but will still keep the
411  // capture making it impossible to do anything in the modal dialog itself
412  wxWindow* win = wxWindow::GetCapture();
413  if( win )
414  win->ReleaseMouse();
415 
416  // Get the optimal parent
417  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
418 
419  wxASSERT_MSG( !m_qmodal_parent_disabler,
420  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
421 
422  // quasi-modal: disable only my "optimal" parent
424 
425  // Apple in its infinite wisdom will raise a disabled window before even passing
426  // us the event, so we have no way to stop it. Instead, we must set an order on
427  // the windows so that the quasi-modal will be pushed in front of the disabled
428  // window when it is raised.
430 
431  Show( true );
432 
433  m_qmodal_showing = true;
434 
435  WX_EVENT_LOOP event_loop;
436 
437  m_qmodal_loop = &event_loop;
438 
439  event_loop.Run();
440 
441  m_qmodal_showing = false;
442 
443  return GetReturnCode();
444 }
bool m_qmodal_showing
Definition: dialog_shim.h:213
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:211
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:214
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:65

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(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), 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::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ TransferDataFromWindow()

bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow ( )
override

Definition at line 594 of file dialog_footprint_properties_fp_editor.cpp.

595 {
596  if( !Validate() )
597  return false;
598 
599  if( !DIALOG_SHIM::TransferDataFromWindow() )
600  return false;
601 
603  return false;
604 
606  return false;
607 
608  auto view = m_frame->GetCanvas()->GetView();
609  BOARD_COMMIT commit( m_frame );
610  commit.Modify( m_footprint );
611 
612  LIB_ID fpID = m_footprint->GetFPID();
613  fpID.SetLibItemName( m_FootprintNameCtrl->GetValue(), false );
614  m_footprint->SetFPID( fpID );
615 
616  m_footprint->SetDescription( m_DocCtrl->GetValue() );
617  m_footprint->SetKeywords( m_KeywordCtrl->GetValue() );
618 
619  // copy reference and value
620  m_footprint->Reference() = m_texts->at( 0 );
621  m_footprint->Value() = m_texts->at( 1 );
622 
623  size_t i = 2;
624  std::vector<FP_TEXT*> items_to_remove;
625 
626  for( BOARD_ITEM* item : m_footprint->GraphicalItems() )
627  {
628  FP_TEXT* textItem = dynamic_cast<FP_TEXT*>( item );
629 
630  if( textItem )
631  {
632  // copy grid table entries till we run out, then delete any remaining texts
633  if( i < m_texts->size() )
634  *textItem = m_texts->at( i++ );
635  else // store this item to remove and delete it later,
636  // after the graphic list is explored:
637  items_to_remove.push_back( textItem );
638  }
639  }
640 
641  // Remove text items:
643 
644  for( FP_TEXT* item: items_to_remove )
645  {
646  selTool->RemoveItemFromSel( item );
647  view->Remove( item );
648  item->DeleteStructure();
649  }
650 
651  // if there are still grid table entries, create new texts for them
652  while( i < m_texts->size() )
653  {
654  FP_TEXT* newText = new FP_TEXT( m_texts->at( i++ ) );
655  m_footprint->Add( newText, ADD_MODE::APPEND );
656  view->Add( newText );
657  }
658 
659  int attributes = 0;
660 
661  switch( m_componentType->GetSelection() )
662  {
663  case 0: attributes |= FP_THROUGH_HOLE; break;
664  case 1: attributes |= FP_SMD; break;
665  default: break;
666  }
667 
668  if( m_boardOnly->GetValue() )
669  attributes |= FP_BOARD_ONLY;
670 
671  if( m_excludeFromPosFiles->GetValue() )
672  attributes |= FP_EXCLUDE_FROM_POS_FILES;
673 
674  if( m_excludeFromBOM->GetValue() )
675  attributes |= FP_EXCLUDE_FROM_BOM;
676 
677  m_footprint->SetAttributes( attributes );
678 
681 
682  // Initialize masks clearances
686 
687  double dtmp = 0.0;
688  wxString msg = m_SolderPasteMarginRatioCtrl->GetValue();
689  msg.ToDouble( &dtmp );
690 
691  // A -50% margin ratio means no paste on a pad, the ratio must be >= -50%
692  if( dtmp < -50.0 )
693  dtmp = -50.0;
694  // A margin ratio is always <= 0
695  // 0 means use full pad copper area
696  if( dtmp > 0.0 )
697  dtmp = 0.0;
698 
700 
701  switch( m_ZoneConnectionChoice->GetSelection() )
702  {
703  default:
708  }
709 
710  std::list<FP_3DMODEL>* draw3D = &m_footprint->Models();
711  draw3D->clear();
712  draw3D->insert( draw3D->end(), m_shapes3D_list.begin(), m_shapes3D_list.end() );
713 
714  commit.Push( _( "Modify footprint properties" ) );
715 
716  return true;
717 }
std::list< FP_3DMODEL > & Models()
Definition: footprint.h:173
void SetZoneConnection(ZONE_CONNECTION aType)
Definition: footprint.h:217
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: footprint.h:215
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetAttributes(int aAttributes)
Definition: footprint.h:227
void SetPlacementCost180(int aCost)
Definition: footprint.h:530
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:457
void SetDescription(const wxString &aDoc)
Definition: footprint.h:189
FP_TEXT & Reference()
Definition: footprint.h:458
pads are covered by copper
void SetLocalClearance(int aClearance)
Definition: footprint.h:201
#define _(s)
DRAWINGS & GraphicalItems()
Definition: footprint.h:162
const LIB_ID & GetFPID() const
Definition: footprint.h:185
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:204
Use thermal relief for pads.
void SetFPID(const LIB_ID &aFPID)
Definition: footprint.h:186
void SetKeywords(const wxString &aKeywords)
Definition: footprint.h:192
The selection tool: currently supports:
Pads are not covered.
virtual long long int GetValue()
Return the current value in Internal Units.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
void RemoveItemFromSel(BOARD_ITEM *aItem, bool aQuietMode=false)
Multiple item unselection event handler.
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Removes an item from the container.
Definition: footprint.cpp:472
void SetPlacementCost90(int aCost)
Definition: footprint.h:533
void SetLocalSolderMaskMargin(int aMargin)
Definition: footprint.h:198
void SetLocalSolderPasteMargin(int aMargin)
Definition: footprint.h:212

References _, FOOTPRINT::Add(), APPEND, WX_GRID::CommitPendingChanges(), FP_BOARD_ONLY, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_SMD, FP_THROUGH_HOLE, FULL, PCB_BASE_FRAME::GetCanvas(), FOOTPRINT::GetFPID(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), UNIT_BINDER::GetValue(), PCB_DRAW_PANEL_GAL::GetView(), FOOTPRINT::GraphicalItems(), INHERITED, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_boardOnly, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_componentType, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_CostRot180Ctrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_CostRot90Ctrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_DocCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_excludeFromBOM, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_excludeFromPosFiles, m_footprint, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_FootprintNameCtrl, m_frame, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_KeywordCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, m_netClearance, m_shapes3D_list, m_solderMask, m_solderPaste, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl, m_texts, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_ZoneConnectionChoice, FOOTPRINT::Models(), COMMIT::Modify(), NONE, BOARD_COMMIT::Push(), FOOTPRINT::Reference(), PCB_SELECTION_TOOL::RemoveItemFromSel(), FOOTPRINT::SetAttributes(), FOOTPRINT::SetDescription(), FOOTPRINT::SetFPID(), FOOTPRINT::SetKeywords(), LIB_ID::SetLibItemName(), FOOTPRINT::SetLocalClearance(), FOOTPRINT::SetLocalSolderMaskMargin(), FOOTPRINT::SetLocalSolderPasteMargin(), FOOTPRINT::SetLocalSolderPasteMarginRatio(), FOOTPRINT::SetPlacementCost180(), FOOTPRINT::SetPlacementCost90(), FOOTPRINT::SetZoneConnection(), THERMAL, Validate(), and FOOTPRINT::Value().

◆ TransferDataToWindow()

bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow ( )
override

Definition at line 194 of file dialog_footprint_properties_fp_editor.cpp.

195 {
196  LIB_ID fpID = m_footprint->GetFPID();
197  wxString footprintName = fpID.GetLibItemName();
198 
199  m_FootprintNameCtrl->ChangeValue( footprintName );
200 
201  m_DocCtrl->SetValue( m_footprint->GetDescription() );
202  m_KeywordCtrl->SetValue( m_footprint->GetKeywords() );
203 
204  if( !wxDialog::TransferDataToWindow() )
205  return false;
206 
207  if( !m_PanelGeneral->TransferDataToWindow() )
208  return false;
209 
210  if( !m_Panel3D->TransferDataToWindow() )
211  return false;
212 
213  // Module Texts
214 
215  m_texts->push_back( m_footprint->Reference() );
216  m_texts->push_back( m_footprint->Value() );
217 
218  for( auto item : m_footprint->GraphicalItems() )
219  {
220  auto textItem = dyn_cast<FP_TEXT*>( item );
221 
222  if( textItem )
223  m_texts->push_back( *textItem );
224  }
225 
226  // notify the grid
227  wxGridTableMessage tmsg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_texts->GetNumberRows() );
228  m_itemsGrid->ProcessTableMessage( tmsg );
229 
230  // Footprint Properties
233 
235  m_componentType->SetSelection( 0 );
236  else if( m_footprint->GetAttributes() & FP_SMD )
237  m_componentType->SetSelection( 1 );
238  else
239  m_componentType->SetSelection( 2 );
240 
244 
245  // Local Clearances
246 
250 
251  // Prefer "-0" to "0" for normally negative values
253  m_SolderPasteMarginCtrl->SetValue( wxT( "-" ) + m_SolderPasteMarginCtrl->GetValue() );
254 
255  // Add solder paste margin ratio in percent
256  // for the usual default value 0.0, display -0.0 (or -0,0 in some countries)
257  wxString msg;
258  msg.Printf( wxT( "%f" ), m_footprint->GetLocalSolderPasteMarginRatio() * 100.0 );
259 
261  msg[0] == '0') // Sometimes Printf adds a sign if the value is very small (0.0)
262  m_SolderPasteMarginRatioCtrl->SetValue( wxT("-") + msg );
263  else
265 
266  switch( m_footprint->GetZoneConnection() )
267  {
268  default:
270  m_ZoneConnectionChoice->SetSelection( 0 );
271  break;
273  m_ZoneConnectionChoice->SetSelection( 1 );
274  break;
276  m_ZoneConnectionChoice->SetSelection( 2 );
277  break;
279  m_ZoneConnectionChoice->SetSelection( 3 );
280  break;
281  }
282 
283  // 3D Settings
284 
285  wxString default_path;
286  wxGetEnv( KICAD6_3DMODEL_DIR, &default_path );
287 #ifdef __WINDOWS__
288  default_path.Replace( wxT( "/" ), wxT( "\\" ) );
289 #endif
290 
291  m_shapes3D_list.clear();
292  m_modelsGrid->DeleteRows( 0, m_modelsGrid->GetNumberRows() );
293 
294  wxString origPath, alias, shortPath;
295  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
296 
297  for( const FP_3DMODEL& model : m_footprint->Models() )
298  {
299  m_shapes3D_list.push_back( model );
300  origPath = model.m_Filename;
301 
302  if( res && res->SplitAlias( origPath, alias, shortPath ) )
303  origPath = alias + wxT( ":" ) + shortPath;
304 
305  m_modelsGrid->AppendRows( 1 );
306  int row = m_modelsGrid->GetNumberRows() - 1;
307  m_modelsGrid->SetCellValue( row, 0, origPath );
308  m_modelsGrid->SetCellValue( row, 1, model.m_Show ? wxT( "1" ) : wxT( "0" ) );
309  }
310 
311  select3DModel( 0 ); // will clamp idx within bounds
313 
314  for( int col = 0; col < m_itemsGrid->GetNumberCols(); col++ )
315  {
316  // Adjust min size to the column label size
317  m_itemsGrid->SetColMinimalWidth( col, m_itemsGrid->GetVisibleWidth( col, true, false,
318  false ) );
319  // Adjust the column size.
320  int col_size = m_itemsGrid->GetVisibleWidth( col, true, true, false );
321 
322  if( col == FPT_LAYER ) // This one's a drop-down. Check all possible values.
323  {
324  BOARD* board = m_footprint->GetBoard();
325 
326  for( PCB_LAYER_ID layer : board->GetEnabledLayers().Seq() )
327  col_size = std::max( col_size, GetTextExtent( board->GetLayerName( layer ) ).x );
328 
329  // And the swatch:
330  col_size += 20;
331  }
332 
333  if( m_itemsGrid->IsColShown( col ) )
334  m_itemsGrid->SetColSize( col, col_size );
335  }
336 
337  m_itemsGrid->SetRowLabelSize( m_itemsGrid->GetVisibleWidth( -1, true, true, true ) );
338  m_modelsGrid->SetColSize( 1, m_modelsGrid->GetVisibleWidth( 1, true, false, false ) );
339 
340  Layout();
341  adjustGridColumns( m_itemsGrid->GetRect().GetWidth() );
342 
343  return true;
344 }
const wxString & GetDescription() const
Definition: footprint.h:188
const UTF8 & GetLibItemName() const
Definition: lib_id.h:106
std::list< FP_3DMODEL > & Models()
Definition: footprint.h:173
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:360
#define KICAD6_3DMODEL_DIR
A variable name whose value holds the path of 3D shape files.
Definition: eda_3d_viewer.h:45
void UpdateDummyFootprint(bool aRelaodRequired=true)
Copy shapes from the current shape list which are flagged for preview to the copy of footprint that i...
int GetPlacementCost180() const
Definition: footprint.h:529
int GetNumberRows() override
bool SplitAlias(const wxString &aFileName, wxString &anAlias, wxString &aRelPath) const
Return true if the given name contains an alias and populates the string anAlias with the alias and a...
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:465
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
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
void SetValue(const wxString &aValue) override
Set a new value in evaluator buffer, and display it in the wxTextCtrl.
int GetVisibleWidth(int aCol, bool aHeader=true, bool aContents=false, bool aKeep=true)
Calculates the specified column based on the actual size of the text on screen.
Definition: wx_grid.cpp:238
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:457
FP_TEXT & Reference()
Definition: footprint.h:458
PCB_LAYER_ID
A quick note on layer IDs:
pads are covered by copper
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:50
int GetLocalClearance() const
Definition: footprint.h:200
DRAWINGS & GraphicalItems()
Definition: footprint.h:162
const LIB_ID & GetFPID() const
Definition: footprint.h:185
const wxString & GetKeywords() const
Definition: footprint.h:191
Use thermal relief for pads.
int GetLocalSolderMaskMargin() const
Definition: footprint.h:197
Provide an extensible class to resolve 3D model paths.
int GetAttributes() const
Definition: footprint.h:226
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
Pads are not covered.
double GetLocalSolderPasteMarginRatio() const
Definition: footprint.h:214
ZONE_CONNECTION GetZoneConnection() const
Definition: footprint.h:218
int GetPlacementCost90() const
Definition: footprint.h:532
int GetLocalSolderPasteMargin() const
Definition: footprint.h:211

References adjustGridColumns(), FP_BOARD_ONLY, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_SMD, FP_THROUGH_HOLE, FPT_LAYER, FULL, FOOTPRINT::GetAttributes(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetDescription(), BOARD::GetEnabledLayers(), FOOTPRINT::GetFPID(), FOOTPRINT::GetKeywords(), BOARD::GetLayerName(), LIB_ID::GetLibItemName(), FOOTPRINT::GetLocalClearance(), FOOTPRINT::GetLocalSolderMaskMargin(), FOOTPRINT::GetLocalSolderPasteMargin(), FOOTPRINT::GetLocalSolderPasteMarginRatio(), FP_TEXT_GRID_TABLE::GetNumberRows(), FOOTPRINT::GetPlacementCost180(), FOOTPRINT::GetPlacementCost90(), WX_GRID::GetVisibleWidth(), FOOTPRINT::GetZoneConnection(), FOOTPRINT::GraphicalItems(), INHERITED, KICAD6_3DMODEL_DIR, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_boardOnly, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_componentType, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_CostRot180Ctrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_CostRot90Ctrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_DocCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_excludeFromBOM, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_excludeFromPosFiles, m_footprint, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_FootprintNameCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_KeywordCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_modelsGrid, m_netClearance, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_Panel3D, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_PanelGeneral, m_previewPane, m_shapes3D_list, m_solderMask, m_solderPaste, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl, m_texts, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_ZoneConnectionChoice, FOOTPRINT::Models(), NONE, KIWAY_HOLDER::Prj(), FOOTPRINT::Reference(), select3DModel(), LSET::Seq(), TEXT_CTRL_EVAL::SetValue(), UNIT_BINDER::SetValue(), FILENAME_RESOLVER::SplitAlias(), THERMAL, PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint(), and FOOTPRINT::Value().

◆ Validate()

bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate ( )
override

Definition at line 546 of file dialog_footprint_properties_fp_editor.cpp.

547 {
549  return false;
550 
551  if( !DIALOG_SHIM::Validate() )
552  return false;
553 
554  // First, test for invalid chars in footprint name
555  wxString footprintName = m_FootprintNameCtrl->GetValue();
556 
557  if( !checkFootprintName( footprintName ) )
558  {
559  if( m_NoteBook->GetSelection() != 0 )
560  m_NoteBook->SetSelection( 0 );
561 
563  m_delayedFocusPage = 0;
564 
565  return false;
566  }
567 
568  // Check for empty texts.
569  for( size_t i = 2; i < m_texts->size(); ++i )
570  {
571  FP_TEXT& text = m_texts->at( i );
572 
573  if( text.GetText().IsEmpty() )
574  {
575  if( m_NoteBook->GetSelection() != 0 )
576  m_NoteBook->SetSelection( 0 );
577 
578  m_delayedErrorMessage = _( "Text items must have some content." );
581  m_delayedFocusRow = i;
582 
583  return false;
584  }
585  }
586 
587  if( !m_netClearance.Validate( 0, INT_MAX ) )
588  return false;
589 
590  return true;
591 }
#define _(s)
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
virtual bool Validate(double aMin, double aMax, EDA_UNITS aUnits=EDA_UNITS::UNSCALED)
Validate the control against the given range, informing the user of any errors found.

References _, checkFootprintName(), WX_GRID::CommitPendingChanges(), FPT_TEXT, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_FootprintNameCtrl, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid, m_netClearance, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NoteBook, m_texts, text, and UNIT_BINDER::Validate().

Referenced by TransferDataFromWindow().

◆ 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

◆ bLowerSizer3D

wxBoxSizer* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::bLowerSizer3D
protectedinherited

◆ bSizerMain3D

wxBoxSizer* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::bSizerMain3D
protectedinherited

◆ m_allow180Label

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_allow180Label
protectedinherited

◆ m_allow90Label

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_allow90Label
protectedinherited

◆ m_boardOnly

wxCheckBox* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_boardOnly
protectedinherited

◆ m_bpAdd

◆ m_bpDelete

◆ m_button3DShapeAdd

◆ m_button3DShapeBrowse

◆ m_button3DShapeRemove

◆ m_buttonConfig3DPaths

◆ m_componentType

wxChoice* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_componentType
protectedinherited

◆ m_componentTypeLabel

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_componentTypeLabel
protectedinherited

◆ m_CostRot180Ctrl

wxSlider* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_CostRot180Ctrl
protectedinherited

◆ m_CostRot90Ctrl

wxSlider* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_CostRot90Ctrl
protectedinherited

◆ m_delayedErrorMessage

wxString DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_delayedErrorMessage
private

◆ m_delayedFocusColumn

int DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_delayedFocusColumn
private

◆ m_delayedFocusCtrl

wxControl* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_delayedFocusCtrl
private

◆ m_delayedFocusGrid

WX_GRID* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_delayedFocusGrid
private

◆ m_delayedFocusPage

int DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_delayedFocusPage
private

◆ m_delayedFocusRow

int DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_delayedFocusRow
private

◆ m_DocCtrl

wxTextCtrl* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_DocCtrl
protectedinherited

◆ m_excludeFromBOM

wxCheckBox* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_excludeFromBOM
protectedinherited

◆ m_excludeFromPosFiles

wxCheckBox* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_excludeFromPosFiles
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 208 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_footprint

FOOTPRINT* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_footprint
private

◆ m_FootprintNameCtrl

◆ m_frame

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 209 of file dialog_shim.h.

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

◆ m_inSelect

bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_inSelect
private

Definition at line 94 of file dialog_footprint_properties_fp_editor.h.

Referenced by On3DModelSelected(), and select3DModel().

◆ m_itemsGrid

◆ m_KeywordCtrl

wxTextCtrl* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_KeywordCtrl
protectedinherited

◆ m_modelsGrid

◆ m_netClearance

UNIT_BINDER DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_netClearance
private

◆ m_NetClearanceCtrl

wxTextCtrl* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NetClearanceCtrl
protectedinherited

◆ m_NetClearanceLabel

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NetClearanceLabel
protectedinherited

◆ m_NetClearanceUnits

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_NetClearanceUnits
protectedinherited

◆ m_NoteBook

◆ m_page

int DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_page = 0
staticprivate

◆ m_Panel3D

wxPanel* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_Panel3D
protectedinherited

◆ m_PanelClearances

wxPanel* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_PanelClearances
protectedinherited

◆ m_PanelGeneral

wxPanel* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_PanelGeneral
protectedinherited

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

◆ m_previewPane

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_sdbSizerStdButtons

wxStdDialogButtonSizer* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_sdbSizerStdButtons
protectedinherited

◆ m_sdbSizerStdButtonsCancel

wxButton* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_sdbSizerStdButtonsCancel
protectedinherited

◆ m_sdbSizerStdButtonsOK

wxButton* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_sdbSizerStdButtonsOK
protectedinherited

◆ m_shapes3D_list

std::vector<FP_3DMODEL> DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_shapes3D_list
private

◆ m_sizerAllow180

wxBoxSizer* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_sizerAllow180
protectedinherited

◆ m_sizerAllow90

wxBoxSizer* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_sizerAllow90
protectedinherited

◆ m_sizerAP

wxStaticBoxSizer* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_sizerAP
protectedinherited

◆ m_solderMask

UNIT_BINDER DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_solderMask
private

◆ m_SolderMaskMarginCtrl

wxTextCtrl* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderMaskMarginCtrl
protectedinherited

◆ m_SolderMaskMarginLabel

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderMaskMarginLabel
protectedinherited

◆ m_SolderMaskMarginUnits

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderMaskMarginUnits
protectedinherited

◆ m_solderPaste

UNIT_BINDER DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_solderPaste
private

◆ m_SolderPasteMarginCtrl

wxTextCtrl* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginCtrl
protectedinherited

◆ m_SolderPasteMarginLabel

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginLabel
protectedinherited

◆ m_SolderPasteMarginRatioCtrl

TEXT_CTRL_EVAL* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl
protectedinherited

◆ m_SolderPasteMarginUnits

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginUnits
protectedinherited

◆ m_SolderPasteRatioMarginUnits

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteRatioMarginUnits
protectedinherited

◆ m_staticText16

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticText16
protectedinherited

◆ m_staticTextInfo

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfo
protectedinherited

◆ m_staticTextInfoCopper

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoCopper
protectedinherited

◆ m_staticTextInfoPaste

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoPaste
protectedinherited

◆ m_staticTextInfoValNeg

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoValNeg
protectedinherited

◆ m_staticTextInfoValPos

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextInfoValPos
protectedinherited

◆ m_staticTextRatio

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_staticTextRatio
protectedinherited

◆ m_tabOrder

◆ m_texts

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_ZoneConnectionChoice

wxChoice* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_ZoneConnectionChoice
protectedinherited

◆ staticKeywordsLabel

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::staticKeywordsLabel
protectedinherited

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