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 OnModify ()
 
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_PasteMarginRatioLabel
 
TEXT_CTRL_EVALm_PasteMarginRatioCtrl
 
wxStaticText * m_PasteMarginRatioUnits
 
wxStaticText * m_staticTextInfoCopper
 
wxStaticText * m_staticTextInfoPaste
 
wxStaticText * m_staticText16
 
wxChoice * m_ZoneConnectionChoice
 
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
 
wxSize m_initialSize
 

Private Member Functions

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 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
 
UNIT_BINDER m_solderPasteRatio
 
wxControl * m_delayedFocusCtrl
 
NOTEBOOK_PAGES m_delayedFocusPage
 
WX_GRIDm_delayedFocusGrid
 
int m_delayedFocusRow
 
int m_delayedFocusColumn
 
wxString m_delayedErrorMessage
 
PANEL_FP_PROPERTIES_3D_MODELm_3dPanel
 

Static Private Attributes

static NOTEBOOK_PAGES m_page = NOTEBOOK_PAGES::PAGE_GENERAL
 

Detailed Description

Definition at line 47 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 59 of file dialog_footprint_properties_fp_editor.cpp.

61  :
63  m_frame( aParent ),
64  m_footprint( aFootprint ),
72 {
73  // Create the 3D models page
75  m_NoteBook->AddPage( m_3dPanel, _("3D Models"), false );
76 
78 
79  m_delayedErrorMessage = wxEmptyString;
80  m_delayedFocusCtrl = nullptr;
81  m_delayedFocusGrid = nullptr;
82  m_delayedFocusRow = -1;
85 
86  // Give an icon
87  wxIcon icon;
88  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit ) );
89  SetIcon( icon );
90 
91  // Give a bit more room for combobox editors
92  m_itemsGrid->SetDefaultRowSize( m_itemsGrid->GetDefaultRowSize() + 4 );
93 
95  m_itemsGrid->PushEventHandler( new GRID_TRICKS( m_itemsGrid ) );
96  m_itemsGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
97 
98  // Show/hide columns according to the user's preference
100 
102 
103  // Set font sizes
104  wxFont infoFont = KIUI::GetInfoFont( this );
105 #if __WXMAC__
106  m_allow90Label->SetFont( infoFont );
107  m_allow180Label->SetFont( infoFont );
108 #endif
109 
110  infoFont.SetStyle( wxFONTSTYLE_ITALIC );
111  m_staticTextInfoValNeg->SetFont( infoFont );
112  m_staticTextInfoValPos->SetFont( infoFont );
113  m_staticTextInfoCopper->SetFont( infoFont );
114  m_staticTextInfoPaste->SetFont( infoFont );
115 
116  if( static_cast<int>( m_page ) >= 0 )
117  m_NoteBook->SetSelection( (unsigned) m_page );
118 
120  {
122  m_delayedFocusRow = 0;
125  }
127  {
129  }
130 
132 
135 
136  m_sdbSizerStdButtonsOK->SetDefault();
137 
138  // Configure button logos
139  m_bpAdd->SetBitmap( KiBitmap( BITMAPS::small_plus ) );
140  m_bpDelete->SetBitmap( KiBitmap( BITMAPS::small_trash ) );
141 
142  // wxFormBuilder doesn't include this event...
143  m_itemsGrid->Connect( wxEVT_GRID_CELL_CHANGING,
145  nullptr, this );
146 
148 }
virtual void SetNegativeZero()
Definition: unit_binder.h:67
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:136
wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:144
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:55
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:72
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
#define _(s)
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)
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
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual void SetUnits(EDA_UNITS aUnits)
Normally not needed (as the UNIT_BINDER inherits from the parent frame), but can be used to set to DE...
Definition: unit_binder.cpp:92
FOOTPRINT_EDITOR_SETTINGS * GetSettings()

