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 62 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 175 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.

177  :
179 {
180  m_parent = aParent;
181  m_libEntry = aLibEntry;
182  m_skipCopyFromPanel = false;
183 
184 #ifndef KICAD_SPICE
185  m_spiceFieldsButton->Show(false);
186 #endif
187 
188  // Configure button logos
189  addFieldButton->SetBitmap( KiBitmap( plus_xpm ) );
190  deleteFieldButton->SetBitmap( KiBitmap( minus_xpm ) );
191  moveUpButton->SetBitmap( KiBitmap( go_up_xpm ) );
192  moveDownButton->SetBitmap( KiBitmap( go_down_xpm ) );
193 }
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 366 of file dialog_edit_libentry_fields_in_lib.cpp.

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

367 {
368  // in case m_FieldsBuf[REFERENCE].m_Orient has changed on screen only, grab
369  // screen contents.
370  if( !copyPanelToSelectedField() )
371  return;
372 
373  unsigned fieldNdx = m_FieldsBuf.size();
374 
375  LIB_FIELD blank( fieldNdx );
376 
377  m_FieldsBuf.push_back( blank );
378  m_FieldsBuf[fieldNdx].SetName( TEMPLATE_FIELDNAME::GetDefaultFieldName( fieldNdx ) );
379 
380  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx] );
381 
382  m_skipCopyFromPanel = true;
383  setSelectedFieldNdx( fieldNdx );
384  m_skipCopyFromPanel = false;
385 }
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 836 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().

837 {
838  unsigned fieldNdx = getSelectedFieldNdx();
839 
840  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
841  return true;
842 
843  // Check for illegal field text.
844  if( fieldValueTextCtrl->GetValidator()
845  && !fieldValueTextCtrl->GetValidator()->Validate( this ) )
846  return false;
847 
848  LIB_FIELD& field = m_FieldsBuf[fieldNdx];
849 
850  if( showCheckBox->GetValue() )
851  field.SetVisible( true );
852  else
853  field.SetVisible( false );
854 
855  if( rotateCheckBox->GetValue() )
856  field.SetTextAngle( TEXT_ANGLE_VERT );
857  else
859 
860  // Copy the text justification
861  static const EDA_TEXT_HJUSTIFY_T hjustify[3] = {
864  };
865 
866  static const EDA_TEXT_VJUSTIFY_T vjustify[3] = {
869  };
870 
871  field.SetHorizJustify( hjustify[m_FieldHJustifyCtrl->GetSelection()] );
872  field.SetVertJustify( vjustify[m_FieldVJustifyCtrl->GetSelection()] );
873 
874  // Blank/empty field texts for REFERENCE and VALUE are not allowed.
875  // (Value is the name of the component in lib!)
876  // Change them only if user provided a non blank value
877  if( !fieldValueTextCtrl->GetValue().IsEmpty() || fieldNdx > VALUE )
878  field.SetText( fieldValueTextCtrl->GetValue() );
879 
880  // FieldNameTextCtrl has a tricked value in it for VALUE index, do not copy it back.
881  // It has the "Chip Name" appended.
882  if( field.GetId() >= MANDATORY_FIELDS )
883  {
884  wxString name = fieldNameTextCtrl->GetValue();
885  field.SetName( name );
886  }
887 
888  setRowItem( fieldNdx, field ); // update fieldListCtrl
889 
891 
892  field.SetTextSize( wxSize( tmp, tmp ) );
893 
894  int style = m_StyleRadioBox->GetSelection();
895 
896  field.SetItalic( (style & 1 ) != 0 );
897  field.SetBold( (style & 2 ) != 0 );
898 
899  wxPoint pos( ValueFromString( g_UserUnit, posXTextCtrl->GetValue() ),
900  ValueFromString( g_UserUnit, posYTextCtrl->GetValue() ) );
901 
902  // Note: the Y axis for components in lib is from bottom to top
903  // and the screen axis is top to bottom: we must change the y coord sign for editing
904  pos.y = -pos.y;
905 
906  field.SetTextPos( pos );
907 
908  return true;
909 }
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:90
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:655
#define TEXT_ANGLE_VERT
Definition: common.h:91
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:675
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 709 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().

