KiCad PCB EDA Suite
DIALOG_LIB_SYMBOL_PROPERTIES Class Reference

#include <dialog_lib_symbol_properties.h>

Inheritance diagram for DIALOG_LIB_SYMBOL_PROPERTIES:
DIALOG_LIB_SYMBOL_PROPERTIES_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG , FRAME , PANEL }
 

Public Member Functions

 DIALOG_LIB_SYMBOL_PROPERTIES (SYMBOL_EDIT_FRAME *parent, LIB_SYMBOL *aLibEntry)
 
 ~DIALOG_LIB_SYMBOL_PROPERTIES ()
 
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
 
void SetupStandardButtons (std::map< int, wxString > aLabels={})
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
bool HasKiway () const
 Safety check before asking for the Kiway reference. 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)
 

Public Attributes

SYMBOL_EDIT_FRAMEm_Parent
 
LIB_SYMBOLm_libEntry
 
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
 
UNIT_BINDER m_pinNameOffset
 
wxControl * m_delayedFocusCtrl
 
WX_GRIDm_delayedFocusGrid
 
int m_delayedFocusRow
 
int m_delayedFocusColumn
 
int m_delayedFocusPage
 
wxString m_delayedErrorMessage
 
wxString m_shownColumns
 
wxSize m_size
 

Protected Member Functions

bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
bool Validate () override
 
void onPowerCheckBox (wxCommandEvent &aEvent) override
 
void OnText (wxCommandEvent &event) override
 
void OnCombobox (wxCommandEvent &event) override
 
void OnCheckBox (wxCommandEvent &event) override
 
void OnSpinCtrl (wxSpinEvent &event) override
 
void OnSpinCtrlText (wxCommandEvent &event) override
 
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_PanelBasic
 
WX_GRIDm_grid
 
wxBoxSizer * bButtonSize
 
wxBitmapButton * m_bpAdd
 
wxBitmapButton * m_bpMoveUp
 
wxBitmapButton * m_bpMoveDown
 
wxBitmapButton * m_bpDelete
 
wxTextCtrl * m_SymbolNameCtrl
 
wxTextCtrl * m_DescCtrl
 
wxStaticText * staticKeywordsLabel
 
wxTextCtrl * m_KeywordCtrl
 
wxStaticText * m_inheritsStaticText
 
wxComboBox * m_inheritanceSelectCombo
 
wxBoxSizer * bSizerLowerBasicPanel
 
wxCheckBox * m_AsConvertButt
 
wxCheckBox * m_OptionPower
 
wxCheckBox * m_excludeFromBomCheckBox
 
wxCheckBox * m_excludeFromBoardCheckBox
 
wxStaticText * m_staticTextNbUnits
 
wxSpinCtrl * m_SelNumberOfUnits
 
wxCheckBox * m_OptionPartsInterchangeable
 
wxCheckBox * m_ShowPinNumButt
 
wxCheckBox * m_ShowPinNameButt
 
wxCheckBox * m_PinsNameInsideButt
 
wxStaticText * m_nameOffsetLabel
 
wxTextCtrl * m_nameOffsetCtrl
 
wxStaticText * m_nameOffsetUnits
 
wxPanel * m_PanelFootprintFilter
 
wxStaticText * m_staticTextFootprints
 
wxListBox * m_FootprintFilterListBox
 
wxBitmapButton * m_addFilterButton
 
wxBitmapButton * m_editFilterButton
 
wxBitmapButton * m_deleteFilterButton
 
wxButton * m_spiceFieldsButton
 
wxStdDialogButtonSizer * m_stdSizerButton
 
wxButton * m_stdSizerButtonOK
 
wxButton * m_stdSizerButtonCancel
 
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 Types

enum  LAST_LAYOUT { NONE , ALIAS , PARENT }
 

Private Member Functions

void OnAddField (wxCommandEvent &event) override
 
void OnDeleteField (wxCommandEvent &event) override
 
void OnMoveUp (wxCommandEvent &event) override
 
void OnMoveDown (wxCommandEvent &event) override
 
void OnSymbolNameKillFocus (wxFocusEvent &event) override
 
void OnSymbolNameText (wxCommandEvent &event) override
 
void OnAddFootprintFilter (wxCommandEvent &event) override
 
void OnDeleteFootprintFilter (wxCommandEvent &event) override
 
void OnEditFootprintFilter (wxCommandEvent &event) override
 
void OnSizeGrid (wxSizeEvent &event) override
 
void OnGridCellChanging (wxGridEvent &event)
 
void OnEditSpiceModel (wxCommandEvent &event) override
 
void OnUpdateUI (wxUpdateUIEvent &event) override
 
void OnFilterDClick (wxMouseEvent &event) override
 
void OnCancelButtonClick (wxCommandEvent &event) override
 
void adjustGridColumns ()
 
void syncControlStates (bool aIsAlias)
 
void OnCloseWindow (wxCloseEvent &aEvent)
 Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM. More...
 
void OnButton (wxCommandEvent &aEvent)
 Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM. More...
 
void OnGridEditorShown (wxGridEvent &event)
 
void OnGridEditorHidden (wxGridEvent &event)
 
 DECLARE_EVENT_TABLE ()
 

Private Attributes

KIWAYm_kiway
 
HOLDER_TYPE m_type
 

Static Private Attributes

static int m_lastOpenedPage = 0
 
static LAST_LAYOUT m_lastLayout = DIALOG_LIB_SYMBOL_PROPERTIES::NONE
 

Detailed Description

Definition at line 38 of file dialog_lib_symbol_properties.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.

◆ LAST_LAYOUT

Constructor & Destructor Documentation

◆ DIALOG_LIB_SYMBOL_PROPERTIES()

DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES ( SYMBOL_EDIT_FRAME parent,
LIB_SYMBOL aLibEntry 
)

Definition at line 51 of file dialog_lib_symbol_properties.cpp.

