KiCad PCB EDA Suite
DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB Class Reference
Inheritance diagram for DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB:
DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB (LIB_EDIT_FRAME *aParent, LIB_PART *aLibEntry)
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) 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...
 

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 FixOSXCancelButtonIssue ()
 A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms. More...
 

Protected Attributes

wxListCtrl * fieldListCtrl
 
wxBitmapButton * moveUpButton
 
wxBitmapButton * moveDownButton
 
wxBitmapButton * deleteFieldButton
 
wxBitmapButton * addFieldButton
 
wxButton * m_spiceFieldsButton
 
wxRadioBox * m_FieldHJustifyCtrl
 
wxRadioBox * m_FieldVJustifyCtrl
 
wxCheckBox * showCheckBox
 
wxCheckBox * rotateCheckBox
 
wxRadioBox * m_StyleRadioBox
 
wxStaticText * fieldNameLabel
 
wxTextCtrl * fieldNameTextCtrl
 
wxStaticText * fieldValueLabel
 
wxTextCtrl * fieldValueTextCtrl
 
wxButton * m_show_datasheet_button
 
wxStaticText * textSizeLabel
 
wxTextCtrl * textSizeTextCtrl
 
wxStaticText * m_staticTextUnitSize
 
wxStaticText * posXLabel
 
wxTextCtrl * posXTextCtrl
 
wxStaticText * m_staticTextUnitPosX
 
wxStaticText * posYLabel
 
wxTextCtrl * posYTextCtrl
 
wxStaticText * m_staticTextUnitPosY
 
wxStaticLine * m_staticline1
 
wxStdDialogButtonSizer * stdDialogButtonSizer
 
wxButton * stdDialogButtonSizerOK
 
wxButton * stdDialogButtonSizerCancel
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

void OnInitDialog (wxInitDialogEvent &event) override
 
void OnCloseDialog (wxCloseEvent &event) override
 
void OnListItemDeselected (wxListEvent &event) override
 
void OnListItemSelected (wxListEvent &event) override
 
void addFieldButtonHandler (wxCommandEvent &event) override
 
void EditSpiceModel (wxCommandEvent &event) override
 
void deleteFieldButtonHandler (wxCommandEvent &event) override
 Function deleteFieldButtonHandler deletes a field. More...
 
void moveUpButtonHandler (wxCommandEvent &event) override
 
void moveDownButtonHandler (wxCommandEvent &event) override
 
void OnCancelButtonClick (wxCommandEvent &event) override
 
void OnOKButtonClick (wxCommandEvent &event) override
 
void showButtonHandler (wxCommandEvent &event) override
 
void setSelectedFieldNdx (int aFieldNdx)
 
int getSelectedFieldNdx ()
 
void initBuffers ()
 Function initBuffers sets up to edit the given component. More...
 
LIB_FIELDfindField (const wxString &aFieldName)
 Function findField searches m_FieldsBuf and returns a LIB_FIELD with aFieldName or NULL if not found. More...
 
void copySelectedFieldToPanel ()
 Function copySelectedFieldToPanel sets the values displayed on the panel according to the currently selected field row. More...
 
bool copyPanelToSelectedField ()
 Function copyPanelToSelectedField copies the values displayed on the panel fields to the currently selected field. More...
 
void setRowItem (int aFieldNdx, const wxString &aName, const wxString &aValue)
 
void setRowItem (int aFieldNdx, const LIB_FIELD &aField)
 
void updateDisplay ()
 Function updateDisplay update the listbox showing fields, according to the fields texts must be called after a text change in fields, if this change is not an edition. More...
 

Private Attributes

LIB_EDIT_FRAMEm_parent
 
LIB_PARTm_libEntry
 
bool m_skipCopyFromPanel
 
std::vector< LIB_FIELDm_FieldsBuf
 a copy of the edited component's LIB_FIELDs More...
 

Detailed Description

Definition at line 61 of file dialog_edit_libentry_fields_in_lib.cpp.

Constructor & Destructor Documentation

DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB ( LIB_EDIT_FRAME aParent,
LIB_PART aLibEntry 
)

Definition at line 174 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::addFieldButton, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::deleteFieldButton, KiBitmap(), m_libEntry, m_parent, m_skipCopyFromPanel, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_spiceFieldsButton, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::moveDownButton, and DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::moveUpButton.

176  :
178 {
179  m_parent = aParent;
180  m_libEntry = aLibEntry;
181  m_skipCopyFromPanel = false;
182 
183 #ifndef KICAD_SPICE
184  m_spiceFieldsButton->Show(false);
185 #endif
186 
187  // Configure button logos
188  addFieldButton->SetBitmap( KiBitmap( plus_xpm ) );
189  deleteFieldButton->SetBitmap( KiBitmap( minus_xpm ) );
190  moveUpButton->SetBitmap( KiBitmap( go_up_xpm ) );
191  moveDownButton->SetBitmap( KiBitmap( go_down_xpm ) );
192 }
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:36
DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Field Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxCAPTION|wxCLOSE_BOX|wxDEFAULT_DIALOG_STYLE|wxMAXIMIZE_BOX|wxMINIMIZE_BOX|wxRESIZE_BORDER|wxSYSTEM_MENU)

Member Function Documentation

void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::addFieldButtonHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 365 of file dialog_edit_libentry_fields_in_lib.cpp.

References copyPanelToSelectedField(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), m_FieldsBuf, m_skipCopyFromPanel, setRowItem(), and setSelectedFieldNdx().

366 {
367  // in case m_FieldsBuf[REFERENCE].m_Orient has changed on screen only, grab
368  // screen contents.
369  if( !copyPanelToSelectedField() )
370  return;
371 
372  unsigned fieldNdx = m_FieldsBuf.size();
373 
374  LIB_FIELD blank( fieldNdx );
375 
376  m_FieldsBuf.push_back( blank );
377  m_FieldsBuf[fieldNdx].SetName( TEMPLATE_FIELDNAME::GetDefaultFieldName( fieldNdx ) );
378 
379  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx] );
380 
381  m_skipCopyFromPanel = true;
382  setSelectedFieldNdx( fieldNdx );
383  m_skipCopyFromPanel = false;
384 }
bool copyPanelToSelectedField()
Function copyPanelToSelectedField copies the values displayed on the panel fields to the currently se...
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
static const wxString GetDefaultFieldName(int aFieldNdx)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
bool DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::copyPanelToSelectedField ( )
private

Function copyPanelToSelectedField copies the values displayed on the panel fields to the currently selected field.

Returns
bool - true if all fields are OK, else false if the user has put bad data into a field, and this value can be used to deny a row change.