References _, DIALOG_SHIM::finishDialogSettings(), KIUI::GetInfoFont(), FOOTPRINT_EDIT_FRAME::GetSettings(), icon_modedit, KiBitmap(), m_3dPanel, 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, 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, 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_sdbSizerStdButtonsOK, m_solderPaste, m_solderPasteRatio, 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, OnGridCellChanging(), PAGE_CLEARANCES, PAGE_GENERAL, PAGE_UNKNOWN, PERCENT, DIALOG_SHIM::SetInitialFocus(), UNIT_BINDER::SetNegativeZero(), WX_GRID::SetTable(), UNIT_BINDER::SetUnits(), WX_GRID::ShowHideColumns(), small_plus, and small_trash.

◆ ~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR()

DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR ( )
override

Definition at line 151 of file dialog_footprint_properties_fp_editor.cpp.

152 {
154  m_itemsGrid->GetShownColumns().ToStdString();
155 
156  // Prevents crash bug in wxGrid's d'tor
158 
159  m_itemsGrid->Disconnect( wxEVT_GRID_CELL_CHANGING,
161  nullptr, this );
162 
163  // Delete the GRID_TRICKS.
164  m_itemsGrid->PopEventHandler( true );
165 
166  m_page = static_cast<NOTEBOOK_PAGES>( m_NoteBook->GetSelection() );
167 
168  // the GL canvas on the 3D models page has to be visible before it is destroyed
169  m_NoteBook->SetSelection( static_cast<int>( NOTEBOOK_PAGES::PAGE_3D_MODELS ) );
170 }
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:104
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:117
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_NoteBook, m_page, m_texts, OnGridCellChanging(), and PAGE_3D_MODELS.

Member Function Documentation

◆ adjustGridColumns()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::adjustGridColumns ( int  aWidth)
private

Definition at line 552 of file dialog_footprint_properties_fp_editor.cpp.

553 {
554  // Account for scroll bars
555  int itemsWidth = aWidth - ( m_itemsGrid->GetSize().x - m_itemsGrid->GetClientSize().x );
556 
557  itemsWidth -= m_itemsGrid->GetRowLabelSize();
558 
559  for( int i = 1; i < m_itemsGrid->GetNumberCols(); i++ )
560  itemsWidth -= m_itemsGrid->GetColSize( i );
561 
562  if( itemsWidth > 0 )
563  {
564  m_itemsGrid->SetColSize( 0, std::max( itemsWidth,
565  m_itemsGrid->GetVisibleWidth( 0, true, false, false ) ) );
566  }
567 
568  // Update the width of the 3D panel
570 }
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:246

References PANEL_FP_PROPERTIES_3D_MODEL::AdjustGridColumnWidths(), WX_GRID::GetVisibleWidth(), m_3dPanel, and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_itemsGrid.

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

◆ checkFootprintName()

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

Definition at line 273 of file dialog_footprint_properties_fp_editor.cpp.

274 {
275  if( aFootprintName.IsEmpty() )
276  {
277  m_delayedErrorMessage = _( "Footprint must have a name." );
278  return false;
279  }
280  else if( !FOOTPRINT::IsLibNameValid( aFootprintName ) )
281  {
282  m_delayedErrorMessage.Printf( _( "Footprint name may not contain '%s'." ),
284  return false;
285  }
286 
287  return true;
288 }
#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:1432
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:1443

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

Referenced by Validate().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 312 of file dialog_shim.cpp.

313 {
314  // so we can do logging of this state change:
315  return wxDialog::Enable( enable );
316 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 480 of file dialog_shim.cpp.

481 {
482  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
483  // handle validation in the same way as other dialogs.
484  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
485  return;
486 
487  SetReturnCode( retCode );
488 
489  if( !IsQuasiModal() )
490  {
491  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
492  "wasn't called" );
493  return;
494  }
495 
496  if( m_qmodal_loop )
497  {
498  if( m_qmodal_loop->IsRunning() )
499  m_qmodal_loop->Exit( 0 );
500  else
501  m_qmodal_loop->ScheduleExit( 0 );
502 
503  m_qmodal_loop = nullptr;
504  }
505 
507  m_qmodal_parent_disabler = nullptr;
508 
509  Show( false );
510 }
bool IsQuasiModal() const
Definition: dialog_shim.h:106
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:213
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:216

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

Referenced by NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), 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 151 of file dialog_shim.cpp.

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

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), 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_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_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), 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_PCM::DIALOG_PCM(), 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_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_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_FIELD_PROPERTIES::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 169 of file dialog_shim.cpp.