52 :
54 m_Parent( aParent ),
55 m_libEntry( aLibEntry ),
57 m_delayedFocusCtrl( nullptr ),
58 m_delayedFocusGrid( nullptr ),
62{
63 // Give a bit more room for combobox editors
64 m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
67 m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this ) );
68 m_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
69
70 // Show/hide columns according to the user's preference
73
74 wxGridCellAttr* attr = new wxGridCellAttr;
75 attr->SetEditor( new GRID_CELL_URL_EDITOR( this, Prj().SchSearchS() ) );
76 m_grid->SetAttr( DATASHEET_FIELD, FDC_VALUE, attr );
77
78 m_SymbolNameCtrl->SetValidator( SCH_FIELD_VALIDATOR( true, VALUE_FIELD ) );
79
80 // Configure button logos
81 m_bpAdd->SetBitmap( KiBitmap( BITMAPS::small_plus ) );
83 m_bpMoveUp->SetBitmap( KiBitmap( BITMAPS::small_up ) );
88
90
91 if( aParent->IsSymbolFromLegacyLibrary() && !aParent->IsSymbolFromSchematic() )
92 {
93 m_stdSizerButtonCancel->SetDefault();
94 m_stdSizerButtonOK->SetLabel( _( "Read Only" ) );
95 m_stdSizerButtonOK->Enable( false );
96 }
97
98#ifndef KICAD_SPICE
99 m_spiceFieldsButton->Hide();
100#endif
101
102 // wxFormBuilder doesn't include this event...
103 m_grid->Connect( wxEVT_GRID_CELL_CHANGING,
105 nullptr, this );
106
108 {
111 {
112 resetSize();
113 }
114 }
115
118
119 m_grid->GetParent()->Layout();
121 Layout();
122
124}
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
DIALOG_LIB_SYMBOL_PROPERTIES_BASE(wxWindow *parent, wxWindowID id=ID_LIBEDIT_NOTEBOOK, const wxString &title=_("Library Symbol Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void resetSize()
Clear the existing dialog size and position.
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
Definition: lib_symbol.h:180
bool IsAlias() const
Definition: lib_symbol.h:181
A text control validator used for validating the text allowed in library and schematic symbol fields.
SYMBOL_EDITOR_SETTINGS * GetSettings() const
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:172
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:93
#define _(s)
@ FDC_VALUE
@ DATASHEET_FIELD
name of datasheet
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".

References _, ALIAS, DATASHEET_FIELD, FDC_VALUE, DIALOG_SHIM::finishDialogSettings(), SYMBOL_EDIT_FRAME::GetSettings(), LIB_SYMBOL::IsAlias(), LIB_SYMBOL::IsRoot(), SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary(), SYMBOL_EDIT_FRAME::IsSymbolFromSchematic(), KiBitmap(), DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_addFilterButton, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_bpAdd, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_bpDelete, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_bpMoveDown, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_bpMoveUp, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_deleteFilterButton, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_editFilterButton, SYMBOL_EDITOR_SETTINGS::m_EditSymbolVisibleColumns, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, m_lastLayout, m_libEntry, m_Parent, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_spiceFieldsButton, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_stdSizerButtonCancel, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_stdSizerButtonOK, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SymbolNameCtrl, NONE, OnGridCellChanging(), PARENT, KIWAY_HOLDER::Prj(), DIALOG_SHIM::resetSize(), WX_GRID::SetTable(), DIALOG_SHIM::SetupStandardButtons(), WX_GRID::ShowHideColumns(), small_down, small_edit, small_plus, small_trash, small_up, syncControlStates(), and VALUE_FIELD.

◆ ~DIALOG_LIB_SYMBOL_PROPERTIES()

DIALOG_LIB_SYMBOL_PROPERTIES::~DIALOG_LIB_SYMBOL_PROPERTIES ( )

Definition at line 127 of file dialog_lib_symbol_properties.cpp.

128{
129 m_lastOpenedPage = m_NoteBook->GetSelection( );
130
133
134 // Prevents crash bug in wxGrid's d'tor
136
137 m_grid->Disconnect( wxEVT_GRID_CELL_CHANGING,
139 nullptr, this );
140
141 // Delete the GRID_TRICKS.
142 m_grid->PopEventHandler( true );
143}
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:139
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:153

References WX_GRID::DestroyTable(), SYMBOL_EDIT_FRAME::GetSettings(), WX_GRID::GetShownColumns(), SYMBOL_EDITOR_SETTINGS::m_EditSymbolVisibleColumns, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, m_lastOpenedPage, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_NoteBook, m_Parent, and OnGridCellChanging().

Member Function Documentation

◆ adjustGridColumns()

void DIALOG_LIB_SYMBOL_PROPERTIES::adjustGridColumns ( )
private

Definition at line 713 of file dialog_lib_symbol_properties.cpp.

714{
715 // Account for scroll bars
717
718 m_grid->AutoSizeColumn( FDC_NAME );
719
720 int fixedColsWidth = m_grid->GetColSize( FDC_NAME );
721
722 for( int i = 2; i < m_grid->GetNumberCols(); i++ )
723 fixedColsWidth += m_grid->GetColSize( i );
724
725 m_grid->SetColSize( FDC_VALUE, width - fixedColsWidth );
726}
@ FDC_NAME
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition: gtk/ui.cpp:126

References FDC_NAME, FDC_VALUE, KIPLATFORM::UI::GetUnobscuredSize(), and DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid.

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

◆ DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )
privateinherited

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 319 of file dialog_shim.cpp.

320{
321 // so we can do logging of this state change:
322 return wxDialog::Enable( enable );
323}

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 487 of file dialog_shim.cpp.

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

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

Referenced by EDA_3D_CONTROLLER::Main(), NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), 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 158 of file dialog_shim.cpp.