710 {
711  unsigned fieldNdx = getSelectedFieldNdx();
712 
713  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
714  return;
715 
716  LIB_FIELD& field = m_FieldsBuf[fieldNdx];
717 
718  showCheckBox->SetValue( field.IsVisible() );
719 
720  rotateCheckBox->SetValue( field.GetTextAngle() == TEXT_ANGLE_VERT );
721 
722  int style = 0;
723 
724  if( field.IsItalic() )
725  style = 1;
726 
727  if( field.IsBold() )
728  style |= 2;
729 
730  m_StyleRadioBox->SetSelection( style );
731 
732  // Select the right text justification
733  if( field.GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT )
734  m_FieldHJustifyCtrl->SetSelection(0);
735  else if( field.GetHorizJustify() == GR_TEXT_HJUSTIFY_RIGHT )
736  m_FieldHJustifyCtrl->SetSelection(2);
737  else
738  m_FieldHJustifyCtrl->SetSelection(1);
739 
740  if( field.GetVertJustify() == GR_TEXT_VJUSTIFY_BOTTOM )
741  m_FieldVJustifyCtrl->SetSelection(0);
742  else if( field.GetVertJustify() == GR_TEXT_VJUSTIFY_TOP )
743  m_FieldVJustifyCtrl->SetSelection(2);
744  else
745  m_FieldVJustifyCtrl->SetSelection(1);
746 
747 
748  // Field names have become more important than field ids, so we cannot
749  // mangle the names in the buffer but we can do so in the panel.
750  if( field.GetId() == VALUE )
751  {
752  // This field is the lib name and the default value when loading this component in
753  // schematic. The value is now not editable here (in this dialog) because changing
754  // it is equivalent to create a new component or alias. This is handles in libedir,
755  // not in this dialog.
756  fieldNameTextCtrl->SetValue( field.GetName() + wxT( " / " ) + _( "Chip Name" ) );
757  fieldValueTextCtrl->Enable( false );
758  }
759  else
760  {
761  fieldValueTextCtrl->Enable( true );
762  fieldNameTextCtrl->SetValue( field.GetName() );
763  }
764 
765  // if fieldNdx == REFERENCE, VALUE, FOOTPRINT, or DATASHEET, then disable field name editing
766  fieldNameTextCtrl->Enable( fieldNdx >= MANDATORY_FIELDS );
767  fieldNameTextCtrl->SetEditable( fieldNdx >= MANDATORY_FIELDS );
768 
769  // only user defined fields may be moved, and not the top most user defined
770  // field since it would be moving up into the fixed fields, > not >=
771  moveUpButton->Enable( fieldNdx > MANDATORY_FIELDS );
772  moveDownButton->Enable( ( fieldNdx >= MANDATORY_FIELDS ) && ( fieldNdx < ( m_FieldsBuf.size() - 1 ) ) );
773 
774  // if fieldNdx == REFERENCE, VALUE, then disable delete button
775  deleteFieldButton->Enable( fieldNdx >= MANDATORY_FIELDS );
776 
777  fieldValueTextCtrl->SetValidator( SCH_FIELD_VALIDATOR( true, field.GetId() ) );
778  fieldValueTextCtrl->SetValue( field.GetText() );
779 
781 
782  m_show_datasheet_button->Enable( fieldNdx == DATASHEET || fieldNdx == FOOTPRINT );
783 
784  if( fieldNdx == DATASHEET )
785  {
786  m_show_datasheet_button->SetLabel( _( "Show Datasheet" ) );
787  m_show_datasheet_button->SetToolTip(
788  _("If your datasheet is given as an http:// link,"
789  " then pressing this button should bring it up in your webbrowser.") );
790  }
791  else if( fieldNdx == FOOTPRINT )
792  {
793  m_show_datasheet_button->SetLabel( _( "Browse Footprints" ) );
794  m_show_datasheet_button->SetToolTip(
795  _("Open the footprint browser to choose a footprint and assign it.") );
796  }
797  else
798  {
799  m_show_datasheet_button->SetLabel( wxEmptyString );
800  m_show_datasheet_button->SetToolTip(
801  _("Used only for fields Footprint and Datasheet.") );
802  }
803 
804  wxPoint coord = field.GetTextPos();
805  wxPoint zero;
806 
807  // If the field value is empty and the position is at relative zero, we set the
808  // initial position as a small offset from the ref field, and orient
809  // it the same as the ref field. That is likely to put it at least
810  // close to the desired position.
811  if( coord == zero && field.GetText().IsEmpty() )
812  {
813  rotateCheckBox->SetValue( m_FieldsBuf[REFERENCE].GetTextAngle() == TEXT_ANGLE_VERT );
814 
815  coord.x = m_FieldsBuf[REFERENCE].GetTextPos().x +
816  (fieldNdx - MANDATORY_FIELDS + 1) * 100;
817  coord.y = m_FieldsBuf[REFERENCE].GetTextPos().y +
818  (fieldNdx - MANDATORY_FIELDS + 1) * 100;
819 
820  // coord can compute negative if field is < MANDATORY_FIELDS, e.g. FOOTPRINT.
821  // That is ok, we basically don't want all the new empty fields on
822  // top of each other.
823  }
824 
825  wxString coordText = StringFromValue( g_UserUnit, coord.x );
826  posXTextCtrl->SetValue( coordText );
827 
828  // Note: the Y axis for components in lib is from bottom to top
829  // and the screen axis is top to bottom: we must change the y coord sign for editing
830  coord.y = -coord.y;
831  coordText = StringFromValue( g_UserUnit, coord.y );
832  posYTextCtrl->SetValue( coordText );
833 }
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:91
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:605
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 388 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().

