KiCad PCB EDA Suite
DIALOG_EDIT_COMPONENT_IN_LIBRARY Class Reference

#include <dialog_edit_component_in_lib.h>

Inheritance diagram for DIALOG_EDIT_COMPONENT_IN_LIBRARY:
DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
bool Validate () override
 
 DIALOG_EDIT_COMPONENT_IN_LIBRARY (LIB_EDIT_FRAME *parent, LIB_PART *aLibEntry)
 Constructors. More...
 
 ~DIALOG_EDIT_COMPONENT_IN_LIBRARY ()
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS_T GetUserUnits () const override
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Public Attributes

wxConfigBase * m_config
 
LIB_EDIT_FRAMEm_Parent
 
LIB_PARTm_libEntry
 
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
 
int m_currentAlias
 
LIB_ALIASES m_aliasesBuffer
 
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
 
int m_width
 

Protected Member Functions

void FinishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void SetSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int HorizPixelsFromDU (int x)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 

Protected Attributes

wxNotebook * m_NoteBook
 
wxPanel * m_PanelBasic
 
WX_GRIDm_grid
 
wxBitmapButton * m_bpAdd
 
wxBitmapButton * m_bpMoveUp
 
wxBitmapButton * m_bpMoveDown
 
wxBitmapButton * m_bpDelete
 
wxTextCtrl * m_SymbolNameCtrl
 
wxTextCtrl * m_DescCtrl
 
wxStaticText * staticKeywordsLabel
 
wxTextCtrl * m_KeywordCtrl
 
wxCheckBox * m_AsConvertButt
 
wxCheckBox * m_OptionPower
 
wxStaticText * m_staticTextNbUnits
 
wxSpinCtrl * m_SelNumberOfUnits
 
wxCheckBox * m_OptionPartsLocked
 
wxCheckBox * m_ShowPinNumButt
 
wxCheckBox * m_ShowPinNameButt
 
wxCheckBox * m_PinsNameInsideButt
 
wxStaticText * m_nameOffsetLabel
 
wxTextCtrl * m_nameOffsetCtrl
 
wxStaticText * m_nameOffsetUnits
 
wxPanel * m_PanelAlias
 
wxListBox * m_aliasListBox
 
wxBitmapButton * m_addAliasButton
 
wxBitmapButton * m_deleteAliasButton
 
wxStaticText * m_staticText12
 
WX_GRIDm_aliasGrid
 
wxTextCtrl * m_AliasNameCtrl
 
wxTextCtrl * m_AliasDescCtrl
 
wxStaticText * staticAliasKeywordsLabel
 
wxTextCtrl * m_AliasKeywordsCtrl
 
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_T m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

void transferAliasDataToBuffer ()
 
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 OnSelectAlias (wxCommandEvent &event) override
 
void OnAddAlias (wxCommandEvent &event) override
 
void OnDeleteAlias (wxCommandEvent &event) override
 
void OnAddFootprintFilter (wxCommandEvent &event) override
 
void OnDeleteFootprintFilter (wxCommandEvent &event) override
 
void OnEditFootprintFilter (wxCommandEvent &event) override
 
void OnSizeGrid (wxSizeEvent &event) override
 
void OnSizeAliasGrid (wxSizeEvent &event) override
 
void OnGridCellChanging (wxGridEvent &event)
 
void OnAliasGridCellChanging (wxGridEvent &event)
 
void OnAliasNameKillFocus (wxFocusEvent &event) override
 
void OnAliasNameText (wxCommandEvent &event) override
 
void OnEditSpiceModel (wxCommandEvent &event) override
 
void OnUpdateUI (wxUpdateUIEvent &event) override
 
void OnFilterDClick (wxMouseEvent &event) override
 
void OnCancelButtonClick (wxCommandEvent &event) override
 
void updateAliasName (bool aFromGrid, const wxString &aName)
 
bool checkAliasName (const wxString &aName)
 
void adjustGridColumns (int aWidth)
 
void adjustAliasGridColumns (int aWidth)
 

Static Private Attributes

static int m_lastOpenedPage = 0
 

Detailed Description

Definition at line 39 of file dialog_edit_component_in_lib.h.

Constructor & Destructor Documentation

◆ DIALOG_EDIT_COMPONENT_IN_LIBRARY()

DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY ( LIB_EDIT_FRAME parent,
LIB_PART aLibEntry 
)

Constructors.

Definition at line 60 of file dialog_edit_component_in_lib.cpp.

61  :
63  m_Parent( aParent ),
64  m_libEntry( aLibEntry ),
65  m_currentAlias( wxNOT_FOUND ),
67  m_delayedFocusCtrl( nullptr ),
68  m_delayedFocusGrid( nullptr ),
69  m_delayedFocusRow( -1 ),
71  m_delayedFocusPage( -1 ),
72  m_width( 0 )
73 {
75 
76  // Give a bit more room for combobox editors
77  m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
78  m_aliasGrid->SetDefaultRowSize( m_aliasGrid->GetDefaultRowSize() + 4 );
79 
80  // Work around a bug in wxWidgets where it fails to recalculate the grid height
81  // after changing the default row size
82  m_aliasGrid->AppendRows( 1 );
83  m_aliasGrid->DeleteRows( m_grid->GetNumberRows() - 1, 1 );
84 
85  m_fields = new FIELDS_GRID_TABLE<LIB_FIELD>( this, aParent, m_libEntry );
87 
88  m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this ) );
89  m_aliasGrid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this ) );
90 
91  // Show/hide columns according to the user's preference
92  m_config->Read( LibEditFieldsShownColumnsKey, &m_shownColumns, wxT( "0 1 2 3 4 5 6 7" ) );
94 
95  // Hide non-overridden rows in aliases grid
96  m_aliasGrid->HideRow( REFERENCE );
97  m_aliasGrid->HideRow( FOOTPRINT );
98 
99  wxGridCellAttr* attr = new wxGridCellAttr;
100  attr->SetReadOnly();
101  m_aliasGrid->SetColAttr( FDC_NAME, attr );
103  m_aliasGrid->SetCellValue( DATASHEET, FDC_NAME,
105 
106  attr = new wxGridCellAttr;
107  attr->SetEditor( new GRID_CELL_URL_EDITOR( this ) );
108  m_aliasGrid->SetAttr( DATASHEET, FDC_VALUE, attr );
109 
110  m_SymbolNameCtrl->SetValidator( SCH_FIELD_VALIDATOR( true, VALUE ) );
111 
112  // Configure button logos
113  m_bpAdd->SetBitmap( KiBitmap( small_plus_xpm ) );
114  m_bpDelete->SetBitmap( KiBitmap( trash_xpm ) );
115  m_bpMoveUp->SetBitmap( KiBitmap( small_up_xpm ) );
116  m_bpMoveDown->SetBitmap( KiBitmap( small_down_xpm ) );
117  m_addAliasButton->SetBitmap( KiBitmap( small_plus_xpm ) );
118  m_deleteAliasButton->SetBitmap( KiBitmap( trash_xpm ) );
119  m_addFilterButton->SetBitmap( KiBitmap( small_plus_xpm ) );
120  m_deleteFilterButton->SetBitmap( KiBitmap( trash_xpm ) );
121  m_editFilterButton->SetBitmap( KiBitmap( small_edit_xpm ) );
122 
123  m_stdSizerButtonOK->SetDefault();
124 
125 #ifndef KICAD_SPICE
126  m_spiceFieldsButton->Hide();
127 #endif
128 
129  // wxFormBuilder doesn't include this event...
130  m_grid->Connect( wxEVT_GRID_CELL_CHANGING,
132  NULL, this );
133  m_aliasGrid->Connect( wxEVT_GRID_CELL_CHANGING,
135  NULL, this );
136 
137  m_grid->GetParent()->Layout();
138  m_aliasGrid->GetParent()->Layout();
139  Layout();
140 
142 }
name of datasheet
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:119
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
static const wxString GetDefaultFieldName(int aFieldNdx)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:57
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
#define VALUE
DIALOG_EDIT_COMPONENT_IN_LIBRARY_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)
#define LibEditFieldsShownColumnsKey
class SCH_FILED_VALIDATOR
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

References DATASHEET, FDC_NAME, FDC_VALUE, DIALOG_SHIM::FinishDialogSettings(), FOOTPRINT, TEMPLATE_FIELDNAME::GetDefaultFieldName(), KiBitmap(), Kiface(), KIFACE_I::KifaceSettings(), LibEditFieldsShownColumnsKey, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_addAliasButton, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_addFilterButton, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_bpAdd, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_bpDelete, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_bpMoveDown, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_bpMoveUp, m_config, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_deleteAliasButton, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_deleteFilterButton, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_editFilterButton, m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, m_libEntry, m_shownColumns, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_spiceFieldsButton, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_stdSizerButtonOK, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SymbolNameCtrl, OnAliasGridCellChanging(), OnGridCellChanging(), REFERENCE, WX_GRID::SetTable(), WX_GRID::ShowHideColumns(), and VALUE.

◆ ~DIALOG_EDIT_COMPONENT_IN_LIBRARY()

DIALOG_EDIT_COMPONENT_IN_LIBRARY::~DIALOG_EDIT_COMPONENT_IN_LIBRARY ( )

Definition at line 145 of file dialog_edit_component_in_lib.cpp.

146 {
147  m_lastOpenedPage = m_NoteBook->GetSelection( );
148 
150 
151  // Prevents crash bug in wxGrid's d'tor
153 
154  m_grid->Disconnect( wxEVT_GRID_CELL_CHANGING,
156  NULL, this );
157  m_aliasGrid->Disconnect( wxEVT_GRID_CELL_CHANGING,
159  NULL, this );
160 
161  // Delete the GRID_TRICKS.
162  m_grid->PopEventHandler( true );
163  m_aliasGrid->PopEventHandler( true );
164 
165  // An OK will have transferred these and cleared the buffer, but we have to delete them
166  // on a Cancel.
167  for( LIB_ALIAS* alias : m_aliasesBuffer )
168  delete alias;
169 }
Part library alias object definition.
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:88
#define LibEditFieldsShownColumnsKey
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:101
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

References WX_GRID::DestroyTable(), WX_GRID::GetShownColumns(), LibEditFieldsShownColumnsKey, m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, m_config, m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, m_lastOpenedPage, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_NoteBook, OnAliasGridCellChanging(), and OnGridCellChanging().

Member Function Documentation

◆ adjustAliasGridColumns()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::adjustAliasGridColumns ( int  aWidth)
private

◆ adjustGridColumns()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::adjustGridColumns ( int  aWidth)
private

Definition at line 814 of file dialog_edit_component_in_lib.cpp.

815 {
816  m_width = aWidth;
817 
818  // Account for scroll bars
819  aWidth -= ( m_grid->GetSize().x - m_grid->GetClientSize().x );
820 
821  m_grid->AutoSizeColumn( FDC_NAME );
822 
823  int fixedColsWidth = m_grid->GetColSize( FDC_NAME );
824 
825  for( int i = 2; i < m_grid->GetNumberCols(); i++ )
826  fixedColsWidth += m_grid->GetColSize( i );
827 
828  m_grid->SetColSize( FDC_VALUE, aWidth - fixedColsWidth );
829 }
size_t i
Definition: json11.cpp:597

References FDC_NAME, FDC_VALUE, i, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, and m_width.

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

◆ checkAliasName()

bool DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName ( const wxString &  aName)
private

Definition at line 649 of file dialog_edit_component_in_lib.cpp.

650 {
651  if( aName.IsEmpty() )
652  return false;
653 
654  for( int i = 0; i < (int)m_aliasListBox->GetCount(); ++i )
655  {
656  if( i == m_aliasListBox->GetSelection() )
657  continue;
658 
659  if( m_aliasListBox->GetString( i ).CmpNoCase( aName ) == 0 )
660  {
661  wxString msg;
662  msg.Printf( _( "Alias \"%s\" already exists." ), aName );
663  DisplayInfoMessage( this, msg );
664  return false;
665  }
666  }
667 
668  wxString library = m_Parent->GetCurLib();
669 
670  if( !library.empty() )
671  {
672  LIB_ALIAS* existing = Prj().SchSymbolLibTable()->LoadSymbol( library, aName );
673 
674  if( existing && existing->GetPart()->GetName() != m_libEntry->GetName() )
675  {
676  wxString msg;
677  msg.Printf( _( "Symbol name \"%s\" already exists in library \"%s\"." ),
678  aName, library );
679  DisplayErrorMessage( this, msg );
680  return false;
681  }
682  }
683 
684  return true;
685 }
Part library alias object definition.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Function DisplayErrorMessage displays an error message with aMessage.
Definition: confirm.cpp:257
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
LIB_PART * GetPart() const
Get the shared LIB_PART.
const wxString & GetName() const
size_t i
Definition: json11.cpp:597
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:275

References DisplayErrorMessage(), DisplayInfoMessage(), LIB_EDIT_FRAME::GetCurLib(), LIB_PART::GetName(), LIB_ALIAS::GetPart(), i, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, m_libEntry, m_Parent, and KIWAY_HOLDER::Prj().

Referenced by OnAliasGridCellChanging(), and OnAliasNameKillFocus().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 230 of file dialog_shim.cpp.

231 {
232  // so we can do logging of this state change:
233 
234 #if defined(DEBUG)
235  const char* type_id = typeid( *this ).name();
236  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
237  fflush(0); //Needed on msys2 to immediately print the message
238 #endif
239 
240  return wxDialog::Enable( enable );
241 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 391 of file dialog_shim.cpp.

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

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

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

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

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

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

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

Definition at line 129 of file dialog_shim.cpp.

130 {
131  // must be called from the constructor of derived classes,
132  // when all widgets are initialized, and therefore their size fixed
133 
134  // SetSizeHints fixes the minimal size of sizers in the dialog
135  // (SetSizeHints calls Fit(), so no need to call it)
136  GetSizer()->SetSizeHints( this );
137 
138  // the default position, when calling the first time the dlg
139  Center();
140 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXIT::DIALOG_EXIT(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_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_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 150 of file dialog_shim.cpp.

151 {
152  wxSize sz( x, 0 );
153  return ConvertDialogToPixels( sz ).x;
154 }

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

◆ IsQuasiModal()

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:94

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), SCH_EDIT_FRAME::doUpdatePcb(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::KiwayMailIn(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAddAlias()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAddAlias ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 688 of file dialog_edit_component_in_lib.cpp.

689 {
691  return;
692 
693  wxCommandEvent dummy;
694  wxString aliasname = _( "untitled" );
695  int suffix = 1;
696 
697  while( m_libEntry->HasAlias( aliasname ) )
698  aliasname = wxString::Format( _( "untitled%i" ), suffix++ );
699 
700  LIB_ALIAS* alias = new LIB_ALIAS( aliasname, m_libEntry );
701 
702  // Initialize with parent's data
703  alias->SetDescription( m_DescCtrl->GetValue() );
704  alias->SetKeyWords( m_KeywordCtrl->GetValue() );
705  alias->SetDocFileName( m_grid->GetCellValue( DATASHEET, FDC_VALUE ) );
706 
707  m_aliasesBuffer.push_back( alias ); // transfers ownership of alias to aliasesBuffer
708 
709  m_aliasListBox->Append( aliasname );
710  m_aliasListBox->SetSelection( m_aliasListBox->GetCount() - 1 );
711  OnSelectAlias( dummy );
712 }
Part library alias object definition.
name of datasheet
void SetDocFileName(const wxString &aDocFileName)
void OnSelectAlias(wxCommandEvent &event) override
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
void SetDescription(const wxString &aDescription)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
void SetKeyWords(const wxString &aKeyWords)
bool HasAlias(const wxString &aName) const
Test if alias aName is in part alias list.

References WX_GRID::CommitPendingChanges(), DATASHEET, dummy(), FDC_VALUE, Format(), LIB_PART::HasAlias(), m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, m_delayedFocusCtrl, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_DescCtrl, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_KeywordCtrl, m_libEntry, OnSelectAlias(), LIB_ALIAS::SetDescription(), LIB_ALIAS::SetDocFileName(), and LIB_ALIAS::SetKeyWords().

◆ OnAddField()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 413 of file dialog_edit_component_in_lib.cpp.

414 {
415  if( !m_grid->CommitPendingChanges() )
416  return;
417 
418  int fieldID = m_fields->size();
419  LIB_FIELD newField( m_libEntry, fieldID );
420 
421  m_fields->push_back( newField );
422 
423  // notify the grid
424  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
425  m_grid->ProcessTableMessage( msg );
426 
427  m_grid->MakeCellVisible( m_fields->size() - 1, 0 );
428  m_grid->SetGridCursor( m_fields->size() - 1, 0 );
429 
430  m_grid->EnableCellEditControl();
431  m_grid->ShowCellEditControl();
432 }
Field object used in symbol libraries.
Definition: lib_field.h:59
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

References WX_GRID::CommitPendingChanges(), m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, and m_libEntry.

◆ OnAddFootprintFilter()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAddFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 759 of file dialog_edit_component_in_lib.cpp.

760 {
761  wxString filterLine;
762  LIB_PART* component = m_Parent->GetCurPart();
763 
764  if( component == NULL )
765  return;
766 
767  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Filter:" ), _( "Add Footprint Filter" ), filterLine );
768 
769  if( dlg.ShowModal() == wxID_CANCEL || dlg.GetValue().IsEmpty() )
770  return;
771 
772  filterLine = dlg.GetValue();
773  filterLine.Replace( wxT( " " ), wxT( "_" ) );
774 
775  // duplicate filters do no harm, so don't be a nanny.
776 
777  m_FootprintFilterListBox->Append( filterLine );
778  m_FootprintFilterListBox->SetSelection( m_FootprintFilterListBox->GetCount() - 1 );
779 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
Define a library symbol object.

References LIB_EDIT_FRAME::GetCurPart(), WX_TEXT_ENTRY_DIALOG::GetValue(), DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_FootprintFilterListBox, and m_Parent.

Referenced by OnFilterDClick().

◆ OnAliasGridCellChanging()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAliasGridCellChanging ( wxGridEvent &  event)
private

Definition at line 525 of file dialog_edit_component_in_lib.cpp.

526 {
527  if( event.GetRow() == VALUE )
528  {
529  int idx = m_aliasListBox->GetSelection();
530  wxString newName = event.GetString();
531 
532  if( idx < 0 || !checkAliasName( newName ) )
533  {
534  event.Veto();
535 
537  m_delayedFocusRow = event.GetRow();
538  m_delayedFocusColumn = event.GetCol();
539  m_delayedFocusPage = 1;
540  }
541  else
542  updateAliasName( true, newName );
543  }
544 }
void updateAliasName(bool aFromGrid, const wxString &aName)
#define VALUE

References checkAliasName(), DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, updateAliasName(), and VALUE.

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

◆ OnAliasNameKillFocus()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAliasNameKillFocus ( wxFocusEvent &  event)
overrideprivatevirtual

◆ OnAliasNameText()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAliasNameText ( wxCommandEvent &  event)
overrideprivatevirtual

◆ OnCancelButtonClick()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 751 of file dialog_edit_component_in_lib.cpp.

752 {
753  // Running the Footprint Browser gums up the works and causes the automatic cancel
754  // stuff to no longer work. So we do it here ourselves.
755  EndQuasiModal( wxID_CANCEL );
756 }
void EndQuasiModal(int retCode)

References DIALOG_SHIM::EndQuasiModal().

◆ OnDeleteAlias()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnDeleteAlias ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 715 of file dialog_edit_component_in_lib.cpp.

716 {
718  return;
719 
720  int sel = m_aliasListBox->GetSelection();
721 
722  if( sel == wxNOT_FOUND )
723  return;
724 
725  m_aliasListBox->Delete( (unsigned) sel );
726  m_aliasesBuffer.erase( m_aliasesBuffer.begin() + sel );
727  m_currentAlias = wxNOT_FOUND;
728 
729  if( m_aliasListBox->GetCount() == 0 )
730  m_aliasListBox->SetSelection( wxNOT_FOUND );
731  else
732  m_aliasListBox->SetSelection( std::max( 0, sel - 1 ) );
733 
734  wxCommandEvent dummy;
735  OnSelectAlias( dummy );
736 }
void OnSelectAlias(wxCommandEvent &event) override
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
#define max(a, b)
Definition: auxiliary.h:86

References WX_GRID::CommitPendingChanges(), dummy(), m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, m_currentAlias, m_delayedFocusCtrl, max, and OnSelectAlias().

◆ OnDeleteField()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 435 of file dialog_edit_component_in_lib.cpp.

436 {
437  int curRow = m_grid->GetGridCursorRow();
438 
439  if( curRow < 0 )
440  return;
441  else if( curRow < MANDATORY_FIELDS )
442  {
443  DisplayError( this, wxString::Format( _( "The first %d fields are mandatory." ),
444  MANDATORY_FIELDS ) );
445  return;
446  }
447 
448  m_grid->CommitPendingChanges( true /* quiet mode */ );
449 
450  m_fields->erase( m_fields->begin() + curRow );
451 
452  // notify the grid
453  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, curRow, 1 );
454  m_grid->ProcessTableMessage( msg );
455 
456  if( m_grid->GetNumberRows() > 0 )
457  {
458  m_grid->MakeCellVisible( std::max( 0, curRow-1 ), m_grid->GetGridCursorCol() );
459  m_grid->SetGridCursor( std::max( 0, curRow-1 ), m_grid->GetGridCursorCol() );
460  }
461 }
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define max(a, b)
Definition: auxiliary.h:86
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243

References WX_GRID::CommitPendingChanges(), DisplayError(), Format(), m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, MANDATORY_FIELDS, and max.

◆ OnDeleteFootprintFilter()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnDeleteFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 782 of file dialog_edit_component_in_lib.cpp.

783 {
784  int ii = m_FootprintFilterListBox->GetSelection();
785 
786  if( ii >= 0 )
787  {
788  m_FootprintFilterListBox->Delete( (unsigned) ii );
789 
790  if( m_FootprintFilterListBox->GetCount() == 0 )
791  m_FootprintFilterListBox->SetSelection( wxNOT_FOUND );
792  else
793  m_FootprintFilterListBox->SetSelection( std::max( 0, ii - 1 ) );
794  }
795 }
#define max(a, b)
Definition: auxiliary.h:86

References DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_FootprintFilterListBox, and max.

◆ OnEditFootprintFilter()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnEditFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 798 of file dialog_edit_component_in_lib.cpp.

799 {
800  int idx = m_FootprintFilterListBox->GetSelection();
801 
802  if( idx >= 0 )
803  {
804  wxString filter = m_FootprintFilterListBox->GetStringSelection();
805 
806  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Filter:" ), _( "Edit Footprint Filter" ), filter );
807 
808  if( dlg.ShowModal() == wxID_OK && !dlg.GetValue().IsEmpty() )
809  m_FootprintFilterListBox->SetString( (unsigned) idx, dlg.GetValue() );
810  }
811 }

References WX_TEXT_ENTRY_DIALOG::GetValue(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_FootprintFilterListBox.

Referenced by OnFilterDClick().

◆ OnEditSpiceModel()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnEditSpiceModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 579 of file dialog_edit_component_in_lib.cpp.

580 {
581 #ifdef KICAD_SPICE
582  int diff = m_fields->size();
583  auto cmp = SCH_COMPONENT( *m_libEntry, m_libEntry->GetLibId(), nullptr );
584 
585  DIALOG_SPICE_MODEL dialog( this, cmp, m_fields );
586 
587  if( dialog.ShowModal() != wxID_OK )
588  return;
589 
590  diff = m_fields->size() - diff;
591 
592  if( diff > 0 )
593  {
594  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, diff );
595  m_grid->ProcessTableMessage( msg );
596  }
597  else if( diff < 0 )
598  {
599  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, 0, diff );
600  m_grid->ProcessTableMessage( msg );
601  }
602 
603  m_grid->ForceRefresh();
604 #endif /* KICAD_SPICE */
605 }
const LIB_ID & GetLibId() const
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:70
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

References LIB_PART::GetLibId(), m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, and m_libEntry.

◆ OnFilterDClick()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnFilterDClick ( wxMouseEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 739 of file dialog_edit_component_in_lib.cpp.

740 {
741  int idx = m_FootprintFilterListBox->HitTest( event.GetPosition() );
742  wxCommandEvent dummy;
743 
744  if( idx >= 0 )
746  else
748 }
void OnAddFootprintFilter(wxCommandEvent &event) override
void OnEditFootprintFilter(wxCommandEvent &event) override
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...

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

◆ OnGridCellChanging()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnGridCellChanging ( wxGridEvent &  event)
private

Definition at line 374 of file dialog_edit_component_in_lib.cpp.

375 {
376  wxGridCellEditor* editor = m_grid->GetCellEditor( event.GetRow(), event.GetCol() );
377  wxControl* control = editor->GetControl();
378 
379  if( control && control->GetValidator() && !control->GetValidator()->Validate( control ) )
380  {
381  event.Veto();
382 
384  m_delayedFocusRow = event.GetRow();
385  m_delayedFocusColumn = event.GetCol();
386  m_delayedFocusPage = 0;
387  }
388  else if( event.GetRow() == VALUE && event.GetCol() == FDC_VALUE )
389  m_SymbolNameCtrl->ChangeValue( event.GetString() );
390 
391  editor->DecRef();
392 }
#define VALUE

References FDC_VALUE, m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SymbolNameCtrl, and VALUE.

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

◆ OnMoveDown()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnMoveDown ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 486 of file dialog_edit_component_in_lib.cpp.

487 {
488  if( !m_grid->CommitPendingChanges() )
489  return;
490 
491  int i = m_grid->GetGridCursorRow();
492 
493  if( i >= MANDATORY_FIELDS && i + 1 < m_fields->GetNumberRows() )
494  {
495  LIB_FIELD tmp = m_fields->at( (unsigned) i );
496  m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
497  m_fields->insert( m_fields->begin() + i + 1, tmp );
498  m_grid->ForceRefresh();
499 
500  m_grid->SetGridCursor( i + 1, m_grid->GetGridCursorCol() );
501  m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
502  }
503  else
504  wxBell();
505 }
int GetNumberRows() override
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
Field object used in symbol libraries.
Definition: lib_field.h:59
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
size_t i
Definition: json11.cpp:597
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

References WX_GRID::CommitPendingChanges(), FIELDS_GRID_TABLE< T >::GetNumberRows(), i, m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, and MANDATORY_FIELDS.

◆ OnMoveUp()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnMoveUp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 464 of file dialog_edit_component_in_lib.cpp.

465 {
466  if( !m_grid->CommitPendingChanges() )
467  return;
468 
469  int i = m_grid->GetGridCursorRow();
470 
471  if( i > MANDATORY_FIELDS )
472  {
473  LIB_FIELD tmp = m_fields->at( (unsigned) i );
474  m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
475  m_fields->insert( m_fields->begin() + i - 1, tmp );
476  m_grid->ForceRefresh();
477 
478  m_grid->SetGridCursor( i - 1, m_grid->GetGridCursorCol() );
479  m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
480  }
481  else
482  wxBell();
483 }
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
Field object used in symbol libraries.
Definition: lib_field.h:59
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
size_t i
Definition: json11.cpp:597
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

References WX_GRID::CommitPendingChanges(), i, m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, and MANDATORY_FIELDS.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 293 of file dialog_shim.cpp.

294 {
295  if( m_firstPaintEvent )
296  {
297 #ifdef __WXMAC__
298  fixOSXCancelButtonIssue( this );
299  selectAllInTextCtrls( GetChildren() );
300 #endif
301 
303  m_initialFocusTarget->SetFocus();
304  else
305  SetFocus(); // Focus the dialog itself
306 
307  m_firstPaintEvent = false;
308  }
309 
310  event.Skip();
311 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180
bool m_firstPaintEvent
Definition: dialog_shim.h:179

References DIALOG_SHIM::m_firstPaintEvent, and DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnSelectAlias()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnSelectAlias ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 608 of file dialog_edit_component_in_lib.cpp.

609 {
611  {
612  m_aliasListBox->SetSelection( m_currentAlias ); // veto selection change
613  return;
614  }
615 
616  // Copy any pending changes back into the buffer
618 
619  LIB_ALIAS* alias = nullptr;
620  int newIdx = m_aliasListBox->GetSelection();
621 
622  if( newIdx >= 0 )
623  {
624  alias = m_aliasesBuffer[ newIdx ];
625 
626  m_aliasGrid->SetCellValue( VALUE, FDC_VALUE, alias->GetName() );
627  m_aliasGrid->SetCellValue( DATASHEET, FDC_VALUE, alias->GetDocFileName() );
628 
629  // Use ChangeValue() so we don't generate events
630  m_AliasNameCtrl->ChangeValue( alias->GetName() );
631  m_AliasDescCtrl->ChangeValue( alias->GetDescription() );
632  m_AliasKeywordsCtrl->ChangeValue( alias->GetKeyWords() );
633  }
634  else
635  {
636  m_aliasGrid->SetCellValue( VALUE, FDC_VALUE, wxEmptyString );
637  m_aliasGrid->SetCellValue( DATASHEET, FDC_VALUE, wxEmptyString );
638 
639  // Use ChangeValue() so we don't generate events
640  m_AliasNameCtrl->ChangeValue( wxEmptyString );
641  m_AliasDescCtrl->ChangeValue( wxEmptyString );
642  m_AliasKeywordsCtrl->ChangeValue( wxEmptyString );
643  }
644 
645  m_currentAlias = newIdx;
646 }
Part library alias object definition.
name of datasheet
const wxString & GetDocFileName() const
#define VALUE
const wxString & GetKeyWords() const
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
const wxString & GetDescription() override
const wxString & GetName() const override

References WX_GRID::CommitPendingChanges(), DATASHEET, FDC_VALUE, LIB_ALIAS::GetDescription(), LIB_ALIAS::GetDocFileName(), LIB_ALIAS::GetKeyWords(), LIB_ALIAS::GetName(), DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasDescCtrl, m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasKeywordsCtrl, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasNameCtrl, m_currentAlias, m_delayedFocusCtrl, transferAliasDataToBuffer(), and VALUE.

Referenced by OnAddAlias(), OnDeleteAlias(), OnUpdateUI(), and TransferDataToWindow().

◆ OnSizeAliasGrid()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnSizeAliasGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 934 of file dialog_edit_component_in_lib.cpp.

935 {
936  adjustAliasGridColumns( event.GetSize().GetX() );
937 
938  event.Skip();
939 }

References adjustAliasGridColumns().

◆ OnSizeGrid()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 922 of file dialog_edit_component_in_lib.cpp.

923 {
924  auto new_size = event.GetSize().GetX();
925 
926  if( new_size != m_width )
927  {
928  adjustGridColumns( event.GetSize().GetX() );
929  event.Skip();
930  }
931 }

References adjustGridColumns(), and m_width.

◆ OnSymbolNameKillFocus()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnSymbolNameKillFocus ( wxFocusEvent &  event)
overrideprivatevirtual

◆ OnSymbolNameText()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnSymbolNameText ( wxCommandEvent &  event)
overrideprivatevirtual

◆ OnUpdateUI()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE.

Definition at line 839 of file dialog_edit_component_in_lib.cpp.

840 {
841  m_OptionPartsLocked->Enable( m_SelNumberOfUnits->GetValue() > 1 );
843 
844  if( m_grid->IsCellEditControlShown() )
845  {
846  int row = m_grid->GetGridCursorRow();
847  int col = m_grid->GetGridCursorCol();
848 
849  if( row == VALUE && col == FDC_VALUE )
850  {
851  wxGridCellEditor* editor = m_grid->GetCellEditor( row, col );
852  m_SymbolNameCtrl->ChangeValue( editor->GetValue() );
853  editor->DecRef();
854  }
855  }
856 
857  // Synthesize a Select event when the selection is cleared
858  if( m_aliasListBox->GetSelection() == wxNOT_FOUND && m_currentAlias != wxNOT_FOUND )
859  {
860  wxCommandEvent dummy;
861  OnSelectAlias( dummy );
862  }
863 
864  // Handle shown columns changes
865  wxString shownColumns = m_grid->GetShownColumns();
866 
867  if( shownColumns != m_shownColumns )
868  {
869  m_shownColumns = shownColumns;
870 
871  if( !m_grid->IsCellEditControlShown() )
872  adjustGridColumns( m_grid->GetRect().GetWidth() );
873  }
874 
875  // Handle a delayed focus. The delay allows us to:
876  // a) change focus when the error was triggered from within a killFocus handler
877  // b) show the correct notebook page in the background before the error dialog comes up
878  // when triggered from an OK or a notebook page change
879 
880  if( m_delayedFocusPage >= 0 && m_NoteBook->GetSelection() != m_delayedFocusPage )
881  {
882  m_NoteBook->SetSelection( (unsigned) m_delayedFocusPage );
883  m_delayedFocusPage = -1;
884  }
885 
886  if( !m_delayedErrorMessage.IsEmpty() )
887  {
888  // We will re-enter this routine when the error dialog is displayed, so make
889  // sure we don't keep putting up more dialogs.
890  wxString msg = m_delayedErrorMessage;
891  m_delayedErrorMessage = wxEmptyString;
892 
893  // Do not use DisplayErrorMessage(); it screws up window order on Mac
894  DisplayError( nullptr, msg );
895  }
896 
897  if( m_delayedFocusCtrl )
898  {
899  m_delayedFocusCtrl->SetFocus();
900 
901  if( dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl ) )
902  dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl )->SelectAll();
903 
904  m_delayedFocusCtrl = nullptr;
905  }
906  else if( m_delayedFocusGrid )
907  {
908  m_delayedFocusGrid->SetFocus();
911 
912  m_delayedFocusGrid->EnableCellEditControl( true );
913  m_delayedFocusGrid->ShowCellEditControl();
914 
915  m_delayedFocusGrid = nullptr;
916  m_delayedFocusRow = -1;
918  }
919 }
#define VALUE
void OnSelectAlias(wxCommandEvent &event) override
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:101
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243
void Enable(bool aEnable)
Function Enable Enables/diasables the label, widget and units label.

References adjustGridColumns(), DisplayError(), dummy(), UNIT_BINDER::Enable(), FDC_VALUE, WX_GRID::GetShownColumns(), DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, m_currentAlias, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusCtrl, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_NoteBook, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_OptionPartsLocked, m_pinNameOffset, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_PinsNameInsideButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SelNumberOfUnits, m_shownColumns, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SymbolNameCtrl, OnSelectAlias(), and VALUE.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doUpdatePcb(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLoadProject(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnPrint(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), KICAD_MANAGER_FRAME::OnRunGerbview(), DIALOG_BOM::OnRunPlugin(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), KICAD_MANAGER_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::Process_Config(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::saveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

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

117  {
118  m_initialFocusTarget = aWindow;
119  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180

References DIALOG_SHIM::m_initialFocusTarget.

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

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 47 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetSizeInDU()

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

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

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

Definition at line 143 of file dialog_shim.cpp.

144 {
145  wxSize sz( x, y );
146  SetSize( ConvertDialogToPixels( sz ) );
147 }

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 171 of file dialog_shim.cpp.

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

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_SCH_FIND::OnCancel(), SCH_EDIT_FRAME::OnFindItems(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 337 of file dialog_shim.cpp.

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

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

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), SCH_EDIT_FRAME::InstallHierarchyFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), LIB_EDIT_FRAME::OnEditComponentProperties(), PCB_EDIT_FRAME::OnEditTracksAndVias(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectComponentFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ transferAliasDataToBuffer()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::transferAliasDataToBuffer ( )
private

Definition at line 565 of file dialog_edit_component_in_lib.cpp.

566 {
567  if( m_currentAlias >= 0 )
568  {
570 
571  alias->SetName( m_aliasGrid->GetCellValue( VALUE, FDC_VALUE ) );
572  alias->SetDocFileName( m_aliasGrid->GetCellValue( DATASHEET, FDC_VALUE ) );
573  alias->SetDescription( m_AliasDescCtrl->GetValue() );
574  alias->SetKeyWords( m_AliasKeywordsCtrl->GetValue() );
575  }
576 }
Part library alias object definition.
name of datasheet
void SetDocFileName(const wxString &aDocFileName)
void SetName(const wxString &aName)
#define VALUE
void SetDescription(const wxString &aDescription)
void SetKeyWords(const wxString &aKeyWords)

References DATASHEET, FDC_VALUE, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasDescCtrl, m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasKeywordsCtrl, m_currentAlias, LIB_ALIAS::SetDescription(), LIB_ALIAS::SetDocFileName(), LIB_ALIAS::SetKeyWords(), LIB_ALIAS::SetName(), and VALUE.

Referenced by OnSelectAlias(), and TransferDataFromWindow().

◆ TransferDataFromWindow()

bool DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow ( )
override

Definition at line 304 of file dialog_edit_component_in_lib.cpp.

305 {
306  if( !wxDialog::TransferDataFromWindow() )
307  return false;
308 
309  LIB_ALIAS* rootAlias = m_libEntry->GetAlias( m_libEntry->GetName() );
310 
312 
313  // The Y axis for components in lib is from bottom to top while the screen axis is top
314  // to bottom: we must change the y coord sign when writing back to the library
315  for( size_t i = 0; i < m_fields->size(); ++i )
316  {
317  wxPoint pos = m_fields->at( i ).GetPosition();
318  pos.y = -pos.y;
319  m_fields->at( i ).SetPosition( pos );
320  }
321 
322  // Datasheet field is special; copy it to the root alias docfilename
323  rootAlias->SetDocFileName( m_fields->at( DATASHEET ).GetText() );
324  m_fields->at( DATASHEET ).SetText( wxEmptyString );
325 
327 
328  // We need to keep the name and the value the same at the moment!
330 
331  rootAlias->SetDescription( m_DescCtrl->GetValue() );
332  rootAlias->SetKeyWords( m_KeywordCtrl->GetValue() );
333 
336 
337  m_libEntry->SetConversion( m_AsConvertButt->GetValue() );
338 
339  if( m_OptionPower->GetValue() )
340  m_libEntry->SetPower();
341  else
343 
346 
347  if( m_PinsNameInsideButt->GetValue() )
348  {
349  int offset = KiROUND( (double) m_pinNameOffset.GetValue() / IU_PER_MILS );
350 
351  // We interpret an offset of 0 as "outside", so make sure it's non-zero
352  m_libEntry->SetPinNameOffset( offset == 0 ? 20 : offset );
353  }
354  else
355  {
356  m_libEntry->SetPinNameOffset( 0 ); // pin text outside the body (name is on the pin)
357  }
358 
361 
362  for( LIB_ALIAS* alias : m_aliasesBuffer )
363  m_libEntry->AddAlias( alias ); // Transfers ownership; no need to delete
364 
365  m_aliasesBuffer.clear();
366 
367  m_libEntry->GetFootprints().Clear();
369 
370  return true;
371 }
int GetUnitCount() const
Part library alias object definition.
void SetConversion(bool aSetConvert)
Set or clear the alternate body style (DeMorgan) for the part.
void SetPower()
name of datasheet
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:121
LIB_ALIAS * GetAlias(size_t aIndex)
LIB_FIELD & GetValueField()
Return reference to the value field.
void AddAlias(const wxString &aName)
Add an alias aName to the part.
void SetDocFileName(const wxString &aDocFileName)
virtual int GetValue()
Function GetValue Returns the current value in Internal Units.
void SetUnitCount(int count)
Set the units per part count.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
void SetDescription(const wxString &aDescription)
wxArrayString & GetFootprints()
void RemoveAllAliases()
void SetShowPinNumbers(bool aShow)
Set or clear the pin number visibility flag.
const wxString & GetName() const
void SetKeyWords(const wxString &aKeyWords)
void SaveCopyInUndoList(EDA_ITEM *ItemToCopy, UNDO_REDO_T undoType=UR_LIBEDIT)
Create a copy of the current component, and save it in the undo list.
size_t i
Definition: json11.cpp:597
#define IU_PER_MILS
Definition: plotter.cpp:134
virtual void SetName(const wxString &aName)
void SetShowPinNames(bool aShow)
Set or clear the pin name visibility flag.
void SetPinNameOffset(int aOffset)
Set the offset in mils of the pin name text from the pin symbol.
void SetFields(const std::vector< LIB_FIELD > &aFieldsList)
Overwrite all the existing fields in this symbol with fields supplied in aFieldsList.
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
void LockUnits(bool aLockUnits)
Set interchangeable the property for part units.
void SetNormal()

References LIB_PART::AddAlias(), DATASHEET, LIB_PART::GetAlias(), LIB_PART::GetFootprints(), LIB_PART::GetName(), EDA_TEXT::GetText(), LIB_PART::GetUnitCount(), UNIT_BINDER::GetValue(), LIB_PART::GetValueField(), i, IU_PER_MILS, KiROUND(), LIB_PART::LockUnits(), m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AsConvertButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_DescCtrl, m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_FootprintFilterListBox, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_KeywordCtrl, m_libEntry, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_OptionPartsLocked, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_OptionPower, m_Parent, m_pinNameOffset, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_PinsNameInsideButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SelNumberOfUnits, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_ShowPinNameButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_ShowPinNumButt, LIB_PART::RemoveAllAliases(), LIB_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetConversion(), LIB_ALIAS::SetDescription(), LIB_ALIAS::SetDocFileName(), LIB_PART::SetFields(), LIB_ALIAS::SetKeyWords(), LIB_PART::SetName(), LIB_PART::SetNormal(), LIB_PART::SetPinNameOffset(), LIB_PART::SetPower(), LIB_PART::SetShowPinNames(), LIB_PART::SetShowPinNumbers(), LIB_PART::SetUnitCount(), and transferAliasDataToBuffer().

◆ TransferDataToWindow()

bool DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow ( )
override

Definition at line 172 of file dialog_edit_component_in_lib.cpp.

173 {
174  if( !wxDialog::TransferDataToWindow() )
175  return false;
176 
177  LIB_ALIAS* rootAlias = m_libEntry->GetAlias( m_libEntry->GetName() );
178 
179  // Push a copy of each field into m_fields
181 
182  // Datasheet field is special; grab its value from the docfilename
183  m_fields->at( DATASHEET ).SetText( rootAlias->GetDocFileName() );
184 
185  // The Y axis for components in lib is from bottom to top while the screen axis is top
186  // to bottom: we must change the y coord sign for editing
187  for( size_t i = 0; i < m_fields->size(); ++i )
188  {
189  wxPoint pos = m_fields->at( i ).GetPosition();
190  pos.y = -pos.y;
191  m_fields->at( i ).SetPosition( pos );
192  }
193 
194  // notify the grid
195  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_fields->GetNumberRows() );
196  m_grid->ProcessTableMessage( msg );
197  adjustGridColumns( m_grid->GetRect().GetWidth());
198 
199  m_SymbolNameCtrl->SetValue( m_libEntry->GetName() );
200 
201  m_DescCtrl->SetValue( rootAlias->GetDescription() );
202  m_KeywordCtrl->SetValue( rootAlias->GetKeyWords() );
203 
206  m_AsConvertButt->SetValue( m_libEntry->HasConversion() );
207  m_OptionPower->SetValue( m_libEntry->IsPower() );
208 
210  m_ShowPinNameButt->SetValue( m_libEntry->ShowPinNames() );
211  m_PinsNameInsideButt->SetValue( m_libEntry->GetPinNameOffset() != 0 );
213 
214  const LIB_ALIASES aliases = m_libEntry->GetAliases();
215 
216  for( LIB_ALIAS* alias : aliases )
217  {
218  if( alias->IsRoot() )
219  continue;
220 
221  m_aliasesBuffer.push_back( new LIB_ALIAS( *alias, m_libEntry ) );
222  m_aliasListBox->Append( alias->GetName() );
223  }
224 
225  if( m_aliasListBox->GetCount() )
226  {
227  m_aliasListBox->SetSelection( 0 );
228 
229  wxCommandEvent dummy;
230  OnSelectAlias( dummy );
231  }
232 
233  adjustAliasGridColumns( m_aliasGrid->GetClientRect().GetWidth() - 4 );
234 
236 
237  m_NoteBook->SetSelection( (unsigned) m_lastOpenedPage );
238 
239  return true;
240 }
int GetUnitCount() const
Part library alias object definition.
name of datasheet
int GetPinNameOffset()
int GetNumberRows() override
LIB_ALIAS * GetAlias(size_t aIndex)
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
std::vector< LIB_ALIAS * > LIB_ALIASES
const wxString & GetDocFileName() const
bool ShowPinNames()
bool ShowPinNumbers()
const wxString & GetKeyWords() const
void OnSelectAlias(wxCommandEvent &event) override
wxArrayString & GetFootprints()
const wxString & GetDescription() override
bool IsPower() const
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
const wxString & GetName() const
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
size_t i
Definition: json11.cpp:597
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
bool UnitsLocked() const
Check whether part units are interchangeable.
void GetFields(LIB_FIELDS &aList)
Return a list of fields within this part.
LIB_ALIASES GetAliases() const

References adjustAliasGridColumns(), adjustGridColumns(), DATASHEET, dummy(), LIB_PART::GetAlias(), LIB_PART::GetAliases(), LIB_ALIAS::GetDescription(), LIB_ALIAS::GetDocFileName(), LIB_PART::GetFields(), LIB_PART::GetFootprints(), LIB_ALIAS::GetKeyWords(), LIB_PART::GetName(), FIELDS_GRID_TABLE< T >::GetNumberRows(), LIB_PART::GetPinNameOffset(), LIB_PART::GetUnitCount(), LIB_PART::HasConversion(), i, LIB_PART::IsPower(), m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AsConvertButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_DescCtrl, m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_FootprintFilterListBox, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_KeywordCtrl, m_lastOpenedPage, m_libEntry, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_NoteBook, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_OptionPartsLocked, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_OptionPower, m_pinNameOffset, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_PinsNameInsideButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SelNumberOfUnits, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_ShowPinNameButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_ShowPinNumButt, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SymbolNameCtrl, OnSelectAlias(), UNIT_BINDER::SetValue(), LIB_PART::ShowPinNames(), LIB_PART::ShowPinNumbers(), and LIB_PART::UnitsLocked().

◆ updateAliasName()

void DIALOG_EDIT_COMPONENT_IN_LIBRARY::updateAliasName ( bool  aFromGrid,
const wxString &  aName 
)
private

Definition at line 508 of file dialog_edit_component_in_lib.cpp.

509 {
510  int idx = m_aliasListBox->GetSelection();
511 
512  if( idx >= 0 )
513  {
514  m_aliasListBox->SetString( (unsigned) idx, aName );
515  m_aliasesBuffer[ idx ]->SetName( aName );
516 
517  if( aFromGrid )
518  m_AliasNameCtrl->ChangeValue( aName );
519  else
520  m_aliasGrid->SetCellValue( VALUE, FDC_VALUE, aName );
521  }
522 }
#define VALUE

References FDC_VALUE, m_aliasesBuffer, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasListBox, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasNameCtrl, and VALUE.

Referenced by OnAliasGridCellChanging(), and OnAliasNameText().

◆ Validate()

bool DIALOG_EDIT_COMPONENT_IN_LIBRARY::Validate ( )
override

Definition at line 243 of file dialog_edit_component_in_lib.cpp.

244 {
246  return false;
247 
248  if( !SCH_COMPONENT::IsReferenceStringValid( m_fields->at( REFERENCE ).GetText() ) )
249  {
250  if( m_NoteBook->GetSelection() != 0 )
251  m_NoteBook->SetSelection( 0 );
252 
253  m_delayedErrorMessage = _( "References must start with a letter." );
257  m_delayedFocusPage = 0;
258 
259  return false;
260  }
261 
262  // Check for missing field names.
263  for( size_t i = MANDATORY_FIELDS; i < m_fields->size(); ++i )
264  {
265  LIB_FIELD& field = m_fields->at( i );
266  wxString fieldName = field.GetName( false );
267 
268  if( fieldName.IsEmpty() )
269  {
270  if( m_NoteBook->GetSelection() != 0 )
271  m_NoteBook->SetSelection( 0 );
272 
273  m_delayedErrorMessage = _( "Fields must have a name." );
277  m_delayedFocusPage = 0;
278 
279  return false;
280  }
281  }
282 
283  if( m_SelNumberOfUnits->GetValue() < m_libEntry->GetUnitCount() )
284  {
285  if( !IsOK( this, _( "Delete extra units from symbol?" ) ) )
286  return false;
287  }
288 
289  if( m_AsConvertButt->GetValue() && !m_libEntry->HasConversion() )
290  {
291  if( !IsOK( this, _( "Add new pins for alternate body style (DeMorgan) to symbol?" ) ) )
292  return false;
293  }
294  else if( !m_AsConvertButt->GetValue() && m_libEntry->HasConversion() )
295  {
296  if( !IsOK( this, _( "Delete alternate body style (DeMorgan) draw items from symbol?" ) ) )
297  return false;
298  }
299 
300  return true;
301 }
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:448
int GetUnitCount() const
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Reference of part, i.e. "IC21".
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:167
size_t i
Definition: json11.cpp:597
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:293

References WX_GRID::CommitPendingChanges(), FDC_NAME, FDC_VALUE, LIB_FIELD::GetName(), LIB_PART::GetUnitCount(), LIB_PART::HasConversion(), i, IsOK(), SCH_COMPONENT::IsReferenceStringValid(), DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_aliasGrid, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AsConvertButt, m_delayedErrorMessage, m_delayedFocusColumn, m_delayedFocusGrid, m_delayedFocusPage, m_delayedFocusRow, m_fields, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_grid, m_libEntry, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_NoteBook, DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SelNumberOfUnits, MANDATORY_FIELDS, and REFERENCE.

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 157 of file dialog_shim.cpp.

158 {
159  wxSize sz( 0, y );
160  return ConvertDialogToPixels( sz ).y;
161 }

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

Member Data Documentation

◆ m_addAliasButton

◆ m_addFilterButton

◆ m_AliasDescCtrl

wxTextCtrl* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasDescCtrl
protectedinherited

◆ m_aliasesBuffer

◆ m_aliasGrid

◆ m_AliasKeywordsCtrl

wxTextCtrl* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AliasKeywordsCtrl
protectedinherited

◆ m_aliasListBox

◆ m_AliasNameCtrl

◆ m_AsConvertButt

wxCheckBox* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_AsConvertButt
protectedinherited

◆ m_bpAdd

◆ m_bpDelete

◆ m_bpMoveDown

◆ m_bpMoveUp

◆ m_config

wxConfigBase* DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_config

◆ m_currentAlias

int DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_currentAlias

◆ m_delayedErrorMessage

wxString DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_delayedErrorMessage

Definition at line 60 of file dialog_edit_component_in_lib.h.

Referenced by OnUpdateUI(), and Validate().

◆ m_delayedFocusColumn

int DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_delayedFocusColumn

◆ m_delayedFocusCtrl

wxControl* DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_delayedFocusCtrl

◆ m_delayedFocusGrid

WX_GRID* DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_delayedFocusGrid

◆ m_delayedFocusPage

int DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_delayedFocusPage

◆ m_delayedFocusRow

int DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_delayedFocusRow

◆ m_deleteAliasButton

◆ m_deleteFilterButton

◆ m_DescCtrl

wxTextCtrl* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_DescCtrl
protectedinherited

◆ m_editFilterButton

◆ m_fields

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 179 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_FootprintFilterListBox

◆ m_grid

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 180 of file dialog_shim.h.

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

◆ m_KeywordCtrl

wxTextCtrl* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_KeywordCtrl
protectedinherited

◆ m_lastOpenedPage

int DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_lastOpenedPage = 0
staticprivate

◆ m_libEntry

◆ m_nameOffsetCtrl

wxTextCtrl* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_nameOffsetCtrl
protectedinherited

◆ m_nameOffsetLabel

wxStaticText* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_nameOffsetLabel
protectedinherited

◆ m_nameOffsetUnits

wxStaticText* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_nameOffsetUnits
protectedinherited

◆ m_NoteBook

wxNotebook* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_NoteBook
protectedinherited

◆ m_OptionPartsLocked

wxCheckBox* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_OptionPartsLocked
protectedinherited

◆ m_OptionPower

wxCheckBox* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_OptionPower
protectedinherited

◆ m_PanelAlias

wxPanel* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_PanelAlias
protectedinherited

◆ m_PanelBasic

wxPanel* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_PanelBasic
protectedinherited

◆ m_PanelFootprintFilter

wxPanel* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_PanelFootprintFilter
protectedinherited

◆ m_Parent

LIB_EDIT_FRAME* DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_Parent

◆ m_pinNameOffset

UNIT_BINDER DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_pinNameOffset

◆ m_PinsNameInsideButt

wxCheckBox* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_PinsNameInsideButt
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_SelNumberOfUnits

wxSpinCtrl* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_SelNumberOfUnits
protectedinherited

◆ m_shownColumns

wxString DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_shownColumns

Definition at line 62 of file dialog_edit_component_in_lib.h.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY(), and OnUpdateUI().

◆ m_ShowPinNameButt

wxCheckBox* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_ShowPinNameButt
protectedinherited

◆ m_ShowPinNumButt

wxCheckBox* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_ShowPinNumButt
protectedinherited

◆ m_spiceFieldsButton

◆ m_staticText12

wxStaticText* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_staticText12
protectedinherited

◆ m_staticTextFootprints

wxStaticText* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_staticTextFootprints
protectedinherited

◆ m_staticTextNbUnits

wxStaticText* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_staticTextNbUnits
protectedinherited

◆ m_stdSizerButton

wxStdDialogButtonSizer* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_stdSizerButton
protectedinherited

◆ m_stdSizerButtonCancel

wxButton* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_stdSizerButtonCancel
protectedinherited

◆ m_stdSizerButtonOK

wxButton* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::m_stdSizerButtonOK
protectedinherited

◆ m_SymbolNameCtrl

◆ m_units

◆ m_width

int DIALOG_EDIT_COMPONENT_IN_LIBRARY::m_width

Definition at line 63 of file dialog_edit_component_in_lib.h.

Referenced by adjustGridColumns(), and OnSizeGrid().

◆ staticAliasKeywordsLabel

wxStaticText* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::staticAliasKeywordsLabel
protectedinherited

◆ staticKeywordsLabel

wxStaticText* DIALOG_EDIT_COMPONENT_IN_LIBRARY_BASE::staticKeywordsLabel
protectedinherited

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