170 {
171  wxSize sz( x, 0 );
172  return ConvertDialogToPixels( sz ).x;
173 }

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

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

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 132 of file dialog_shim.h.

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

◆ 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_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AskToSaveChanges(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), 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(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), 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(), 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_FIELD_PROPERTIES::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(), 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().

◆ OnAddField()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 477 of file dialog_footprint_properties_fp_editor.cpp.

478 {
480  return;
481 
482  const BOARD_DESIGN_SETTINGS& dsnSettings = m_frame->GetDesignSettings();
483  FP_TEXT textItem( m_footprint );
484 
485  // Set active layer if legal; otherwise copy layer from previous text item
487  textItem.SetLayer( m_frame->GetActiveLayer() );
488  else
489  textItem.SetLayer( m_texts->at( m_texts->size() - 1 ).GetLayer() );
490 
491  textItem.SetTextSize( dsnSettings.GetTextSize( textItem.GetLayer() ) );
492  textItem.SetTextThickness( dsnSettings.GetTextThickness( textItem.GetLayer() ) );
493  textItem.SetItalic( dsnSettings.GetTextItalic( textItem.GetLayer() ) );
494 
495  m_texts->push_back( textItem );
496 
497  // notify the grid
498  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
499  m_itemsGrid->ProcessTableMessage( msg );
500 
501  m_itemsGrid->SetFocus();
502  m_itemsGrid->MakeCellVisible( m_texts->size() - 1, 0 );
503  m_itemsGrid->SetGridCursor( m_texts->size() - 1, 0 );
504 
505  m_itemsGrid->EnableCellEditControl( true );
506  m_itemsGrid->ShowCellEditControl();
507 }
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:829
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:190
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, and HTML_MESSAGE_BOX.

Definition at line 570 of file dialog_shim.cpp.