389 {
390  unsigned fieldNdx = getSelectedFieldNdx();
391 
392  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
393  return;
394 
395  if( fieldNdx < MANDATORY_FIELDS )
396  {
397  wxBell();
398  return;
399  }
400 
401  m_skipCopyFromPanel = true;
402 
403  if( m_FieldsBuf[fieldNdx].GetText().IsEmpty() )
404  {
405  m_FieldsBuf.erase( m_FieldsBuf.begin() + fieldNdx );
406  fieldListCtrl->DeleteItem( fieldNdx );
407 
408  if( fieldNdx >= m_FieldsBuf.size() )
409  --fieldNdx;
410  }
411  else
412  {
413  m_FieldsBuf[fieldNdx].Empty();
415  }
416 
417  updateDisplay( );
418 
419  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx] );
420  setSelectedFieldNdx( fieldNdx );
421  m_skipCopyFromPanel = false;
422 }
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 322 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().

323 {
324 #ifdef KICAD_SPICE
325  // DIALOG_SPICE_MODEL expects a SCH_COMPONENT,
326  // and a list of SCH_FIELDS to create/edit/delete Spice fields.
327  SCH_COMPONENT component; // This dummy component
328 
329  // Build fields list from the m_FieldsBuf fields buffer dialog
330  // to be sure to use the current fields.
331  SCH_FIELDS schfields;
332 
333  for( unsigned ii = 0; ii < m_FieldsBuf.size(); ++ii )
334  {
335  LIB_FIELD& libfield = m_FieldsBuf[ii];
336  SCH_FIELD schfield( libfield.GetTextPos(), libfield.GetId(),
337  &component, libfield.GetName() );
338  schfield.ImportValues( m_FieldsBuf[ii] );
339  schfield.SetText( m_FieldsBuf[ii].GetText() );
340 
341  schfields.push_back( schfield );
342  }
343 
344  component.SetFields( schfields );
345 
346  DIALOG_SPICE_MODEL dialog( this, component, schfields );
347 
348  if( dialog.ShowModal() != wxID_OK )
349  return;
350 
351  // Transfert sch fields to the m_FieldsBuf fields buffer dialog:
352  m_FieldsBuf.clear();
353 
354  for( unsigned ii = 0; ii < schfields.size(); ii++ )
355  {
356  LIB_FIELD libfield;
357  schfields[ii].ExportValues( libfield );
358  m_FieldsBuf.push_back( libfield );
359  }
360 
361  updateDisplay();
362 #endif /* KICAD_SPICE */
363 }
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:605
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 570 of file dialog_edit_libentry_fields_in_lib.cpp.

References m_FieldsBuf.

Referenced by initBuffers().

571 {
572  for( unsigned i=0; i<m_FieldsBuf.size(); ++i )
573  {
574  if( aFieldName == m_FieldsBuf[i].GetName() )
575  return &m_FieldsBuf[i];
576  }
577  return NULL;
578 }
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_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), 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 581 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().

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

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

426 {
427  unsigned int fieldNdx = getSelectedFieldNdx();
428 
429  // Ensure there is at least one field after this one
430  if( fieldNdx >= ( m_FieldsBuf.size() - 1 ) )
431  {
432  return;
433  }
434 
435  // The first field which can be moved up is the second user field
436  // so any field which id < MANDATORY_FIELDS cannot be moved down
437  if( fieldNdx < MANDATORY_FIELDS )
438  return;
439 
440  if( !copyPanelToSelectedField() )
441  return;
442 
443  // swap the fieldNdx field with the one before it, in both the vector
444  // and in the fieldListCtrl
445  LIB_FIELD tmp = m_FieldsBuf[fieldNdx + 1];
446 
447  m_FieldsBuf[fieldNdx + 1] = m_FieldsBuf[fieldNdx];
448  setRowItem( fieldNdx + 1, m_FieldsBuf[fieldNdx] );
449  m_FieldsBuf[fieldNdx + 1].SetId( fieldNdx + 1 );
450 
451  m_FieldsBuf[fieldNdx] = tmp;
452  setRowItem( fieldNdx, tmp );
453  m_FieldsBuf[fieldNdx].SetId( fieldNdx );
454 
455  updateDisplay( );
456 
457  m_skipCopyFromPanel = true;
458  setSelectedFieldNdx( fieldNdx + 1 );
459  m_skipCopyFromPanel = false;
460 }
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 463 of file dialog_edit_libentry_fields_in_lib.cpp.

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