159{
160 // must be called from the constructor of derived classes,
161 // when all widgets are initialized, and therefore their size fixed
162
163 // SetSizeHints fixes the minimal size of sizers in the dialog
164 // (SetSizeHints calls Fit(), so no need to call it)
165 GetSizer()->SetSizeHints( this );
166}

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), 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_COPPER_ZONE::DIALOG_COPPER_ZONE(), 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_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_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_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_IMPORT::DIALOG_NETLIST_IMPORT(), 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_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), 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_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_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_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), PAGED_DIALOG::finishInitialization(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::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:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
inlineinherited

Safety check before asking for the Kiway reference.

Returns
true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

64 {
65 return m_kiway != nullptr;
66 }
KIWAY * m_kiway
Definition: kiway_holder.h:84

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

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

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

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

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

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 134 of file dialog_shim.h.

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

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

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(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), SIM_PLOT_FRAME::onProbe(), PCB_EDIT_FRAME::OnQuit(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), SIM_PLOT_FRAME::onTune(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCH_EDITOR_CONTROL::rescueProject(), PCB_EDIT_FRAME::RunEeschema(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), PCB_BASE_FRAME::SelectLibrary(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SendSelectItems(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDIT_FRAME::TestStandalone(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ OnAddField()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 482 of file dialog_lib_symbol_properties.cpp.

483{
485 return;
486
488 int fieldID = m_fields->size();
489 LIB_FIELD newField( m_libEntry, fieldID );
490
491 newField.SetTextSize( wxSize( Mils2iu( settings->m_Defaults.text_size ),
492 Mils2iu( settings->m_Defaults.text_size ) ) );
493
494 m_fields->push_back( newField );
495
496 // notify the grid
497 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
498 m_grid->ProcessTableMessage( msg );
499
500 m_grid->MakeCellVisible( (int) m_fields->size() - 1, 0 );
501 m_grid->SetGridCursor( (int) m_fields->size() - 1, 0 );
502
503 m_grid->EnableCellEditControl();
504 m_grid->ShowCellEditControl();
505
506 OnModify();
507}
void OnModify()
Field object used in symbol libraries.
Definition: lib_field.h:60
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:226

References WX_GRID::CommitPendingChanges(), SYMBOL_EDIT_FRAME::GetSettings(), SYMBOL_EDITOR_SETTINGS::m_Defaults, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, m_libEntry, m_Parent, DIALOG_SHIM::OnModify(), EDA_TEXT::SetTextSize(), and SYMBOL_EDITOR_SETTINGS::DEFAULTS::text_size.

◆ OnAddFootprintFilter()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnAddFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 656 of file dialog_lib_symbol_properties.cpp.

657{
658 wxString filterLine;
659 WX_TEXT_ENTRY_DIALOG dlg( this, _( "Filter:" ), _( "Add Footprint Filter" ), filterLine );
660
661 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetValue().IsEmpty() )
662 return;
663
664 filterLine = dlg.GetValue();
665 filterLine.Replace( wxT( " " ), wxT( "_" ) );
666
667 // duplicate filters do no harm, so don't be a nanny.
668
669 m_FootprintFilterListBox->Append( filterLine );
670 m_FootprintFilterListBox->SetSelection( (int) m_FootprintFilterListBox->GetCount() - 1 );
671
672 OnModify();
673}
A KICAD version of wxTextEntryDialog which supports the various improvements/work-arounds from DIALOG...

References _, WX_TEXT_ENTRY_DIALOG::GetValue(), DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_FootprintFilterListBox, and DIALOG_SHIM::OnModify().

Referenced by OnFilterDClick().

◆ OnButton()

void DIALOG_SHIM::OnButton ( wxCommandEvent &  aEvent)
privateinherited

Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 533 of file dialog_shim.cpp.

534{
535 const int id = aEvent.GetId();
536
537 // If we are pressing a button to exit, we need to enable the escapeID
538 // otherwise the dialog does not process cancel
539 if( id == wxID_CANCEL )
540 SetEscapeId( wxID_ANY );
541
542 if( IsQuasiModal() )
543 {
544 if( id == GetAffirmativeId() )
545 {
546 EndQuasiModal( id );
547 }
548 else if( id == wxID_APPLY )
549 {
550 // Dialogs that provide Apply buttons should make sure data is valid before
551 // allowing a transfer, as there is no other way to indicate failure
552 // (i.e. the dialog can't refuse to close as it might with OK, because it
553 // isn't closing anyway)
554 if( Validate() )
555 {
556 ignore_unused( TransferDataFromWindow() );
557 }
558 }
559 else if( id == GetEscapeId() || (id == wxID_CANCEL && GetEscapeId() == wxID_ANY) )
560 {
561 EndQuasiModal( wxID_CANCEL );
562 }
563 else // not a standard button
564 {
565 aEvent.Skip();
566 }
567
568 return;
569 }
570
571 // This is mandatory to allow wxDialogBase::OnButton() to be called.
572 aEvent.Skip();
573}
void EndQuasiModal(int retCode)
void ignore_unused(const T &)
Definition: ignore.h:24

References DIALOG_SHIM::EndQuasiModal(), ignore_unused(), and DIALOG_SHIM::IsQuasiModal().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnCancelButtonClick()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 648 of file dialog_lib_symbol_properties.cpp.

649{
650 // Running the Footprint Browser gums up the works and causes the automatic cancel
651 // stuff to no longer work. So we do it here ourselves.
652 EndQuasiModal( wxID_CANCEL );
653}

References DIALOG_SHIM::EndQuasiModal().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in HK_PROMPT_DIALOG, DIALOG_CHOOSE_SYMBOL, and HTML_MESSAGE_BOX.

Definition at line 576 of file dialog_shim.cpp.

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

◆ OnCheckBox()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnCheckBox ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 861 of file dialog_lib_symbol_properties.cpp.

862{
863 OnModify();
864}

References DIALOG_SHIM::OnModify().

◆ OnCloseWindow()

void DIALOG_SHIM::OnCloseWindow ( wxCloseEvent &  aEvent)
privateinherited

Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 520 of file dialog_shim.cpp.

521{
522 if( IsQuasiModal() )
523 {
524 EndQuasiModal( wxID_CANCEL );
525 return;
526 }
527
528 // This is mandatory to allow wxDialogBase::OnCloseWindow() to be called.
529 aEvent.Skip();
530}

References DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::IsQuasiModal().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnCombobox()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnCombobox ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 855 of file dialog_lib_symbol_properties.cpp.

856{
857 OnModify();
858}

References DIALOG_SHIM::OnModify().

◆ OnDeleteField()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 510 of file dialog_lib_symbol_properties.cpp.

511{
512 wxArrayInt selectedRows = m_grid->GetSelectedRows();
513
514 if( selectedRows.empty() && m_grid->GetGridCursorRow() >= 0 )
515 selectedRows.push_back( m_grid->GetGridCursorRow() );
516
517 if( selectedRows.empty() )
518 return;
519
520 for( int row : selectedRows )
521 {
522 if( row < MANDATORY_FIELDS )
523 {
524 DisplayError( this, wxString::Format( _( "The first %d fields are mandatory." ),
526 return;
527 }
528 }
529
530 m_grid->CommitPendingChanges( true /* quiet mode */ );
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_fields->erase( m_fields->begin() + row );
538
539 // notify the grid
540 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, row, 1 );
541 m_grid->ProcessTableMessage( msg );
542
543 if( m_grid->GetNumberRows() > 0 )
544 {
545 m_grid->MakeCellVisible( std::max( 0, row-1 ), m_grid->GetGridCursorCol() );
546 m_grid->SetGridCursor( std::max( 0, row-1 ), m_grid->GetGridCursorCol() );
547 }
548 }
549
550 OnModify();
551}
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:280
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
@ MANDATORY_FIELDS
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

References _, WX_GRID::CommitPendingChanges(), DisplayError(), Format(), m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, MANDATORY_FIELDS, and DIALOG_SHIM::OnModify().

◆ OnDeleteFootprintFilter()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 676 of file dialog_lib_symbol_properties.cpp.

677{
678 int ii = m_FootprintFilterListBox->GetSelection();
679
680 if( ii >= 0 )
681 {
682 m_FootprintFilterListBox->Delete( (unsigned) ii );
683
684 if( m_FootprintFilterListBox->GetCount() == 0 )
685 m_FootprintFilterListBox->SetSelection( wxNOT_FOUND );
686 else
687 m_FootprintFilterListBox->SetSelection( std::max( 0, ii - 1 ) );
688 }
689
690 OnModify();
691}

References DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_FootprintFilterListBox, and DIALOG_SHIM::OnModify().

◆ OnEditFootprintFilter()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnEditFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 694 of file dialog_lib_symbol_properties.cpp.

695{
696 int idx = m_FootprintFilterListBox->GetSelection();
697
698 if( idx >= 0 )
699 {
700 wxString filter = m_FootprintFilterListBox->GetStringSelection();
701
702 WX_TEXT_ENTRY_DIALOG dlg( this, _( "Filter:" ), _( "Edit Footprint Filter" ), filter );
703
704 if( dlg.ShowModal() == wxID_OK && !dlg.GetValue().IsEmpty() )
705 {
706 m_FootprintFilterListBox->SetString( (unsigned) idx, dlg.GetValue() );
707 OnModify();
708 }
709 }
710}

References _, filter, WX_TEXT_ENTRY_DIALOG::GetValue(), DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_FootprintFilterListBox, and DIALOG_SHIM::OnModify().

Referenced by OnFilterDClick().

◆ OnEditSpiceModel()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 606 of file dialog_lib_symbol_properties.cpp.

607{
608#ifdef KICAD_SPICE
609 int diff = m_fields->size();
610 auto symbol = SCH_SYMBOL( *m_libEntry, m_libEntry->GetLibId(), nullptr, 0 );
611
612 DIALOG_SIM_MODEL dialog( this, symbol, *m_fields );
613
614 if( dialog.ShowModal() != wxID_OK )
615 return;
616
617 diff = (int) m_fields->size() - diff;
618
619 if( diff > 0 )
620 {
621 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, diff );
622 m_grid->ProcessTableMessage( msg );
623 }
624 else if( diff < 0 )
625 {
626 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, 0, -diff );
627 m_grid->ProcessTableMessage( msg );
628 }
629
630 OnModify();
631 m_grid->ForceRefresh();
632#endif /* KICAD_SPICE */
633}
LIB_ID GetLibId() const override
Definition: lib_symbol.h:139
Schematic symbol object.
Definition: sch_symbol.h:79

References LIB_SYMBOL::GetLibId(), m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, m_libEntry, and DIALOG_SHIM::OnModify().

◆ OnFilterDClick()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnFilterDClick ( wxMouseEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 636 of file dialog_lib_symbol_properties.cpp.

637{
638 int idx = m_FootprintFilterListBox->HitTest( event.GetPosition() );
639 wxCommandEvent dummy;
640
641 if( idx >= 0 )
643 else
645}
void OnEditFootprintFilter(wxCommandEvent &event) override
void OnAddFootprintFilter(wxCommandEvent &event) override
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:73

References dummy(), DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_FootprintFilterListBox, OnAddFootprintFilter(), and OnEditFootprintFilter().

◆ OnGridCellChanging()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnGridCellChanging ( wxGridEvent &  event)
private

Definition at line 412 of file dialog_lib_symbol_properties.cpp.

413{
414 wxGridCellEditor* editor = m_grid->GetCellEditor( event.GetRow(), event.GetCol() );
415 wxControl* control = editor->GetControl();
416
417 if( control && control->GetValidator() && !control->GetValidator()->Validate( control ) )
418 {
419 event.Veto();
420
422 m_delayedFocusRow = event.GetRow();
423 m_delayedFocusColumn = event.GetCol();
425 }
426 else if( event.GetCol() == FDC_NAME )
427 {
428 wxString newName = event.GetString();
429
430 for( int i = 0; i < m_grid->GetNumberRows(); ++i )
431 {
432 if( i == event.GetRow() )
433 continue;
434
435 if( newName.CmpNoCase( m_grid->GetCellValue( i, FDC_NAME ) ) == 0 )
436 {
437 DisplayError( this, wxString::Format( _( "The name '%s' is already in use." ),
438 newName ) );
439 event.Veto();
440 m_delayedFocusRow = event.GetRow();
441 m_delayedFocusColumn = event.GetCol();
442 }
443 }
444 }
445 else if( event.GetRow() == VALUE_FIELD && event.GetCol() == FDC_VALUE )
446 {
447 m_SymbolNameCtrl->ChangeValue( event.GetString() );
448 }
449
450 editor->DecRef();
451}

References _, DisplayError(), editor, FDC_NAME, FDC_VALUE, Format(), m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SymbolNameCtrl, and VALUE_FIELD.

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

◆ OnGridEditorHidden()

void DIALOG_SHIM::OnGridEditorHidden ( wxGridEvent &  event)
privateinherited

Definition at line 642 of file dialog_shim.cpp.

643{
644 SetEscapeId( wxID_ANY );
645 event.Skip();
646}

◆ OnGridEditorShown()

void DIALOG_SHIM::OnGridEditorShown ( wxGridEvent &  event)
privateinherited

Definition at line 635 of file dialog_shim.cpp.

636{
637 SetEscapeId( wxID_NONE );
638 event.Skip();
639}

◆ OnModify()

◆ OnMoveDown()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveDown ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 580 of file dialog_lib_symbol_properties.cpp.

581{
583 return;
584
585 int i = m_grid->GetGridCursorRow();
586
587 if( i >= MANDATORY_FIELDS && i + 1 < m_fields->GetNumberRows() )
588 {
589 LIB_FIELD tmp = m_fields->at( (unsigned) i );
590 m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
591 m_fields->insert( m_fields->begin() + i + 1, tmp );
592 m_grid->ForceRefresh();
593
594 m_grid->SetGridCursor( i + 1, m_grid->GetGridCursorCol() );
595 m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
596
597 OnModify();
598 }
599 else
600 {
601 wxBell();
602 }
603}
int GetNumberRows() override

References WX_GRID::CommitPendingChanges(), FIELDS_GRID_TABLE< T >::GetNumberRows(), m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, MANDATORY_FIELDS, and DIALOG_SHIM::OnModify().

◆ OnMoveUp()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveUp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 554 of file dialog_lib_symbol_properties.cpp.

555{
557 return;
558
559 int i = m_grid->GetGridCursorRow();
560
561 if( i > MANDATORY_FIELDS )
562 {
563 LIB_FIELD tmp = m_fields->at( (unsigned) i );
564 m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
565 m_fields->insert( m_fields->begin() + i - 1, tmp );
566 m_grid->ForceRefresh();
567
568 m_grid->SetGridCursor( i - 1, m_grid->GetGridCursorCol() );
569 m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
570
571 OnModify();
572 }
573 else
574 {
575 wxBell();
576 }
577}

References WX_GRID::CommitPendingChanges(), m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, MANDATORY_FIELDS, and DIALOG_SHIM::OnModify().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 387 of file dialog_shim.cpp.

388{
390 {
392
393 selectAllInTextCtrls( GetChildren() );
394
397 else
398 KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
399
400 m_firstPaintEvent = false;
401 }
402
403 event.Skip();
404}
bool m_firstPaintEvent
Definition: dialog_shim.h:212
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:213
static void selectAllInTextCtrls(wxWindowList &children)
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onPowerCheckBox()

void DIALOG_LIB_SYMBOL_PROPERTIES::onPowerCheckBox ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

◆ OnSizeGrid()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 805 of file dialog_lib_symbol_properties.cpp.

806{
807 auto new_size = event.GetSize();
808
809 if( new_size != m_size )
810 {
811 m_size = new_size;
812
814 }
815
816 // Always propagate a wxSizeEvent:
817 event.Skip();
818}

References adjustGridColumns(), and m_size.

◆ OnSpinCtrl()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnSpinCtrl ( wxSpinEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 867 of file dialog_lib_symbol_properties.cpp.

868{
869 OnModify();
870}

References DIALOG_SHIM::OnModify().

◆ OnSpinCtrlText()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnSpinCtrlText ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 873 of file dialog_lib_symbol_properties.cpp.

874{
875 OnModify();
876}

References DIALOG_SHIM::OnModify().

◆ OnSymbolNameKillFocus()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnSymbolNameKillFocus ( wxFocusEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 461 of file dialog_lib_symbol_properties.cpp.

462{
463 if( !m_delayedFocusCtrl )
464 {
465 // If the validation fails and we throw up a dialog then GTK will give us another
466 // KillFocus event and we end up in infinite recursion. So we use m_delayedFocusCtrl
467 // as a re-entrancy block and then clear it again if validation passes.
470
471 if( m_SymbolNameCtrl->GetValidator()->Validate( m_SymbolNameCtrl ) )
472 {
473 m_delayedFocusCtrl = nullptr;
475 }
476 }
477
478 event.Skip();
479}

References m_delayedFocusCtrl, m_delayedFocusPage, and DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SymbolNameCtrl.

◆ OnSymbolNameText()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnSymbolNameText ( wxCommandEvent &  event)
overrideprivatevirtual

◆ OnText()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnText ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 849 of file dialog_lib_symbol_properties.cpp.

850{
851 OnModify();
852}

References DIALOG_SHIM::OnModify().

◆ OnUpdateUI()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 729 of file dialog_lib_symbol_properties.cpp.

730{
731 m_OptionPartsInterchangeable->Enable( m_SelNumberOfUnits->GetValue() > 1 );
733
734 if( m_grid->IsCellEditControlShown() )
735 {
736 int row = m_grid->GetGridCursorRow();
737 int col = m_grid->GetGridCursorCol();
738
739 if( row == VALUE_FIELD && col == FDC_VALUE )
740 {
741 wxGridCellEditor* editor = m_grid->GetCellEditor( row, col );
742 m_SymbolNameCtrl->ChangeValue( editor->GetValue() );
743 editor->DecRef();
744 }
745 }
746
747 // Handle shown columns changes
748 wxString shownColumns = m_grid->GetShownColumns();
749
750 if( shownColumns != m_shownColumns )
751 {
752 m_shownColumns = shownColumns;
753
754 if( !m_grid->IsCellEditControlShown() )
756 }
757
758 // Handle a delayed focus. The delay allows us to:
759 // a) change focus when the error was triggered from within a killFocus handler
760 // b) show the correct notebook page in the background before the error dialog comes up
761 // when triggered from an OK or a notebook page change
762
763 if( m_delayedFocusPage >= 0 && m_NoteBook->GetSelection() != m_delayedFocusPage )
764 {
765 m_NoteBook->ChangeSelection( (unsigned) m_delayedFocusPage );
767 }
768
769 if( !m_delayedErrorMessage.IsEmpty() )
770 {
771 // We will re-enter this routine when the error dialog is displayed, so make
772 // sure we don't keep putting up more dialogs.
773 wxString msg = m_delayedErrorMessage;
774 m_delayedErrorMessage = wxEmptyString;
775
776 // Do not use DisplayErrorMessage(); it screws up window order on Mac
777 DisplayError( nullptr, msg );
778 }
779
781 {
782 m_delayedFocusCtrl->SetFocus();
783
784 if( auto textEntry = dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl ) )
785 textEntry->SelectAll();
786
787 m_delayedFocusCtrl = nullptr;
788 }
789 else if( m_delayedFocusGrid )
790 {
791 m_delayedFocusGrid->SetFocus();
794
795 m_delayedFocusGrid->EnableCellEditControl( true );
796 m_delayedFocusGrid->ShowCellEditControl();
797
798 m_delayedFocusGrid = nullptr;
801 }
802}
void Enable(bool aEnable)
Enable/disable the label, widget and units label.

References adjustGridColumns(), DisplayError(), editor, UNIT_BINDER::Enable(), FDC_VALUE, WX_GRID::GetShownColumns(), m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_NoteBook, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_OptionPartsInterchangeable, m_pinNameOffset, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_PinsNameInsideButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SelNumberOfUnits, m_shownColumns, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SymbolNameCtrl, and VALUE_FIELD.

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

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), 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_LIB_SYMBOL_PROPERTIES(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), 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(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), 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(), 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(), PCB_EDIT_FRAME::GetLastPath(), 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(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), PCB_EDIT_FRAME::LoadFootprints(), SCH_EDIT_FRAME::LoadProject(), KICAD_MANAGER_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(), PCB_EDIT_FRAME::onBoardLoaded(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_NETLIST_IMPORT::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), 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(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChanged(), DIALOG_BOARD_SETUP::OnPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_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(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), 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(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), PCB_EDIT_FRAME::RunEeschema(), 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(), EDA_BASE_FRAME::SaveSettings(), SIM_PLOT_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), PCB_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::SetLastPath(), GERBVIEW_FRAME::SetPageSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SYMBOL_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_LIBRARY_MANAGER::symTable(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PCB_EDIT_FRAME::TestStandalone(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SCH_EDIT_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), 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 294 of file dialog_shim.cpp.

295{
296 const char* hash_key;
297
298 if( m_hash_key.size() )
299 {
300 // a special case like EDA_LIST_DIALOG, which has multiple uses.
301 hash_key = m_hash_key.c_str();
302 }
303 else
304 {
305 hash_key = typeid(*this).name();
306 }
307
308 std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
309
310 if( it == class_map.end() )
311 return;
312
313 wxRect rect = it->second;
314 rect.SetSize( wxSize( 0, 0 ) );
315 class_map[ hash_key ] = rect;
316}
std::string m_hash_key
Definition: dialog_shim.h:203
static std::unordered_map< std::string, wxRect > class_map

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by 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 }

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), 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_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), 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_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_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(), DIALOG_COPPER_ZONE::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::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}
const char * name
Definition: DXF_plotter.cpp:56

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