571 {
572  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
573  {
574  if( m_parentFrame )
575  {
577  return;
578  }
579  }
580  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
581  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
582  {
583  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
584  return;
585  }
586  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
587  {
588  wxWindow* currentWindow = wxWindow::FindFocus();
589  int currentIdx = -1;
590  int delta = aEvt.ShiftDown() ? -1 : 1;
591 
592  auto advance = [&]( int& idx )
593  {
594  // Wrap-around modulus
595  int size = m_tabOrder.size();
596  idx = ( ( idx + delta ) % size + size ) % size;
597  };
598 
599  for( size_t i = 0; i < m_tabOrder.size(); ++i )
600  {
601  if( m_tabOrder[i] == currentWindow )
602  {
603  currentIdx = (int) i;
604  break;
605  }
606  }
607 
608  if( currentIdx >= 0 )
609  {
610  advance( currentIdx );
611 
612  //todo: We don't currently have non-textentry dialog boxes but this will break if
613  // we add them.
614 #ifdef __APPLE__
615  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
616  advance( currentIdx );
617 #endif
618 
619  m_tabOrder[ currentIdx ]->SetFocus();
620  return;
621  }
622  }
623 
624  aEvt.Skip();
625 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:220
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:218
virtual void ToggleUserUnits()
constexpr int delta

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

Referenced by DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_TEXT_PROPERTIES::~DIALOG_TEXT_PROPERTIES().

◆ OnDeleteField()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 510 of file dialog_footprint_properties_fp_editor.cpp.

511 {
513  return;
514 
515  wxArrayInt selectedRows = m_itemsGrid->GetSelectedRows();
516 
517  if( selectedRows.empty() && m_itemsGrid->GetGridCursorRow() >= 0 )
518  selectedRows.push_back( m_itemsGrid->GetGridCursorRow() );
519 
520  if( selectedRows.empty() )
521  return;
522 
523  for( int row : selectedRows )
524  {
525  if( row < 2 )
526  {
527  DisplayError( nullptr, _( "Reference and value are mandatory." ) );
528  return;
529  }
530  }
531 
532  // Reverse sort so deleting a row doesn't change the indexes of the other rows.
533  selectedRows.Sort( []( int* first, int* second ) { return *second - *first; } );
534 
535  for( int row : selectedRows )
536  {
537  m_texts->erase( m_texts->begin() + row );
538 
539  // notify the grid
540  wxGridTableMessage msg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_DELETED, row, 1 );
541  m_itemsGrid->ProcessTableMessage( msg );
542 
543  if( m_itemsGrid->GetNumberRows() > 0 )
544  {
545  m_itemsGrid->MakeCellVisible( std::max( 0, row-1 ), m_itemsGrid->GetGridCursorCol() );
546  m_itemsGrid->SetGridCursor( std::max( 0, row-1 ), m_itemsGrid->GetGridCursorCol() );
547  }
548  }
549 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
#define _(s)
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190

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 468 of file dialog_footprint_properties_fp_editor.cpp.

469 {
471  {
472  // Currently: nothing to do
473  }
474 }
static bool footprintIsFromBoard(FOOTPRINT *aFootprint)

References footprintIsFromBoard(), and m_footprint.

◆ OnGridCellChanging()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnGridCellChanging ( wxGridEvent &  event)
private

Definition at line 462 of file dialog_footprint_properties_fp_editor.cpp.

463 {
464  // Currently: nothing to do
465 }

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 627 of file dialog_footprint_properties_fp_editor.cpp.

628 {
629  adjustGridColumns( event.GetSize().GetX() );
630 
631  event.Skip();
632 }

References adjustGridColumns().

◆ OnInitDlg()

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

◆ OnModify()

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 380 of file dialog_shim.cpp.

381 {
382  if( m_firstPaintEvent )
383  {
385 
386  selectAllInTextCtrls( GetChildren() );
387 
390  else
391  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
392 
393  m_firstPaintEvent = false;
394  }
395 
396  event.Skip();
397 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:211
bool m_firstPaintEvent
Definition: dialog_shim.h:210
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().

◆ OnUpdateUI()

void DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE.

Definition at line 573 of file dialog_footprint_properties_fp_editor.cpp.

574 {
575  if( !m_itemsGrid->IsCellEditControlShown() )
576  adjustGridColumns( m_itemsGrid->GetRect().GetWidth() );
577 
578  // Handle a delayed focus. The delay allows us to:
579  // a) change focus when the error was triggered from within a killFocus handler
580  // b) show the correct notebook page in the background before the error dialog comes up
581  // when triggered from an OK or a notebook page change
582 
583  if( static_cast<int>( m_delayedFocusPage ) >= 0 )
584  {
585  if( m_NoteBook->GetSelection() != static_cast<int>( m_delayedFocusPage ) )
586  m_NoteBook->ChangeSelection( static_cast<int>( m_delayedFocusPage ) );
587 
589  }
590 
591  if( !m_delayedErrorMessage.IsEmpty() )
592  {
593  // We will re-enter this routine when the error dialog is displayed, so make
594  // sure we don't keep putting up more dialogs.
595  wxString msg = m_delayedErrorMessage;
596  m_delayedErrorMessage = wxEmptyString;
597 
598  // Do not use DisplayErrorMessage(); it screws up window order on Mac
599  DisplayError( nullptr, msg );
600  }
601 
602  if( m_delayedFocusCtrl )
603  {
604  m_delayedFocusCtrl->SetFocus();
605 
606  if( auto textEntry = dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl ) )
607  textEntry->SelectAll();
608 
609  m_delayedFocusCtrl = nullptr;
610  }
611  else if( m_delayedFocusGrid )
612  {
613  m_delayedFocusGrid->SetFocus();
616 
617  m_delayedFocusGrid->EnableCellEditControl( true );
618  m_delayedFocusGrid->ShowCellEditControl();
619 
620  m_delayedFocusGrid = nullptr;
621  m_delayedFocusRow = -1;
623  }
624 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279

References adjustGridColumns(), DisplayError(), 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_NoteBook, and PAGE_UNKNOWN.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

37 {
38  return Kiway().Prj();
39 }
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:190

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(), PANEL_FP_PROPERTIES_3D_MODEL::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_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(), SIM_PLOT_FRAME::getDefaultFilename(), SIM_PLOT_FRAME::getDefaultPath(), 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(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::loadWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), 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_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChange(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::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_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), 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(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), 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(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), 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(), SCH_EDIT_FRAME::saveSchematicFile(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), 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(), 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(), PANEL_SETUP_RULES::TransferDataToWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), 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 287 of file dialog_shim.cpp.

288 {
289  const char* hash_key;
290 
291  if( m_hash_key.size() )
292  {
293  // a special case like EDA_LIST_DIALOG, which has multiple uses.
294  hash_key = m_hash_key.c_str();
295  }
296  else
297  {
298  hash_key = typeid(*this).name();
299  }
300 
301  std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
302 
303  if( it == class_map.end() )
304  return;
305 
306  wxRect rect = it->second;
307  rect.SetSize( wxSize( 0, 0 ) );
308  class_map[ hash_key ] = rect;
309 }
std::string m_hash_key
Definition: dialog_shim.h:201
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().

◆ 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:211

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_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_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), 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_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_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_FIELD_PROPERTIES::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_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

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