464 {
465  unsigned fieldNdx = getSelectedFieldNdx();
466 
467  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
468  return;
469 
470  // The first field which can be moved up is the second user field
471  // so any field which id <= MANDATORY_FIELDS cannot be moved up
472  if( fieldNdx <= MANDATORY_FIELDS )
473  return;
474 
475  if( !copyPanelToSelectedField() )
476  return;
477 
478  // swap the fieldNdx field with the one before it, in both the vector
479  // and in the fieldListCtrl
480  LIB_FIELD tmp = m_FieldsBuf[fieldNdx - 1];
481 
482  m_FieldsBuf[fieldNdx - 1] = m_FieldsBuf[fieldNdx];
483  setRowItem( fieldNdx - 1, m_FieldsBuf[fieldNdx] );
484  m_FieldsBuf[fieldNdx - 1].SetId(fieldNdx - 1);
485 
486  m_FieldsBuf[fieldNdx] = tmp;
487  setRowItem( fieldNdx, tmp );
488  m_FieldsBuf[fieldNdx].SetId(fieldNdx);
489 
490  updateDisplay( );
491 
492  m_skipCopyFromPanel = true;
493  setSelectedFieldNdx( fieldNdx - 1 );
494  m_skipCopyFromPanel = false;
495 }
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 242 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_SHIM::EndQuasiModal().

243 {
244  EndQuasiModal( wxID_CANCEL );
245 }
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 248 of file dialog_edit_libentry_fields_in_lib.cpp.

References DIALOG_SHIM::EndQuasiModal().

249 {
250  // On wxWidgets 2.8, and on Linux, call EndQuasiModal here is mandatory
251  // Otherwise, the main event loop is never restored, and Eeschema does not
252  // respond to any event, because the DIALOG_SHIM destructor is never called.
253  // on wxWidgets 3.0, or on Windows, the DIALOG_SHIM destructor is called,
254  // and calls EndQuasiModal.
255  // Therefore calling EndQuasiModal here is not mandatory but it creates no issues.
256  EndQuasiModal( wxID_CANCEL );
257 }
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 196 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.

197 {
198  m_skipCopyFromPanel = false;
199  wxListItem columnLabel;
200 
201  columnLabel.SetImage( -1 );
202 
203  columnLabel.SetText( _( "Name" ) );
204  fieldListCtrl->InsertColumn( COLUMN_FIELD_NAME, columnLabel );
205 
206  columnLabel.SetText( _( "Value" ) );
207  fieldListCtrl->InsertColumn( COLUMN_TEXT, columnLabel );
208 
212 
213  initBuffers();
215 
216  stdDialogButtonSizerOK->SetDefault();
217 
218  // Now all widgets have the size fixed, call FinishDialogSettings
220 }
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 223 of file dialog_edit_libentry_fields_in_lib.cpp.

References copyPanelToSelectedField(), and m_skipCopyFromPanel.

224 {
225  if( !m_skipCopyFromPanel )
226  {
227  if( !copyPanelToSelectedField() )
228  event.Skip(); // do not go to the next row
229  }
230 }
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 233 of file dialog_edit_libentry_fields_in_lib.cpp.

References copySelectedFieldToPanel(), and s_SelectedRow.

234 {
235  // remember the selected row, statically
236  s_SelectedRow = event.GetIndex();
237 
239 }
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 260 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.