198{
199 wxDialog::SetPosition( aNewPosition );
200
201 // Now update the stored position:
202 const char* hash_key;
203
204 if( m_hash_key.size() )
205 {
206 // a special case like EDA_LIST_DIALOG, which has multiple uses.
207 hash_key = m_hash_key.c_str();
208 }
209 else
210 {
211 hash_key = typeid(*this).name();
212 }
213
214 std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
215
216 if( it == class_map.end() )
217 return;
218
219 wxRect rect = it->second;
220 rect.SetPosition( aNewPosition );
221
222 class_map[ hash_key ] = rect;
223}
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 169 of file dialog_shim.cpp.

170{
171 wxSize sz( x, y );
172 SetSize( ConvertDialogToPixels( sz ) );
173}

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

◆ SetupStandardButtons()

void DIALOG_SHIM::SetupStandardButtons ( std::map< int, wxString >  aLabels = {})
inherited

Definition at line 709 of file dialog_shim.cpp.

710{
711 recursiveDescent( GetSizer(), aLabels );
712}
static void recursiveDescent(wxSizer *aSizer, std::map< int, wxString > &aLabels)

References recursiveDescent().

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CLEANUP_GRAPHICS::DIALOG_CLEANUP_GRAPHICS(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_CREATE_ARRAY::DIALOG_CREATE_ARRAY(), DIALOG_DIELECTRIC_MATERIAL::DIALOG_DIELECTRIC_MATERIAL(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FILTER_SELECTION::DIALOG_FILTER_SELECTION(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GLOBAL_DELETION::DIALOG_GLOBAL_DELETION(), 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_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_SETTINGS::DIALOG_IMPORT_SETTINGS(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MIGRATE_SETTINGS::DIALOG_MIGRATE_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), 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_PRIMITIVES_TRANSFORM::DIALOG_PAD_PRIMITIVES_TRANSFORM(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_PNS_DIFF_PAIR_DIMENSIONS::DIALOG_PNS_DIFF_PAIR_DIMENSIONS(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::DIALOG_PNS_LENGTH_TUNING_SETTINGS(), 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_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_SETTINGS::DIALOG_SIM_SETTINGS(), 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_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_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_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), NETLIST_DIALOG_ADD_GENERATOR::NETLIST_DIALOG_ADD_GENERATOR(), PAGED_DIALOG::PAGED_DIALOG(), DIALOG_CLEANUP_TRACKS_AND_VIAS::setupOKButtonLabel(), WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_ENTRY_DIALOG().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 226 of file dialog_shim.cpp.

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

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

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), EE_INSPECTION_TOOL::CrossProbe(), 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(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::readNetListAndFpFiles(), DIALOG_PAD_PROPERTIES::Show(), EDA_VIEW_SWITCHER::Show(), DIALOG_FIND::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 437 of file dialog_shim.cpp.

438{
439 // This is an exception safe way to zero a pointer before returning.
440 // Yes, even though DismissModal() clears this first normally, this is
441 // here in case there's an exception before the dialog is dismissed.
442 struct NULLER
443 {
444 void*& m_what;
445 NULLER( void*& aPtr ) : m_what( aPtr ) {}
446 ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
447 } clear_this( (void*&) m_qmodal_loop );
448
449 // release the mouse if it's currently captured as the window having it
450 // will be disabled when this dialog is shown -- but will still keep the
451 // capture making it impossible to do anything in the modal dialog itself
452 wxWindow* win = wxWindow::GetCapture();
453 if( win )
454 win->ReleaseMouse();
455
456 // Get the optimal parent
457 wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
458
459 wxASSERT_MSG( !m_qmodal_parent_disabler, wxT( "Caller using ShowQuasiModal() twice on same "
460 "window?" ) );
461
462 // quasi-modal: disable only my "optimal" parent
464
465 // Apple in its infinite wisdom will raise a disabled window before even passing
466 // us the event, so we have no way to stop it. Instead, we must set an order on
467 // the windows so that the quasi-modal will be pushed in front of the disabled
468 // window when it is raised.
470
471 Show( true );
472
473 m_qmodal_showing = true;
474
475 WX_EVENT_LOOP event_loop;
476
477 m_qmodal_loop = &event_loop;
478
479 event_loop.Run();
480
481 m_qmodal_showing = false;
482
483 return GetReturnCode();
484}
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:46
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
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(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), PCB::IFACE::CreateWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), 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(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and PCB_EDIT_FRAME::ToPlotter().

◆ syncControlStates()

◆ TransferDataFromWindow()

bool DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow ( )
overrideprotected

Definition at line 300 of file dialog_lib_symbol_properties.cpp.

301{
302 if( !wxDialog::TransferDataFromWindow() )
303 return false;
304
306 return false;
307
308 // We need to keep the name and the value the same at the moment!
309 wxString newName = EscapeString( m_fields->at( VALUE_FIELD ).GetText(), CTX_LIBID );
310 wxString oldName = m_libEntry->GetName();
311
312 if( oldName != newName )
313 {
314 wxString libName = m_Parent->GetCurLib();
315
316 if( m_Parent->GetLibManager().SymbolExists( newName, libName ) )
317 {
318 wxString msg;
319
320 msg.Printf( _( "Symbol name '%s' already in use in library '%s'." ),
321 UnescapeString( newName ),
322 libName );
323 DisplayErrorMessage( this, msg );
324 return false;
325 }
326
328 }
329 else
330 {
332 }
333
334 // The Y axis for components in lib is from bottom to top while the screen axis is top
335 // to bottom: we must change the y coord sign when writing back to the library
336 for( size_t i = 0; i < m_fields->size(); ++i )
337 {
338 VECTOR2I pos = m_fields->at( i ).GetPosition();
339 pos.y = -pos.y;
340 m_fields->at( i ).SetPosition( pos );
341 m_fields->at( i ).SetId( i );
342 }
343
345
346 // Update the parent for inherited symbols
347 if( m_libEntry->IsAlias() )
348 {
349 wxString parentName = EscapeString( m_inheritanceSelectCombo->GetValue(), CTX_LIBID );
350
351 // The parentName was verified to be non-empty in the Validator
352 wxString libName = m_Parent->GetCurLib();
353
354 // Get the parent from the libManager based on the name set in the inheritance combo box.
355 LIB_SYMBOL* newParent = m_Parent->GetLibManager().GetAlias( parentName, libName );
356
357 // Verify that the requested parent exists
358 wxCHECK( newParent, false );
359
360 // Verify that the new parent is not an alias.
361 wxCHECK( !newParent->IsAlias(), false );
362
363 m_libEntry->SetParent( newParent );
364 }
365
366 // We need to keep the name and the value the same at the moment!
367 m_libEntry->SetName( newName );
368 m_libEntry->SetDescription( m_DescCtrl->GetValue() );
369 m_libEntry->SetKeyWords( m_KeywordCtrl->GetValue() );
372 !m_OptionPartsInterchangeable->GetValue() );
375
376 if( m_OptionPower->GetValue() )
378 else
380
383
386
387 if( m_PinsNameInsideButt->GetValue() )
388 {
389 int offset = KiROUND( (double) m_pinNameOffset.GetValue() );
390
391 // We interpret an offset of 0 as "outside", so make sure it's non-zero
392 m_libEntry->SetPinNameOffset( offset == 0 ? 20 : offset );
393 }
394 else
395 {
396 m_libEntry->SetPinNameOffset( 0 ); // pin text outside the body (name is on the pin)
397 }
398
400
402
403 // It's possible that the symbol being edited has no pins, in which case there may be no
404 // alternate body style objects causing #LIB_SYMBOL::HasCoversion() to always return false.
405 // This allows the user to edit the alternate body style just in case this condition occurs.
407
408 return true;
409}
Define a library symbol object.
Definition: lib_symbol.h:99
void SetIncludeOnBoard(bool aIncludeOnBoard)
Set or clear include in board netlist flag.
Definition: lib_symbol.h:621
void SetShowPinNames(bool aShow)
Set or clear the pin name visibility flag.
Definition: lib_symbol.h:597
void SetConversion(bool aSetConvert, bool aDuplicatePins=true)
Set or clear the alternate body style (DeMorgan) for the symbol.
void SetUnitCount(int aCount, bool aDuplicateDrawItems=true)
Set the units per symbol count.
void SetPinNameOffset(int aOffset)
Set the offset in mils of the pin name text from the pin symbol.
Definition: lib_symbol.h:589
void SetPower()
Definition: lib_symbol.cpp:482
void LockUnits(bool aLockUnits)
Set interchangeable the property for symbol units.
Definition: lib_symbol.h:245
void SetShowPinNumbers(bool aShow)
Set or clear the pin number visibility flag.
Definition: lib_symbol.h:605
void SetParent(LIB_SYMBOL *aParent=nullptr)
Definition: lib_symbol.cpp:372
wxString GetName() const override
Definition: lib_symbol.h:137
void SetDescription(const wxString &aDescription)
Definition: lib_symbol.h:144
void SetKeyWords(const wxString &aKeyWords)
Definition: lib_symbol.h:157
void SetFPFilters(const wxArrayString &aFilters)
Definition: lib_symbol.h:190
int GetUnitCount() const override
For items with units, return the number of units.
void SetIncludeInBom(bool aIncludeInBom)
Set or clear the include in schematic bill of materials flag.
Definition: lib_symbol.h:613
void SetFields(const std::vector< LIB_FIELD > &aFieldsList)
Overwrite all the existing fields in this symbol with fields supplied in aFieldsList.
Definition: lib_symbol.cpp:969
virtual void SetName(const wxString &aName)
Definition: lib_symbol.cpp:363
void SetNormal()
Definition: lib_symbol.cpp:500
void UpdateAfterSymbolProperties(wxString *aOldName=nullptr)
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
SYMBOL_LIBRARY_MANAGER & GetLibManager()
void SetShowDeMorgan(bool show)
void SaveCopyInUndoList(EDA_ITEM *aItem, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT, bool aAppend=false)
Create a copy of the current symbol, and save it in the undo list.
LIB_SYMBOL * GetAlias(const wxString &aAlias, const wxString &aLibrary) const
Return either an alias of a working LIB_SYMBOL copy, or alias of the original symbol if there is no w...
bool SymbolExists(const wxString &aAlias, const wxString &aLibrary) const
Return true if symbol with a specific alias exists in library (either original one or buffered).
virtual long long int GetValue()
Return the current value in Internal Units.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:299
wxString UnescapeString(const wxString &aSource)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
@ CTX_LIBID
Definition: string_utils.h:55
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:80

References _, WX_GRID::CommitPendingChanges(), CTX_LIBID, DisplayErrorMessage(), EscapeString(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_EDIT_FRAME::GetCurLib(), SYMBOL_EDIT_FRAME::GetLibManager(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetUnitCount(), UNIT_BINDER::GetValue(), LIB_SYMBOL::IsAlias(), KiROUND(), LIB_RENAME, LIB_SYMBOL::LockUnits(), DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_AsConvertButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_DescCtrl, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_excludeFromBoardCheckBox, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_excludeFromBomCheckBox, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_FootprintFilterListBox, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_inheritanceSelectCombo, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_KeywordCtrl, m_libEntry, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_OptionPartsInterchangeable, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_OptionPower, m_Parent, m_pinNameOffset, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_PinsNameInsideButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SelNumberOfUnits, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_ShowPinNameButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_ShowPinNumButt, SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetDescription(), LIB_SYMBOL::SetFields(), LIB_SYMBOL::SetFPFilters(), LIB_SYMBOL::SetIncludeInBom(), LIB_SYMBOL::SetIncludeOnBoard(), LIB_SYMBOL::SetKeyWords(), LIB_SYMBOL::SetName(), LIB_SYMBOL::SetNormal(), LIB_SYMBOL::SetParent(), LIB_SYMBOL::SetPinNameOffset(), LIB_SYMBOL::SetPower(), SYMBOL_EDIT_FRAME::SetShowDeMorgan(), LIB_SYMBOL::SetShowPinNames(), LIB_SYMBOL::SetShowPinNumbers(), LIB_SYMBOL::SetUnitCount(), SYMBOL_LIBRARY_MANAGER::SymbolExists(), UnescapeString(), SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties(), VALUE_FIELD, and VECTOR2< T >::y.

◆ TransferDataToWindow()

bool DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow ( )
overrideprotected

Definition at line 146 of file dialog_lib_symbol_properties.cpp.

147{
148 if( !wxDialog::TransferDataToWindow() )
149 return false;
150
151 // Push a copy of each field into m_updateFields
153
154 // The Y axis for components in lib is from bottom to top while the screen axis is top
155 // to bottom: we must change the y coord sign for editing
156 for( size_t i = 0; i < m_fields->size(); ++i )
157 {
158 VECTOR2I pos = m_fields->at( i ).GetPosition();
159 pos.y = -pos.y;
160 m_fields->at( i ).SetPosition( pos );
161 }
162
163 // notify the grid
164 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_fields->GetNumberRows() );
165 m_grid->ProcessTableMessage( msg );
167
169
170 m_DescCtrl->ChangeValue( m_libEntry->GetDescription() );
171 m_KeywordCtrl->ChangeValue( m_libEntry->GetKeyWords() );
174 m_libEntry->GetUnitCount() == 1 );
175
176 // If a symbol contains no conversion-specific pins or graphic items, symbol->HasConversion()
177 // will return false. But when editing a symbol with DeMorgan option set, we don't want to
178 // keep turning it off just because there aren't any conversion-specific items yet, so we force
179 // it to on if the parent frame has it enabled.
181
182 m_OptionPower->SetValue( m_libEntry->IsPower() );
185
190
191 wxArrayString tmp = m_libEntry->GetFPFilters();
192 m_FootprintFilterListBox->Append( tmp );
193
194 // Populate the list of root parts for inherited objects.
195 if( m_libEntry->IsAlias() )
196 {
197 wxArrayString rootSymbolNames;
198 wxString libName = m_Parent->GetCurLib();
199
200 // Someone forgot to set the current library in the editor frame window.
201 wxCHECK( !libName.empty(), false );
202
203 m_Parent->GetLibManager().GetRootSymbolNames( libName, rootSymbolNames );
204 m_inheritanceSelectCombo->Append( rootSymbolNames );
205
206 LIB_SYMBOL_SPTR rootSymbol = m_libEntry->GetParent().lock();
207
208 wxCHECK( rootSymbol, false );
209
210 wxString parentName = UnescapeString( rootSymbol->GetName() );
211 int selection = m_inheritanceSelectCombo->FindString( parentName );
212
213 wxCHECK( selection != wxNOT_FOUND, false );
214 m_inheritanceSelectCombo->SetSelection( selection );
215
217 }
218
219 m_NoteBook->SetSelection( (unsigned) m_lastOpenedPage );
220
221 return true;
222}
int GetPinNameOffset() const
Definition: lib_symbol.h:590
wxString GetKeyWords() const
Definition: lib_symbol.h:159
bool UnitsLocked() const
Check whether symbol units are interchangeable.
Definition: lib_symbol.h:251
bool IsPower() const
Definition: lib_symbol.cpp:473
bool GetIncludeOnBoard() const
Definition: lib_symbol.h:622
bool ShowPinNames() const
Definition: lib_symbol.h:598
void GetFields(std::vector< LIB_FIELD * > &aList)
Return a list of fields within this symbol.
Definition: lib_symbol.cpp:986
wxArrayString GetFPFilters() const
Definition: lib_symbol.h:192
bool GetIncludeInBom() const
Definition: lib_symbol.h:614
wxString GetDescription() override
Definition: lib_symbol.h:146
LIB_SYMBOL_REF & GetParent()
Definition: lib_symbol.h:126
bool ShowPinNumbers() const
Definition: lib_symbol.h:606
bool GetShowDeMorgan() const
void GetRootSymbolNames(const wxString &aLibName, wxArrayString &aRootSymbolNames)
virtual void ChangeValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion WITHOUT trigger...
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition: lib_symbol.h:45

References adjustGridColumns(), UNIT_BINDER::ChangeValue(), SYMBOL_EDIT_FRAME::GetCurLib(), LIB_SYMBOL::GetDescription(), LIB_SYMBOL::GetFields(), LIB_SYMBOL::GetFPFilters(), LIB_SYMBOL::GetIncludeInBom(), LIB_SYMBOL::GetIncludeOnBoard(), LIB_SYMBOL::GetKeyWords(), SYMBOL_EDIT_FRAME::GetLibManager(), LIB_SYMBOL::GetName(), FIELDS_GRID_TABLE< T >::GetNumberRows(), LIB_SYMBOL::GetParent(), LIB_SYMBOL::GetPinNameOffset(), SYMBOL_LIBRARY_MANAGER::GetRootSymbolNames(), SYMBOL_EDIT_FRAME::GetShowDeMorgan(), LIB_SYMBOL::GetUnitCount(), LIB_SYMBOL::IsAlias(), LIB_SYMBOL::IsPower(), DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_AsConvertButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_DescCtrl, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_excludeFromBoardCheckBox, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_excludeFromBomCheckBox, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_FootprintFilterListBox, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_inheritanceSelectCombo, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_KeywordCtrl, m_lastOpenedPage, m_libEntry, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_NoteBook, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_OptionPartsInterchangeable, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_OptionPower, m_Parent, m_pinNameOffset, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_PinsNameInsideButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SelNumberOfUnits, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_ShowPinNameButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_ShowPinNumButt, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SymbolNameCtrl, LIB_SYMBOL::ShowPinNames(), LIB_SYMBOL::ShowPinNumbers(), UnescapeString(), LIB_SYMBOL::UnitsLocked(), and VECTOR2< T >::y.

◆ Validate()

bool DIALOG_LIB_SYMBOL_PROPERTIES::Validate ( )
overrideprotected

Definition at line 225 of file dialog_lib_symbol_properties.cpp.

226{
228 return false;
229
230 // Alias symbol reference can be empty because it inherits from the parent symbol.
231 if( m_libEntry->IsRoot() &&
233 {
234 if( m_NoteBook->GetSelection() != 0 )
235 m_NoteBook->SetSelection( 0 );
236
237 m_delayedErrorMessage = _( "References must start with a letter." );
242
243 return false;
244 }
245
246 // Check for missing field names.
247 for( size_t i = MANDATORY_FIELDS; i < m_fields->size(); ++i )
248 {
249 LIB_FIELD& field = m_fields->at( i );
250 wxString fieldName = field.GetName( false );
251
252 if( fieldName.IsEmpty() )
253 {
254 if( m_NoteBook->GetSelection() != 0 )
255 m_NoteBook->SetSelection( 0 );
256
257 m_delayedErrorMessage = _( "Fields must have a name." );
262
263 return false;
264 }
265 }
266
267 // Verify that the parent name is set if the symbol is inherited
268 if( m_libEntry->IsAlias() )
269 {
270 wxString parentName = m_inheritanceSelectCombo->GetValue();
271
272 if( parentName.IsEmpty() )
273 {
274 m_delayedErrorMessage = _( "Aliased symbol must have a parent selected" );
275
276 return false;
277 }
278 }
279
280 /*
281 * Confirm destructive actions.
282 */
283
284 if( m_SelNumberOfUnits->GetValue() < m_libEntry->GetUnitCount() )
285 {
286 if( !IsOK( this, _( "Delete extra units from symbol?" ) ) )
287 return false;
288 }
289
290 if( !m_AsConvertButt->GetValue() && m_libEntry->HasConversion() )
291 {
292 if( !IsOK( this, _( "Delete alternate body style (De Morgan) from symbol?" ) ) )
293 return false;
294 }
295
296 return true;
297}
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
Definition: lib_field.cpp:415
bool HasConversion() const
Test if symbol has more than one body conversion type (DeMorgan).
static bool IsReferenceStringValid(const wxString &aReferenceString)
Test for an acceptable reference string.
Definition: sch_symbol.cpp:523
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:342
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".

References _, WX_GRID::CommitPendingChanges(), FDC_NAME, FDC_VALUE, LIB_FIELD::GetName(), LIB_SYMBOL::GetUnitCount(), LIB_SYMBOL::HasConversion(), LIB_SYMBOL::IsAlias(), IsOK(), SCH_SYMBOL::IsReferenceStringValid(), LIB_SYMBOL::IsRoot(), DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_AsConvertButt, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_inheritanceSelectCombo, m_libEntry, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_NoteBook, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SelNumberOfUnits, MANDATORY_FIELDS, and REFERENCE_FIELD.

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

184{
185 wxSize sz( 0, y );
186 return ConvertDialogToPixels( sz ).y;
187}

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ bButtonSize

wxBoxSizer* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::bButtonSize
protectedinherited

◆ bSizerLowerBasicPanel

wxBoxSizer* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::bSizerLowerBasicPanel
protectedinherited

◆ m_addFilterButton

wxBitmapButton* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_addFilterButton
protectedinherited

◆ m_AsConvertButt

◆ m_bpAdd

◆ m_bpDelete

◆ m_bpMoveDown

◆ m_bpMoveUp

◆ m_delayedErrorMessage

wxString DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedErrorMessage

Definition at line 90 of file dialog_lib_symbol_properties.h.

Referenced by OnUpdateUI(), and Validate().

◆ m_delayedFocusColumn

int DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedFocusColumn

Definition at line 88 of file dialog_lib_symbol_properties.h.

Referenced by OnGridCellChanging(), OnUpdateUI(), and Validate().

◆ m_delayedFocusCtrl

wxControl* DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedFocusCtrl

Definition at line 85 of file dialog_lib_symbol_properties.h.

Referenced by OnSymbolNameKillFocus(), and OnUpdateUI().

◆ m_delayedFocusGrid

WX_GRID* DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedFocusGrid

Definition at line 86 of file dialog_lib_symbol_properties.h.

Referenced by OnGridCellChanging(), OnUpdateUI(), and Validate().

◆ m_delayedFocusPage

int DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedFocusPage

◆ m_delayedFocusRow

int DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedFocusRow

Definition at line 87 of file dialog_lib_symbol_properties.h.

Referenced by OnGridCellChanging(), OnUpdateUI(), and Validate().

◆ m_deleteFilterButton

wxBitmapButton* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_deleteFilterButton
protectedinherited

◆ m_DescCtrl

◆ m_editFilterButton

wxBitmapButton* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_editFilterButton
protectedinherited

◆ m_excludeFromBoardCheckBox

◆ m_excludeFromBomCheckBox

◆ m_fields

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 212 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_FootprintFilterListBox

◆ m_grid

◆ m_hash_key

◆ m_inheritanceSelectCombo

◆ m_inheritsStaticText

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_inheritsStaticText
protectedinherited

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

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

Referenced by DIALOG_SHIM::Show().

◆ m_KeywordCtrl

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

◆ m_lastLayout

DIALOG_LIB_SYMBOL_PROPERTIES::LAST_LAYOUT DIALOG_LIB_SYMBOL_PROPERTIES::m_lastLayout = DIALOG_LIB_SYMBOL_PROPERTIES::NONE
staticprivate

Definition at line 104 of file dialog_lib_symbol_properties.h.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES().

◆ m_lastOpenedPage

int DIALOG_LIB_SYMBOL_PROPERTIES::m_lastOpenedPage = 0
staticprivate

◆ m_libEntry

◆ m_nameOffsetCtrl

wxTextCtrl* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_nameOffsetCtrl
protectedinherited

◆ m_nameOffsetLabel

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_nameOffsetLabel
protectedinherited

◆ m_nameOffsetUnits

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_nameOffsetUnits
protectedinherited

◆ m_NoteBook

wxNotebook* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_NoteBook
protectedinherited

◆ m_OptionPartsInterchangeable

◆ m_OptionPower

◆ m_PanelBasic

wxPanel* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_PanelBasic
protectedinherited

◆ m_PanelFootprintFilter

wxPanel* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_PanelFootprintFilter
protectedinherited

◆ m_Parent

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

◆ m_pinNameOffset

UNIT_BINDER DIALOG_LIB_SYMBOL_PROPERTIES::m_pinNameOffset

◆ m_PinsNameInsideButt

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_SelNumberOfUnits

◆ m_shownColumns

wxString DIALOG_LIB_SYMBOL_PROPERTIES::m_shownColumns

Definition at line 92 of file dialog_lib_symbol_properties.h.

Referenced by OnUpdateUI().

◆ m_ShowPinNameButt

◆ m_ShowPinNumButt

◆ m_size

wxSize DIALOG_LIB_SYMBOL_PROPERTIES::m_size

Definition at line 93 of file dialog_lib_symbol_properties.h.

Referenced by OnSizeGrid().

◆ m_spiceFieldsButton

wxButton* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_spiceFieldsButton
protectedinherited

◆ m_staticTextFootprints

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_staticTextFootprints
protectedinherited

◆ m_staticTextNbUnits

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_staticTextNbUnits
protectedinherited

◆ m_stdSizerButton

wxStdDialogButtonSizer* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_stdSizerButton
protectedinherited

◆ m_stdSizerButtonCancel

wxButton* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_stdSizerButtonCancel
protectedinherited

◆ m_stdSizerButtonOK

wxButton* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_stdSizerButtonOK
protectedinherited

◆ m_SymbolNameCtrl

◆ m_tabOrder

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type
privateinherited

Definition at line 85 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::GetType(), and SIM_PLOT_FRAME::onSimFinished().

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ staticKeywordsLabel

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::staticKeywordsLabel
protectedinherited

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