Definition at line 835 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldNameTextCtrl, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldValueTextCtrl, g_UserUnit, LIB_FIELD::GetId(), getSelectedFieldNdx(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_FieldHJustifyCtrl, m_FieldsBuf, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_FieldVJustifyCtrl, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_StyleRadioBox, MANDATORY_FIELDS, name, EDA_GRAPHIC_TEXT_CTRL::ParseSize(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posXTextCtrl, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posYTextCtrl, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::rotateCheckBox, EDA_TEXT::SetBold(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), LIB_FIELD::SetName(), setRowItem(), LIB_FIELD::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::showCheckBox, TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::textSizeTextCtrl, VALUE, ValueFromString(), and wxPoint::y.

Referenced by addFieldButtonHandler(), moveDownButtonHandler(), moveUpButtonHandler(), OnListItemDeselected(), and OnOKButtonClick().

836 {
837  unsigned fieldNdx = getSelectedFieldNdx();
838 
839  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
840  return true;
841 
842  // Check for illegal field text.
843  if( fieldValueTextCtrl->GetValidator()
844  && !fieldValueTextCtrl->GetValidator()->Validate( this ) )
845  return false;
846 
847  LIB_FIELD& field = m_FieldsBuf[fieldNdx];
848 
849  if( showCheckBox->GetValue() )
850  field.SetVisible( true );
851  else
852  field.SetVisible( false );
853 
854  if( rotateCheckBox->GetValue() )
855  field.SetTextAngle( TEXT_ANGLE_VERT );
856  else
858 
859  // Copy the text justification
860  static const EDA_TEXT_HJUSTIFY_T hjustify[3] = {
863  };
864 
865  static const EDA_TEXT_VJUSTIFY_T vjustify[3] = {
868  };
869 
870  field.SetHorizJustify( hjustify[m_FieldHJustifyCtrl->GetSelection()] );
871  field.SetVertJustify( vjustify[m_FieldVJustifyCtrl->GetSelection()] );
872 
873  // Blank/empty field texts for REFERENCE and VALUE are not allowed.
874  // (Value is the name of the component in lib!)
875  // Change them only if user provided a non blank value
876  if( !fieldValueTextCtrl->GetValue().IsEmpty() || fieldNdx > VALUE )
877  field.SetText( fieldValueTextCtrl->GetValue() );
878 
879  // FieldNameTextCtrl has a tricked value in it for VALUE index, do not copy it back.
880  // It has the "Chip Name" appended.
881  if( field.GetId() >= MANDATORY_FIELDS )
882  {
883  wxString name = fieldNameTextCtrl->GetValue();
884  field.SetName( name );
885  }
886 
887  setRowItem( fieldNdx, field ); // update fieldListCtrl
888 
890 
891  field.SetTextSize( wxSize( tmp, tmp ) );
892 
893  int style = m_StyleRadioBox->GetSelection();
894 
895  field.SetItalic( (style & 1 ) != 0 );
896  field.SetBold( (style & 2 ) != 0 );
897 
898  wxPoint pos( ValueFromString( g_UserUnit, posXTextCtrl->GetValue() ),
899  ValueFromString( g_UserUnit, posYTextCtrl->GetValue() ) );
900 
901  // Note: the Y axis for components in lib is from bottom to top
902  // and the screen axis is top to bottom: we must change the y coord sign for editing
903  pos.y = -pos.y;
904 
905  field.SetTextPos( pos );
906 
907  return true;
908 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:156
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: common.h:91
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:47
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
void SetItalic(bool isItalic)
Definition: eda_text.h:169
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
void SetVisible(bool aVisible)
Definition: eda_text.h:175
static int ParseSize(const wxString &sizeText, EDA_UNITS_T user_unit)
Definition: wxwineda.cpp:123
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:214
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
void SetName(const wxString &aName)
Function SetName.
Definition: lib_field.cpp:659
#define TEXT_ANGLE_VERT
Definition: common.h:92
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:679
int GetId() const
Definition: lib_field.h:136
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:194
int ValueFromString(EDA_UNITS_T aUnits, const wxString &aTextValue)
Function ValueFromString converts aTextValue in aUnits to internal units used by the application...
Definition: base_units.cpp:368
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:54
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:56
Field Value of part, i.e. "3.3K".
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:193
const char * name
void SetBold(bool aBold)
Definition: eda_text.h:172
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::copySelectedFieldToPanel ( )
private

Function copySelectedFieldToPanel sets the values displayed on the panel according to the currently selected field row.

Definition at line 708 of file dialog_edit_libentry_fields_in_lib.cpp.

References DATASHEET, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::deleteFieldButton, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldNameTextCtrl, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldValueTextCtrl, FOOTPRINT, EDA_GRAPHIC_TEXT_CTRL::FormatSize(), g_UserUnit, EDA_TEXT::GetHorizJustify(), LIB_FIELD::GetId(), LIB_FIELD::GetName(), getSelectedFieldNdx(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), LIB_FIELD::IsVisible(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_FieldHJustifyCtrl, m_FieldsBuf, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_FieldVJustifyCtrl, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_show_datasheet_button, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_StyleRadioBox, MANDATORY_FIELDS, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::moveDownButton, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::moveUpButton, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posXTextCtrl, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posYTextCtrl, REFERENCE, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::rotateCheckBox, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::showCheckBox, StringFromValue(), TEXT_ANGLE_VERT, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::textSizeTextCtrl, VALUE, wxPoint::x, and wxPoint::y.

Referenced by deleteFieldButtonHandler(), OnInitDialog(), and OnListItemSelected().

709 {
710  unsigned fieldNdx = getSelectedFieldNdx();
711 
712  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
713  return;
714 
715  LIB_FIELD& field = m_FieldsBuf[fieldNdx];
716 
717  showCheckBox->SetValue( field.IsVisible() );
718 
719  rotateCheckBox->SetValue( field.GetTextAngle() == TEXT_ANGLE_VERT );
720 
721  int style = 0;
722 
723  if( field.IsItalic() )
724  style = 1;
725 
726  if( field.IsBold() )
727  style |= 2;
728 
729  m_StyleRadioBox->SetSelection( style );
730 
731  // Select the right text justification
732  if( field.GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT )
733  m_FieldHJustifyCtrl->SetSelection(0);
734  else if( field.GetHorizJustify() == GR_TEXT_HJUSTIFY_RIGHT )
735  m_FieldHJustifyCtrl->SetSelection(2);
736  else
737  m_FieldHJustifyCtrl->SetSelection(1);
738 
739  if( field.GetVertJustify() == GR_TEXT_VJUSTIFY_BOTTOM )
740  m_FieldVJustifyCtrl->SetSelection(0);
741  else if( field.GetVertJustify() == GR_TEXT_VJUSTIFY_TOP )
742  m_FieldVJustifyCtrl->SetSelection(2);
743  else
744  m_FieldVJustifyCtrl->SetSelection(1);
745 
746 
747  // Field names have become more important than field ids, so we cannot
748  // mangle the names in the buffer but we can do so in the panel.
749  if( field.GetId() == VALUE )
750  {
751  // This field is the lib name and the default value when loading this component in
752  // schematic. The value is now not editable here (in this dialog) because changing
753  // it is equivalent to create a new component or alias. This is handles in libedir,
754  // not in this dialog.
755  fieldNameTextCtrl->SetValue( field.GetName() + wxT( " / " ) + _( "Chip Name" ) );
756  fieldValueTextCtrl->Enable( false );
757  }
758  else
759  {
760  fieldValueTextCtrl->Enable( true );
761  fieldNameTextCtrl->SetValue( field.GetName() );
762  }
763 
764  // if fieldNdx == REFERENCE, VALUE, FOOTPRINT, or DATASHEET, then disable field name editing
765  fieldNameTextCtrl->Enable( fieldNdx >= MANDATORY_FIELDS );
766  fieldNameTextCtrl->SetEditable( fieldNdx >= MANDATORY_FIELDS );
767 
768  // only user defined fields may be moved, and not the top most user defined
769  // field since it would be moving up into the fixed fields, > not >=
770  moveUpButton->Enable( fieldNdx > MANDATORY_FIELDS );
771  moveDownButton->Enable( ( fieldNdx >= MANDATORY_FIELDS ) && ( fieldNdx < ( m_FieldsBuf.size() - 1 ) ) );
772 
773  // if fieldNdx == REFERENCE, VALUE, then disable delete button
774  deleteFieldButton->Enable( fieldNdx >= MANDATORY_FIELDS );
775 
776  fieldValueTextCtrl->SetValidator( SCH_FIELD_VALIDATOR( true, field.GetId() ) );
777  fieldValueTextCtrl->SetValue( field.GetText() );
778 
780 
781  m_show_datasheet_button->Enable( fieldNdx == DATASHEET || fieldNdx == FOOTPRINT );
782 
783  if( fieldNdx == DATASHEET )
784  {
785  m_show_datasheet_button->SetLabel( _( "Show Datasheet" ) );
786  m_show_datasheet_button->SetToolTip(
787  _("If your datasheet is given as an http:// link,"
788  " then pressing this button should bring it up in your webbrowser.") );
789  }
790  else if( fieldNdx == FOOTPRINT )
791  {
792  m_show_datasheet_button->SetLabel( _( "Browse Footprints" ) );
793  m_show_datasheet_button->SetToolTip(
794  _("Open the footprint browser to choose a footprint and assign it.") );
795  }
796  else
797  {
798  m_show_datasheet_button->SetLabel( wxEmptyString );
799  m_show_datasheet_button->SetToolTip(
800  _("Used only for fields Footprint and Datasheet.") );
801  }
802 
803  wxPoint coord = field.GetTextPos();
804  wxPoint zero;
805 
806  // If the field value is empty and the position is at relative zero, we set the
807  // initial position as a small offset from the ref field, and orient
808  // it the same as the ref field. That is likely to put it at least
809  // close to the desired position.
810  if( coord == zero && field.GetText().IsEmpty() )
811  {
812  rotateCheckBox->SetValue( m_FieldsBuf[REFERENCE].GetTextAngle() == TEXT_ANGLE_VERT );
813 
814  coord.x = m_FieldsBuf[REFERENCE].GetTextPos().x +
815  (fieldNdx - MANDATORY_FIELDS + 1) * 100;
816  coord.y = m_FieldsBuf[REFERENCE].GetTextPos().y +
817  (fieldNdx - MANDATORY_FIELDS + 1) * 100;
818 
819  // coord can compute negative if field is < MANDATORY_FIELDS, e.g. FOOTPRINT.
820  // That is ok, we basically don't want all the new empty fields on
821  // top of each other.
822  }
823 
824  wxString coordText = StringFromValue( g_UserUnit, coord.x );
825  posXTextCtrl->SetValue( coordText );
826 
827  // Note: the Y axis for components in lib is from bottom to top
828  // and the screen axis is top to bottom: we must change the y coord sign for editing
829  coord.y = -coord.y;
830  coordText = StringFromValue( g_UserUnit, coord.y );
831  posYTextCtrl->SetValue( coordText );
832 }
name of datasheet
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
bool IsItalic() const
Definition: eda_text.h:170
wxString StringFromValue(EDA_UNITS_T aUnit, int aValue, bool aAddUnitSymbol)
Function StringFromValue returns the string from aValue according to units (inch, mm ...
Definition: base_units.cpp:203
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:190
#define TEXT_ANGLE_VERT
Definition: common.h:92
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
bool IsBold() const
Definition: eda_text.h:173
double GetTextAngle() const
Definition: eda_text.h:164
int GetId() const
Definition: lib_field.h:136
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:609
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:56
Field Value of part, i.e. "3.3K".
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:191
bool IsVisible() const
Function IsVisible.
Definition: lib_field.h:168
const wxSize & GetTextSize() const
Definition: eda_text.h:215
class SCH_FILED_VALIDATOR
static wxString FormatSize(EDA_UNITS_T user_unit, int textSize)
Function FormatSize formats a string containing the size in the desired units.
Definition: wxwineda.cpp:84
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::deleteFieldButtonHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Function deleteFieldButtonHandler deletes a field.

MANDATORY_FIELDS cannot be deleted. If a field is empty, it is removed. if not empty, the text is removed.

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 387 of file dialog_edit_libentry_fields_in_lib.cpp.

References copySelectedFieldToPanel(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldListCtrl, getSelectedFieldNdx(), GetText(), m_FieldsBuf, m_skipCopyFromPanel, MANDATORY_FIELDS, setRowItem(), setSelectedFieldNdx(), and updateDisplay().

388 {
389  unsigned fieldNdx = getSelectedFieldNdx();
390 
391  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
392  return;
393 
394  if( fieldNdx < MANDATORY_FIELDS )
395  {
396  wxBell();
397  return;
398  }
399 
400  m_skipCopyFromPanel = true;
401 
402  if( m_FieldsBuf[fieldNdx].GetText().IsEmpty() )
403  {
404  m_FieldsBuf.erase( m_FieldsBuf.begin() + fieldNdx );
405  fieldListCtrl->DeleteItem( fieldNdx );
406 
407  if( fieldNdx >= m_FieldsBuf.size() )
408  --fieldNdx;
409  }
410  else
411  {
412  m_FieldsBuf[fieldNdx].Empty();
414  }
415 
416  updateDisplay( );
417 
418  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx] );
419  setSelectedFieldNdx( fieldNdx );
420  m_skipCopyFromPanel = false;
421 }
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
void updateDisplay()
Function updateDisplay update the listbox showing fields, according to the fields texts must be calle...
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
void copySelectedFieldToPanel()
Function copySelectedFieldToPanel sets the values displayed on the panel according to the currently s...
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::EditSpiceModel ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 321 of file dialog_edit_libentry_fields_in_lib.cpp.

References LIB_FIELD::GetId(), LIB_FIELD::GetName(), GetText(), EDA_TEXT::GetTextPos(), SCH_FIELD::ImportValues(), m_FieldsBuf, SCH_COMPONENT::SetFields(), and updateDisplay().

322 {
323 #ifdef KICAD_SPICE
324  // DIALOG_SPICE_MODEL expects a SCH_COMPONENT,
325  // and a list of SCH_FIELDS to create/edit/delete Spice fields.
326  SCH_COMPONENT component; // This dummy component
327 
328  // Build fields list from the m_FieldsBuf fields buffer dialog
329  // to be sure to use the current fields.
330  SCH_FIELDS schfields;
331 
332  for( unsigned ii = 0; ii < m_FieldsBuf.size(); ++ii )
333  {
334  LIB_FIELD& libfield = m_FieldsBuf[ii];
335  SCH_FIELD schfield( libfield.GetTextPos(), libfield.GetId(),
336  &component, libfield.GetName() );
337  schfield.ImportValues( m_FieldsBuf[ii] );
338  schfield.SetText( m_FieldsBuf[ii].GetText() );
339 
340  schfields.push_back( schfield );
341  }
342 
343  component.SetFields( schfields );
344 
345  DIALOG_SPICE_MODEL dialog( this, component, schfields );
346 
347  if( dialog.ShowModal() != wxID_OK )
348  return;
349 
350  // Transfert sch fields to the m_FieldsBuf fields buffer dialog:
351  m_FieldsBuf.clear();
352 
353  for( unsigned ii = 0; ii < schfields.size(); ii++ )
354  {
355  LIB_FIELD libfield;
356  schfields[ii].ExportValues( libfield );
357  m_FieldsBuf.push_back( libfield );
358  }
359 
360  updateDisplay();
361 #endif /* KICAD_SPICE */
362 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
void ImportValues(const LIB_FIELD &aSource)
Function ImportValues copy parameters from a LIB_FIELD source.
Definition: sch_field.cpp:221
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
void updateDisplay()
Function updateDisplay update the listbox showing fields, according to the fields texts must be calle...
void SetFields(const SCH_FIELDS &aFields)
Set multiple schematic fields.
int GetId() const
Definition: lib_field.h:136
std::vector< SCH_FIELD > SCH_FIELDS
A container for several SCH_FIELD items.
Definition: sch_component.h:53
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:609
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 182 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

183 {
184  // so we can do logging of this state change:
185 
186 #if defined(DEBUG)
187  const char* type_id = typeid( *this ).name();
188  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
189 #endif
190 
191  return wxDialog::Enable( enable );
192 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 540 of file dialog_shim.cpp.

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), OnCloseDialog(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCloseDialog(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), DIALOG_EXCHANGE_MODULE::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

541 {
542  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
543  // handle validation in the same way as other dialogs.
544  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
545  return;
546 
547  SetReturnCode( retCode );
548 
549  if( !IsQuasiModal() )
550  {
551  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
552  return;
553  }
554 
555  m_qmodal_showing = false;
556 
557  if( m_qmodal_loop )
558  {
559  if( m_qmodal_loop->IsRunning() )
560  m_qmodal_loop->Exit( 0 );
561  else
562  m_qmodal_loop->ScheduleExit( 0 );
563 
564  m_qmodal_loop = NULL;
565  }
566 
569 
570  Show( false );
571 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool IsQuasiModal()
Definition: dialog_shim.h:93
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
LIB_FIELD * DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::findField ( const wxString &  aFieldName)
private

Function findField searches m_FieldsBuf and returns a LIB_FIELD with aFieldName or NULL if not found.

Definition at line 569 of file dialog_edit_libentry_fields_in_lib.cpp.

References m_FieldsBuf.

Referenced by initBuffers().

570 {
571  for( unsigned i=0; i<m_FieldsBuf.size(); ++i )
572  {
573  if( aFieldName == m_FieldsBuf[i].GetName() )
574  return &m_FieldsBuf[i];
575  }
576  return NULL;
577 }
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
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 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by COLOR4D_PICKER_DLG::COLOR4D_PICKER_DLG(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DESIGN_RULES::DIALOG_DESIGN_RULES(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG(), 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_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIBEDIT_OPTIONS::DIALOG_LIBEDIT_OPTIONS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_PRETTY_LIB::DIALOG_SELECT_PRETTY_LIB(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_EDIT_ONE_FIELD::init(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_LIB_EDIT_PIN::OnInitDialog(), OnInitDialog(), DIALOG_TRACK_VIA_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnInitDlg(), DialogEditModuleText::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_MODULE_MODULE_EDITOR::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_MODULE_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), and DIALOG_SIGNAL_LIST::TransferDataToWindow().

105 {
106  // must be called from the constructor of derived classes,
107  // when all widgets are initialized, and therefore their size fixed
108 
109  // SetSizeHints fixes the minimal size of sizers in the dialog
110  // (SetSizeHints calls Fit(), so no need to call it)
111  GetSizer()->SetSizeHints( this );
112 
113  // the default position, when calling the first time the dlg
114  Center();
115 }
void DIALOG_SHIM::FixOSXCancelButtonIssue ( )
protectedinherited

A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.

Definition at line 117 of file dialog_shim.cpp.

Referenced by DIALOG_SHIM::Show().

118 {
119 #ifdef __WXMAC__
120  // A ugly hack to fix an issue on OSX: ctrl+c closes the dialog instead of
121  // copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer
122  // created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority
123  // to copy text standard accelerator, and the dlg is closed when trying to copy text
124  wxButton* button = dynamic_cast< wxButton* > ( wxWindow::FindWindowById( wxID_CANCEL, this ) );
125 
126  if( button )
127  button->SetLabel( _( "Cancel" ) );
128 #endif
129 }
int DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::getSelectedFieldNdx ( )
private
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers ( )
private

Function initBuffers sets up to edit the given component.

Definition at line 580 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldListCtrl, findField(), findfield(), FRAME_SCH, LIB_PART::GetFields(), LIB_FIELD::GetName(), SCH_EDIT_FRAME::GetTemplateFieldNames(), KIWAY_HOLDER::Kiway(), m_FieldsBuf, m_libEntry, MANDATORY_FIELDS, KIWAY::Player(), s_SelectedRow, LIB_FIELD::SetName(), setRowItem(), setSelectedFieldNdx(), LIB_FIELD::SetText(), and EDA_TEXT::SetVisible().

Referenced by OnInitDialog().

581 {
582  LIB_FIELDS cmpFields;
583 
584  m_libEntry->GetFields( cmpFields );
585 
586  /* We have 3 component related field lists to be aware of: 1) UI
587  presentation (m_FieldsBuf), 2) fields in component ram copy, and 3)
588  fields recorded with component on disk. m_FieldsBuf is the list of UI
589  fields, and this list is not the same as the list which is in the
590  component, which is also not the same as the list on disk. All 3 lists
591  are potentially different. In the UI we choose to preserve the order of
592  the first MANDATORY_FIELDS which are sometimes called fixed fields. Then
593  we append the template fieldnames in the exact same order as the
594  template fieldname editor shows them. Then we append any user defined
595  fieldnames which came from the component, and user can modify it during
596  editing, but cannot delete or move a fixed field.
597  */
598 
599  m_FieldsBuf.clear();
600 
601  /* When this code was written, all field constructors ensured that the
602  MANDATORY_FIELDS are all present within a component (in ram only). So we can
603  knowingly copy them over in the normal order. Copy only the fixed fields
604  at first. Please do not break the field constructors.
605  */
606 
607  // fixed fields:
608  for( int i=0; i<MANDATORY_FIELDS; ++i )
609  {
610  m_FieldsBuf.push_back( cmpFields[i] );
611  }
612 
613  // Add template fieldnames:
614  // Now copy in the template fields, in the order that they are present in the
615  // template field editor UI.
616  SCH_EDIT_FRAME* editor = (SCH_EDIT_FRAME*) Kiway().Player( FRAME_SCH, true );
617 
618  const TEMPLATE_FIELDNAMES& tfnames = editor->GetTemplateFieldNames();
619 
620  for( TEMPLATE_FIELDNAMES::const_iterator it = tfnames.begin(); it!=tfnames.end(); ++it )
621  {
622  // add a new field unconditionally to the UI only for this template fieldname
623 
624  // field id must not be in range 0 - MANDATORY_FIELDS, set before saving to disk
625  LIB_FIELD fld( m_libEntry, -1 );
626 
627  // See if field by same name already exists in component.
628  LIB_FIELD* libField = findfield( cmpFields, it->m_Name );
629 
630  // If the field does not already exist in the component, then we
631  // use defaults from the template fieldname, otherwise the original
632  // values from the component will be set.
633  if( !libField )
634  {
635  fld.SetName( it->m_Name );
636  fld.SetText( it->m_Value ); // empty? ok too.
637 
638  if( !it->m_Visible )
639  fld.SetVisible( false );
640  else
641  fld.SetVisible( true );
642  }
643  else
644  {
645  fld = *libField; // copy values from component, m_Name too
646  }
647 
648  m_FieldsBuf.push_back( fld );
649  }
650 
651  // Lastly, append any original fields from the component which were not added
652  // from the set of fixed fields nor from the set of template fields.
653  for( unsigned i=MANDATORY_FIELDS; i<cmpFields.size(); ++i )
654  {
655  LIB_FIELD* cmp = &cmpFields[i];
656  LIB_FIELD* buf = findField( cmp->GetName() );
657 
658  if( !buf )
659  {
660  m_FieldsBuf.push_back( *cmp );
661  }
662  }
663 
664  /* field names have become more important than field ids, so we cannot
665  mangle the names in the buffer, but can do so in the panel, see elsewhere.
666  m_FieldsBuf[VALUE].m_Name << wxT( "/" ) << _( "Chip Name" );
667  */
668 
669  for( unsigned ii = 0; ii < m_FieldsBuf.size(); ++ii )
670  {
671  setRowItem( ii, m_FieldsBuf[ii] );
672  }
673 
674  // put focus on the list ctrl
675  fieldListCtrl->SetFocus();
676 
677  // resume editing at the last row edited, last time dialog was up.
678  if ( s_SelectedRow < (int) m_FieldsBuf.size() )
679  s_SelectedRow = 0;
680 
682 }
LIB_FIELD * findField(const wxString &aFieldName)
Function findField searches m_FieldsBuf and returns a LIB_FIELD with aFieldName or NULL if not found...
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
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
static LIB_FIELD * findfield(const LIB_FIELDS &aList, const wxString &aFieldName)
Function findfield searches a LIB_FIELD_LIST for aFieldName.
Schematic editor (Eeschema) main window.
Definition: schframe.h:117
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, KIWAY_PLAYER *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:302
std::vector< TEMPLATE_FIELDNAME > TEMPLATE_FIELDNAMES
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:609
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames()
Function GetTemplateFieldName returns a template field names list for read only access.
Definition: schframe.h:326
std::vector< LIB_FIELD > LIB_FIELDS
Definition: lib_field.h:261
static int s_SelectedRow
void GetFields(LIB_FIELDS &aList)
Function GetFields returns a list of fields withing this part.
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.

References KIWAY_HOLDER::m_kiway.

Referenced by SCH_EDIT_FRAME::AppendOneEEProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), initBuffers(), LIB_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), SCH_SHEET::Load(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), 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::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and DIALOG_EXCHANGE_MODULE::ViewAndSelectFootprint().

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:85
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::moveDownButtonHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 424 of file dialog_edit_libentry_fields_in_lib.cpp.

References copyPanelToSelectedField(), getSelectedFieldNdx(), m_FieldsBuf, m_skipCopyFromPanel, MANDATORY_FIELDS, setRowItem(), setSelectedFieldNdx(), and updateDisplay().

425 {
426  unsigned int fieldNdx = getSelectedFieldNdx();
427 
428  // Ensure there is at least one field after this one
429  if( fieldNdx >= ( m_FieldsBuf.size() - 1 ) )
430  {
431  return;
432  }
433 
434  // The first field which can be moved up is the second user field
435  // so any field which id < MANDATORY_FIELDS cannot be moved down
436  if( fieldNdx < MANDATORY_FIELDS )
437  return;
438 
439  if( !copyPanelToSelectedField() )
440  return;
441 
442  // swap the fieldNdx field with the one before it, in both the vector
443  // and in the fieldListCtrl
444  LIB_FIELD tmp = m_FieldsBuf[fieldNdx + 1];
445 
446  m_FieldsBuf[fieldNdx + 1] = m_FieldsBuf[fieldNdx];
447  setRowItem( fieldNdx + 1, m_FieldsBuf[fieldNdx] );
448  m_FieldsBuf[fieldNdx + 1].SetId( fieldNdx + 1 );
449 
450  m_FieldsBuf[fieldNdx] = tmp;
451  setRowItem( fieldNdx, tmp );
452  m_FieldsBuf[fieldNdx].SetId( fieldNdx );
453 
454  updateDisplay( );
455 
456  m_skipCopyFromPanel = true;
457  setSelectedFieldNdx( fieldNdx + 1 );
458  m_skipCopyFromPanel = false;
459 }
bool copyPanelToSelectedField()
Function copyPanelToSelectedField copies the values displayed on the panel fields to the currently se...
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
void updateDisplay()
Function updateDisplay update the listbox showing fields, according to the fields texts must be calle...
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::moveUpButtonHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 462 of file dialog_edit_libentry_fields_in_lib.cpp.

References copyPanelToSelectedField(), getSelectedFieldNdx(), m_FieldsBuf, m_skipCopyFromPanel, MANDATORY_FIELDS, setRowItem(), setSelectedFieldNdx(), and updateDisplay().

463 {
464  unsigned fieldNdx = getSelectedFieldNdx();
465 
466  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
467  return;
468 
469  // The first field which can be moved up is the second user field
470  // so any field which id <= MANDATORY_FIELDS cannot be moved up
471  if( fieldNdx <= MANDATORY_FIELDS )
472  return;
473 
474  if( !copyPanelToSelectedField() )
475  return;
476 
477  // swap the fieldNdx field with the one before it, in both the vector
478  // and in the fieldListCtrl
479  LIB_FIELD tmp = m_FieldsBuf[fieldNdx - 1];
480 
481  m_FieldsBuf[fieldNdx - 1] = m_FieldsBuf[fieldNdx];
482  setRowItem( fieldNdx - 1, m_FieldsBuf[fieldNdx] );
483  m_FieldsBuf[fieldNdx - 1].SetId(fieldNdx - 1);
484 
485  m_FieldsBuf[fieldNdx] = tmp;
486  setRowItem( fieldNdx, tmp );
487  m_FieldsBuf[fieldNdx].SetId(fieldNdx);
488 
489  updateDisplay( );
490 
491  m_skipCopyFromPanel = true;
492  setSelectedFieldNdx( fieldNdx - 1 );
493  m_skipCopyFromPanel = false;
494 }
bool copyPanelToSelectedField()
Function copyPanelToSelectedField copies the values displayed on the panel fields to the currently se...
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
void updateDisplay()
Function updateDisplay update the listbox showing fields, according to the fields texts must be calle...
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCancelButtonClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 241 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_SHIM::EndQuasiModal().

242 {
243  EndQuasiModal( wxID_CANCEL );
244 }
void EndQuasiModal(int retCode)
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCloseDialog ( wxCloseEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 247 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_SHIM::EndQuasiModal().

248 {
249  // On wxWidgets 2.8, and on Linux, call EndQuasiModal here is mandatory
250  // Otherwise, the main event loop is never restored, and Eeschema does not
251  // respond to any event, because the DIALOG_SHIM destructor is never called.
252  // on wxWidgets 3.0, or on Windows, the DIALOG_SHIM destructor is called,
253  // and calls EndQuasiModal.
254  // Therefore calling EndQuasiModal here is not mandatory but it creates no issues.
255  EndQuasiModal( wxID_CANCEL );
256 }
void EndQuasiModal(int retCode)
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog ( wxInitDialogEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 195 of file dialog_edit_libentry_fields_in_lib.cpp.

References COLUMN_FIELD_NAME, COLUMN_TEXT, copySelectedFieldToPanel(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldListCtrl, DIALOG_SHIM::FinishDialogSettings(), g_UserUnit, GetAbbreviatedUnitsLabel(), initBuffers(), m_skipCopyFromPanel, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_staticTextUnitPosX, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_staticTextUnitPosY, DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_staticTextUnitSize, and DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::stdDialogButtonSizerOK.

196 {
197  m_skipCopyFromPanel = false;
198  wxListItem columnLabel;
199 
200  columnLabel.SetImage( -1 );
201 
202  columnLabel.SetText( _( "Name" ) );
203  fieldListCtrl->InsertColumn( COLUMN_FIELD_NAME, columnLabel );
204 
205  columnLabel.SetText( _( "Value" ) );
206  fieldListCtrl->InsertColumn( COLUMN_TEXT, columnLabel );
207 
211 
212  initBuffers();
214 
215  stdDialogButtonSizerOK->SetDefault();
216 
217  // Now all widgets have the size fixed, call FinishDialogSettings
219 }
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
wxString GetAbbreviatedUnitsLabel(EDA_UNITS_T aUnit)
Definition: base_units.cpp:479
void initBuffers()
Function initBuffers sets up to edit the given component.
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:56
void copySelectedFieldToPanel()
Function copySelectedFieldToPanel sets the values displayed on the panel according to the currently s...
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnListItemDeselected ( wxListEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 222 of file dialog_edit_libentry_fields_in_lib.cpp.

References copyPanelToSelectedField(), and m_skipCopyFromPanel.

223 {
224  if( !m_skipCopyFromPanel )
225  {
226  if( !copyPanelToSelectedField() )
227  event.Skip(); // do not go to the next row
228  }
229 }
bool copyPanelToSelectedField()
Function copyPanelToSelectedField copies the values displayed on the panel fields to the currently se...
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnListItemSelected ( wxListEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 232 of file dialog_edit_libentry_fields_in_lib.cpp.

References copySelectedFieldToPanel(), and s_SelectedRow.

233 {
234  // remember the selected row, statically
235  s_SelectedRow = event.GetIndex();
236 
238 }
static int s_SelectedRow
void copySelectedFieldToPanel()
Function copySelectedFieldToPanel sets the values displayed on the panel according to the currently s...
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 259 of file dialog_edit_libentry_fields_in_lib.cpp.

References copyPanelToSelectedField(), DisplayError(), DIALOG_SHIM::EndQuasiModal(), Format(), LIB_PART::GetAlias(), GetChars(), GetText(), EDA_TEXT::GetText(), LIB_PART::GetValueField(), LIB_PART::HasAlias(), SCH_COMPONENT::IsReferenceStringValid(), LIB_ALIAS::IsRoot(), m_FieldsBuf, m_libEntry, m_parent, MANDATORY_FIELDS, LIB_EDIT_FRAME::OnModify(), REFERENCE, LIB_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetFields(), and VALUE.

260 {
261  if( !copyPanelToSelectedField() )
262  return;
263 
264  // test if reference prefix is acceptable
266  {
267  DisplayError( NULL, _( "Illegal reference. References must start with a letter." ) );
268  return;
269  }
270 
271  /* Note: this code is now (2010-dec-04) not used, because the value field is no more editable
272  * because changing the value is equivalent to create a new component or alias.
273  * This is now handled in libedit main frame, and no more in this dialog
274  * but this code is not removed, just in case
275  */
276  /* If a new name entered in the VALUE field, that it not an existing alias name
277  * or root alias of the component */
278  wxString newvalue = m_FieldsBuf[VALUE].GetText();
279 
280  if( m_libEntry->HasAlias( newvalue ) && !m_libEntry->GetAlias( newvalue )->IsRoot() )
281  {
282  wxString msg = wxString::Format(
283  _( "A new name is entered for this component\n"
284  "An alias %s already exists!\n"
285  "Cannot update this component" ),
286  GetChars( newvalue )
287  );
288  DisplayError( this, msg );
289  return;
290  }
291  /* End unused code */
292 
293  // save old cmp in undo list
295 
296  // delete any fields with no name or no value before we copy all of m_FieldsBuf
297  // back into the component
298  for( unsigned i = MANDATORY_FIELDS; i < m_FieldsBuf.size(); )
299  {
300  if( m_FieldsBuf[i].GetName().IsEmpty() || m_FieldsBuf[i].GetText().IsEmpty() )
301  {
302  m_FieldsBuf.erase( m_FieldsBuf.begin() + i );
303  continue;
304  }
305 
306  ++i;
307  }
308 
309  // copy all the fields back, fully replacing any previous fields
311 
312  // We need to keep the name and the value the same at the moment!
313  SetName( m_libEntry->GetValueField().GetText() );
314 
315  m_parent->OnModify();
316 
317  EndQuasiModal( wxID_OK );
318 }
bool copyPanelToSelectedField()
Function copyPanelToSelectedField copies the values displayed on the panel fields to the currently se...
LIB_ALIAS * GetAlias(size_t aIndex)
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
bool HasAlias(const wxString &aName) const
Test if alias aName is in part alias list.
LIB_FIELD & GetValueField()
Return reference to the value field.
void OnModify()
Function OnModify Must be called after a schematic change in order to set the "modify" flag of the cu...
Definition: libeditframe.h:369
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
Field Reference of part, i.e. "IC21".
bool IsRoot() const
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
Field Value of part, i.e. "3.3K".
void EndQuasiModal(int retCode)
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
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 bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
void SetFields(const std::vector< LIB_FIELD > &aFieldsList)
Function SetFields overwrites all the existing in this part with fields supplied in aFieldsList...
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:71
void SaveCopyInUndoList(EDA_ITEM *ItemToCopy)
Function SaveCopyInUndoList.
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.

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

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), SCH_EDIT_FRAME::backAnnotateFootprints(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_SCREEN::CheckComponentsToPartsLinks(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), SCH_EDIT_FRAME::CreateArchiveLibrary(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), LIB_EDIT_FRAME::DeleteOnePart(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EESCHEMA_CONFIG::DIALOG_EESCHEMA_CONFIG(), DIALOG_FP_LIB_TABLE::DIALOG_FP_LIB_TABLE(), DIALOG_MODULE_BOARD_EDITOR::DIALOG_MODULE_BOARD_EDITOR(), DIALOG_MODULE_MODULE_EDITOR::DIALOG_MODULE_MODULE_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), LIB_VIEW_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportToGenCAD(), 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(), LIB_EDIT_FRAME::GetCurPart(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), FOOTPRINT_EDIT_FRAME::getLibPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_EDIT_FRAME::InstallConfigFrame(), SCH_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), DIALOG_BOM_EDITOR::LoadComponents(), CVPCB_MAINFRAME::LoadFootprintFiles(), SCH_EDIT_FRAME::LoadOneEEFile(), LIB_EDIT_FRAME::LoadOneLibraryPart(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertLibClick(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertPath(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), LIB_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_NETLIST::OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_MODULE_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), DIALOG_NETLIST::OnSaveMessagesToFile(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectIcLib(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OnSelectUnit(), DIALOG_SPICE_MODEL::onSemiSelectLib(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDITOR_CONTROL::PlaceModule(), SCH_EDIT_FRAME::prepareForNetlist(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_SCREEN::Save(), LIB_EDIT_FRAME::SaveActiveLibrary(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_ERC::TestErc(), DIALOG_SPICE_MODEL::updateFromFile(), SIM_PLOT_FRAME::updateNetlistExporter(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), CVPCB_MAINFRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_MODULE_BOARD_EDITOR::~DIALOG_MODULE_BOARD_EDITOR(), and DIALOG_MODULE_MODULE_EDITOR::~DIALOG_MODULE_MODULE_EDITOR().

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:144
void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

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

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

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

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

Definition at line 685 of file dialog_edit_libentry_fields_in_lib.cpp.

References COLUMN_FIELD_NAME, COLUMN_TEXT, and DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldListCtrl.

Referenced by addFieldButtonHandler(), copyPanelToSelectedField(), deleteFieldButtonHandler(), initBuffers(), moveDownButtonHandler(), moveUpButtonHandler(), setRowItem(), showButtonHandler(), and updateDisplay().

686 {
687  wxASSERT( aFieldNdx >= 0 );
688 
689  // insert blanks if aFieldNdx is referencing a "yet to be defined" row
690  while( aFieldNdx >= fieldListCtrl->GetItemCount() )
691  {
692  long ndx = fieldListCtrl->InsertItem( fieldListCtrl->GetItemCount(), wxEmptyString );
693 
694  wxASSERT( ndx >= 0 );
695 
696  fieldListCtrl->SetItem( ndx, COLUMN_TEXT, wxEmptyString );
697  }
698 
699  fieldListCtrl->SetItem( aFieldNdx, COLUMN_FIELD_NAME, aName );
700  fieldListCtrl->SetItem( aFieldNdx, COLUMN_TEXT, aValue );
701 
702  // recompute the column widths here, after setting texts
703  fieldListCtrl->SetColumnWidth( COLUMN_FIELD_NAME, wxLIST_AUTOSIZE );
704  fieldListCtrl->SetColumnWidth( COLUMN_TEXT, wxLIST_AUTOSIZE );
705 }
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::setRowItem ( int  aFieldNdx,
const LIB_FIELD aField 
)
inlineprivate

Definition at line 126 of file dialog_edit_libentry_fields_in_lib.cpp.

References LIB_FIELD::GetName(), EDA_TEXT::GetText(), and setRowItem().

127  {
128  setRowItem( aFieldNdx, aField.GetName(), aField.GetText() );
129  }
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:609
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::setSelectedFieldNdx ( int  aFieldNdx)
private

Definition at line 524 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldListCtrl, m_FieldsBuf, and s_SelectedRow.

Referenced by addFieldButtonHandler(), deleteFieldButtonHandler(), initBuffers(), moveDownButtonHandler(), and moveUpButtonHandler().

525 {
526  // deselect old selection, but I think this is done by single selection
527  // flag within fieldListCtrl
528  // fieldListCtrl->SetItemState( s_SelectedRow, 0, wxLIST_STATE_SELECTED|wxLIST_STATE_FOCUSED);
529 
530  if( aFieldNdx >= (int) m_FieldsBuf.size() )
531  aFieldNdx = m_FieldsBuf.size() - 1;
532 
533  if( aFieldNdx < 0 )
534  aFieldNdx = 0;
535 
536  fieldListCtrl->SetItemState( aFieldNdx, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
537  fieldListCtrl->EnsureVisible( aFieldNdx );
538 
539  s_SelectedRow = aFieldNdx;
540 }
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
static int s_SelectedRow
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 139 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::FixOSXCancelButtonIssue(), EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_SCH_FIND::OnCancel(), DIALOG_ANNOTATE::OnCancelClick(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_MODULE::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

140 {
141  bool ret;
142  const char* hash_key;
143 
144  if( m_hash_key.size() )
145  {
146  // a special case like EDA_LIST_DIALOG, which has multiple uses.
147  hash_key = m_hash_key.c_str();
148  }
149  else
150  {
151  hash_key = typeid(*this).name();
152  }
153 
154  // Show or hide the window. If hiding, save current position and size.
155  // If showing, use previous position and size.
156  if( show )
157  {
158  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
159  ret = wxDialog::Show( show );
160 
161  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
162  EDA_RECT r = class_map[ hash_key ];
163 
164  if( r.GetSize().x != 0 && r.GetSize().y != 0 )
165  SetSize( r.GetPosition().x, r.GetPosition().y, r.GetSize().x, r.GetSize().y, 0 );
166  }
167  else
168  {
169  // Save the dialog's position & size before hiding, using classname as key
170  EDA_RECT r( wxDialog::GetPosition(), wxDialog::GetSize() );
171  class_map[ hash_key ] = r;
172 
173  ret = wxDialog::Show( show );
174  }
175 
177 
178  return ret;
179 }
std::string m_hash_key
Definition: dialog_shim.h:128
void FixOSXCancelButtonIssue()
A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.
static RECT_MAP class_map
const wxPoint & GetPosition() const
Class EDA_RECT handles the component boundary box.
const wxSize & GetSize() const
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE.

Definition at line 497 of file dialog_edit_libentry_fields_in_lib.cpp.

References DATASHEET, KIWAY_PLAYER::Destroy(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldValueTextCtrl, FOOTPRINT, FRAME_PCB_MODULE_VIEWER_MODAL, getSelectedFieldNdx(), KIWAY_HOLDER::Kiway(), m_FieldsBuf, KIWAY::Player(), setRowItem(), and KIWAY_PLAYER::ShowModal().

498 {
499  unsigned fieldNdx = getSelectedFieldNdx();
500 
501  if( fieldNdx == DATASHEET )
502  {
503  wxString datasheet_uri = fieldValueTextCtrl->GetValue();
504  ::wxLaunchDefaultBrowser( datasheet_uri );
505  }
506  else if( fieldNdx == FOOTPRINT )
507  {
508  // pick a footprint using the footprint picker.
509  wxString fpid;
510 
512 
513  if( frame->ShowModal( &fpid, this ) )
514  {
515  fieldValueTextCtrl->SetValue( fpid );
516  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx].GetName( false ), fpid );
517  }
518 
519  frame->Destroy();
520  }
521 }
Class KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a porti...
Definition: kiway_player.h:111
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
name of datasheet
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs
Field Name Module PCB, i.e. "16DIP300".
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, KIWAY_PLAYER *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:302
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
VTBL_ENTRY bool ShowModal(wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxF...
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 495 of file dialog_shim.cpp.

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

Referenced by LIB_EDIT_FRAME::DeleteOnePart(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), SCH_EDIT_FRAME::InstallHierarchyFrame(), InvokeDialogCreateBOMEditor(), LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

496 {
497  // This is an exception safe way to zero a pointer before returning.
498  // Yes, even though DismissModal() clears this first normally, this is
499  // here in case there's an exception before the dialog is dismissed.
500  struct NULLER
501  {
502  void*& m_what;
503  NULLER( void*& aPtr ) : m_what( aPtr ) {}
504  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
505  } clear_this( (void*&) m_qmodal_loop );
506 
507  // release the mouse if it's currently captured as the window having it
508  // will be disabled when this dialog is shown -- but will still keep the
509  // capture making it impossible to do anything in the modal dialog itself
510  wxWindow* win = wxWindow::GetCapture();
511  if( win )
512  win->ReleaseMouse();
513 
514  // Get the optimal parent
515  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
516 
517  // Show the optimal parent
518  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
519 
520  wxASSERT_MSG( !m_qmodal_parent_disabler,
521  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
522 
523  // quasi-modal: disable only my "optimal" parent
525 
526  Show( true );
527 
528  m_qmodal_showing = true;
529 
530  EVENT_LOOP event_loop;
531 
532  m_qmodal_loop = &event_loop;
533 
534  event_loop.Run();
535 
536  return GetReturnCode();
537 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:33
#define DBG(x)
Definition: fctsys.h:33
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::updateDisplay ( )
inlineprivate

Function updateDisplay update the listbox showing fields, according to the fields texts must be called after a text change in fields, if this change is not an edition.

Definition at line 136 of file dialog_edit_libentry_fields_in_lib.cpp.

References m_FieldsBuf, MANDATORY_FIELDS, and setRowItem().

Referenced by deleteFieldButtonHandler(), EditSpiceModel(), moveDownButtonHandler(), and moveUpButtonHandler().

137  {
138  for( unsigned ii = MANDATORY_FIELDS; ii<m_FieldsBuf.size(); ii++ )
139  setRowItem( ii, m_FieldsBuf[ii] );
140  }
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
std::vector< LIB_FIELD > m_FieldsBuf
a copy of the edited component's LIB_FIELDs

Member Data Documentation

wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldNameLabel
protectedinherited
wxTextCtrl* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldNameTextCtrl
protectedinherited
wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldValueLabel
protectedinherited
wxTextCtrl* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::fieldValueTextCtrl
protectedinherited
wxRadioBox* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_FieldHJustifyCtrl
protectedinherited
wxRadioBox* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_FieldVJustifyCtrl
protectedinherited
std::string DIALOG_SHIM::m_hash_key
protectedinherited
LIB_PART* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::m_libEntry
private
LIB_EDIT_FRAME* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::m_parent
private
EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 131 of file dialog_shim.h.

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

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited
bool DIALOG_SHIM::m_qmodal_showing
protectedinherited
wxStaticLine* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_staticline1
protectedinherited
wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_staticTextUnitPosX
protectedinherited
wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_staticTextUnitPosY
protectedinherited
wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_staticTextUnitSize
protectedinherited
wxRadioBox* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::m_StyleRadioBox
protectedinherited
wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posXLabel
protectedinherited
wxTextCtrl* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posXTextCtrl
protectedinherited
wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posYLabel
protectedinherited
wxTextCtrl* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::posYTextCtrl
protectedinherited
wxCheckBox* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::rotateCheckBox
protectedinherited
wxCheckBox* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::showCheckBox
protectedinherited
wxStdDialogButtonSizer* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::stdDialogButtonSizer
protectedinherited
wxButton* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::stdDialogButtonSizerCancel
protectedinherited
wxButton* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::stdDialogButtonSizerOK
protectedinherited
wxStaticText* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::textSizeLabel
protectedinherited
wxTextCtrl* DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB_BASE::textSizeTextCtrl
protectedinherited

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