"this" is a KIWAY_HOLDER mix-in.

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

Definition at line 43 of file kiway_holder.cpp.

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

References ignore_unused(), 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 190 of file dialog_shim.cpp.

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

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

Referenced by 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 162 of file dialog_shim.cpp.

163 {
164  wxSize sz( x, y );
165  SetSize( ConvertDialogToPixels( sz ) );
166 }

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

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

References class_map, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DRC_TOOL::CrossProbe(), 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(), DIALOG_FIND::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 430 of file dialog_shim.cpp.

431 {
432  // This is an exception safe way to zero a pointer before returning.
433  // Yes, even though DismissModal() clears this first normally, this is
434  // here in case there's an exception before the dialog is dismissed.
435  struct NULLER
436  {
437  void*& m_what;
438  NULLER( void*& aPtr ) : m_what( aPtr ) {}
439  ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
440  } clear_this( (void*&) m_qmodal_loop );
441 
442  // release the mouse if it's currently captured as the window having it
443  // will be disabled when this dialog is shown -- but will still keep the
444  // capture making it impossible to do anything in the modal dialog itself
445  wxWindow* win = wxWindow::GetCapture();
446  if( win )
447  win->ReleaseMouse();
448 
449  // Get the optimal parent
450  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
451 
452  wxASSERT_MSG( !m_qmodal_parent_disabler,
453  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
454 
455  // quasi-modal: disable only my "optimal" parent
457 
458  // Apple in its infinite wisdom will raise a disabled window before even passing
459  // us the event, so we have no way to stop it. Instead, we must set an order on
460  // the windows so that the quasi-modal will be pushed in front of the disabled
461  // window when it is raised.
463 
464  Show( true );
465 
466  m_qmodal_showing = true;
467 
468  WX_EVENT_LOOP event_loop;
469 
470  m_qmodal_loop = &event_loop;
471 
472  event_loop.Run();
473 
474  m_qmodal_showing = false;
475 
476  return GetReturnCode();
477 }
bool m_qmodal_showing
Definition: dialog_shim.h:215
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:213
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:216
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:44
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 339 of file dialog_footprint_properties_fp_editor.cpp.

340 {
341  if( !Validate() )
342  return false;
343 
344  if( !DIALOG_SHIM::TransferDataFromWindow() )
345  return false;
346 
348  return false;
349 
350  // This only commits the editor, model updating is done below so it is inside
351  // the commit
353  return false;
354 
355  auto view = m_frame->GetCanvas()->GetView();
356  BOARD_COMMIT commit( m_frame );
357  commit.Modify( m_footprint );
358 
359  LIB_ID fpID = m_footprint->GetFPID();
360  fpID.SetLibItemName( m_FootprintNameCtrl->GetValue() );
361  m_footprint->SetFPID( fpID );
362 
363  m_footprint->SetDescription( m_DocCtrl->GetValue() );
364  m_footprint->SetKeywords( m_KeywordCtrl->GetValue() );
365 
366  // copy reference and value
367  m_footprint->Reference() = m_texts->at( 0 );
368  m_footprint->Value() = m_texts->at( 1 );
369 
370  size_t i = 2;
371  std::vector<FP_TEXT*> items_to_remove;
372 
373  for( BOARD_ITEM* item : m_footprint->GraphicalItems() )
374  {
375  FP_TEXT* textItem = dynamic_cast<FP_TEXT*>( item );
376 
377  if( textItem )
378  {
379  // copy grid table entries till we run out, then delete any remaining texts
380  if( i < m_texts->size() )
381  *textItem = m_texts->at( i++ );
382  else // store this item to remove and delete it later,
383  // after the graphic list is explored:
384  items_to_remove.push_back( textItem );
385  }
386  }
387 
388  // Remove text items:
390 
391  for( FP_TEXT* item: items_to_remove )
392  {
393  selTool->RemoveItemFromSel( item );
394  view->Remove( item );
395  item->DeleteStructure();
396  }
397 
398  // if there are still grid table entries, create new texts for them
399  while( i < m_texts->size() )
400  {
401  FP_TEXT* newText = new FP_TEXT( m_texts->at( i++ ) );
402  m_footprint->Add( newText, ADD_MODE::APPEND );
403  view->Add( newText );
404  }
405 
406  int attributes = 0;
407 
408  switch( m_componentType->GetSelection() )
409  {
410  case 0: attributes |= FP_THROUGH_HOLE; break;
411  case 1: attributes |= FP_SMD; break;
412  default: break;
413  }
414 
415  if( m_boardOnly->GetValue() )
416  attributes |= FP_BOARD_ONLY;
417 
418  if( m_excludeFromPosFiles->GetValue() )
419  attributes |= FP_EXCLUDE_FROM_POS_FILES;
420 
421  if( m_excludeFromBOM->GetValue() )
422  attributes |= FP_EXCLUDE_FROM_BOM;
423 
424  m_footprint->SetAttributes( attributes );
425 
428 
429  // Initialize masks clearances
434 
435  switch( m_ZoneConnectionChoice->GetSelection() )
436  {
437  default:
442  }
443 
444  // Copy the models from the panel to the footprint
445  std::vector<FP_3DMODEL>& panelList = m_3dPanel->GetModelList();
446  std::list<FP_3DMODEL>* fpList = &m_footprint->Models();
447  fpList->clear();
448  fpList->insert( fpList->end(), panelList.begin(), panelList.end() );
449 
450  commit.Push( _( "Modify footprint properties" ) );
451 
452  return true;
453 }
std::list< FP_3DMODEL > & Models()
Definition: footprint.h:183
void SetZoneConnection(ZONE_CONNECTION aType)
Definition: footprint.h:227
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:49
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
std::vector< FP_3DMODEL > & GetModelList()
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: footprint.h:225
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:237
void SetPlacementCost180(int aCost)
Definition: footprint.h:580
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:500
void SetDescription(const wxString &aDoc)
Definition: footprint.h:199
FP_TEXT & Reference()
Definition: footprint.h:501
pads are covered by copper
void SetLocalClearance(int aClearance)
Definition: footprint.h:211
#define _(s)
DRAWINGS & GraphicalItems()
Definition: footprint.h:172
const LIB_ID & GetFPID() const
Definition: footprint.h:195
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:108
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Use thermal relief for pads.
void SetFPID(const LIB_ID &aFPID)
Definition: footprint.h:196
void SetKeywords(const wxString &aKeywords)
Definition: footprint.h:202
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:513
virtual double GetDoubleValue()
Return the current value in Internal Units.
void SetPlacementCost90(int aCost)
Definition: footprint.h:583
void SetLocalSolderMaskMargin(int aMargin)
Definition: footprint.h:208
void SetLocalSolderPasteMargin(int aMargin)
Definition: footprint.h:222

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(), UNIT_BINDER::GetDoubleValue(), FOOTPRINT::GetFPID(), PANEL_FP_PROPERTIES_3D_MODEL::GetModelList(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), UNIT_BINDER::GetValue(), PCB_DRAW_PANEL_GAL::GetView(), FOOTPRINT::GraphicalItems(), INHERITED, m_3dPanel, 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, m_netClearance, m_solderMask, m_solderPaste, m_solderPasteRatio, 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, PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow(), Validate(), and FOOTPRINT::Value().

◆ TransferDataToWindow()

bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow ( )
override

Definition at line 173 of file dialog_footprint_properties_fp_editor.cpp.

174 {
175  LIB_ID fpID = m_footprint->GetFPID();
176  wxString footprintName = fpID.GetLibItemName();
177 
178  m_FootprintNameCtrl->ChangeValue( footprintName );
179 
180  m_DocCtrl->SetValue( m_footprint->GetDescription() );
181  m_KeywordCtrl->SetValue( m_footprint->GetKeywords() );
182 
183  if( !wxDialog::TransferDataToWindow() )
184  return false;
185 
186  if( !m_PanelGeneral->TransferDataToWindow() )
187  return false;
188 
189  // Add the models to the panel
191  return false;
192 
193  // Footprint Texts
194  m_texts->push_back( m_footprint->Reference() );
195  m_texts->push_back( m_footprint->Value() );
196 
197  for( auto item : m_footprint->GraphicalItems() )
198  {
199  auto textItem = dyn_cast<FP_TEXT*>( item );
200 
201  if( textItem )
202  m_texts->push_back( *textItem );
203  }
204 
205  // Notify the grid
206  wxGridTableMessage tmsg( m_texts, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_texts->GetNumberRows() );
207  m_itemsGrid->ProcessTableMessage( tmsg );
208 
209  // Footprint Properties
212 
214  m_componentType->SetSelection( 0 );
215  else if( m_footprint->GetAttributes() & FP_SMD )
216  m_componentType->SetSelection( 1 );
217  else
218  m_componentType->SetSelection( 2 );
219 
223 
224  // Local Clearances
225 
230 
231  switch( m_footprint->GetZoneConnection() )
232  {
233  default:
234  case ZONE_CONNECTION::INHERITED: m_ZoneConnectionChoice->SetSelection( 0 ); break;
235  case ZONE_CONNECTION::FULL: m_ZoneConnectionChoice->SetSelection( 1 ); break;
236  case ZONE_CONNECTION::THERMAL: m_ZoneConnectionChoice->SetSelection( 2 ); break;
237  case ZONE_CONNECTION::NONE: m_ZoneConnectionChoice->SetSelection( 3 ); break;
238  }
239 
240  // Items grid
241  for( int col = 0; col < m_itemsGrid->GetNumberCols(); col++ )
242  {
243  // Adjust min size to the column label size
244  m_itemsGrid->SetColMinimalWidth( col, m_itemsGrid->GetVisibleWidth( col, true, false,
245  false ) );
246  // Adjust the column size.
247  int col_size = m_itemsGrid->GetVisibleWidth( col, true, true, false );
248 
249  if( col == FPT_LAYER ) // This one's a drop-down. Check all possible values.
250  {
251  BOARD* board = m_footprint->GetBoard();
252 
253  for( PCB_LAYER_ID layer : board->GetEnabledLayers().Seq() )
254  col_size = std::max( col_size, GetTextExtent( board->GetLayerName( layer ) ).x );
255 
256  // And the swatch:
257  col_size += 20;
258  }
259 
260  if( m_itemsGrid->IsColShown( col ) )
261  m_itemsGrid->SetColSize( col, col_size );
262  }
263 
264  m_itemsGrid->SetRowLabelSize( m_itemsGrid->GetVisibleWidth( -1, true, true, true ) );
265 
266  Layout();
267  adjustGridColumns( m_itemsGrid->GetRect().GetWidth() );
268 
269  return true;
270 }
const wxString & GetDescription() const
Definition: footprint.h:198
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:362
int GetPlacementCost180() const
Definition: footprint.h:579
int GetNumberRows() override
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:467
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
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:246
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:500
FP_TEXT & Reference()
Definition: footprint.h:501
pads are covered by copper
int GetLocalClearance() const
Definition: footprint.h:210
DRAWINGS & GraphicalItems()
Definition: footprint.h:172
const LIB_ID & GetFPID() const
Definition: footprint.h:195
const wxString & GetKeywords() const
Definition: footprint.h:201
Use thermal relief for pads.
int GetLocalSolderMaskMargin() const
Definition: footprint.h:207
int GetAttributes() const
Definition: footprint.h:236
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:191
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:65
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:224
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:36
ZONE_CONNECTION GetZoneConnection() const
Definition: footprint.h:228
int GetPlacementCost90() const
Definition: footprint.h:582
int GetLocalSolderPasteMargin() const
Definition: footprint.h:221
virtual void SetDoubleValue(double aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.

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, m_3dPanel, 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, m_netClearance, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_PanelGeneral, m_solderMask, m_solderPaste, m_solderPasteRatio, m_texts, DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_ZoneConnectionChoice, NONE, FOOTPRINT::Reference(), LSET::Seq(), UNIT_BINDER::SetDoubleValue(), UNIT_BINDER::SetValue(), THERMAL, PANEL_FP_PROPERTIES_3D_MODEL::TransferDataToWindow(), and FOOTPRINT::Value().

◆ Validate()

bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate ( )
override

Definition at line 291 of file dialog_footprint_properties_fp_editor.cpp.

292 {
294  return false;
295 
296  if( !DIALOG_SHIM::Validate() )
297  return false;
298 
299  // First, test for invalid chars in footprint name
300  wxString footprintName = m_FootprintNameCtrl->GetValue();
301 
302  if( !checkFootprintName( footprintName ) )
303  {
304  if( m_NoteBook->GetSelection() != 0 )
305  m_NoteBook->SetSelection( 0 );
306 
309 
310  return false;
311  }
312 
313  // Check for empty texts.
314  for( size_t i = 2; i < m_texts->size(); ++i )
315  {
316  FP_TEXT& text = m_texts->at( i );
317 
318  if( text.GetText().IsEmpty() )
319  {
320  if( m_NoteBook->GetSelection() != 0 )
321  m_NoteBook->SetSelection( 0 );
322 
323  m_delayedErrorMessage = _( "Text items must have some content." );
326  m_delayedFocusRow = i;
327 
328  return false;
329  }
330  }
331 
332  if( !m_netClearance.Validate( 0, INT_MAX ) )
333  return false;
334 
335  return true;
336 }
#define _(s)
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:190
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, PAGE_GENERAL, 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 176 of file dialog_shim.cpp.

177 {
178  wxSize sz( 0, y );
179  return ConvertDialogToPixels( sz ).y;
180 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_3dPanel

PANEL_FP_PROPERTIES_3D_MODEL* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_3dPanel
private

◆ 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_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

NOTEBOOK_PAGES 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 210 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 211 of file dialog_shim.h.

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

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize
protectedinherited

Definition at line 223 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

◆ m_itemsGrid

◆ m_KeywordCtrl

wxTextCtrl* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_KeywordCtrl
protectedinherited

◆ 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

NOTEBOOK_PAGES DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_page = NOTEBOOK_PAGES::PAGE_GENERAL
staticprivate

◆ 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_PasteMarginRatioCtrl

TEXT_CTRL_EVAL* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_PasteMarginRatioCtrl
protectedinherited

◆ m_PasteMarginRatioLabel

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_PasteMarginRatioLabel
protectedinherited

◆ m_PasteMarginRatioUnits

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_PasteMarginRatioUnits
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 213 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 215 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_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_SolderPasteMarginUnits

wxStaticText* DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE::m_SolderPasteMarginUnits
protectedinherited

◆ m_solderPasteRatio

UNIT_BINDER DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::m_solderPasteRatio
private

◆ 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_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: