KiCad PCB EDA Suite
DIALOG_FOOTPRINT_FP_EDITOR Class Reference

#include <dialog_edit_footprint_for_fp_editor.h>

Inheritance diagram for DIALOG_FOOTPRINT_FP_EDITOR:
DIALOG_FOOTPRINT_FP_EDITOR_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 DIALOG_FOOTPRINT_FP_EDITOR (FOOTPRINT_EDIT_FRAME *aParent, MODULE *aModule)
 
 ~DIALOG_FOOTPRINT_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 ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS_T GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

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

Protected 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)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 

Protected Attributes

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
 
wxRadioBox * m_AutoPlaceCtrl
 
wxStaticBoxSizer * m_sizerAP
 
wxBoxSizer * m_sizerAllow90
 
wxStaticText * m_allow90Label
 
wxSlider * m_CostRot90Ctrl
 
wxBoxSizer * m_sizerAllow180
 
wxStaticText * m_allow180Label
 
wxSlider * m_CostRot180Ctrl
 
wxRadioBox * m_AttributsCtrl
 
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_T m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

void 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

wxConfigBase * m_config
 
FOOTPRINT_EDIT_FRAMEm_frame
 
MODULEm_footprint
 
TEXT_MOD_GRID_TABLEm_texts
 
UNIT_BINDER m_netClearance
 
UNIT_BINDER m_solderMask
 
UNIT_BINDER m_solderPaste
 
std::vector< MODULE_3D_SETTINGSm_shapes3D_list
 
PANEL_PREV_3Dm_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_edit_footprint_for_fp_editor.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_FOOTPRINT_FP_EDITOR()

DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR ( FOOTPRINT_EDIT_FRAME aParent,
MODULE aModule 
)

Definition at line 55 of file dialog_edit_footprint_for_fp_editor.cpp.

56  :
61  m_inSelect( false )
62 {
64 
65  m_frame = aParent;
66  m_footprint = aModule;
67 
69 
70  m_delayedErrorMessage = wxEmptyString;
71  m_delayedFocusCtrl = nullptr;
72  m_delayedFocusGrid = nullptr;
73  m_delayedFocusRow = -1;
75  m_delayedFocusPage = -1;
76 
77  // Give an icon
78  wxIcon icon;
79  icon.CopyFromBitmap( KiBitmap( icon_modedit_xpm ) );
80  SetIcon( icon );
81 
82  // Give a bit more room for combobox editors
83  m_itemsGrid->SetDefaultRowSize( m_itemsGrid->GetDefaultRowSize() + 4 );
84  m_modelsGrid->SetDefaultRowSize( m_modelsGrid->GetDefaultRowSize() + 4 );
85 
87  m_itemsGrid->PushEventHandler( new GRID_TRICKS( m_itemsGrid ) );
88  m_modelsGrid->PushEventHandler( new GRID_TRICKS( m_modelsGrid ) );
89 
90  // Show/hide columns according to the user's preference
91  wxString shownColumns;
92  m_config->Read( LibFootprintTextShownColumnsKey, &shownColumns, wxT( "0 1 2 3 4 5 6" ) );
93  m_itemsGrid->ShowHideColumns( shownColumns );
94 
95  // Set up the 3D models grid
96  wxGridCellAttr* attr = new wxGridCellAttr;
97  attr->SetRenderer( new wxGridCellBoolRenderer() );
98  attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
99  attr->SetAlignment( wxALIGN_CENTER, wxALIGN_BOTTOM );
100  m_modelsGrid->SetColAttr( 1, attr );
101  m_modelsGrid->SetWindowStyleFlag( m_modelsGrid->GetWindowStyle() & ~wxHSCROLL );
102 
103  aParent->Prj().Get3DCacheManager()->GetResolver()->SetProgramBase( &Pgm() );
104 
106 
107  bLowerSizer3D->Add( m_PreviewPane, 1, wxEXPAND, 5 );
108 
110 
111  // Set font sizes
112  wxFont infoFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
113  infoFont.SetSymbolicSize( wxFONTSIZE_SMALL );
114  m_allow90Label->SetFont( infoFont );
115  m_allow180Label->SetFont( infoFont );
116  m_staticTextInfoCopper->SetFont( infoFont );
117  m_staticTextInfoPaste->SetFont( infoFont );
118 
119  infoFont.SetStyle( wxFONTSTYLE_ITALIC );
120  m_staticTextInfoValNeg->SetFont( infoFont );
121  m_staticTextInfoValPos->SetFont( infoFont );
122 
123  if( m_page >= 0 )
124  m_NoteBook->SetSelection( (unsigned) m_page );
125 
126  if( m_page == 0 )
127  {
129  m_delayedFocusRow = 0;
131  m_delayedFocusPage = 0;
132  }
133  else if ( m_page == 1 )
135  else
136  {
138  m_delayedFocusRow = 0;
140  m_delayedFocusPage = 2;
141  }
142 
143  m_sdbSizerStdButtonsOK->SetDefault();
144 
145  // Configure button logos
146  m_bpAdd->SetBitmap( KiBitmap( small_plus_xpm ) );
147  m_bpDelete->SetBitmap( KiBitmap( trash_xpm ) );
148  m_button3DShapeAdd->SetBitmap( KiBitmap( small_plus_xpm ) );
149  m_button3DShapeBrowse->SetBitmap( KiBitmap( folder_xpm ) );
150  m_button3DShapeRemove->SetBitmap( KiBitmap( trash_xpm ) );
151 
152  // wxFormBuilder doesn't include this event...
153  m_itemsGrid->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_FOOTPRINT_FP_EDITOR::OnGridCellChanging ), NULL, this );
154 
156 }
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:119
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
Class GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GR...
Definition: grid_tricks.h:51
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
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:57
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:118
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define LibFootprintTextShownColumnsKey
DIALOG_FOOTPRINT_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)
EDA_UNITS_T m_units
Definition: dialog_shim.h:185
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References DIALOG_FOOTPRINT_FP_EDITOR_BASE::bLowerSizer3D, DIALOG_SHIM::FinishDialogSettings(), KiBitmap(), Kiface(), KIFACE_I::KifaceSettings(), LibFootprintTextShownColumnsKey, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow180Label, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow90Label, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_bpAdd, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_bpDelete, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeAdd, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeBrowse, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeRemove, m_config, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, m_footprint, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, m_frame, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook, m_page, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D, m_PreviewPane, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtonsOK, m_shapes3D_list, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoCopper, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoPaste, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValNeg, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValPos, m_texts, DIALOG_SHIM::m_units, OnGridCellChanging(), Pgm(), KIWAY_HOLDER::Prj(), DIALOG_SHIM::SetInitialFocus(), WX_GRID::SetTable(), and WX_GRID::ShowHideColumns().

◆ ~DIALOG_FOOTPRINT_FP_EDITOR()

DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR ( )
override

Definition at line 159 of file dialog_edit_footprint_for_fp_editor.cpp.

160 {
162 
163  // Prevents crash bug in wxGrid's d'tor
165 
166  m_itemsGrid->Disconnect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_FOOTPRINT_FP_EDITOR::OnGridCellChanging ), NULL, this );
167 
168  // Delete the GRID_TRICKS.
169  m_itemsGrid->PopEventHandler( true );
170  m_modelsGrid->PopEventHandler( true );
171 
172  // free the memory used by all models, otherwise models which were
173  // browsed but not used would consume memory
174  Prj().Get3DCacheManager()->FlushCache( false );
175 
176  // the GL canvas has to be visible before it is destroyed
177  m_page = m_NoteBook->GetSelection();
178  m_NoteBook->SetSelection( 1 );
179 
180  delete m_PreviewPane;
181 }
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:88
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define LibFootprintTextShownColumnsKey
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:101

References WX_GRID::DestroyTable(), WX_GRID::GetShownColumns(), LibFootprintTextShownColumnsKey, m_config, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook, m_page, m_PreviewPane, m_texts, OnGridCellChanging(), and KIWAY_HOLDER::Prj().

Member Function Documentation

◆ adjustGridColumns()

void DIALOG_FOOTPRINT_FP_EDITOR::adjustGridColumns ( int  aWidth)
private

Definition at line 784 of file dialog_edit_footprint_for_fp_editor.cpp.

785 {
786  // Account for scroll bars
787  int itemsWidth = aWidth - ( m_itemsGrid->GetSize().x - m_itemsGrid->GetClientSize().x );
788  int modelsWidth = aWidth - ( m_modelsGrid->GetSize().x - m_modelsGrid->GetClientSize().x );
789 
790  itemsWidth -= m_itemsGrid->GetRowLabelSize();
791 
792  for( int i = 1; i < m_itemsGrid->GetNumberCols(); i++ )
793  itemsWidth -= m_itemsGrid->GetColSize( i );
794 
795  if( itemsWidth > 0 )
796  m_itemsGrid->SetColSize( 0, std::max( itemsWidth,
797  m_itemsGrid->GetVisibleWidth( 0, true, false, false ) ) );
798 
799  m_modelsGrid->SetColSize( 0, modelsWidth - m_modelsGrid->GetColSize( 1 ) - 5 );
800 }
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:228
#define max(a, b)
Definition: auxiliary.h:86
size_t i
Definition: json11.cpp:597

References WX_GRID::GetVisibleWidth(), i, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, and max.

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

◆ Cfg3DPath()

void DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 777 of file dialog_edit_footprint_for_fp_editor.cpp.

778 {
779  if( S3D::Configure3DPaths( this, Prj().Get3DCacheManager()->GetResolver() ) )
781 }
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
PROJECT & Prj() const
Function Prj returns 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_PREV_3D::UpdateDummyModule().

◆ checkFootprintName()

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

Definition at line 503 of file dialog_edit_footprint_for_fp_editor.cpp.

504 {
505  if( aFootprintName.IsEmpty() )
506  {
507  m_delayedErrorMessage = _( "Footprint must have a name." );
508  return false;
509  }
510  else if( !MODULE::IsLibNameValid( aFootprintName ) )
511  {
512  m_delayedErrorMessage.Printf( _( "Footprint name may not contain \"%s\"." ),
514  return false;
515  }
516 
517  return true;
518 }
static const wxChar * StringLibNameInvalidChars(bool aUserReadable)
static function StringLibNameInvalidChars Test for validity of the name in a library of the footprint...
#define _(s)
static bool IsLibNameValid(const wxString &aName)
static function IsLibNameValid Test for validity of a name of a footprint to be used in a footprint l...

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

Referenced by OnGridCellChanging(), and Validate().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 238 of file dialog_shim.cpp.

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 398 of file dialog_shim.cpp.

399 {
400  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
401  // handle validation in the same way as other dialogs.
402  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
403  return;
404 
405  SetReturnCode( retCode );
406 
407  if( !IsQuasiModal() )
408  {
409  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
410  return;
411  }
412 
413  if( m_qmodal_loop )
414  {
415  if( m_qmodal_loop->IsRunning() )
416  m_qmodal_loop->Exit( 0 );
417  else
418  m_qmodal_loop->ScheduleExit( 0 );
419 
420  m_qmodal_loop = NULL;
421  }
422 
425 
426  Show( false );
427 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:194
bool IsQuasiModal()
Definition: dialog_shim.h:127
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:197

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

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

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

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

Definition at line 138 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 159 of file dialog_shim.cpp.

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

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

◆ IsCtrl()

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

Definition at line 137 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ On3DModelCellChanged()

void DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged ( wxGridEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 354 of file dialog_edit_footprint_for_fp_editor.cpp.

355 {
356  if( aEvent.GetCol() == 0 )
357  {
358  bool hasAlias = false;
359  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
360  wxString filename = m_modelsGrid->GetCellValue( aEvent.GetRow(), 0 );
361 
362  filename.Replace( "\n", "" );
363  filename.Replace( "\r", "" );
364  filename.Replace( "\t", "" );
365 
366  if( filename.empty() || !res->ValidateFileName( filename, hasAlias ) )
367  {
368  m_delayedErrorMessage = wxString::Format( _( "Invalid filename: %s" ), filename );
370  m_delayedFocusRow = aEvent.GetRow();
371  m_delayedFocusColumn = aEvent.GetCol();
372  m_delayedFocusPage = 2;
373  aEvent.Veto();
374  }
375 
376  // if the user has specified an alias in the name then prepend ':'
377  if( hasAlias )
378  filename.insert( 0, wxT( ":" ) );
379 
380 #ifdef __WINDOWS__
381  // In Kicad files, filenames and paths are stored using Unix notation
382  filename.Replace( wxT( "\\" ), wxT( "/" ) );
383 #endif
384 
385  m_shapes3D_list[ aEvent.GetRow() ].m_Filename = filename;
386  m_modelsGrid->SetCellValue( aEvent.GetRow(), 0, filename );
387  }
388  else if( aEvent.GetCol() == 1 )
389  {
390  wxString previewValue = m_modelsGrid->GetCellValue( aEvent.GetRow(), 1 );
391 
392  m_shapes3D_list[ aEvent.GetRow() ].m_Preview = previewValue == wxT( "1" );
393  }
394 
396 }
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool ValidateFileName(const wxString &aFileName, bool &hasAlias)
Function ValidateName returns true if the given path is a valid aliased relative path.
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References _, Format(), m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_PreviewPane, m_shapes3D_list, KIWAY_HOLDER::Prj(), PANEL_PREV_3D::UpdateDummyModule(), and FILENAME_RESOLVER::ValidateFileName().

◆ On3DModelSelected()

void DIALOG_FOOTPRINT_FP_EDITOR::On3DModelSelected ( wxGridEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 347 of file dialog_edit_footprint_for_fp_editor.cpp.

348 {
349  if( !m_inSelect )
350  select3DModel( aEvent.GetRow() );
351 }

References m_inSelect, and select3DModel().

◆ OnAdd3DModel()

void DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 417 of file dialog_edit_footprint_for_fp_editor.cpp.

418 {
420  return;
421 
422  PROJECT& prj = Prj();
423  MODULE_3D_SETTINGS model;
424 
425  wxString initialpath = prj.GetRString( PROJECT::VIEWER_3D_PATH );
426  wxString sidx = prj.GetRString( PROJECT::VIEWER_3D_FILTER_INDEX );
427  int filter = 0;
428 
429  // If the PROJECT::VIEWER_3D_PATH hasn't been set yet, use the KISYS3DMOD environment
430  // varaible and fall back to the project path if necessary.
431  if( initialpath.IsEmpty() )
432  {
433  if( !wxGetEnv( "KISYS3DMOD", &initialpath ) || initialpath.IsEmpty() )
434  initialpath = prj.GetProjectPath();
435  }
436 
437  if( !sidx.empty() )
438  {
439  long tmp;
440  sidx.ToLong( &tmp );
441 
442  if( tmp > 0 && tmp <= INT_MAX )
443  filter = (int) tmp;
444  }
445 
446  if( !S3D::Select3DModel( this, Prj().Get3DCacheManager(), initialpath, filter, &model )
447  || model.m_Filename.empty() )
448  {
449  return;
450  }
451 
452  prj.SetRString( PROJECT::VIEWER_3D_PATH, initialpath );
453  sidx = wxString::Format( wxT( "%i" ), filter );
455  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
456  wxString alias;
457  wxString shortPath;
458  wxString filename = model.m_Filename;
459 
460  if( res && res->SplitAlias( filename, alias, shortPath ) )
461  filename = alias + wxT( ":" ) + shortPath;
462 
463 #ifdef __WINDOWS__
464  // In Kicad files, filenames and paths are stored using Unix notation
465  model.m_Filename.Replace( "\\", "/" );
466 #endif
467 
468  model.m_Preview = true;
469  m_shapes3D_list.push_back( model );
470 
471  int idx = m_modelsGrid->GetNumberRows();
472  m_modelsGrid->AppendRows( 1 );
473  m_modelsGrid->SetCellValue( idx, 0, filename );
474  m_modelsGrid->SetCellValue( idx, 1, wxT( "1" ) );
475 
477 }
Class PROJECT holds project specific data.
Definition: project.h:58
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
bool m_Preview
Include module in 3D preview.
Definition: class_module.h:103
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:102
bool SplitAlias(const wxString &aFileName, wxString &anAlias, wxString &aRelPath)
Function SplitAlias returns true if the given name contains an alias and populates the string anAlias...
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
wxString m_Filename
The 3D shape filename in 3D library.
Definition: class_module.h:102
VTBL_ENTRY void SetRString(RSTRING_T aStringId, const wxString &aString)
Function SetRString stores a "retained string", which is any session and project specific string iden...
Definition: project.cpp:171
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:186
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool Select3DModel(wxWindow *aParent, S3D_CACHE *aCache, wxString &prevModelSelectDir, int &prevModelWildcard, MODULE_3D_SETTINGS *aModel)
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References WX_GRID::CommitPendingChanges(), Format(), PROJECT::GetProjectPath(), PROJECT::GetRString(), MODULE_3D_SETTINGS::m_Filename, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, MODULE_3D_SETTINGS::m_Preview, m_PreviewPane, m_shapes3D_list, KIWAY_HOLDER::Prj(), S3D::Select3DModel(), PROJECT::SetRString(), FILENAME_RESOLVER::SplitAlias(), PANEL_PREV_3D::UpdateDummyModule(), PROJECT::VIEWER_3D_FILTER_INDEX, and PROJECT::VIEWER_3D_PATH.

◆ OnAdd3DRow()

void DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DRow ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 480 of file dialog_edit_footprint_for_fp_editor.cpp.

481 {
483  return;
484 
485  MODULE_3D_SETTINGS model;
486 
487  model.m_Preview = true;
488  m_shapes3D_list.push_back( model );
489 
490  int row = m_modelsGrid->GetNumberRows();
491  m_modelsGrid->AppendRows( 1 );
492  m_modelsGrid->SetCellValue( row, 1, wxT( "1" ) );
493 
494  m_modelsGrid->SetFocus();
495  m_modelsGrid->MakeCellVisible( row, 0 );
496  m_modelsGrid->SetGridCursor( row, 0 );
497 
498  m_modelsGrid->EnableCellEditControl( true );
499  m_modelsGrid->ShowCellEditControl();
500 }
bool m_Preview
Include module in 3D preview.
Definition: class_module.h:103
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References WX_GRID::CommitPendingChanges(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, MODULE_3D_SETTINGS::m_Preview, and m_shapes3D_list.

◆ OnAddField()

void DIALOG_FOOTPRINT_FP_EDITOR::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 715 of file dialog_edit_footprint_for_fp_editor.cpp.

716 {
718  return;
719 
720  const BOARD_DESIGN_SETTINGS& dsnSettings = m_frame->GetDesignSettings();
721  TEXTE_MODULE textMod( m_footprint );
722 
723  // Set active layer if legal; otherwise copy layer from previous text item
724  if( LSET::AllTechMask().test( m_frame->GetActiveLayer() ) )
725  textMod.SetLayer( m_frame->GetActiveLayer() );
726  else
727  textMod.SetLayer( m_texts->at( m_texts->size() - 1 ).GetLayer() );
728 
729  textMod.SetTextSize( dsnSettings.GetTextSize( textMod.GetLayer() ) );
730  textMod.SetThickness( dsnSettings.GetTextThickness( textMod.GetLayer() ) );
731  textMod.SetItalic( dsnSettings.GetTextItalic( textMod.GetLayer() ) );
732 
733  m_texts->push_back( textMod );
734 
735  // notify the grid
736  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
737  m_itemsGrid->ProcessTableMessage( msg );
738 
739  m_itemsGrid->SetFocus();
740  m_itemsGrid->MakeCellVisible( m_texts->size() - 1, 0 );
741  m_itemsGrid->SetGridCursor( m_texts->size() - 1, 0 );
742 
743  m_itemsGrid->EnableCellEditControl( true );
744  m_itemsGrid->ShowCellEditControl();
745 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Function GetDesignSettings returns the BOARD_DESIGN_SETTINGS for the BOARD owned by this frame.
int GetTextThickness(PCB_LAYER_ID aLayer) const
Function GetTextThickness Returns the default text thickness from the layer class for the given layer...
static LSET AllTechMask()
Function AllTechMask returns a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:746
bool GetTextItalic(PCB_LAYER_ID aLayer) const
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
static bool GetLayer(MODEL_VRML &aModel, LAYER_NUM layer, VRML_LAYER **vlayer)
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Function GetTextSize Returns the default text size from the layer class for the given layer.
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

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

◆ OnDeleteField()

void DIALOG_FOOTPRINT_FP_EDITOR::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 748 of file dialog_edit_footprint_for_fp_editor.cpp.

749 {
751  return;
752 
753  int curRow = m_itemsGrid->GetGridCursorRow();
754 
755  if( curRow < 0 )
756  return;
757  else if( curRow < 2 )
758  {
759  DisplayError( nullptr, _( "Reference and value are mandatory." ) );
760  return;
761  }
762 
763  m_texts->erase( m_texts->begin() + curRow );
764 
765  // notify the grid
766  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_DELETED, curRow, 1 );
767  m_itemsGrid->ProcessTableMessage( msg );
768 
769  if( m_itemsGrid->GetNumberRows() > 0 )
770  {
771  m_itemsGrid->MakeCellVisible( std::max( 0, curRow-1 ), m_itemsGrid->GetGridCursorCol() );
772  m_itemsGrid->SetGridCursor( std::max( 0, curRow-1 ), m_itemsGrid->GetGridCursorCol() );
773  }
774 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
#define _(s)
#define max(a, b)
Definition: auxiliary.h:86

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

◆ OnFootprintNameText()

void DIALOG_FOOTPRINT_FP_EDITOR::OnFootprintNameText ( wxCommandEvent &  event)
overrideprivatevirtual

◆ OnGridCellChanging()

void DIALOG_FOOTPRINT_FP_EDITOR::OnGridCellChanging ( wxGridEvent &  event)
private

Definition at line 680 of file dialog_edit_footprint_for_fp_editor.cpp.

681 {
682  if( event.GetRow() == 1 && event.GetCol() == TMC_TEXT )
683  {
684  if( !checkFootprintName( event.GetString() ) )
685  {
686  event.Veto();
687 
688  if( m_NoteBook->GetSelection() != 0 )
689  m_NoteBook->SetSelection( 0 );
690 
692  m_delayedFocusRow = event.GetRow();
693  m_delayedFocusColumn = event.GetCol();
694  m_delayedFocusPage = 0;
695  }
696  else if( !footprintIsFromBoard( m_footprint ) )
697  {
698  // Keep Name and Value of footprints in library in sync
699  m_FootprintNameCtrl->ChangeValue( event.GetString() );
700  }
701  }
702 }
static bool footprintIsFromBoard(MODULE *aFootprint)
bool checkFootprintName(const wxString &aFootprintName)

References checkFootprintName(), footprintIsFromBoard(), m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, m_footprint, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook, and TMC_TEXT.

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

◆ OnGridSize()

void DIALOG_FOOTPRINT_FP_EDITOR::OnGridSize ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 872 of file dialog_edit_footprint_for_fp_editor.cpp.

873 {
874  adjustGridColumns( event.GetSize().GetX());
875 
876  event.Skip();
877 }

References adjustGridColumns().

◆ OnInitDlg()

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

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 299 of file dialog_shim.cpp.

300 {
301  if( m_firstPaintEvent )
302  {
303 #ifdef __WXMAC__
304  fixOSXCancelButtonIssue( this );
305 #endif
306 
307  selectAllInTextCtrls( GetChildren() );
308 
310  m_initialFocusTarget->SetFocus();
311  else
312  SetFocus(); // Focus the dialog itself
313 
314  m_firstPaintEvent = false;
315  }
316 
317  event.Skip();
318 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:192
bool m_firstPaintEvent
Definition: dialog_shim.h:191
static void selectAllInTextCtrls(wxWindowList &children)

References DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnRemove3DModel()

void DIALOG_FOOTPRINT_FP_EDITOR::OnRemove3DModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 399 of file dialog_edit_footprint_for_fp_editor.cpp.

400 {
402  return;
403 
404  int idx = m_modelsGrid->GetGridCursorRow();
405 
406  if( idx >= 0 && m_modelsGrid->GetNumberRows() && !m_shapes3D_list.empty() )
407  {
408  m_shapes3D_list.erase( m_shapes3D_list.begin() + idx );
409  m_modelsGrid->DeleteRows( idx );
410 
411  select3DModel( idx-1 ); // will clamp idx within bounds
413  }
414 }
void UpdateDummyModule(bool aRelaodRequired=true)
UpdateModelInfoList - copy shapes from the current shape list which are flagged for preview to the co...
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References WX_GRID::CommitPendingChanges(), DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_PreviewPane, m_shapes3D_list, select3DModel(), and PANEL_PREV_3D::UpdateDummyModule().

◆ OnUpdateUI()

void DIALOG_FOOTPRINT_FP_EDITOR::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_FP_EDITOR_BASE.

Definition at line 803 of file dialog_edit_footprint_for_fp_editor.cpp.

804 {
805  if( !m_itemsGrid->IsCellEditControlShown() && !m_modelsGrid->IsCellEditControlShown() )
806  adjustGridColumns( m_itemsGrid->GetRect().GetWidth());
807 
808  if( m_itemsGrid->IsCellEditControlShown() )
809  {
810  int row = m_itemsGrid->GetGridCursorRow();
811  int col = m_itemsGrid->GetGridCursorCol();
812 
813  if( row == 1 && col == TMC_TEXT )
814  {
815  wxGridCellEditor* editor = m_itemsGrid->GetCellEditor( row, col );
816  m_FootprintNameCtrl->ChangeValue( editor->GetValue() );
817  editor->DecRef();
818  }
819  }
820 
821  // Handle a delayed focus. The delay allows us to:
822  // a) change focus when the error was triggered from within a killFocus handler
823  // b) show the correct notebook page in the background before the error dialog comes up
824  // when triggered from an OK or a notebook page change
825 
826  if( m_delayedFocusPage >= 0 )
827  {
828  if( m_NoteBook->GetSelection() != m_delayedFocusPage )
829  m_NoteBook->SetSelection( (unsigned) m_delayedFocusPage );
830 
831  m_delayedFocusPage = -1;
832  }
833 
834  if( !m_delayedErrorMessage.IsEmpty() )
835  {
836  // We will re-enter this routine when the error dialog is displayed, so make
837  // sure we don't keep putting up more dialogs.
838  wxString msg = m_delayedErrorMessage;
839  m_delayedErrorMessage = wxEmptyString;
840 
841  // Do not use DisplayErrorMessage(); it screws up window order on Mac
842  DisplayError( nullptr, msg );
843  }
844 
845  if( m_delayedFocusCtrl )
846  {
847  m_delayedFocusCtrl->SetFocus();
848 
849  if( dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl ) )
850  dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl )->SelectAll();
851 
852  m_delayedFocusCtrl = nullptr;
853  }
854  else if( m_delayedFocusGrid )
855  {
856  m_delayedFocusGrid->SetFocus();
859 
860  m_delayedFocusGrid->EnableCellEditControl( true );
861  m_delayedFocusGrid->ShowCellEditControl();
862 
863  m_delayedFocusGrid = nullptr;
864  m_delayedFocusRow = -1;
866  }
867 
868  m_button3DShapeRemove->Enable( m_modelsGrid->GetNumberRows() > 0 );
869 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236

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

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_SCH_SHEET_PROPS::OnBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), ~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ select3DModel()

void DIALOG_FOOTPRINT_FP_EDITOR::select3DModel ( int  aModelIdx)
private

Definition at line 328 of file dialog_edit_footprint_for_fp_editor.cpp.

329 {
330  m_inSelect = true;
331 
332  aModelIdx = std::max( 0, aModelIdx );
333  aModelIdx = std::min( aModelIdx, m_modelsGrid->GetNumberRows() - 1 );
334 
335  if( m_modelsGrid->GetNumberRows() )
336  {
337  m_modelsGrid->SelectRow( aModelIdx );
338  m_modelsGrid->SetGridCursor( aModelIdx, 0 );
339  }
340 
341  m_PreviewPane->SetSelectedModel( aModelIdx );
342 
343  m_inSelect = false;
344 }
void SetSelectedModel(int idx)
SetModelDataIdx - Sets the currently selected index in the model list so that the scale/rotation/offs...
#define max(a, b)
Definition: auxiliary.h:86
#define min(a, b)
Definition: auxiliary.h:85

References m_inSelect, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_PreviewPane, max, min, and PANEL_PREV_3D::SetSelectedModel().

Referenced by On3DModelSelected(), 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 118 of file dialog_shim.h.

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

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 41 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetSizeInDU()

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

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

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

Definition at line 152 of file dialog_shim.cpp.

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

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 179 of file dialog_shim.cpp.

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

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickFootprints(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 344 of file dialog_shim.cpp.

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

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

Referenced by LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDITOR_CONTROL::NavigateHierarchy(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ TransferDataFromWindow()

bool DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow ( )
override

Definition at line 569 of file dialog_edit_footprint_for_fp_editor.cpp.

570 {
571  if( !Validate() )
572  return false;
573 
574  if( !DIALOG_SHIM::TransferDataFromWindow() )
575  return false;
576 
577  if( !m_PanelGeneral->TransferDataFromWindow() )
578  return false;
579 
580  if( !m_Panel3D->TransferDataFromWindow() )
581  return false;
582 
583  auto view = m_frame->GetCanvas()->GetView();
584  BOARD_COMMIT commit( m_frame );
585  commit.Modify( m_footprint );
586 
587  LIB_ID fpID = m_footprint->GetFPID();
588  fpID.SetLibItemName( m_FootprintNameCtrl->GetValue(), false );
589  m_footprint->SetFPID( fpID );
590 
591  m_footprint->SetDescription( m_DocCtrl->GetValue() );
592  m_footprint->SetKeywords( m_KeywordCtrl->GetValue() );
593 
594  // copy reference and value
595  m_footprint->Reference() = m_texts->at( 0 );
596  m_footprint->Value() = m_texts->at( 1 );
597 
598  size_t i = 2;
599  for( auto item : m_footprint->GraphicalItems() )
600  {
601  TEXTE_MODULE* textModule = dyn_cast<TEXTE_MODULE*>( item );
602 
603  if( textModule )
604  {
605  // copy grid table entries till we run out, then delete any remaining texts
606  if( i < m_texts->size() )
607  *textModule = m_texts->at( i++ );
608  else
609  textModule->DeleteStructure();
610  }
611  }
612 
613  // if there are still grid table entries, create new texts for them
614  while( i < m_texts->size() )
615  {
616  auto newText = new TEXTE_MODULE( m_texts->at( i++ ) );
617  m_footprint->Add( newText, ADD_APPEND );
618  view->Add( newText );
619  }
620 
621  m_footprint->SetLocked( m_AutoPlaceCtrl->GetSelection() == 1 );
622 
623  switch( m_AttributsCtrl->GetSelection() )
624  {
625  case 0: m_footprint->SetAttributes( 0 ); break;
626  case 1: m_footprint->SetAttributes( MOD_CMS ); break;
627  case 2: m_footprint->SetAttributes( MOD_VIRTUAL ); break;
628  default: wxFAIL;
629  }
630 
633 
634  // Initialize masks clearances
638 
639  double dtmp = 0.0;
640  wxString msg = m_SolderPasteMarginRatioCtrl->GetValue();
641  msg.ToDouble( &dtmp );
642 
643  // A -50% margin ratio means no paste on a pad, the ratio must be >= -50%
644  if( dtmp < -50.0 )
645  dtmp = -50.0;
646  // A margin ratio is always <= 0
647  // 0 means use full pad copper area
648  if( dtmp > 0.0 )
649  dtmp = 0.0;
650 
652 
653  switch( m_ZoneConnectionChoice->GetSelection() )
654  {
655  default:
660  }
661 
662  std::list<MODULE_3D_SETTINGS>* draw3D = &m_footprint->Models();
663  draw3D->clear();
664  draw3D->insert( draw3D->end(), m_shapes3D_list.begin(), m_shapes3D_list.end() );
665 
667 
668  commit.Push( _( "Modify module properties" ) );
669 
670  return true;
671 }
void SetPlacementCost90(int aCost)
Definition: class_module.h:536
TEXTE_MODULE & Reference()
Definition: class_module.h:457
void SetLocalClearance(int aClearance)
Definition: class_module.h:222
void SetPlacementCost180(int aCost)
Definition: class_module.h:533
void CalculateBoundingBox()
Function CalculateBoundingBox calculates the bounding box in board coordinates.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:76
void DeleteStructure()
Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one.
void SetZoneConnection(ZoneConnection aType)
Definition: class_module.h:230
const LIB_ID & GetFPID() const
Definition: class_module.h:206
DRAWINGS & GraphicalItems()
Definition: class_module.h:175
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_module.h:228
Pads are not covered.
Definition: zones.h:52
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:456
#define _(s)
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_module.h:219
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_module.h:225
std::list< MODULE_3D_SETTINGS > & Models()
Definition: class_module.h:192
void SetLocked(bool isLocked) override
Function SetLocked sets the MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: class_module.h:291
Virtual component: when created by copper shapes on board (Like edge card connectors,...
Definition: class_module.h:78
size_t i
Definition: json11.cpp:597
virtual long long int GetValue()
Function GetValue Returns the current value in Internal Units.
void SetKeywords(const wxString &aKeywords)
Definition: class_module.h:213
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:207
Use thermal relief for pads.
Definition: zones.h:53
void SetAttributes(int aAttributes)
Definition: class_module.h:240
pads are covered by copper
Definition: zones.h:54
void SetDescription(const wxString &aDoc)
Definition: class_module.h:210
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References _, MODULE::Add(), ADD_APPEND, MODULE::CalculateBoundingBox(), BOARD_ITEM::DeleteStructure(), PCB_BASE_FRAME::GetCanvas(), MODULE::GetFPID(), UNIT_BINDER::GetValue(), PCB_DRAW_PANEL_GAL::GetView(), MODULE::GraphicalItems(), i, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AttributsCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AutoPlaceCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot180Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot90Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_DocCtrl, m_footprint, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, m_frame, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_KeywordCtrl, m_netClearance, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelGeneral, m_shapes3D_list, m_solderMask, m_solderPaste, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl, m_texts, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_ZoneConnectionChoice, MOD_CMS, MOD_VIRTUAL, MODULE::Models(), COMMIT::Modify(), PAD_ZONE_CONN_FULL, PAD_ZONE_CONN_INHERITED, PAD_ZONE_CONN_NONE, PAD_ZONE_CONN_THERMAL, BOARD_COMMIT::Push(), MODULE::Reference(), MODULE::SetAttributes(), MODULE::SetDescription(), MODULE::SetFPID(), MODULE::SetKeywords(), LIB_ID::SetLibItemName(), MODULE::SetLocalClearance(), MODULE::SetLocalSolderMaskMargin(), MODULE::SetLocalSolderPasteMargin(), MODULE::SetLocalSolderPasteMarginRatio(), MODULE::SetLocked(), MODULE::SetPlacementCost180(), MODULE::SetPlacementCost90(), MODULE::SetZoneConnection(), Validate(), and MODULE::Value().

◆ TransferDataToWindow()

bool DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow ( )
override

Definition at line 184 of file dialog_edit_footprint_for_fp_editor.cpp.

185 {
186  LIB_ID fpID = m_footprint->GetFPID();
187  wxString footprintName = fpID.GetLibItemName();
188 
189  m_FootprintNameCtrl->ChangeValue( footprintName );
190 
191  m_DocCtrl->SetValue( m_footprint->GetDescription() );
192  m_KeywordCtrl->SetValue( m_footprint->GetKeywords() );
193 
194  if( !wxDialog::TransferDataToWindow() )
195  return false;
196 
197  if( !m_PanelGeneral->TransferDataToWindow() )
198  return false;
199 
200  if( !m_Panel3D->TransferDataToWindow() )
201  return false;
202 
203  // Module Texts
204 
205  m_texts->push_back( m_footprint->Reference() );
206  m_texts->push_back( m_footprint->Value() );
207 
208  for( auto item : m_footprint->GraphicalItems() )
209  {
210  auto textModule = dyn_cast<TEXTE_MODULE*>( item );
211 
212  if( textModule )
213  m_texts->push_back( *textModule );
214  }
215 
216  // notify the grid
217  wxGridTableMessage tmsg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_texts->GetNumberRows() );
218  m_itemsGrid->ProcessTableMessage( tmsg );
219 
220  // Module Properties
221 
222  m_AutoPlaceCtrl->SetSelection( (m_footprint->IsLocked()) ? 1 : 0 );
223  m_AutoPlaceCtrl->SetItemToolTip( 0, _( "Enable hotkey move commands and Auto Placement" ) );
224  m_AutoPlaceCtrl->SetItemToolTip( 1, _( "Disable hotkey move commands and Auto Placement" ) );
225 
228 
229  m_AttributsCtrl->SetItemToolTip( 0, _( "Use this attribute for most non SMD footprints\n"
230  "Footprints with this option are not put in the footprint position list file" ) );
231  m_AttributsCtrl->SetItemToolTip( 1, _( "Use this attribute for SMD footprints.\n"
232  "Only footprints with this option are put in the footprint position list file" ) );
233  m_AttributsCtrl->SetItemToolTip( 2, _( "Use this attribute for \"virtual\" footprints drawn on board\n"
234  "such as an edge connector (old ISA PC bus for instance)" ) );
235 
236  switch( m_footprint->GetAttributes() & 255 )
237  {
238  case MOD_CMS: m_AttributsCtrl->SetSelection( 1 ); break;
239  case MOD_VIRTUAL: m_AttributsCtrl->SetSelection( 2 ); break;
240  case 0:
241  default: m_AttributsCtrl->SetSelection( 0 ); break;
242  }
243 
244  // Local Clearances
245 
249 
250  // Prefer "-0" to "0" for normally negative values
252  m_SolderPasteMarginCtrl->SetValue( wxT( "-" ) + m_SolderPasteMarginCtrl->GetValue() );
253 
254  // Add solder paste margin ratio in percent
255  // for the usual default value 0.0, display -0.0 (or -0,0 in some countries)
256  wxString msg;
257  msg.Printf( wxT( "%f" ), m_footprint->GetLocalSolderPasteMarginRatio() * 100.0 );
258 
260  msg[0] == '0') // Sometimes Printf adds a sign if the value is very small (0.0)
261  m_SolderPasteMarginRatioCtrl->SetValue( wxT("-") + msg );
262  else
264 
265  switch( m_footprint->GetZoneConnection() )
266  {
267  default:
268  case PAD_ZONE_CONN_INHERITED: m_ZoneConnectionChoice->SetSelection( 0 ); break;
269  case PAD_ZONE_CONN_FULL: m_ZoneConnectionChoice->SetSelection( 1 ); break;
270  case PAD_ZONE_CONN_THERMAL: m_ZoneConnectionChoice->SetSelection( 2 ); break;
271  case PAD_ZONE_CONN_NONE: m_ZoneConnectionChoice->SetSelection( 3 ); break;
272  }
273 
274  // 3D Settings
275 
276  wxString default_path;
277  wxGetEnv( KISYS3DMOD, &default_path );
278 #ifdef __WINDOWS__
279  default_path.Replace( wxT( "/" ), wxT( "\\" ) );
280 #endif
281 
282  m_shapes3D_list.clear();
283  m_modelsGrid->DeleteRows( 0, m_modelsGrid->GetNumberRows() );
284 
285  wxString origPath, alias, shortPath;
286  FILENAME_RESOLVER* res = Prj().Get3DCacheManager()->GetResolver();
287 
288  for( MODULE_3D_SETTINGS model : m_footprint->Models() )
289  {
290  m_shapes3D_list.push_back( model );
291  origPath = model.m_Filename;
292 
293  if( res && res->SplitAlias( origPath, alias, shortPath ) )
294  origPath = alias + wxT( ":" ) + shortPath;
295 
296  m_modelsGrid->AppendRows( 1 );
297  int row = m_modelsGrid->GetNumberRows() - 1;
298  m_modelsGrid->SetCellValue( row, 0, origPath );
299  m_modelsGrid->SetCellValue( row, 1, model.m_Preview ? wxT( "1" ) : wxT( "0" ) );
300  }
301 
302  select3DModel( 0 ); // will clamp idx within bounds
303 
304  for( int col = 0; col < m_itemsGrid->GetNumberCols(); col++ )
305  {
306  // Adjust min size to the column label size
307  m_itemsGrid->SetColMinimalWidth( col, m_itemsGrid->GetVisibleWidth( col, true, false, false ) );
308  // Adjust the column size. The column 6 has a small bitmap, so its width must be taken in account
309  int col_size = m_itemsGrid->GetVisibleWidth( col, true, true, false );
310 
311  if( col == 6 )
312  col_size += 20;
313 
314  if( m_itemsGrid->IsColShown( col ) )
315  m_itemsGrid->SetColSize( col, col_size );
316  }
317 
318  m_itemsGrid->SetRowLabelSize( m_itemsGrid->GetVisibleWidth( -1, true, true, true ) );
319  m_modelsGrid->SetColSize( 1, m_modelsGrid->GetVisibleWidth( 1, true, false, false ) );
320 
321  Layout();
322  adjustGridColumns( m_itemsGrid->GetRect().GetWidth());
323 
324  return true;
325 }
int GetAttributes() const
Definition: class_module.h:239
int GetPlacementCost90() const
Definition: class_module.h:535
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
TEXTE_MODULE & Reference()
Definition: class_module.h:457
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:76
const LIB_ID & GetFPID() const
Definition: class_module.h:206
#define KISYS3DMOD
A variable name whose value holds the path of 3D shape files.
Definition: eda_3d_viewer.h:44
DRAWINGS & GraphicalItems()
Definition: class_module.h:175
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int GetLocalSolderMaskMargin() const
Definition: class_module.h:218
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:228
Pads are not covered.
Definition: zones.h:52
bool SplitAlias(const wxString &aFileName, wxString &anAlias, wxString &aRelPath)
Function SplitAlias returns true if the given name contains an alias and populates the string anAlias...
int GetLocalClearance() const
Definition: class_module.h:221
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:456
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:281
const wxString & GetKeywords() const
Definition: class_module.h:212
int GetLocalSolderPasteMargin() const
Definition: class_module.h:224
int GetPlacementCost180() const
Definition: class_module.h:532
const wxString & GetDescription() const
Definition: class_module.h:209
double GetLocalSolderPasteMarginRatio() const
Definition: class_module.h:227
std::list< MODULE_3D_SETTINGS > & Models()
Definition: class_module.h:192
Virtual component: when created by copper shapes on board (Like edge card connectors,...
Definition: class_module.h:78
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
Use thermal relief for pads.
Definition: zones.h:53
ZoneConnection GetZoneConnection() const
Definition: class_module.h:231
pads are covered by copper
Definition: zones.h:54
int GetNumberRows() override
std::vector< MODULE_3D_SETTINGS > m_shapes3D_list

References _, adjustGridColumns(), MODULE::GetAttributes(), MODULE::GetDescription(), MODULE::GetFPID(), MODULE::GetKeywords(), LIB_ID::GetLibItemName(), MODULE::GetLocalClearance(), MODULE::GetLocalSolderMaskMargin(), MODULE::GetLocalSolderPasteMargin(), MODULE::GetLocalSolderPasteMarginRatio(), TEXT_MOD_GRID_TABLE::GetNumberRows(), MODULE::GetPlacementCost180(), MODULE::GetPlacementCost90(), WX_GRID::GetVisibleWidth(), MODULE::GetZoneConnection(), MODULE::GraphicalItems(), MODULE::IsLocked(), KISYS3DMOD, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AttributsCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AutoPlaceCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot180Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot90Ctrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_DocCtrl, m_footprint, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_KeywordCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_modelsGrid, m_netClearance, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelGeneral, m_shapes3D_list, m_solderMask, m_solderPaste, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl, m_texts, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_ZoneConnectionChoice, MOD_CMS, MOD_VIRTUAL, MODULE::Models(), PAD_ZONE_CONN_FULL, PAD_ZONE_CONN_INHERITED, PAD_ZONE_CONN_NONE, PAD_ZONE_CONN_THERMAL, KIWAY_HOLDER::Prj(), MODULE::Reference(), select3DModel(), TEXT_CTRL_EVAL::SetValue(), UNIT_BINDER::SetValue(), FILENAME_RESOLVER::SplitAlias(), and MODULE::Value().

◆ Validate()

bool DIALOG_FOOTPRINT_FP_EDITOR::Validate ( )
override

Definition at line 521 of file dialog_edit_footprint_for_fp_editor.cpp.

522 {
524  return false;
525 
526  if( !DIALOG_SHIM::Validate() )
527  return false;
528 
529  // First, test for invalid chars in module name
530  wxString footprintName = m_FootprintNameCtrl->GetValue();
531 
532  if( !checkFootprintName( footprintName ) )
533  {
534  if( m_NoteBook->GetSelection() != 0 )
535  m_NoteBook->SetSelection( 0 );
536 
538  m_delayedFocusPage = 0;
539 
540  return false;
541  }
542 
543  // Check for empty texts.
544  for( size_t i = 2; i < m_texts->size(); ++i )
545  {
546  TEXTE_MODULE& text = m_texts->at( i );
547 
548  if( text.GetText().IsEmpty() )
549  {
550  if( m_NoteBook->GetSelection() != 0 )
551  m_NoteBook->SetSelection( 0 );
552 
553  m_delayedErrorMessage = _( "Text items must have some content." );
557 
558  return false;
559  }
560  }
561 
562  if( !m_netClearance.Validate( 0, INT_MAX ) )
563  return false;
564 
565  return true;
566 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
virtual bool Validate(long long int aMin, long long int aMax, bool setFocusOnError=true)
Function Validate Validates the control against the given range, informing the user of any errors fou...
#define _(s)
size_t i
Definition: json11.cpp:597
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
bool checkFootprintName(const wxString &aFootprintName)

References _, checkFootprintName(), WX_GRID::CommitPendingChanges(), EDA_TEXT::GetText(), i, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_FootprintNameCtrl, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_itemsGrid, m_netClearance, DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NoteBook, m_texts, TMC_TEXT, and UNIT_BINDER::Validate().

Referenced by TransferDataFromWindow().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

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

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

Member Data Documentation

◆ bLowerSizer3D

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::bLowerSizer3D
protectedinherited

◆ bSizerMain3D

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::bSizerMain3D
protectedinherited

◆ m_allow180Label

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow180Label
protectedinherited

◆ m_allow90Label

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_allow90Label
protectedinherited

◆ m_AttributsCtrl

wxRadioBox* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AttributsCtrl
protectedinherited

◆ m_AutoPlaceCtrl

wxRadioBox* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_AutoPlaceCtrl
protectedinherited

◆ m_bpAdd

◆ m_bpDelete

◆ m_button3DShapeAdd

wxBitmapButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeAdd
protectedinherited

◆ m_button3DShapeBrowse

wxBitmapButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeBrowse
protectedinherited

◆ m_button3DShapeRemove

wxBitmapButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_button3DShapeRemove
protectedinherited

◆ m_buttonConfig3DPaths

wxButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_buttonConfig3DPaths
protectedinherited

◆ m_config

wxConfigBase* DIALOG_FOOTPRINT_FP_EDITOR::m_config
private

◆ m_CostRot180Ctrl

wxSlider* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot180Ctrl
protectedinherited

◆ m_CostRot90Ctrl

wxSlider* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_CostRot90Ctrl
protectedinherited

◆ m_delayedErrorMessage

wxString DIALOG_FOOTPRINT_FP_EDITOR::m_delayedErrorMessage
private

◆ m_delayedFocusColumn

int DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusColumn
private

◆ m_delayedFocusCtrl

wxControl* DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusCtrl
private

◆ m_delayedFocusGrid

WX_GRID* DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusGrid
private

◆ m_delayedFocusPage

int DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusPage
private

◆ m_delayedFocusRow

int DIALOG_FOOTPRINT_FP_EDITOR::m_delayedFocusRow
private

◆ m_DocCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_DocCtrl
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 191 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_footprint

◆ m_FootprintNameCtrl

◆ m_frame

FOOTPRINT_EDIT_FRAME* DIALOG_FOOTPRINT_FP_EDITOR::m_frame
private

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 192 of file dialog_shim.h.

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

◆ m_inSelect

bool DIALOG_FOOTPRINT_FP_EDITOR::m_inSelect
private

Definition at line 65 of file dialog_edit_footprint_for_fp_editor.h.

Referenced by On3DModelSelected(), and select3DModel().

◆ m_itemsGrid

◆ m_KeywordCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_KeywordCtrl
protectedinherited

◆ m_modelsGrid

◆ m_netClearance

UNIT_BINDER DIALOG_FOOTPRINT_FP_EDITOR::m_netClearance
private

◆ m_NetClearanceCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceCtrl
protectedinherited

◆ m_NetClearanceLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceLabel
protectedinherited

◆ m_NetClearanceUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_NetClearanceUnits
protectedinherited

◆ m_NoteBook

◆ m_page

int DIALOG_FOOTPRINT_FP_EDITOR::m_page = 0
staticprivate

◆ m_Panel3D

wxPanel* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_Panel3D
protectedinherited

◆ m_PanelClearances

wxPanel* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelClearances
protectedinherited

◆ m_PanelGeneral

wxPanel* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_PanelGeneral
protectedinherited

◆ m_PreviewPane

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 194 of file dialog_shim.h.

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

◆ m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 196 of file dialog_shim.h.

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

◆ m_sdbSizerStdButtons

wxStdDialogButtonSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtons
protectedinherited

◆ m_sdbSizerStdButtonsCancel

wxButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtonsCancel
protectedinherited

◆ m_sdbSizerStdButtonsOK

wxButton* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sdbSizerStdButtonsOK
protectedinherited

◆ m_shapes3D_list

◆ m_sizerAllow180

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sizerAllow180
protectedinherited

◆ m_sizerAllow90

wxBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sizerAllow90
protectedinherited

◆ m_sizerAP

wxStaticBoxSizer* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_sizerAP
protectedinherited

◆ m_solderMask

UNIT_BINDER DIALOG_FOOTPRINT_FP_EDITOR::m_solderMask
private

◆ m_SolderMaskMarginCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderMaskMarginCtrl
protectedinherited

◆ m_SolderMaskMarginLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderMaskMarginLabel
protectedinherited

◆ m_SolderMaskMarginUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderMaskMarginUnits
protectedinherited

◆ m_solderPaste

UNIT_BINDER DIALOG_FOOTPRINT_FP_EDITOR::m_solderPaste
private

◆ m_SolderPasteMarginCtrl

wxTextCtrl* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginCtrl
protectedinherited

◆ m_SolderPasteMarginLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginLabel
protectedinherited

◆ m_SolderPasteMarginRatioCtrl

TEXT_CTRL_EVAL* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginRatioCtrl
protectedinherited

◆ m_SolderPasteMarginUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteMarginUnits
protectedinherited

◆ m_SolderPasteRatioMarginUnits

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_SolderPasteRatioMarginUnits
protectedinherited

◆ m_staticText16

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticText16
protectedinherited

◆ m_staticTextInfo

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfo
protectedinherited

◆ m_staticTextInfoCopper

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoCopper
protectedinherited

◆ m_staticTextInfoPaste

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoPaste
protectedinherited

◆ m_staticTextInfoValNeg

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValNeg
protectedinherited

◆ m_staticTextInfoValPos

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextInfoValPos
protectedinherited

◆ m_staticTextRatio

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_staticTextRatio
protectedinherited

◆ m_tabOrder

◆ m_texts

◆ m_units

◆ m_ZoneConnectionChoice

wxChoice* DIALOG_FOOTPRINT_FP_EDITOR_BASE::m_ZoneConnectionChoice
protectedinherited

◆ staticKeywordsLabel

wxStaticText* DIALOG_FOOTPRINT_FP_EDITOR_BASE::staticKeywordsLabel
protectedinherited

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