KiCad PCB EDA Suite
DIALOG_SCH_FIELD_PROPERTIES Class Reference

Handle editing a single symbol field in the schematic editor. More...

#include <dialog_field_properties.h>

Inheritance diagram for DIALOG_SCH_FIELD_PROPERTIES:
DIALOG_FIELD_PROPERTIES DIALOG_LIB_TEXT_PROPERTIES_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_SCH_FIELD_PROPERTIES (SCH_BASE_FRAME *aParent, const wxString &aTitle, const SCH_FIELD *aField)
 
 ~DIALOG_SCH_FIELD_PROPERTIES ()
 
void onScintillaCharAdded (wxStyledTextEvent &aEvent)
 
void UpdateField (SCH_FIELD *aField, SCH_SHEET_PATH *aSheetPath)
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
SCH_BASE_FRAMEGetParent ()
 
const wxString & GetText () const
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
void OnModify ()
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

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

Protected Member Functions

void init ()
 
void updateText (EDA_TEXT *aText)
 
void OnTextValueSelectButtonClick (wxCommandEvent &aEvent) override
 Handle the select button next to the text value field. More...
 
virtual void OnSetFocusText (wxFocusEvent &event) override
 Used to select the variant part of some text fields (for instance, the question mark or number in a reference). More...
 
virtual void OnCloseDialog (wxCloseEvent &event)
 
void finishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void setSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int horizPixelsFromDU (int x) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

UNIT_BINDER m_posX
 
UNIT_BINDER m_posY
 
UNIT_BINDER m_textSize
 
int m_fieldId
 
bool m_isPower
 
wxString m_text
 
bool m_isItalic
 
bool m_isBold
 
wxPoint m_position
 
int m_size
 
bool m_isVertical
 
int m_verticalJustification
 
int m_horizontalJustification
 
bool m_isVisible
 
bool m_firstFocus
 
SCINTILLA_TRICKSm_scintillaTricks
 
wxStaticText * m_textLabel
 
wxTextCtrl * m_TextCtrl
 
wxStyledTextCtrl * m_StyledTextCtrl
 
wxBitmapButton * m_TextValueSelectButton
 
wxStaticText * m_note
 
wxCheckBox * m_visible
 
wxStaticText * m_xPosLabel
 
wxTextCtrl * m_xPosCtrl
 
wxStaticText * m_xPosUnits
 
wxCheckBox * m_italic
 
wxStaticText * m_orientLabel
 
wxChoice * m_orientChoice
 
wxStaticText * m_yPosLabel
 
wxTextCtrl * m_yPosCtrl
 
wxStaticText * m_yPosUnits
 
wxCheckBox * m_bold
 
wxStaticText * m_hAlignLabel
 
wxChoice * m_hAlignChoice
 
wxStaticText * m_textSizeLabel
 
wxTextCtrl * m_textSizeCtrl
 
wxStaticText * m_textSizeUnits
 
wxStaticText * m_vAlignLabel
 
wxChoice * m_vAlignChoice
 
wxCheckBox * m_CommonUnit
 
wxCheckBox * m_CommonConvert
 
wxStaticLine * m_staticline2
 
wxStdDialogButtonSizer * m_sdbSizerButtons
 
wxButton * m_sdbSizerButtonsOK
 
wxButton * m_sdbSizerButtonsCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 
wxSize m_initialSize
 

Private Attributes

const SCH_FIELDm_field
 
bool m_isSheetFilename
 

Detailed Description

Handle editing a single symbol field in the schematic editor.

Note
Use ShowQuasiModal when calling this class!

Definition at line 145 of file dialog_field_properties.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_SCH_FIELD_PROPERTIES()

DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES ( SCH_BASE_FRAME aParent,
const wxString &  aTitle,
const SCH_FIELD aField 
)

Definition at line 312 of file dialog_field_properties.cpp.

314  :
315  DIALOG_FIELD_PROPERTIES( aParent, aTitle, aField ),
316  m_field( aField )
317 {
318  m_isSheetFilename = false;
319 
320  if( aField->GetParent() && aField->GetParent()->Type() == SCH_SYMBOL_T )
321  {
322  m_fieldId = aField->GetId();
323  }
324  else if( aField->GetParent() && aField->GetParent()->Type() == SCH_SHEET_T )
325  {
326  switch( aField->GetId() )
327  {
328  case SHEETNAME:
330  break;
331 
332  case SHEETFILENAME:
333  m_isSheetFilename = true;
335  m_note->SetLabel( wxString::Format( m_note->GetLabel(),
336  _( "Sheet filename can only be modified in Sheet Properties dialog." ) ) );
337  m_note->Show( true );
338  break;
339 
340  default:
342  break;
343  }
344  }
345 
346  // show text variable cross-references in a human-readable format
347  m_text = aField->Schematic()->ConvertKIIDsToRefs( aField->GetText() );
348 
349  m_isPower = false;
350 
351  m_textLabel->SetLabel( m_field->GetName() + ":" );
352 
354 
357 
358  // The library symbol may have been removed so using SCH_SYMBOL::GetLibSymbolRef() here
359  // could result in a segfault. If the library symbol is no longer available, the
360  // schematic fields can still edit so set the power symbol flag to false. This may not
361  // be entirely accurate if the power library is missing but it's better then a segfault.
362  if( aField->GetParent() && aField->GetParent()->Type() == SCH_SYMBOL_T )
363  {
364  const SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( aField->GetParent() );
365  const LIB_SYMBOL* libSymbol = GetParent()->GetLibSymbol( symbol->GetLibId(), true );
366 
367  if( libSymbol && libSymbol->IsPower() )
368  m_isPower = true;
369  }
370 
371  m_StyledTextCtrl->Bind( wxEVT_STC_CHARADDED,
373 
374  init();
375 
376  if( m_isSheetFilename )
377  {
378  m_StyledTextCtrl->Enable( false );
379  m_TextCtrl->Enable( false );
380  }
381 }
wxPoint GetPosition() const override
Definition: sch_field.cpp:843
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:104
int GetId() const
Definition: sch_field.h:113
Define a library symbol object.
Definition: lib_symbol.h:96
#define SHEETNAME_V
void onScintillaCharAdded(wxStyledTextEvent &aEvent)
EDA_TEXT_VJUSTIFY_T GetEffectiveVertJustify() const
Definition: sch_field.cpp:407
#define SHEETFILENAME_V
DIALOG_FIELD_PROPERTIES(SCH_BASE_FRAME *aParent, const wxString &aTitle, const EDA_TEXT *aTextItem)
EDA_ITEM * GetParent() const
Definition: eda_item.h:114
#define _(s)
#define SHEETUSERFIELD_V
EDA_TEXT_HJUSTIFY_T GetEffectiveHorizJustify() const
Definition: sch_field.cpp:370
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxString ConvertKIIDsToRefs(const wxString &aSource) const
Definition: schematic.cpp:344
Schematic symbol object.
Definition: sch_symbol.h:78
wxString GetName(bool aUseDefaultName=true) const
Return the field name.
Definition: sch_field.cpp:679
LIB_SYMBOL * GetLibSymbol(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:154
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:147

References _, SCHEMATIC::ConvertKIIDsToRefs(), Format(), SCH_FIELD::GetEffectiveHorizJustify(), SCH_FIELD::GetEffectiveVertJustify(), SCH_FIELD::GetId(), SCH_SYMBOL::GetLibId(), SCH_BASE_FRAME::GetLibSymbol(), SCH_FIELD::GetName(), DIALOG_FIELD_PROPERTIES::GetParent(), EDA_ITEM::GetParent(), SCH_FIELD::GetPosition(), EDA_TEXT::GetText(), DIALOG_FIELD_PROPERTIES::init(), m_field, DIALOG_FIELD_PROPERTIES::m_fieldId, DIALOG_FIELD_PROPERTIES::m_horizontalJustification, DIALOG_FIELD_PROPERTIES::m_isPower, m_isSheetFilename, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_note, DIALOG_FIELD_PROPERTIES::m_position, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_StyledTextCtrl, DIALOG_FIELD_PROPERTIES::m_text, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_TextCtrl, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_textLabel, DIALOG_FIELD_PROPERTIES::m_verticalJustification, onScintillaCharAdded(), SCH_SHEET_T, SCH_SYMBOL_T, SCH_ITEM::Schematic(), SHEETFILENAME, SHEETFILENAME_V, SHEETNAME, SHEETNAME_V, SHEETUSERFIELD_V, and EDA_ITEM::Type().

◆ ~DIALOG_SCH_FIELD_PROPERTIES()

DIALOG_SCH_FIELD_PROPERTIES::~DIALOG_SCH_FIELD_PROPERTIES ( )
inline

Definition at line 151 of file dialog_field_properties.h.

151 {}

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 312 of file dialog_shim.cpp.

313 {
314  // so we can do logging of this state change:
315  return wxDialog::Enable( enable );
316 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 480 of file dialog_shim.cpp.

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

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

Referenced by NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )
protectedinherited

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

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 151 of file dialog_shim.cpp.

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

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetParent()

SCH_BASE_FRAME* DIALOG_FIELD_PROPERTIES::GetParent ( void  )
inlineinherited

Definition at line 58 of file dialog_field_properties.h.

58 { return dynamic_cast< SCH_BASE_FRAME* >( wxDialog::GetParent() ); }

Referenced by DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_FIELD_PROPERTIES::init(), onScintillaCharAdded(), and UpdateField().

◆ GetText()

const wxString& DIALOG_FIELD_PROPERTIES::GetText ( ) const
inlineinherited

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 169 of file dialog_shim.cpp.

170 {
171  wxSize sz( x, 0 );
172  return ConvertDialogToPixels( sz ).x;
173 }

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

◆ init()

void DIALOG_FIELD_PROPERTIES::init ( )
protectedinherited

Definition at line 90 of file dialog_field_properties.cpp.

91 {
92  SCH_BASE_FRAME* parent = GetParent();
93  bool isSymbolEditor = parent && parent->IsType( FRAME_SCH_SYMBOL_EDITOR );
94 
95  // Disable options for graphic text editing which are not needed for fields.
96  m_CommonConvert->Show( false );
97  m_CommonUnit->Show( false );
98 
99  // Predefined fields cannot contain some chars, or cannot be empty,
100  // and need a SCH_FIELD_VALIDATOR (m_StyledTextCtrl cannot use a SCH_FIELD_VALIDATOR).
101  bool use_validator = m_fieldId == REFERENCE_FIELD
102  || m_fieldId == VALUE_FIELD
105  || m_fieldId == SHEETNAME_V
107 
108  if( use_validator )
109  {
110  m_TextCtrl->SetValidator( SCH_FIELD_VALIDATOR( isSymbolEditor, m_fieldId, &m_text ) );
112 
113  m_StyledTextCtrl->Show( false );
114  }
115  else
116  {
118 
119  m_TextCtrl->Show( false );
120  }
121 
122  // Show the footprint selection dialog if this is the footprint field.
125 
126  // Value fields of power symbols cannot be modified. This will grey out
127  // the text box and display an explanation.
128  if( m_fieldId == VALUE_FIELD && m_isPower )
129  {
130  m_note->SetLabel( wxString::Format( m_note->GetLabel(),
131  _( "Power symbol value field text cannot be changed." ) ) );
132  m_note->Show( true );
133  m_TextCtrl->Enable( false );
134  }
135  else
136  {
137  m_TextCtrl->Enable( true );
138  }
139 
140  m_sdbSizerButtonsOK->SetDefault();
141 
142  GetSizer()->SetSizeHints( this );
143 
144  // Adjust the height of the scintilla text editor after the first layout
145  // To show only one line
146  // (multiline text are is supported in fields and will be removed)
147  if( m_StyledTextCtrl->IsShown() )
148  {
149  wxSize maxSize = m_StyledTextCtrl->GetSize();
150  maxSize.x = -1; // Do not fix the max width
151  maxSize.y = m_xPosCtrl->GetSize().y;
152  m_StyledTextCtrl->SetMaxSize( maxSize );
153  m_StyledTextCtrl->SetUseVerticalScrollBar( false );
154  m_StyledTextCtrl->SetUseHorizontalScrollBar( false );
155  }
156 
157  // Now all widgets have the size fixed, call FinishDialogSettings
159 }
Field Reference of part, i.e. "IC21".
#define SHEETNAME_V
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:97
name of datasheet
Field Value of part, i.e. "3.3K".
#define SHEETFILENAME_V
#define _(s)
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
bool IsType(FRAME_T aType) const
A text control validator used for validating the text allowed in library and schematic symbol fields.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Field Name Module PCB, i.e. "16DIP300".

References _, DATASHEET_FIELD, DIALOG_SHIM::finishDialogSettings(), FOOTPRINT_FIELD, Format(), FRAME_SCH_SYMBOL_EDITOR, DIALOG_FIELD_PROPERTIES::GetParent(), EDA_BASE_FRAME::IsType(), KiBitmap(), DIALOG_LIB_TEXT_PROPERTIES_BASE::m_CommonConvert, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_CommonUnit, DIALOG_FIELD_PROPERTIES::m_fieldId, DIALOG_FIELD_PROPERTIES::m_isPower, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_note, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_sdbSizerButtonsOK, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_StyledTextCtrl, DIALOG_FIELD_PROPERTIES::m_text, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_TextCtrl, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_TextValueSelectButton, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_xPosCtrl, REFERENCE_FIELD, DIALOG_SHIM::SetInitialFocus(), SHEETFILENAME_V, SHEETNAME_V, small_library, and VALUE_FIELD.

Referenced by DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), and DIALOG_SCH_FIELD_PROPERTIES().

◆ IsCtrl()

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

Definition at line 126 of file dialog_shim.h.

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

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 132 of file dialog_shim.h.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

54  {
55  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56  return *m_kiway;
57  }
KIWAY * m_kiway
Definition: kiway_holder.h:75

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AskToSaveChanges(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, and HTML_MESSAGE_BOX.

Definition at line 570 of file dialog_shim.cpp.

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

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

Referenced by DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_TEXT_PROPERTIES::~DIALOG_TEXT_PROPERTIES().

◆ OnCloseDialog()

virtual void DIALOG_LIB_TEXT_PROPERTIES_BASE::OnCloseDialog ( wxCloseEvent &  event)
inlineprotectedvirtualinherited

◆ OnModify()

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 380 of file dialog_shim.cpp.

381 {
382  if( m_firstPaintEvent )
383  {
385 
386  selectAllInTextCtrls( GetChildren() );
387 
390  else
391  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
392 
393  m_firstPaintEvent = false;
394  }
395 
396  event.Skip();
397 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:211
bool m_firstPaintEvent
Definition: dialog_shim.h:210
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onScintillaCharAdded()

void DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded ( wxStyledTextEvent &  aEvent)

Definition at line 384 of file dialog_field_properties.cpp.

385 {
386  int key = aEvent.GetKey();
387 
388  SCH_EDIT_FRAME* editFrame = static_cast<SCH_EDIT_FRAME*>( GetParent() );
389  wxArrayString autocompleteTokens;
390  int pos = m_StyledTextCtrl->GetCurrentPos();
391  int start = m_StyledTextCtrl->WordStartPosition( pos, true );
392  wxString partial;
393 
394  // Currently, '\n' is not allowed in fields. So remove it when entered
395  // TODO: see if we must close the dialog. However this is not obvious, as
396  // if a \n is typed (and removed) when a text is selected, this text is deleted
397  // (in fact replaced by \n, that is removed by the filter)
398  if( key == '\n' )
399  {
400  wxString text = m_StyledTextCtrl->GetText();
401  int currpos = m_StyledTextCtrl->GetCurrentPos();
402  text.Replace( "\n", "" );
403  m_StyledTextCtrl->SetText( text );
404  m_StyledTextCtrl->GotoPos( currpos-1 );
405  return;
406  }
407 
408  auto textVarRef =
409  [&]( int pt )
410  {
411  return pt >= 2
412  && m_StyledTextCtrl->GetCharAt( pt - 2 ) == '$'
413  && m_StyledTextCtrl->GetCharAt( pt - 1 ) == '{';
414  };
415 
416  // Check for cross-reference
417  if( start > 1 && m_StyledTextCtrl->GetCharAt( start - 1 ) == ':' )
418  {
419  int refStart = m_StyledTextCtrl->WordStartPosition( start - 1, true );
420 
421  if( textVarRef( refStart ) )
422  {
423  partial = m_StyledTextCtrl->GetRange( start, pos );
424 
425  wxString ref = m_StyledTextCtrl->GetRange( refStart, start - 1 );
426  SCH_SHEET_LIST sheets = editFrame->Schematic().GetSheets();
427  SCH_REFERENCE_LIST refs;
428  SCH_SYMBOL* refSymbol = nullptr;
429 
430  sheets.GetSymbols( refs );
431 
432  for( size_t jj = 0; jj < refs.GetCount(); jj++ )
433  {
434  if( refs[ jj ].GetSymbol()->GetRef( &refs[ jj ].GetSheetPath(), true ) == ref )
435  {
436  refSymbol = refs[ jj ].GetSymbol();
437  break;
438  }
439  }
440 
441  if( refSymbol )
442  refSymbol->GetContextualTextVars( &autocompleteTokens );
443  }
444  }
445  else if( textVarRef( start ) )
446  {
447  partial = m_StyledTextCtrl->GetTextRange( start, pos );
448 
449  SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_field->GetParent() );
450  SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( m_field->GetParent() );
451 
452  if( symbol )
453  {
454  symbol->GetContextualTextVars( &autocompleteTokens );
455 
456  SCHEMATIC* schematic = symbol->Schematic();
457 
458  if( schematic && schematic->CurrentSheet().Last() )
459  schematic->CurrentSheet().Last()->GetContextualTextVars( &autocompleteTokens );
460  }
461 
462  if( sheet )
463  sheet->GetContextualTextVars( &autocompleteTokens );
464 
465  for( std::pair<wxString, wxString> entry : Prj().GetTextVars() )
466  autocompleteTokens.push_back( entry.first );
467  }
468 
469  m_scintillaTricks->DoAutocomplete( partial, autocompleteTokens );
470  m_StyledTextCtrl->SetFocus();
471 }
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Holds all the data relating to one schematic.
Definition: schematic.h:59
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
void DoAutocomplete(const wxString &aPartial, const wxArrayString &aTokens)
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:104
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this sheet.
Definition: sch_sheet.cpp:212
Schematic editor (Eeschema) main window.
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this symbol.
Definition: sch_symbol.cpp:928
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
SCHEMATIC & Schematic() const
size_t GetCount() const
EDA_ITEM * GetParent() const
Definition: eda_item.h:114
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
SCINTILLA_TRICKS * m_scintillaTricks
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:121

References SCHEMATIC::CurrentSheet(), SCINTILLA_TRICKS::DoAutocomplete(), SCH_SHEET::GetContextualTextVars(), SCH_SYMBOL::GetContextualTextVars(), SCH_REFERENCE_LIST::GetCount(), DIALOG_FIELD_PROPERTIES::GetParent(), EDA_ITEM::GetParent(), SCHEMATIC::GetSheets(), SCH_SHEET_LIST::GetSymbols(), SCH_SHEET_PATH::Last(), m_field, DIALOG_FIELD_PROPERTIES::m_scintillaTricks, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_StyledTextCtrl, KIWAY_HOLDER::Prj(), SCH_EDIT_FRAME::Schematic(), SCH_ITEM::Schematic(), and text.

Referenced by DIALOG_SCH_FIELD_PROPERTIES().

◆ OnSetFocusText()

void DIALOG_FIELD_PROPERTIES::OnSetFocusText ( wxFocusEvent &  event)
overrideprotectedvirtualinherited

Used to select the variant part of some text fields (for instance, the question mark or number in a reference).

Reimplemented from DIALOG_LIB_TEXT_PROPERTIES_BASE.

Definition at line 186 of file dialog_field_properties.cpp.

187 {
188  if( m_firstFocus )
189  {
190 #ifdef __WXGTK__
191  // Force an update of the text control before setting the text selection
192  // This is needed because GTK seems to ignore the selection on first update
193  //
194  // Note that we can't do this on OSX as it tends to provoke Apple's
195  // "[NSAlert runModal] may not be invoked inside of transaction begin/commit pair"
196  // bug. See: https://bugs.launchpad.net/kicad/+bug/1837225
198  m_TextCtrl->Update();
199 #endif
200 
201  if( m_fieldId == REFERENCE_FIELD )
202  KIUI::SelectReferenceNumber( static_cast<wxTextEntry*>( m_TextCtrl ) );
203  else if( m_fieldId == VALUE_FIELD || m_fieldId == SHEETNAME_V )
204  m_TextCtrl->SetSelection( -1, -1 );
205 
206  m_firstFocus = false;
207  }
208 
209  event.Skip();
210 }
Field Reference of part, i.e. "IC21".
void SelectReferenceNumber(wxTextEntry *aTextEntry)
Select the number (or "?") in a reference for ease of editing.
Definition: ui_common.cpp:185
#define SHEETNAME_V
Field Value of part, i.e. "3.3K".

References DIALOG_FIELD_PROPERTIES::m_fieldId, DIALOG_FIELD_PROPERTIES::m_firstFocus, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_TextCtrl, REFERENCE_FIELD, KIUI::SelectReferenceNumber(), SHEETNAME_V, and VALUE_FIELD.

◆ OnTextValueSelectButtonClick()

void DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick ( wxCommandEvent &  aEvent)
overrideprotectedvirtualinherited

Handle the select button next to the text value field.

The current assumption is that this event will only be enabled for footprint type fields. In the future this function may need to be moved to the subclasses to access m_field and check for the field type if more select actions are desired.

Parameters
aEventis the wX event thrown when the button is clicked, this isn't used

Reimplemented from DIALOG_LIB_TEXT_PROPERTIES_BASE.

Definition at line 162 of file dialog_field_properties.cpp.

163 {
164  // pick a footprint using the footprint picker.
165  wxString fpid;
166 
167  if( m_StyledTextCtrl->IsShown() )
168  fpid = m_StyledTextCtrl->GetValue();
169  else
170  fpid = m_TextCtrl->GetValue();
171 
173 
174  if( frame->ShowModal( &fpid, this ) )
175  {
176  if( m_StyledTextCtrl->IsShown() )
177  m_StyledTextCtrl->SetValue( fpid );
178  else
179  m_TextCtrl->SetValue( fpid );
180  }
181 
182  frame->Destroy();
183 }
virtual bool ShowModal(wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until t...
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:64
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:383
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

References KIWAY_PLAYER::Destroy(), FRAME_FOOTPRINT_VIEWER_MODAL, KIWAY_HOLDER::Kiway(), DIALOG_LIB_TEXT_PROPERTIES_BASE::m_StyledTextCtrl, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_TextCtrl, KIWAY::Player(), and KIWAY_PLAYER::ShowModal().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

37 {
38  return Kiway().Prj();
39 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:190

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SIM_PLOT_FRAME::getDefaultFilename(), SIM_PLOT_FRAME::getDefaultPath(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::loadWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChange(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_EDIT_FRAME::saveSchematicFile(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ resetSize()

void DIALOG_SHIM::resetSize ( )
protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 287 of file dialog_shim.cpp.

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

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 97 of file dialog_shim.h.

98  {
99  m_initialFocusTarget = aWindow;
100  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:211

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateWindow().

Definition at line 43 of file kiway_holder.cpp.

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

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 190 of file dialog_shim.cpp.

191 {
192  wxDialog::SetPosition( aNewPosition );
193 
194  // Now update the stored position:
195  const char* hash_key;
196 
197  if( m_hash_key.size() )
198  {
199  // a special case like EDA_LIST_DIALOG, which has multiple uses.
200  hash_key = m_hash_key.c_str();
201  }
202  else
203  {
204  hash_key = typeid(*this).name();
205  }
206 
207  std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
208 
209  if( it == class_map.end() )
210  return;
211 
212  wxRect rect = it->second;
213  rect.SetPosition( aNewPosition );
214 
215  class_map[ hash_key ] = rect;
216 }
std::string m_hash_key
Definition: dialog_shim.h:201
static std::unordered_map< std::string, wxRect > class_map
void SetPosition(const wxString &aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)

References class_map, DIALOG_SHIM::m_hash_key, and PCAD2KICAD::SetPosition().

Referenced by PCB_BASE_FRAME::SelectOneLayer().

◆ setSizeInDU()

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

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

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

Definition at line 162 of file dialog_shim.cpp.

163 {
164  wxSize sz( x, y );
165  SetSize( ConvertDialogToPixels( sz ) );
166 }

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 219 of file dialog_shim.cpp.

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

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

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 430 of file dialog_shim.cpp.

431 {
432  // This is an exception safe way to zero a pointer before returning.
433  // Yes, even though DismissModal() clears this first normally, this is
434  // here in case there's an exception before the dialog is dismissed.
435  struct NULLER
436  {
437  void*& m_what;
438  NULLER( void*& aPtr ) : m_what( aPtr ) {}
439  ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
440  } clear_this( (void*&) m_qmodal_loop );
441 
442  // release the mouse if it's currently captured as the window having it
443  // will be disabled when this dialog is shown -- but will still keep the
444  // capture making it impossible to do anything in the modal dialog itself
445  wxWindow* win = wxWindow::GetCapture();
446  if( win )
447  win->ReleaseMouse();
448 
449  // Get the optimal parent
450  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
451 
452  wxASSERT_MSG( !m_qmodal_parent_disabler,
453  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
454 
455  // quasi-modal: disable only my "optimal" parent
457 
458  // Apple in its infinite wisdom will raise a disabled window before even passing
459  // us the event, so we have no way to stop it. Instead, we must set an order on
460  // the windows so that the quasi-modal will be pushed in front of the disabled
461  // window when it is raised.
463 
464  Show( true );
465 
466  m_qmodal_showing = true;
467 
468  WX_EVENT_LOOP event_loop;
469 
470  m_qmodal_loop = &event_loop;
471 
472  event_loop.Run();
473 
474  m_qmodal_showing = false;
475 
476  return GetReturnCode();
477 }
bool m_qmodal_showing
Definition: dialog_shim.h:215
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:213
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:216
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:44
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:65

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ TransferDataFromWindow()

bool DIALOG_FIELD_PROPERTIES::TransferDataFromWindow ( )
overrideinherited

Definition at line 234 of file dialog_field_properties.cpp.

235 {
236  if( m_TextCtrl->IsShown() )
237  m_text = m_TextCtrl->GetValue();
238  else if( m_StyledTextCtrl->IsShown() )
239  m_text = m_StyledTextCtrl->GetValue();
240 
241  if( m_fieldId == REFERENCE_FIELD )
242  {
243  // Test if the reference string is valid:
245  {
246  DisplayError( this, _( "Illegal reference designator value!" ) );
247  return false;
248  }
249  }
250  else if( m_fieldId == VALUE_FIELD )
251  {
252  if( m_text.IsEmpty() )
253  {
254  DisplayError( this, _( "Value may not be empty." ) );
255  return false;
256  }
257  }
258  else if( m_fieldId == SHEETFILENAME_V )
259  {
260  wxFileName fn( m_text );
261 
262  // It's annoying to throw up nag dialogs when the extension isn't right. Just
263  // fix it.
264  if( fn.GetExt().CmpNoCase( KiCadSchematicFileExtension ) != 0 )
265  {
266  fn.SetExt( KiCadSchematicFileExtension );
267  m_text = fn.GetFullPath();
268  }
269  }
270 
271  m_isVertical = m_orientChoice->GetSelection() == 1;
272  m_position = wxPoint( m_posX.GetValue(), m_posY.GetValue() );
274  m_horizontalJustification = m_hAlignChoice->GetSelection();
275  m_verticalJustification = m_vAlignChoice->GetSelection();
276  m_isVisible = m_visible->GetValue();
277  m_isItalic = m_italic->GetValue();
278  m_isBold = m_bold->GetValue();
279 
280  return true;
281 }
Field Reference of part, i.e. "IC21".
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
Field Value of part, i.e. "3.3K".
#define SHEETFILENAME_V
#define _(s)
const std::string KiCadSchematicFileExtension
virtual long long int GetValue()
Return the current value in Internal Units.
static bool IsReferenceStringValid(const wxString &aReferenceString)
Test for an acceptable reference string.
Definition: sch_symbol.cpp:475

References _, DisplayError(), UNIT_BINDER::GetValue(), SCH_SYMBOL::IsReferenceStringValid(), KiCadSchematicFileExtension, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_bold, DIALOG_FIELD_PROPERTIES::m_fieldId, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_hAlignChoice, DIALOG_FIELD_PROPERTIES::m_horizontalJustification, DIALOG_FIELD_PROPERTIES::m_isBold, DIALOG_FIELD_PROPERTIES::m_isItalic, DIALOG_FIELD_PROPERTIES::m_isVertical, DIALOG_FIELD_PROPERTIES::m_isVisible, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_italic, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_orientChoice, DIALOG_FIELD_PROPERTIES::m_position, DIALOG_FIELD_PROPERTIES::m_posX, DIALOG_FIELD_PROPERTIES::m_posY, DIALOG_FIELD_PROPERTIES::m_size, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_StyledTextCtrl, DIALOG_FIELD_PROPERTIES::m_text, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_TextCtrl, DIALOG_FIELD_PROPERTIES::m_textSize, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_vAlignChoice, DIALOG_FIELD_PROPERTIES::m_verticalJustification, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_visible, REFERENCE_FIELD, SHEETFILENAME_V, and VALUE_FIELD.

◆ TransferDataToWindow()

bool DIALOG_FIELD_PROPERTIES::TransferDataToWindow ( )
overrideinherited

Definition at line 213 of file dialog_field_properties.cpp.

214 {
215  if( m_TextCtrl->IsShown() )
216  m_TextCtrl->SetValue( m_text );
217  else if( m_StyledTextCtrl->IsShown() )
218  m_StyledTextCtrl->SetValue( m_text );
219 
223  m_orientChoice->SetSelection( m_isVertical ? 1 : 0 );
224  m_hAlignChoice->SetSelection( m_horizontalJustification );
225  m_vAlignChoice->SetSelection( m_verticalJustification );
226  m_visible->SetValue( m_isVisible );
227  m_italic->SetValue( m_isItalic );
228  m_bold->SetValue( m_isBold );
229 
230  return true;
231 }
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.

References DIALOG_LIB_TEXT_PROPERTIES_BASE::m_bold, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_hAlignChoice, DIALOG_FIELD_PROPERTIES::m_horizontalJustification, DIALOG_FIELD_PROPERTIES::m_isBold, DIALOG_FIELD_PROPERTIES::m_isItalic, DIALOG_FIELD_PROPERTIES::m_isVertical, DIALOG_FIELD_PROPERTIES::m_isVisible, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_italic, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_orientChoice, DIALOG_FIELD_PROPERTIES::m_position, DIALOG_FIELD_PROPERTIES::m_posX, DIALOG_FIELD_PROPERTIES::m_posY, DIALOG_FIELD_PROPERTIES::m_size, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_StyledTextCtrl, DIALOG_FIELD_PROPERTIES::m_text, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_TextCtrl, DIALOG_FIELD_PROPERTIES::m_textSize, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_vAlignChoice, DIALOG_FIELD_PROPERTIES::m_verticalJustification, DIALOG_LIB_TEXT_PROPERTIES_BASE::m_visible, and UNIT_BINDER::SetValue().

◆ UpdateField()

void DIALOG_SCH_FIELD_PROPERTIES::UpdateField ( SCH_FIELD aField,
SCH_SHEET_PATH aSheetPath 
)

Definition at line 474 of file dialog_field_properties.cpp.

475 {
476  SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
477  SCH_ITEM* parent = dynamic_cast<SCH_ITEM*>( aField->GetParent() );
478  int fieldType = aField->GetId();
479 
480  if( parent && parent->Type() == SCH_SYMBOL_T )
481  {
482  SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( parent );
483 
484  if( fieldType == REFERENCE_FIELD )
485  symbol->SetRef( aSheetPath, m_text );
486  else if( fieldType == VALUE_FIELD )
487  symbol->SetValue( m_text );
488  else if( fieldType == FOOTPRINT_FIELD )
489  symbol->SetFootprint( m_text );
490  }
491 
494  bool positioningModified = false;
495 
496  if( aField->GetPosition() != m_position )
497  positioningModified = true;
498 
499  if( ( aField->GetTextAngle() == TEXT_ANGLE_VERT ) != m_isVertical )
500  positioningModified = true;
501 
502  if( aField->GetEffectiveHorizJustify() != hJustify )
503  positioningModified = true;
504 
505  if( aField->GetEffectiveVertJustify() != vJustify )
506  positioningModified = true;
507 
508  // convert any text variable cross-references to their UUIDs
509  m_text = aField->Schematic()->ConvertRefsToKIIDs( m_text );
510 
511  aField->SetText( m_text );
512  updateText( aField );
513  aField->SetPosition( m_position );
514 
515  // Note that we must set justifications before we can ask if they're flipped. If the old
516  // justification is center then it won't know (whereas if the new justification is center
517  // the we don't care).
518  aField->SetHorizJustify( hJustify );
519  aField->SetVertJustify( vJustify );
520 
521  if( aField->IsHorizJustifyFlipped() )
522  aField->SetHorizJustify( EDA_TEXT::MapHorizJustify( -hJustify ) );
523 
524  if( aField->IsVertJustifyFlipped() )
525  aField->SetVertJustify( EDA_TEXT::MapVertJustify( -vJustify ) );
526 
527  // The value, footprint and datasheet fields should be kept in sync in multi-unit parts.
528  // Of course the symbol must be annotated to collect other units.
529  if( editFrame && parent && parent->Type() == SCH_SYMBOL_T )
530  {
531  SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( parent );
532 
533  if( symbol->IsAnnotated( aSheetPath ) && ( fieldType == VALUE_FIELD
534  || fieldType == FOOTPRINT_FIELD
535  || fieldType == DATASHEET_FIELD ) )
536  {
537  wxString ref = symbol->GetRef( aSheetPath );
538  int unit = symbol->GetUnit();
539  LIB_ID libId = symbol->GetLibId();
540 
541  for( SCH_SHEET_PATH& sheet : editFrame->Schematic().GetSheets() )
542  {
543  SCH_SCREEN* screen = sheet.LastScreen();
544  std::vector<SCH_SYMBOL*> otherUnits;
545  constexpr bool appendUndo = true;
546 
547  CollectOtherUnits( ref, unit, libId, sheet, &otherUnits );
548 
549  for( SCH_SYMBOL* otherUnit : otherUnits )
550  {
551  editFrame->SaveCopyInUndoList( screen, otherUnit, UNDO_REDO::CHANGED,
552  appendUndo );
553 
554  if( fieldType == VALUE_FIELD )
555  otherUnit->SetValue( m_text );
556  else if( fieldType == FOOTPRINT_FIELD )
557  otherUnit->SetFootprint( m_text );
558  else
559  otherUnit->GetField( DATASHEET_FIELD )->SetText( m_text );
560 
561  editFrame->UpdateItem( otherUnit, false, true );
562  }
563  }
564  }
565  }
566 
567  if( positioningModified && parent )
568  parent->ClearFieldsAutoplaced();
569 }
Field Reference of part, i.e. "IC21".
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:82
wxPoint GetPosition() const override
Definition: sch_field.cpp:843
void updateText(EDA_TEXT *aText)
void SetValue(const SCH_SHEET_PATH *sheet, const wxString &aValue)
Definition: sch_symbol.cpp:594
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:104
bool IsVertJustifyFlipped() const
Definition: sch_field.cpp:384
double GetTextAngle() const
Definition: eda_text.h:195
int GetId() const
Definition: sch_field.h:113
Schematic editor (Eeschema) main window.
void CollectOtherUnits(const wxString &aRef, int aUnit, const LIB_ID &aLibId, SCH_SHEET_PATH &aSheet, std::vector< SCH_SYMBOL * > *otherUnits)
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:441
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetFootprint(const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
Definition: sch_symbol.cpp:645
name of datasheet
EDA_TEXT_VJUSTIFY_T GetEffectiveVertJustify() const
Definition: sch_field.cpp:407
static EDA_TEXT_HJUSTIFY_T MapHorizJustify(int aHorizJustify)
Definition: eda_text.cpp:73
Field Value of part, i.e. "3.3K".
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:124
wxString ConvertRefsToKIIDs(const wxString &aSource) const
Definition: schematic.cpp:288
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:223
SCHEMATIC & Schematic() const
void ClearFieldsAutoplaced()
Definition: sch_item.h:427
EDA_ITEM * GetParent() const
Definition: eda_item.h:114
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false)
Mark an item for refresh.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
static EDA_TEXT_VJUSTIFY_T MapVertJustify(int aVertJustify)
Definition: eda_text.cpp:87
EDA_TEXT_HJUSTIFY_T GetEffectiveHorizJustify() const
Definition: sch_field.cpp:370
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:89
bool IsAnnotated(const SCH_SHEET_PATH *aSheet)
Check if the symbol has a valid annotation (reference) for the given sheet path.
Definition: sch_symbol.cpp:517
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
Schematic symbol object.
Definition: sch_symbol.h:78
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:222
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
Definition: sch_symbol.cpp:481
bool IsHorizJustifyFlipped() const
Return whether the field will be rendered with the horizontal justification inverted due to rotation ...
Definition: sch_field.cpp:347
#define TEXT_ANGLE_VERT
Definition: eda_text.h:72
int GetUnit() const
Definition: sch_symbol.h:195
void SetPosition(const wxPoint &aPosition) override
Definition: sch_field.cpp:823
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:147
Field Name Module PCB, i.e. "16DIP300".

References CHANGED, SCH_ITEM::ClearFieldsAutoplaced(), CollectOtherUnits(), SCHEMATIC::ConvertRefsToKIIDs(), DATASHEET_FIELD, FOOTPRINT_FIELD, SCH_FIELD::GetEffectiveHorizJustify(), SCH_FIELD::GetEffectiveVertJustify(), SCH_FIELD::GetId(), SCH_SYMBOL::GetLibId(), DIALOG_FIELD_PROPERTIES::GetParent(), EDA_ITEM::GetParent(), SCH_FIELD::GetPosition(), SCH_SYMBOL::GetRef(), SCHEMATIC::GetSheets(), EDA_TEXT::GetTextAngle(), SCH_SYMBOL::GetUnit(), SCH_SYMBOL::IsAnnotated(), SCH_FIELD::IsHorizJustifyFlipped(), SCH_FIELD::IsVertJustifyFlipped(), DIALOG_FIELD_PROPERTIES::m_horizontalJustification, DIALOG_FIELD_PROPERTIES::m_isVertical, DIALOG_FIELD_PROPERTIES::m_position, DIALOG_FIELD_PROPERTIES::m_text, DIALOG_FIELD_PROPERTIES::m_verticalJustification, EDA_TEXT::MapHorizJustify(), EDA_TEXT::MapVertJustify(), REFERENCE_FIELD, SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SYMBOL_T, SCH_EDIT_FRAME::Schematic(), SCH_ITEM::Schematic(), SCH_SYMBOL::SetFootprint(), EDA_TEXT::SetHorizJustify(), SCH_FIELD::SetPosition(), SCH_SYMBOL::SetRef(), EDA_TEXT::SetText(), SCH_SYMBOL::SetValue(), EDA_TEXT::SetVertJustify(), TEXT_ANGLE_VERT, EDA_ITEM::Type(), SCH_BASE_FRAME::UpdateItem(), DIALOG_FIELD_PROPERTIES::updateText(), and VALUE_FIELD.

Referenced by SCH_EDIT_TOOL::editFieldText().

◆ updateText()

void DIALOG_FIELD_PROPERTIES::updateText ( EDA_TEXT aText)
protectedinherited

Definition at line 284 of file dialog_field_properties.cpp.

285 {
286  if( aText->GetTextWidth() != m_size )
287  aText->SetTextSize( wxSize( m_size, m_size ) );
288 
289  aText->SetVisible( m_isVisible );
291  aText->SetItalic( m_isItalic );
292  aText->SetBold( m_isBold );
293 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:71
void SetItalic(bool isItalic)
Definition: eda_text.h:200
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:258
virtual void SetVisible(bool aVisible)
Definition: eda_text.h:206
int GetTextWidth() const
Definition: eda_text.h:262
#define TEXT_ANGLE_VERT
Definition: eda_text.h:72
virtual void SetTextAngle(double aAngle)
Definition: eda_text.h:188
void SetBold(bool aBold)
Definition: eda_text.h:203

References EDA_TEXT::GetTextWidth(), DIALOG_FIELD_PROPERTIES::m_isBold, DIALOG_FIELD_PROPERTIES::m_isItalic, DIALOG_FIELD_PROPERTIES::m_isVertical, DIALOG_FIELD_PROPERTIES::m_isVisible, DIALOG_FIELD_PROPERTIES::m_size, EDA_TEXT::SetBold(), EDA_TEXT::SetItalic(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVisible(), TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

Referenced by DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and UpdateField().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 176 of file dialog_shim.cpp.

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

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_bold

◆ m_CommonConvert

◆ m_CommonUnit

◆ m_field

const SCH_FIELD* DIALOG_SCH_FIELD_PROPERTIES::m_field
private

Definition at line 158 of file dialog_field_properties.h.

Referenced by DIALOG_SCH_FIELD_PROPERTIES(), and onScintillaCharAdded().

◆ m_fieldId

◆ m_firstFocus

bool DIALOG_FIELD_PROPERTIES::m_firstFocus
protectedinherited

Definition at line 99 of file dialog_field_properties.h.

Referenced by DIALOG_FIELD_PROPERTIES::OnSetFocusText().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 210 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hAlignChoice

◆ m_hAlignLabel

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_hAlignLabel
protectedinherited

◆ m_hash_key

◆ m_horizontalJustification

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 211 of file dialog_shim.h.

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

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize
protectedinherited

Definition at line 223 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

◆ m_isBold

◆ m_isItalic

◆ m_isPower

◆ m_isSheetFilename

bool DIALOG_SCH_FIELD_PROPERTIES::m_isSheetFilename
private

Definition at line 159 of file dialog_field_properties.h.

Referenced by DIALOG_SCH_FIELD_PROPERTIES().

◆ m_isVertical

◆ m_isVisible

◆ m_italic

◆ m_note

◆ m_orientChoice

◆ m_orientLabel

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_orientLabel
protectedinherited

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

◆ m_position

◆ m_posX

UNIT_BINDER DIALOG_FIELD_PROPERTIES::m_posX
protectedinherited

◆ m_posY

UNIT_BINDER DIALOG_FIELD_PROPERTIES::m_posY
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 213 of file dialog_shim.h.

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

◆ m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 215 of file dialog_shim.h.

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

◆ m_scintillaTricks

SCINTILLA_TRICKS* DIALOG_FIELD_PROPERTIES::m_scintillaTricks
protectedinherited

◆ m_sdbSizerButtons

wxStdDialogButtonSizer* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_sdbSizerButtons
protectedinherited

◆ m_sdbSizerButtonsCancel

wxButton* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_sdbSizerButtonsCancel
protectedinherited

◆ m_sdbSizerButtonsOK

wxButton* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_sdbSizerButtonsOK
protectedinherited

◆ m_size

◆ m_staticline2

wxStaticLine* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_staticline2
protectedinherited

◆ m_StyledTextCtrl

◆ m_tabOrder

◆ m_text

◆ m_TextCtrl

◆ m_textLabel

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_textLabel
protectedinherited

◆ m_textSize

UNIT_BINDER DIALOG_FIELD_PROPERTIES::m_textSize
protectedinherited

◆ m_textSizeCtrl

wxTextCtrl* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_textSizeCtrl
protectedinherited

◆ m_textSizeLabel

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_textSizeLabel
protectedinherited

◆ m_textSizeUnits

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_textSizeUnits
protectedinherited

◆ m_TextValueSelectButton

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_vAlignChoice

◆ m_vAlignLabel

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_vAlignLabel
protectedinherited

◆ m_verticalJustification

◆ m_visible

◆ m_xPosCtrl

wxTextCtrl* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_xPosCtrl
protectedinherited

◆ m_xPosLabel

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_xPosLabel
protectedinherited

◆ m_xPosUnits

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_xPosUnits
protectedinherited

◆ m_yPosCtrl

wxTextCtrl* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_yPosCtrl
protectedinherited

◆ m_yPosLabel

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_yPosLabel
protectedinherited

◆ m_yPosUnits

wxStaticText* DIALOG_LIB_TEXT_PROPERTIES_BASE::m_yPosUnits
protectedinherited

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