261 {
262  if( !copyPanelToSelectedField() )
263  return;
264 
265  // test if reference prefix is acceptable
267  {
268  DisplayError( NULL, _( "Illegal reference. References must start with a letter." ) );
269  return;
270  }
271 
272  /* Note: this code is now (2010-dec-04) not used, because the value field is no more editable
273  * because changing the value is equivalent to create a new component or alias.
274  * This is now handled in libedit main frame, and no more in this dialog
275  * but this code is not removed, just in case
276  */
277  /* If a new name entered in the VALUE field, that it not an existing alias name
278  * or root alias of the component */
279  wxString newvalue = m_FieldsBuf[VALUE].GetText();
280 
281  if( m_libEntry->HasAlias( newvalue ) && !m_libEntry->GetAlias( newvalue )->IsRoot() )
282  {
283  wxString msg = wxString::Format(
284  _( "A new name is entered for this component\n"
285  "An alias %s already exists!\n"
286  "Cannot update this component" ),
287  GetChars( newvalue )
288  );
289  DisplayError( this, msg );
290  return;
291  }
292  /* End unused code */
293 
294  // save old cmp in undo list
296 
297  // delete any fields with no name or no value before we copy all of m_FieldsBuf
298  // back into the component
299  for( unsigned i = MANDATORY_FIELDS; i < m_FieldsBuf.size(); )
300  {
301  if( m_FieldsBuf[i].GetName().IsEmpty() || m_FieldsBuf[i].GetText().IsEmpty() )
302  {
303  m_FieldsBuf.erase( m_FieldsBuf.begin() + i );
304  continue;
305  }
306 
307  ++i;
308  }
309 
310  // copy all the fields back, fully replacing any previous fields
312 
313  // We need to keep the name and the value the same at the moment!
314  SetName( m_libEntry->GetValueField().GetText() );
315 
316  m_parent->OnModify();
317 
318  EndQuasiModal( wxID_OK );
319 }
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()
Must be called after a schematic change in order to set the "modify" flag of the current screen...
Definition: libeditframe.h:352
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)
Create a copy of the current component, and save it in the undo list.
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 DIALOG_EDIT_COMPONENT_IN_LIBRARY::AddAliasOfPart(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), LIB_EDIT_FRAME::CreateNewLibraryPart(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), LIB_EDIT_FRAME::DeleteOnePart(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), 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_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), FOOTPRINT_EDIT_FRAME::getLibPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), 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(), LIB_EDIT_FRAME::OnSaveCurrentPart(), DIALOG_NETLIST::OnSaveMessagesToFile(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), LIB_EDIT_FRAME::OnUpdateSaveCurrentLib(), LIB_EDIT_FRAME::OnUpdateSaveCurrentLibAs(), 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(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), 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::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), 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_CHOOSE_COMPONENT::ShowFootprintFor(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), 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 686 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().

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

Definition at line 127 of file dialog_edit_libentry_fields_in_lib.cpp.

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

128  {
129  setRowItem( aFieldNdx, aField.GetName(), aField.GetText() );
130  }
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:605
void DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::setSelectedFieldNdx ( int  aFieldNdx)
private

Definition at line 525 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().

526 {
527  // deselect old selection, but I think this is done by single selection
528  // flag within fieldListCtrl
529  // fieldListCtrl->SetItemState( s_SelectedRow, 0, wxLIST_STATE_SELECTED|wxLIST_STATE_FOCUSED);
530 
531  if( aFieldNdx >= (int) m_FieldsBuf.size() )
532  aFieldNdx = m_FieldsBuf.size() - 1;
533 
534  if( aFieldNdx < 0 )
535  aFieldNdx = 0;
536 
537  fieldListCtrl->SetItemState( aFieldNdx, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
538  fieldListCtrl->EnsureVisible( aFieldNdx );
539 
540  s_SelectedRow = aFieldNdx;
541 }
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 498 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, GetAssociatedDocument(), getSelectedFieldNdx(), KIWAY_HOLDER::Kiway(), m_FieldsBuf, KIWAY::Player(), setRowItem(), and KIWAY_PLAYER::ShowModal().

499 {
500  unsigned fieldNdx = getSelectedFieldNdx();
501 
502  if( fieldNdx == DATASHEET )
503  {
504  wxString datasheet_uri = fieldValueTextCtrl->GetValue();
505  GetAssociatedDocument( this, datasheet_uri );
506  }
507  else if( fieldNdx == FOOTPRINT )
508  {
509  // pick a footprint using the footprint picker.
510  wxString fpid;
511 
513 
514  if( frame->ShowModal( &fpid, this ) )
515  {
516  fieldValueTextCtrl->SetValue( fpid );
517  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx].GetName( false ), fpid );
518  }
519 
520  frame->Destroy();
521  }
522 }
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)
bool GetAssociatedDocument(wxWindow *aParent, const wxString &aDocName, const wxPathList *aPaths)
Function GetAssociatedDocument open a document (file) with the suitable browser.
Definition: eda_doc.cpp:86
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(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), 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 137 of file dialog_edit_libentry_fields_in_lib.cpp.

References m_FieldsBuf, MANDATORY_FIELDS, and setRowItem().

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

138  {
139  for( unsigned ii = MANDATORY_FIELDS; ii<m_FieldsBuf.size(); ii++ )
140  setRowItem( ii, m_FieldsBuf[ii] );
141  }
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: