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_PART *aLibEntry)
 Constructors. More...
 
 ~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)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

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

Public Attributes

SYMBOL_EDIT_FRAMEm_Parent
 
LIB_PARTm_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
 
int m_width
 

Protected Member Functions

bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
bool Validate () override
 
virtual void onPowerCheckBox (wxCommandEvent &aEvent) override
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 
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...
 

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_OptionPartsLocked
 
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_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private 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 (int aWidth)
 
void syncControlStates (bool aIsAlias)
 

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 42 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_PART aLibEntry 
)

Constructors.

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 ),
59  m_delayedFocusRow( -1 ),
61  m_delayedFocusPage( -1 ),
62  m_width( 0 )
63 {
64  // Give a bit more room for combobox editors
65  m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
66  m_fields = new FIELDS_GRID_TABLE<LIB_FIELD>( this, aParent, m_libEntry );
68  m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this ) );
69 
70  // Show/hide columns according to the user's preference
71  auto cfg = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
72  m_grid->ShowHideColumns( cfg->m_EditComponentVisibleColumns );
73 
74  wxGridCellAttr* attr = new wxGridCellAttr;
75  attr->SetEditor( new GRID_CELL_URL_EDITOR( this ) );
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( small_plus_xpm ) );
82  m_bpDelete->SetBitmap( KiBitmap( trash_xpm ) );
83  m_bpMoveUp->SetBitmap( KiBitmap( small_up_xpm ) );
84  m_bpMoveDown->SetBitmap( KiBitmap( small_down_xpm ) );
85  m_addFilterButton->SetBitmap( KiBitmap( small_plus_xpm ) );
86  m_deleteFilterButton->SetBitmap( KiBitmap( trash_xpm ) );
88 
89  m_stdSizerButtonOK->SetDefault();
90 
91 #ifndef KICAD_SPICE
92  m_spiceFieldsButton->Hide();
93 #endif
94 
95  // wxFormBuilder doesn't include this event...
96  m_grid->Connect( wxEVT_GRID_CELL_CHANGING,
98  NULL, this );
99 
101  {
102  if( ( m_lastLayout == DIALOG_LIB_SYMBOL_PROPERTIES::ALIAS && aLibEntry->IsRoot() )
103  || ( m_lastLayout == DIALOG_LIB_SYMBOL_PROPERTIES::PARENT && aLibEntry->IsAlias() ) )
104  {
105  resetSize();
106  }
107  }
108 
111 
112  m_grid->GetParent()->Layout();
114  Layout();
115 
117 }
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:34
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:127
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:65
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
name of datasheet
Field Value of part, i.e. "3.3K".
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:82
#define NULL
const BITMAP_OPAQUE small_down_xpm[1]
Definition: small_down.cpp:24
const BITMAP_OPAQUE small_up_xpm[1]
Definition: small_up.cpp:25
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
const BITMAP_OPAQUE small_edit_xpm[1]
Definition: small_edit.cpp:25
bool IsAlias() const
void resetSize()
Clear the existing dialog size and position.
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
A text control validator used for validating the text allowed in library and schematic component fiel...
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)
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20

References ALIAS, DATASHEET_FIELD, FDC_VALUE, DIALOG_SHIM::finishDialogSettings(), LIB_PART::IsAlias(), LIB_PART::IsRoot(), 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, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, m_lastLayout, m_libEntry, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_spiceFieldsButton, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_stdSizerButtonOK, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SymbolNameCtrl, NONE, NULL, OnGridCellChanging(), PARENT, Pgm(), DIALOG_SHIM::resetSize(), WX_GRID::SetTable(), WX_GRID::ShowHideColumns(), small_down_xpm, small_edit_xpm, small_plus_xpm, small_up_xpm, syncControlStates(), trash_xpm, and VALUE_FIELD.

◆ ~DIALOG_LIB_SYMBOL_PROPERTIES()

DIALOG_LIB_SYMBOL_PROPERTIES::~DIALOG_LIB_SYMBOL_PROPERTIES ( )

Definition at line 120 of file dialog_lib_symbol_properties.cpp.

121 {
122  m_lastOpenedPage = m_NoteBook->GetSelection( );
123 
124  auto cfg = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
126 
127  // Prevents crash bug in wxGrid's d'tor
129 
130  m_grid->Disconnect( wxEVT_GRID_CELL_CHANGING,
132  NULL, this );
133 
134  // Delete the GRID_TRICKS.
135  m_grid->PopEventHandler( true );
136 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
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:96
#define NULL
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:109

References WX_GRID::DestroyTable(), WX_GRID::GetShownColumns(), SYMBOL_EDITOR_SETTINGS::m_EditComponentVisibleColumns, m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, m_lastOpenedPage, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_NoteBook, NULL, OnGridCellChanging(), and Pgm().

Member Function Documentation

◆ adjustGridColumns()

void DIALOG_LIB_SYMBOL_PROPERTIES::adjustGridColumns ( int  aWidth)
private

Definition at line 650 of file dialog_lib_symbol_properties.cpp.

651 {
652  m_width = aWidth;
653 
654  // Account for scroll bars
655  aWidth -= ( m_grid->GetSize().x - m_grid->GetClientSize().x );
656 
657  m_grid->AutoSizeColumn( FDC_NAME );
658 
659  int fixedColsWidth = m_grid->GetColSize( FDC_NAME );
660 
661  for( int i = 2; i < m_grid->GetNumberCols(); i++ )
662  fixedColsWidth += m_grid->GetColSize( i );
663 
664  m_grid->SetColSize( FDC_VALUE, aWidth - fixedColsWidth );
665 }

References FDC_NAME, FDC_VALUE, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, and m_width.

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

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 269 of file dialog_shim.cpp.

270 {
271  // so we can do logging of this state change:
272  return wxDialog::Enable( enable );
273 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 406 of file dialog_shim.cpp.

407 {
408  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
409  // handle validation in the same way as other dialogs.
410  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
411  return;
412 
413  SetReturnCode( retCode );
414 
415  if( !IsQuasiModal() )
416  {
417  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
418  "wasn't called" );
419  return;
420  }
421 
422  if( m_qmodal_loop )
423  {
424  if( m_qmodal_loop->IsRunning() )
425  m_qmodal_loop->Exit( 0 );
426  else
427  m_qmodal_loop->ScheduleExit( 0 );
428 
430  }
431 
434 
435  Show( false );
436 }
bool IsQuasiModal() const
Definition: dialog_shim.h:123
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:199
#define NULL
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:202

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_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 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 147 of file dialog_shim.cpp.

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

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 165 of file dialog_shim.cpp.

166 {
167  wxSize sz( x, 0 );
168  return ConvertDialogToPixels( sz ).x;
169 }

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

◆ IsCtrl()

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

Definition at line 136 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), LIB_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAddField()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 450 of file dialog_lib_symbol_properties.cpp.

451 {
452  if( !m_grid->CommitPendingChanges() )
453  return;
454 
455  auto* settings = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
456  int fieldID = m_fields->size();
457  LIB_FIELD newField( m_libEntry, fieldID );
458 
459  newField.SetTextSize( wxSize( Mils2iu( settings->m_Defaults.text_size ),
460  Mils2iu( settings->m_Defaults.text_size ) ) );
461 
462  m_fields->push_back( newField );
463 
464  // notify the grid
465  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
466  m_grid->ProcessTableMessage( msg );
467 
468  m_grid->MakeCellVisible( (int) m_fields->size() - 1, 0 );
469  m_grid->SetGridCursor( (int) m_fields->size() - 1, 0 );
470 
471  m_grid->EnableCellEditControl();
472  m_grid->ShowCellEditControl();
473 }
Field object used in symbol libraries.
Definition: lib_field.h:59
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:180
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

References WX_GRID::CommitPendingChanges(), m_fields, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_grid, m_libEntry, Pgm(), and EDA_TEXT::SetTextSize().

◆ OnAddFootprintFilter()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnAddFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 600 of file dialog_lib_symbol_properties.cpp.

601 {
602  wxString filterLine;
603  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Filter:" ), _( "Add Footprint Filter" ), filterLine );
604 
605  if( dlg.ShowModal() == wxID_CANCEL || dlg.GetValue().IsEmpty() )
606  return;
607 
608  filterLine = dlg.GetValue();
609  filterLine.Replace( wxT( " " ), wxT( "_" ) );
610 
611  // duplicate filters do no harm, so don't be a nanny.
612 
613  m_FootprintFilterListBox->Append( filterLine );
614  m_FootprintFilterListBox->SetSelection( (int) m_FootprintFilterListBox->GetCount() - 1 );
615 }
A KICAD version of wxTextEntryDialog which supports the various improvments/work-arounds from DIALOG_...
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by OnFilterDClick().

◆ OnCancelButtonClick()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 592 of file dialog_lib_symbol_properties.cpp.

593 {
594  // Running the Footprint Browser gums up the works and causes the automatic cancel
595  // stuff to no longer work. So we do it here ourselves.
596  EndQuasiModal( wxID_CANCEL );
597 }
void EndQuasiModal(int retCode)

References DIALOG_SHIM::EndQuasiModal().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_COMPONENT, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 497 of file dialog_shim.cpp.

498 {
499  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
500  {
501  if( m_parentFrame )
502  {
504  return;
505  }
506  }
507  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
508  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
509  {
510  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
511  return;
512  }
513  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
514  {
515  wxWindow* currentWindow = wxWindow::FindFocus();
516  int currentIdx = -1;
517  int delta = aEvt.ShiftDown() ? -1 : 1;
518 
519  auto advance = [&]( int& idx )
520  {
521  // Wrap-around modulus
522  int size = m_tabOrder.size();
523  idx = ( ( idx + delta ) % size + size ) % size;
524  };
525 
526  for( size_t i = 0; i < m_tabOrder.size(); ++i )
527  {
528  if( m_tabOrder[i] == currentWindow )
529  {
530  currentIdx = (int) i;
531  break;
532  }
533  }
534 
535  if( currentIdx >= 0 )
536  {
537  advance( currentIdx );
538 
539  //todo: We don't currently have non-textentry dialog boxes but this will break if
540  // we add them.
541 #ifdef __APPLE__
542  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
543  advance( currentIdx );
544 #endif
545 
546  m_tabOrder[ currentIdx ]->SetFocus();
547  return;
548  }
549  }
550 
551  aEvt.Skip();
552 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:206
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:204
virtual void ToggleUserUnits()

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

◆ OnDeleteField()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 476 of file dialog_lib_symbol_properties.cpp.

477 {
478  int curRow = m_grid->GetGridCursorRow();
479 
480  if( curRow < 0 )
481  {
482  return;
483  }
484  else if( curRow < MANDATORY_FIELDS )
485  {
486  DisplayError( this, wxString::Format( _( "The first %d fields are mandatory." ),
487  MANDATORY_FIELDS ) );
488  return;
489  }
490 
491  m_grid->CommitPendingChanges( true /* quiet mode */ );
492 
493  m_fields->erase( m_fields->begin() + curRow );
494 
495  // notify the grid
496  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, curRow, 1 );
497  m_grid->ProcessTableMessage( msg );
498 
499  if( m_grid->GetNumberRows() > 0 )
500  {
501  m_grid->MakeCellVisible( std::max( 0, curRow-1 ), m_grid->GetGridCursorCol() );
502  m_grid->SetGridCursor( std::max( 0, curRow-1 ), m_grid->GetGridCursorCol() );
503  }
504 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
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:180
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33

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

◆ OnDeleteFootprintFilter()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 618 of file dialog_lib_symbol_properties.cpp.

619 {
620  int ii = m_FootprintFilterListBox->GetSelection();
621 
622  if( ii >= 0 )
623  {
624  m_FootprintFilterListBox->Delete( (unsigned) ii );
625 
626  if( m_FootprintFilterListBox->GetCount() == 0 )
627  m_FootprintFilterListBox->SetSelection( wxNOT_FOUND );
628  else
629  m_FootprintFilterListBox->SetSelection( std::max( 0, ii - 1 ) );
630  }
631 }

References DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_FootprintFilterListBox.

◆ OnEditFootprintFilter()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnEditFootprintFilter ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 634 of file dialog_lib_symbol_properties.cpp.

635 {
636  int idx = m_FootprintFilterListBox->GetSelection();
637 
638  if( idx >= 0 )
639  {
640  wxString filter = m_FootprintFilterListBox->GetStringSelection();
641 
642  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Filter:" ), _( "Edit Footprint Filter" ), filter );
643 
644  if( dlg.ShowModal() == wxID_OK && !dlg.GetValue().IsEmpty() )
645  m_FootprintFilterListBox->SetString( (unsigned) idx, dlg.GetValue() );
646  }
647 }
A KICAD version of wxTextEntryDialog which supports the various improvments/work-arounds from DIALOG_...
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by OnFilterDClick().

◆ OnEditSpiceModel()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 551 of file dialog_lib_symbol_properties.cpp.

552 {
553 #ifdef KICAD_SPICE
554  int diff = m_fields->size();
555  auto cmp = SCH_COMPONENT( *m_libEntry, m_libEntry->GetLibId(), nullptr );
556 
557  DIALOG_SPICE_MODEL dialog( this, cmp, m_fields );
558 
559  if( dialog.ShowModal() != wxID_OK )
560  return;
561 
562  diff = (int) m_fields->size() - diff;
563 
564  if( diff > 0 )
565  {
566  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, diff );
567  m_grid->ProcessTableMessage( msg );
568  }
569  else if( diff < 0 )
570  {
571  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, 0, -diff );
572  m_grid->ProcessTableMessage( msg );
573  }
574 
575  m_grid->ForceRefresh();
576 #endif /* KICAD_SPICE */
577 }
LIB_ID GetLibId() const override
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
Schematic symbol object.
Definition: sch_component.h:79

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

◆ OnFilterDClick()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnFilterDClick ( wxMouseEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 580 of file dialog_lib_symbol_properties.cpp.

581 {
582  int idx = m_FootprintFilterListBox->HitTest( event.GetPosition() );
583  wxCommandEvent dummy;
584 
585  if( idx >= 0 )
587  else
589 }
void OnEditFootprintFilter(wxCommandEvent &event) override
void OnAddFootprintFilter(wxCommandEvent &event) override
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.

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 392 of file dialog_lib_symbol_properties.cpp.

393 {
394  wxGridCellEditor* editor = m_grid->GetCellEditor( event.GetRow(), event.GetCol() );
395  wxControl* control = editor->GetControl();
396 
397  if( control && control->GetValidator() && !control->GetValidator()->Validate( control ) )
398  {
399  event.Veto();
400 
402  m_delayedFocusRow = event.GetRow();
403  m_delayedFocusColumn = event.GetCol();
404  m_delayedFocusPage = 0;
405  }
406  else if( event.GetCol() == FDC_NAME )
407  {
408  wxString newName = event.GetString();
409 
410  for( int i = 0; i < m_grid->GetNumberRows(); ++i )
411  {
412  if( i == event.GetRow() )
413  continue;
414 
415  if( newName.CmpNoCase( m_grid->GetCellValue( i, FDC_NAME ) ) == 0 )
416  {
417  DisplayError( this, wxString::Format( _( "The name '%s' is already in use." ),
418  newName ) );
419  event.Veto();
420  m_delayedFocusRow = event.GetRow();
421  m_delayedFocusColumn = event.GetCol();
422  }
423  }
424  }
425  else if( event.GetRow() == VALUE_FIELD && event.GetCol() == FDC_VALUE )
426  m_SymbolNameCtrl->ChangeValue( event.GetString() );
427 
428  editor->DecRef();
429 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
Field Value of part, i.e. "3.3K".
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33

References _, DisplayError(), 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().

◆ OnMoveDown()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveDown ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 529 of file dialog_lib_symbol_properties.cpp.

530 {
531  if( !m_grid->CommitPendingChanges() )
532  return;
533 
534  int i = m_grid->GetGridCursorRow();
535 
536  if( i >= MANDATORY_FIELDS && i + 1 < m_fields->GetNumberRows() )
537  {
538  LIB_FIELD tmp = m_fields->at( (unsigned) i );
539  m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
540  m_fields->insert( m_fields->begin() + i + 1, tmp );
541  m_grid->ForceRefresh();
542 
543  m_grid->SetGridCursor( i + 1, m_grid->GetGridCursorCol() );
544  m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
545  }
546  else
547  wxBell();
548 }
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:180
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

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

◆ OnMoveUp()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveUp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 507 of file dialog_lib_symbol_properties.cpp.

508 {
509  if( !m_grid->CommitPendingChanges() )
510  return;
511 
512  int i = m_grid->GetGridCursorRow();
513 
514  if( i > MANDATORY_FIELDS )
515  {
516  LIB_FIELD tmp = m_fields->at( (unsigned) i );
517  m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
518  m_fields->insert( m_fields->begin() + i - 1, tmp );
519  m_grid->ForceRefresh();
520 
521  m_grid->SetGridCursor( i - 1, m_grid->GetGridCursorCol() );
522  m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
523  }
524  else
525  wxBell();
526 }
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:180
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields

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

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 313 of file dialog_shim.cpp.

314 {
315  if( m_firstPaintEvent )
316  {
318 
319  selectAllInTextCtrls( GetChildren() );
320 
323  else
324  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
325 
326  m_firstPaintEvent = false;
327  }
328 
329  event.Skip();
330 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:197
bool m_firstPaintEvent
Definition: dialog_shim.h:196
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:56
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ 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 744 of file dialog_lib_symbol_properties.cpp.

745 {
746  auto new_size = event.GetSize().GetX();
747 
748  if( new_size != m_width )
749  {
750  adjustGridColumns( event.GetSize().GetX() );
751  }
752 
753  // Always propagate a wxSizeEvent:
754  event.Skip();
755 }

References adjustGridColumns(), and m_width.

◆ OnSymbolNameKillFocus()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnSymbolNameKillFocus ( wxFocusEvent &  event)
overrideprivatevirtual

◆ OnSymbolNameText()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnSymbolNameText ( wxCommandEvent &  event)
overrideprivatevirtual

◆ OnUpdateUI()

void DIALOG_LIB_SYMBOL_PROPERTIES::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_LIB_SYMBOL_PROPERTIES_BASE.

Definition at line 668 of file dialog_lib_symbol_properties.cpp.

669 {
670  m_OptionPartsLocked->Enable( m_SelNumberOfUnits->GetValue() > 1 );
672 
673  if( m_grid->IsCellEditControlShown() )
674  {
675  int row = m_grid->GetGridCursorRow();
676  int col = m_grid->GetGridCursorCol();
677 
678  if( row == VALUE_FIELD && col == FDC_VALUE )
679  {
680  wxGridCellEditor* editor = m_grid->GetCellEditor( row, col );
681  m_SymbolNameCtrl->ChangeValue( editor->GetValue() );
682  editor->DecRef();
683  }
684  }
685 
686  // Handle shown columns changes
687  wxString shownColumns = m_grid->GetShownColumns();
688 
689  if( shownColumns != m_shownColumns )
690  {
691  m_shownColumns = shownColumns;
692 
693  if( !m_grid->IsCellEditControlShown() )
694  adjustGridColumns( m_grid->GetRect().GetWidth() );
695  }
696 
697  // Handle a delayed focus. The delay allows us to:
698  // a) change focus when the error was triggered from within a killFocus handler
699  // b) show the correct notebook page in the background before the error dialog comes up
700  // when triggered from an OK or a notebook page change
701 
702  if( m_delayedFocusPage >= 0 && m_NoteBook->GetSelection() != m_delayedFocusPage )
703  {
704  m_NoteBook->SetSelection( (unsigned) m_delayedFocusPage );
705  m_delayedFocusPage = -1;
706  }
707 
708  if( !m_delayedErrorMessage.IsEmpty() )
709  {
710  // We will re-enter this routine when the error dialog is displayed, so make
711  // sure we don't keep putting up more dialogs.
712  wxString msg = m_delayedErrorMessage;
713  m_delayedErrorMessage = wxEmptyString;
714 
715  // Do not use DisplayErrorMessage(); it screws up window order on Mac
716  DisplayError( nullptr, msg );
717  }
718 
719  if( m_delayedFocusCtrl )
720  {
721  m_delayedFocusCtrl->SetFocus();
722 
723  if( auto textEntry = dynamic_cast<wxTextEntry*>( m_delayedFocusCtrl ) )
724  textEntry->SelectAll();
725 
726  m_delayedFocusCtrl = nullptr;
727  }
728  else if( m_delayedFocusGrid )
729  {
730  m_delayedFocusGrid->SetFocus();
733 
734  m_delayedFocusGrid->EnableCellEditControl( true );
735  m_delayedFocusGrid->ShowCellEditControl();
736 
737  m_delayedFocusGrid = nullptr;
738  m_delayedFocusRow = -1;
740  }
741 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
Field Value of part, i.e. "3.3K".
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:109
void Enable(bool aEnable)
Function Enable Enables/diasables the label, widget and units label.

References adjustGridColumns(), DisplayError(), 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_OptionPartsLocked, 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

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

Definition at line 35 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), 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_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SaveOneSymbol(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), 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 244 of file dialog_shim.cpp.

245 {
246  const char* hash_key;
247 
248  if( m_hash_key.size() )
249  {
250  // a special case like EDA_LIST_DIALOG, which has multiple uses.
251  hash_key = m_hash_key.c_str();
252  }
253  else
254  {
255  hash_key = typeid(*this).name();
256  }
257 
258  RECT_MAP::iterator it = class_map.find( hash_key );
259 
260  if( it == class_map.end() )
261  return;
262 
263  EDA_RECT rect = it->second;
264  rect.SetSize( 0, 0 );
265  class_map[ hash_key ] = rect;
266 }
std::string m_hash_key
Definition: dialog_shim.h:191
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

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

115  {
116  m_initialFocusTarget = aWindow;
117  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:197

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_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 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), 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 158 of file dialog_shim.cpp.

159 {
160  wxSize sz( x, y );
161  SetSize( ConvertDialogToPixels( sz ) );
162 }

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 185 of file dialog_shim.cpp.

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

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

Referenced by FOOTPRINT_EDITOR_TOOLS::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EE_INSPECTION_TOOL::RunERC(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 356 of file dialog_shim.cpp.

357 {
358  // This is an exception safe way to zero a pointer before returning.
359  // Yes, even though DismissModal() clears this first normally, this is
360  // here in case there's an exception before the dialog is dismissed.
361  struct NULLER
362  {
363  void*& m_what;
364  NULLER( void*& aPtr ) : m_what( aPtr ) {}
365  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
366  } clear_this( (void*&) m_qmodal_loop );
367 
368  // release the mouse if it's currently captured as the window having it
369  // will be disabled when this dialog is shown -- but will still keep the
370  // capture making it impossible to do anything in the modal dialog itself
371  wxWindow* win = wxWindow::GetCapture();
372  if( win )
373  win->ReleaseMouse();
374 
375  // Get the optimal parent
376  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
377 
378  wxASSERT_MSG( !m_qmodal_parent_disabler,
379  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
380 
381  // quasi-modal: disable only my "optimal" parent
383 
384  // Apple in its infinite wisdom will raise a disabled window before even passing
385  // us the event, so we have no way to stop it. Instead, we must set an order on
386  // the windows so that the quasi-modal will be pushed in front of the disabled
387  // window when it is raised.
389 
390  Show( true );
391 
392  m_qmodal_showing = true;
393 
394  WX_EVENT_LOOP event_loop;
395 
396  m_qmodal_loop = &event_loop;
397 
398  event_loop.Run();
399 
400  m_qmodal_showing = false;
401 
402  return GetReturnCode();
403 }
bool m_qmodal_showing
Definition: dialog_shim.h:201
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:199
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:202
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:42
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:50

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 S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), SCH_DRAWING_TOOLS::createNewText(), LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ syncControlStates()

◆ TransferDataFromWindow()

bool DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow ( )
overrideprotected

Definition at line 287 of file dialog_lib_symbol_properties.cpp.

288 {
289  if( !wxDialog::TransferDataFromWindow() )
290  return false;
291 
292  // We need to keep the name and the value the same at the moment!
293  wxString newName = m_fields->at( VALUE_FIELD ).GetText();
294  wxString oldName = m_libEntry->GetName();
295 
296  if( oldName != newName )
297  {
298  wxString libName = m_Parent->GetCurLib();
299 
300  if( m_Parent->GetLibManager().PartExists( newName, libName ) )
301  {
302  wxString msg;
303 
304  msg.Printf( _( "The name '%s' conflicts with an existing entry in the library '%s'." ),
305  newName, libName );
306  DisplayErrorMessage( this, msg );
307  return false;
308  }
309 
311  }
312  else
313  {
315  }
316 
317  // The Y axis for components in lib is from bottom to top while the screen axis is top
318  // to bottom: we must change the y coord sign when writing back to the library
319  for( size_t i = 0; i < m_fields->size(); ++i )
320  {
321  wxPoint pos = m_fields->at( i ).GetPosition();
322  pos.y = -pos.y;
323  m_fields->at( i ).SetPosition( pos );
324  }
325 
327 
328  // Update the parent for inherited symbols
329  if( m_libEntry->IsAlias() )
330  {
331  wxString parentName = m_inheritanceSelectCombo->GetValue();
332 
333  // The parentName was verified to be non-empty in the Validator
334  wxString libName = m_Parent->GetCurLib();
335 
336  // Get the parent from the libManager based on the name set in the inheritance combo box.
337  LIB_PART* newParent = m_Parent->GetLibManager().GetAlias( parentName, libName );
338 
339  // Verify that the requested parent exists
340  wxCHECK( newParent, false );
341 
342  // Verify that the new parent is not an alias.
343  wxCHECK( !newParent->IsAlias(), false );
344 
345  m_libEntry->SetParent( newParent );
346  }
347 
348  // We need to keep the name and the value the same at the moment!
349  m_libEntry->SetName( newName );
350  m_libEntry->SetDescription( m_DescCtrl->GetValue() );
351  m_libEntry->SetKeyWords( m_KeywordCtrl->GetValue() );
354  m_libEntry->SetConversion( m_AsConvertButt->GetValue() );
355 
356  if( m_OptionPower->GetValue() )
357  m_libEntry->SetPower();
358  else
360 
363 
366 
367  if( m_PinsNameInsideButt->GetValue() )
368  {
369  int offset = KiROUND( (double) m_pinNameOffset.GetValue() );
370 
371  // We interpret an offset of 0 as "outside", so make sure it's non-zero
372  m_libEntry->SetPinNameOffset( offset == 0 ? 20 : offset );
373  }
374  else
375  {
376  m_libEntry->SetPinNameOffset( 0 ); // pin text outside the body (name is on the pin)
377  }
378 
380 
382 
383  // It's possible that the symbol being edited has no pins, in which case there may be no
384  // alternate body style objects causing #LIB_PART::HasCoversion() to always return false.
385  // This allows the user to edit the alternate body style just in case this condition occurs.
386  m_Parent->SetShowDeMorgan( m_AsConvertButt->GetValue() );
387 
388  return true;
389 }
LIB_PART * GetAlias(const wxString &aAlias, const wxString &aLibrary) const
Returns either an alias of a working LIB_PART copy, or alias of the original part if there is no work...
void SetPower()
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:253
wxString GetName() const override
void SetShowDeMorgan(bool show)
bool PartExists(const wxString &aAlias, const wxString &aLibrary) const
Returns true if part with a specific alias exists in library (either original one or buffered).
void SetUnitCount(int aCount, bool aDuplicateDrawItems=true)
Set the units per part count.
void SetFootprintFilters(const wxArrayString &aFootprintFilters)
void SetIncludeInBom(bool aIncludeInBom)
Set or clear the include in schematic bill of materials flag.
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
Field Value of part, i.e. "3.3K".
void UpdateAfterSymbolProperties(wxString *aOldName=nullptr)
void SetConversion(bool aSetConvert, bool aDuplicatePins=true)
Set or clear the alternate body style (DeMorgan) for the part.
int GetUnitCount() const override
For items with units, return the number of units.
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.
void SetDescription(const wxString &aDescription)
SYMBOL_LIBRARY_MANAGER & GetLibManager()
void SetParent(LIB_PART *aParent=nullptr)
Define a library symbol object.
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
void SetShowPinNumbers(bool aShow)
Set or clear the pin number visibility flag.
#define _(s)
Definition: 3d_actions.cpp:33
void SetKeyWords(const wxString &aKeyWords)
bool IsAlias() const
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:68
virtual long long int GetValue()
Function GetValue Returns the current value in Internal Units.
virtual void SetName(const wxString &aName)
void SetIncludeOnBoard(bool aIncludeOnBoard)
Set or clear include in board netlist flag.
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.
void LockUnits(bool aLockUnits)
Set interchangeable the property for part units.
void SetNormal()

References _, DisplayErrorMessage(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_EDIT_FRAME::GetCurLib(), SYMBOL_EDIT_FRAME::GetLibManager(), LIB_PART::GetName(), LIB_PART::GetUnitCount(), UNIT_BINDER::GetValue(), LIB_PART::IsAlias(), KiROUND(), LIB_RENAME, LIB_PART::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_inheritanceSelectCombo, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_KeywordCtrl, m_libEntry, DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_OptionPartsLocked, 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_LIBRARY_MANAGER::PartExists(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetConversion(), LIB_PART::SetDescription(), LIB_PART::SetFields(), LIB_PART::SetFootprintFilters(), LIB_PART::SetIncludeInBom(), LIB_PART::SetIncludeOnBoard(), LIB_PART::SetKeyWords(), LIB_PART::SetName(), LIB_PART::SetNormal(), LIB_PART::SetParent(), LIB_PART::SetPinNameOffset(), LIB_PART::SetPower(), SYMBOL_EDIT_FRAME::SetShowDeMorgan(), LIB_PART::SetShowPinNames(), LIB_PART::SetShowPinNumbers(), LIB_PART::SetUnitCount(), SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties(), and VALUE_FIELD.

◆ TransferDataToWindow()

bool DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow ( )
overrideprotected

Definition at line 139 of file dialog_lib_symbol_properties.cpp.

140 {
141  if( !wxDialog::TransferDataToWindow() )
142  return false;
143 
144  // Push a copy of each field into m_updateFields
146 
147  // The Y axis for components in lib is from bottom to top while the screen axis is top
148  // to bottom: we must change the y coord sign for editing
149  for( size_t i = 0; i < m_fields->size(); ++i )
150  {
151  wxPoint pos = m_fields->at( i ).GetPosition();
152  pos.y = -pos.y;
153  m_fields->at( i ).SetPosition( pos );
154  }
155 
156  // notify the grid
157  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_fields->GetNumberRows() );
158  m_grid->ProcessTableMessage( msg );
159  adjustGridColumns( m_grid->GetRect().GetWidth() );
160 
161  m_SymbolNameCtrl->SetValue( m_libEntry->GetName() );
162 
163  m_DescCtrl->SetValue( m_libEntry->GetDescription() );
164  m_KeywordCtrl->SetValue( m_libEntry->GetKeyWords() );
167  m_AsConvertButt->SetValue( m_libEntry->HasConversion() );
168  m_OptionPower->SetValue( m_libEntry->IsPower() );
171 
173  m_ShowPinNameButt->SetValue( m_libEntry->ShowPinNames() );
174  m_PinsNameInsideButt->SetValue( m_libEntry->GetPinNameOffset() != 0 );
176 
177  wxArrayString tmp = m_libEntry->GetFootprints();
178  m_FootprintFilterListBox->Append( tmp );
179 
180  // Populate the list of root parts for inherited objects.
181  if( m_libEntry->IsAlias() )
182  {
183  wxArrayString rootSymbolNames;
184  wxString libName = m_Parent->GetCurLib();
185 
186  // Someone forgot to set the current library in the editor frame window.
187  wxCHECK( !libName.empty(), false );
188 
189  m_Parent->GetLibManager().GetRootSymbolNames( libName, rootSymbolNames );
190  m_inheritanceSelectCombo->Append( rootSymbolNames );
191 
192  PART_SPTR rootPart = m_libEntry->GetParent().lock();
193 
194  wxCHECK( rootPart, false );
195 
196  wxString parentName = rootPart->GetName();
197  int selection = m_inheritanceSelectCombo->FindString( parentName );
198 
199  wxCHECK( selection != wxNOT_FOUND, false );
200  m_inheritanceSelectCombo->SetSelection( selection );
201 
202  m_lastOpenedPage = 0;
203  }
204 
205  m_NoteBook->SetSelection( (unsigned) m_lastOpenedPage );
206 
207  return true;
208 }
void GetRootSymbolNames(const wxString &aLibName, wxArrayString &aRootSymbolNames)
int GetPinNameOffset()
int GetNumberRows() override
wxString GetName() const override
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
wxString GetKeyWords() const
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
bool ShowPinNames()
bool ShowPinNumbers()
int GetUnitCount() const override
For items with units, return the number of units.
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
SYMBOL_LIBRARY_MANAGER & GetLibManager()
PART_REF & GetParent()
wxString GetDescription() override
wxArrayString GetFootprints() const
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
bool IsPower() const
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
bool IsAlias() const
bool GetIncludeOnBoard() const
bool GetIncludeInBom() const
bool UnitsLocked() const
Check whether part units are interchangeable.
void GetFields(LIB_FIELDS &aList)
Return a list of fields within this part.

References adjustGridColumns(), SYMBOL_EDIT_FRAME::GetCurLib(), LIB_PART::GetDescription(), LIB_PART::GetFields(), LIB_PART::GetFootprints(), LIB_PART::GetIncludeInBom(), LIB_PART::GetIncludeOnBoard(), LIB_PART::GetKeyWords(), SYMBOL_EDIT_FRAME::GetLibManager(), LIB_PART::GetName(), FIELDS_GRID_TABLE< T >::GetNumberRows(), LIB_PART::GetParent(), LIB_PART::GetPinNameOffset(), SYMBOL_LIBRARY_MANAGER::GetRootSymbolNames(), LIB_PART::GetUnitCount(), LIB_PART::HasConversion(), LIB_PART::IsAlias(), LIB_PART::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_OptionPartsLocked, 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, UNIT_BINDER::SetValue(), LIB_PART::ShowPinNames(), LIB_PART::ShowPinNumbers(), and LIB_PART::UnitsLocked().

◆ Validate()

bool DIALOG_LIB_SYMBOL_PROPERTIES::Validate ( )
overrideprotected

Definition at line 211 of file dialog_lib_symbol_properties.cpp.

212 {
213  if( !m_grid->CommitPendingChanges() )
214  return false;
215 
216  // Alias symbol reference can be empty because it inherits from the parent symbol.
217  if( m_libEntry->IsRoot() &&
219  {
220  if( m_NoteBook->GetSelection() != 0 )
221  m_NoteBook->SetSelection( 0 );
222 
223  m_delayedErrorMessage = _( "References must start with a letter." );
227  m_delayedFocusPage = 0;
228 
229  return false;
230  }
231 
232  // Check for missing field names.
233  for( size_t i = MANDATORY_FIELDS; i < m_fields->size(); ++i )
234  {
235  LIB_FIELD& field = m_fields->at( i );
236  wxString fieldName = field.GetName( false );
237 
238  if( fieldName.IsEmpty() )
239  {
240  if( m_NoteBook->GetSelection() != 0 )
241  m_NoteBook->SetSelection( 0 );
242 
243  m_delayedErrorMessage = _( "Fields must have a name." );
246  m_delayedFocusRow = i;
247  m_delayedFocusPage = 0;
248 
249  return false;
250  }
251  }
252 
253  // Verify that the parent name is set if the symbol is inherited
254  if( m_libEntry->IsAlias() )
255  {
256  wxString parentName = m_inheritanceSelectCombo->GetValue();
257 
258  if( parentName.IsEmpty() )
259  {
260  m_delayedErrorMessage = _( "Aliased symbol must have a parent selected" );
261 
262  return false;
263  }
264  }
265 
266  if( m_SelNumberOfUnits->GetValue() < m_libEntry->GetUnitCount() )
267  {
268  if( !IsOK( this, _( "Delete extra units from symbol?" ) ) )
269  return false;
270  }
271 
272  if( m_AsConvertButt->GetValue() && !m_libEntry->HasConversion() )
273  {
274  if( !IsOK( this, _( "Add new pins for alternate body style (DeMorgan) to symbol?" ) ) )
275  return false;
276  }
277  else if( !m_AsConvertButt->GetValue() && m_libEntry->HasConversion() )
278  {
279  if( !IsOK( this, _( "Delete alternate body style (DeMorgan) draw items from symbol?" ) ) )
280  return false;
281  }
282 
283  return true;
284 }
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
wxString GetName(bool aUseDefaultName=true) const
Returns the field name.
Definition: lib_field.cpp:365
int GetUnitCount() const override
For items with units, return the number of units.
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:180
FIELDS_GRID_TABLE< LIB_FIELD > * m_fields
#define _(s)
Definition: 3d_actions.cpp:33
bool IsAlias() const
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
Field Reference of part, i.e. "IC21".
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:284

References _, WX_GRID::CommitPendingChanges(), FDC_NAME, FDC_VALUE, LIB_FIELD::GetName(), LIB_PART::GetUnitCount(), LIB_PART::HasConversion(), LIB_PART::IsAlias(), IsOK(), SCH_COMPONENT::IsReferenceStringValid(), LIB_PART::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 172 of file dialog_shim.cpp.

173 {
174  wxSize sz( 0, y );
175  return ConvertDialogToPixels( sz ).y;
176 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

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

wxCheckBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_AsConvertButt
protectedinherited

◆ m_bpAdd

◆ m_bpDelete

◆ m_bpMoveDown

◆ m_bpMoveUp

◆ m_delayedErrorMessage

wxString DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedErrorMessage

Definition at line 63 of file dialog_lib_symbol_properties.h.

Referenced by OnUpdateUI(), and Validate().

◆ m_delayedFocusColumn

int DIALOG_LIB_SYMBOL_PROPERTIES::m_delayedFocusColumn

Definition at line 61 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 58 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 59 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 60 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

wxTextCtrl* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_DescCtrl
protectedinherited

◆ m_editFilterButton

wxBitmapButton* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_editFilterButton
protectedinherited

◆ m_excludeFromBoardCheckBox

wxCheckBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_excludeFromBoardCheckBox
protectedinherited

◆ m_excludeFromBomCheckBox

wxCheckBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_excludeFromBomCheckBox
protectedinherited

◆ m_fields

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 196 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_FootprintFilterListBox

◆ m_grid

◆ m_hash_key

◆ m_inheritanceSelectCombo

wxComboBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_inheritanceSelectCombo
protectedinherited

◆ m_inheritsStaticText

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_inheritsStaticText
protectedinherited

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 197 of file dialog_shim.h.

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

◆ m_KeywordCtrl

wxTextCtrl* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_KeywordCtrl
protectedinherited

◆ m_lastLayout

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

Definition at line 48 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

LIB_PART* DIALOG_LIB_SYMBOL_PROPERTIES::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_OptionPartsLocked

wxCheckBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_OptionPartsLocked
protectedinherited

◆ 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

SYMBOL_EDIT_FRAME* DIALOG_LIB_SYMBOL_PROPERTIES::m_Parent

Definition at line 51 of file dialog_lib_symbol_properties.h.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 204 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_pinNameOffset

UNIT_BINDER DIALOG_LIB_SYMBOL_PROPERTIES::m_pinNameOffset

◆ m_PinsNameInsideButt

wxCheckBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_PinsNameInsideButt
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_SelNumberOfUnits

wxSpinCtrl* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_SelNumberOfUnits
protectedinherited

◆ m_shownColumns

wxString DIALOG_LIB_SYMBOL_PROPERTIES::m_shownColumns

Definition at line 65 of file dialog_lib_symbol_properties.h.

Referenced by OnUpdateUI().

◆ m_ShowPinNameButt

wxCheckBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_ShowPinNameButt
protectedinherited

◆ m_ShowPinNumButt

wxCheckBox* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::m_ShowPinNumButt
protectedinherited

◆ m_spiceFieldsButton

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

◆ m_width

int DIALOG_LIB_SYMBOL_PROPERTIES::m_width

Definition at line 66 of file dialog_lib_symbol_properties.h.

Referenced by adjustGridColumns(), and OnSizeGrid().

◆ staticKeywordsLabel

wxStaticText* DIALOG_LIB_SYMBOL_PROPERTIES_BASE::staticKeywordsLabel
protectedinherited

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