KiCad PCB EDA Suite
DIALOG_SCH_EDIT_ONE_FIELD Class Reference

DIALOG_SCH_EDIT_ONE_FIELD is a the class to handle editing a single component field in the schematic editor. More...

#include <dialog_edit_one_field.h>

Inheritance diagram for DIALOG_SCH_EDIT_ONE_FIELD:
DIALOG_EDIT_ONE_FIELD DIALOG_LIB_EDIT_TEXT_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_SCH_EDIT_ONE_FIELD (SCH_BASE_FRAME *aParent, const wxString &aTitle, const SCH_FIELD *aField)
 
 ~DIALOG_SCH_EDIT_ONE_FIELD ()
 
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 ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 
static void FixOSXCancelButtonIssue (wxWindow *aWindow)
 

Protected Member Functions

void init ()
 
void updateText (EDA_TEXT *aText)
 
void OnTextValueSelectButtonClick (wxCommandEvent &aEvent) override
 Function OnTextValueSelectButtonClick Handles 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)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 
void ResetSize ()
 Clear the existing dialog size and position. More...
 

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
 
SCINTILLA_TRICKSm_scintillaTricks
 
wxStaticText * m_textLabel
 
wxTextCtrl * m_TextCtrl
 
wxStyledTextCtrl * m_StyledTextCtrl
 
wxStaticText * m_PowerComponentValues
 
wxBitmapButton * m_TextValueSelectButton
 
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_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private Attributes

const SCH_FIELDm_field
 

Detailed Description

DIALOG_SCH_EDIT_ONE_FIELD is a the class to handle editing a single component field in the schematic editor.

Note
Use ShowQuasiModal when calling this class!

Definition at line 144 of file dialog_edit_one_field.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_SCH_EDIT_ONE_FIELD()

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

Definition at line 270 of file dialog_edit_one_field.cpp.

272  :
273  DIALOG_EDIT_ONE_FIELD( aParent, aTitle, aField ),
274  m_field( aField )
275 {
276  if( aField->GetParent() && aField->GetParent()->Type() == SCH_COMPONENT_T )
277  {
278  m_fieldId = aField->GetId();
279  }
280  else if( aField->GetParent() && aField->GetParent()->Type() == SCH_SHEET_T )
281  {
282  switch( aField->GetId() )
283  {
284  case SHEETNAME: m_fieldId = SHEETNAME_V; break;
285  case SHEETFILENAME: m_fieldId = SHEETFILENAME_V; break;
286  default: m_fieldId = SHEETUSERFIELD_V; break;
287  }
288  }
289 
290  // show text variable cross-references in a human-readable format
291  m_text = aField->Schematic()->ConvertKIIDsToRefs( aField->GetText() );
292 
293  m_isPower = false;
294 
295  m_textLabel->SetLabel( m_field->GetName() + ":" );
296 
297  // The library symbol may have been removed so using SCH_COMPONENT::GetPartRef() here
298  // could result in a segfault. If the library symbol is no longer available, the
299  // schematic fields can still edit so set the power symbol flag to false. This may not
300  // be entirely accurate if the power library is missing but it's better then a segfault.
301  if( aField->GetParent() && aField->GetParent()->Type() == SCH_COMPONENT_T )
302  {
303  const SCH_COMPONENT* component = (SCH_COMPONENT*) aField->GetParent();
304  const LIB_PART* part = GetParent()->GetLibPart( component->GetLibId(), true );
305 
306  if( part && part->IsPower() )
307  m_isPower = true;
308  }
309 
310  m_StyledTextCtrl->Bind( wxEVT_STC_CHARADDED, &DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded, this );
311 
312  init();
313 }
void onScintillaCharAdded(wxStyledTextEvent &aEvent)
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
int GetId() const
Definition: sch_field.h:114
LIB_PART * GetLibPart(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
#define SHEETNAME_V
DIALOG_EDIT_ONE_FIELD(SCH_BASE_FRAME *aParent, const wxString &aTitle, const EDA_TEXT *aTextItem)
#define SHEETFILENAME_V
Define a library symbol object.
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
#define SHEETUSERFIELD_V
wxString ConvertKIIDsToRefs(const wxString &aSource) const
Definition: schematic.cpp:258
SCH_BASE_FRAME * GetParent()
bool IsPower() const
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:442
Schematic symbol object.
Definition: sch_component.h:80
const LIB_ID & GetLibId() const
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:127
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCHEMATIC::ConvertKIIDsToRefs(), SCH_FIELD::GetId(), SCH_COMPONENT::GetLibId(), SCH_BASE_FRAME::GetLibPart(), SCH_FIELD::GetName(), DIALOG_EDIT_ONE_FIELD::GetParent(), EDA_ITEM::GetParent(), EDA_TEXT::GetText(), DIALOG_EDIT_ONE_FIELD::init(), LIB_PART::IsPower(), m_field, DIALOG_EDIT_ONE_FIELD::m_fieldId, DIALOG_EDIT_ONE_FIELD::m_isPower, DIALOG_LIB_EDIT_TEXT_BASE::m_StyledTextCtrl, DIALOG_EDIT_ONE_FIELD::m_text, DIALOG_LIB_EDIT_TEXT_BASE::m_textLabel, onScintillaCharAdded(), SCH_COMPONENT_T, SCH_SHEET_T, SCH_ITEM::Schematic(), SHEETFILENAME, SHEETFILENAME_V, SHEETNAME, SHEETNAME_V, SHEETUSERFIELD_V, and EDA_ITEM::Type().

◆ ~DIALOG_SCH_EDIT_ONE_FIELD()

DIALOG_SCH_EDIT_ONE_FIELD::~DIALOG_SCH_EDIT_ONE_FIELD ( )
inline

Definition at line 150 of file dialog_edit_one_field.h.

150 {}

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 269 of file dialog_shim.cpp.

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 388 of file dialog_shim.cpp.

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

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnEditLibrarySymbol(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnEditSymbol(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

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

FinishDialogSettings must be called from derived classes, 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 144 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_EDITOR_DATA::DIALOG_EDITOR_DATA(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_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_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SCH_SHEET_PROPS::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ FixOSXCancelButtonIssue()

static void DIALOG_SHIM::FixOSXCancelButtonIssue ( wxWindow *  aWindow)
staticinherited

◆ GetParent()

SCH_BASE_FRAME* DIALOG_EDIT_ONE_FIELD::GetParent ( void  )
inlineinherited

Definition at line 62 of file dialog_edit_one_field.h.

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

Referenced by DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_EDIT_ONE_FIELD::init(), onScintillaCharAdded(), and UpdateField().

◆ GetText()

const wxString& DIALOG_EDIT_ONE_FIELD::GetText ( ) const
inlineinherited

Definition at line 64 of file dialog_edit_one_field.h.

64 { return m_text; }

References DIALOG_EDIT_ONE_FIELD::m_text.

Referenced by LIB_EDIT_TOOL::editFieldProperties().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 165 of file dialog_shim.cpp.

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

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

◆ init()

void DIALOG_EDIT_ONE_FIELD::init ( )
protectedinherited

Definition at line 81 of file dialog_edit_one_field.cpp.

82 {
83  SCH_BASE_FRAME* parent = GetParent();
84  bool libedit = parent->IsType( FRAME_SCH_LIB_EDITOR );
85 
86  m_TextCtrl->SetValidator( SCH_FIELD_VALIDATOR( libedit, m_fieldId, &m_text ) );
87 
88  // Disable options for graphic text editing which are not needed for fields.
89  m_CommonConvert->Show( false );
90  m_CommonUnit->Show( false );
91 
92  if( !libedit && ( m_fieldId == REFERENCE || m_fieldId == VALUE ) )
93  {
94  m_StyledTextCtrl->Show( false );
96  }
97  else
98  {
99  m_TextCtrl->Show( false );
101  }
102 
103  // Show the footprint selection dialog if this is the footprint field.
106 
107  // Value fields of power components cannot be modified. This will grey out
108  // the text box and display an explanation.
109  if( m_fieldId == VALUE && m_isPower )
110  {
111  m_PowerComponentValues->Show( true );
112  m_TextCtrl->Enable( false );
113  }
114  else
115  {
116  m_PowerComponentValues->Show( false );
117  m_TextCtrl->Enable( true );
118  }
119 
120  m_sdbSizerButtonsOK->SetDefault();
121 
122  GetSizer()->SetSizeHints( this );
123 
124  // Adjust the height of the scintilla text editor after the first layout
125  if( m_StyledTextCtrl->IsShown() )
126  {
127  wxSize maxSize = m_StyledTextCtrl->GetSize();
128  maxSize.y = m_xPosCtrl->GetSize().y;
129  m_StyledTextCtrl->SetMaxSize( maxSize );
130  m_StyledTextCtrl->SetUseVerticalScrollBar( false );
131  m_StyledTextCtrl->SetUseHorizontalScrollBar( false );
132  }
133 
134  // Now all widgets have the size fixed, call FinishDialogSettings
136 }
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:114
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
const BITMAP_OPAQUE small_library_xpm[1]
SCH_BASE_FRAME * GetParent()
Field Value of part, i.e. "3.3K".
bool IsType(FRAME_T aType) const
A text control validator used for validating the text allowed in library and schematic component fiel...
A shim class between EDA_DRAW_FRAME and several derived classes: LIB_EDIT_FRAME, LIB_VIEW_FRAME,...

References DIALOG_SHIM::FinishDialogSettings(), FOOTPRINT, FRAME_SCH_LIB_EDITOR, DIALOG_EDIT_ONE_FIELD::GetParent(), EDA_BASE_FRAME::IsType(), KiBitmap(), DIALOG_LIB_EDIT_TEXT_BASE::m_CommonConvert, DIALOG_LIB_EDIT_TEXT_BASE::m_CommonUnit, DIALOG_EDIT_ONE_FIELD::m_fieldId, DIALOG_EDIT_ONE_FIELD::m_isPower, DIALOG_LIB_EDIT_TEXT_BASE::m_PowerComponentValues, DIALOG_LIB_EDIT_TEXT_BASE::m_sdbSizerButtonsOK, DIALOG_LIB_EDIT_TEXT_BASE::m_StyledTextCtrl, DIALOG_EDIT_ONE_FIELD::m_text, DIALOG_LIB_EDIT_TEXT_BASE::m_TextCtrl, DIALOG_LIB_EDIT_TEXT_BASE::m_TextValueSelectButton, DIALOG_LIB_EDIT_TEXT_BASE::m_xPosCtrl, REFERENCE, DIALOG_SHIM::SetInitialFocus(), small_library_xpm, and VALUE.

Referenced by DIALOG_LIB_EDIT_ONE_FIELD::DIALOG_LIB_EDIT_ONE_FIELD(), and DIALOG_SCH_EDIT_ONE_FIELD().

◆ IsCtrl()

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

Definition at line 136 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

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

◆ OnCloseDialog()

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

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 295 of file dialog_shim.cpp.

296 {
297  if( m_firstPaintEvent )
298  {
300 
301  selectAllInTextCtrls( GetChildren() );
302 
304  m_initialFocusTarget->SetFocus();
305  else
306  SetFocus(); // Focus the dialog itself
307 
308  m_firstPaintEvent = false;
309  }
310 
311  event.Skip();
312 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:204
bool m_firstPaintEvent
Definition: dialog_shim.h:203
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:46
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onScintillaCharAdded()

void DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded ( wxStyledTextEvent &  aEvent)

Definition at line 316 of file dialog_edit_one_field.cpp.

317 {
318  SCH_EDIT_FRAME* editFrame = static_cast<SCH_EDIT_FRAME*>( GetParent() );
319  wxArrayString autocompleteTokens;
320  int pos = m_StyledTextCtrl->GetCurrentPos();
321  int start = m_StyledTextCtrl->WordStartPosition( pos, true );
322  wxString partial;
323 
324  auto textVarRef =
325  [&]( int pt )
326  {
327  return pt >= 2
328  && m_StyledTextCtrl->GetCharAt( pt - 2 ) == '$'
329  && m_StyledTextCtrl->GetCharAt( pt - 1 ) == '{';
330  };
331 
332  // Check for cross-reference
333  if( start > 1 && m_StyledTextCtrl->GetCharAt( start - 1 ) == ':' )
334  {
335  int refStart = m_StyledTextCtrl->WordStartPosition( start - 1, true );
336 
337  if( textVarRef( refStart ) )
338  {
339  partial = m_StyledTextCtrl->GetRange( start, pos );
340 
341  wxString ref = m_StyledTextCtrl->GetRange( refStart, start - 1 );
342  SCH_SHEET_LIST sheets = editFrame->Schematic().GetSheets();
343  SCH_REFERENCE_LIST refs;
344  SCH_COMPONENT* refComponent = nullptr;
345 
346  sheets.GetComponents( refs );
347 
348  for( size_t jj = 0; jj < refs.GetCount(); jj++ )
349  {
350  if( refs[ jj ].GetComp()->GetRef( &refs[ jj ].GetSheetPath(), true ) == ref )
351  {
352  refComponent = refs[ jj ].GetComp();
353  break;
354  }
355  }
356 
357  if( refComponent )
358  refComponent->GetContextualTextVars( &autocompleteTokens );
359  }
360  }
361  else if( textVarRef( start ) )
362  {
363  partial = m_StyledTextCtrl->GetTextRange( start, pos );
364 
365  SCH_COMPONENT* comp = dynamic_cast<SCH_COMPONENT*>( m_field->GetParent() );
366  SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( m_field->GetParent() );
367 
368  if( comp )
369  {
370  comp->GetContextualTextVars( &autocompleteTokens );
371 
372  SCHEMATIC* schematic = comp->Schematic();
373 
374  if( schematic && schematic->CurrentSheet().Last() )
375  schematic->CurrentSheet().Last()->GetContextualTextVars( &autocompleteTokens );
376  }
377 
378  if( sheet )
379  sheet->GetContextualTextVars( &autocompleteTokens );
380 
381  for( std::pair<wxString, wxString> entry : Prj().GetTextVars() )
382  autocompleteTokens.push_back( entry.first );
383  }
384 
385  m_scintillaTricks->DoAutocomplete( partial, autocompleteTokens );
386  m_StyledTextCtrl->SetFocus();
387 }
SCH_SHEET_LIST.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
Holds all the data relating to one schematic A schematic may consist of one or more sheets (and one r...
Definition: schematic.h:42
SCINTILLA_TRICKS * m_scintillaTricks
SCH_SHEET * Last() const
Function Last returns a pointer to the last sheet of the list One can see the others sheet as the "pa...
void DoAutocomplete(const wxString &aPartial, const wxArrayString &aTokens)
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this sheet.
Definition: sch_sheet.cpp:190
Schematic editor (Eeschema) main window.
SCH_REFERENCE_LIST is used to create a flattened list of components because in a complex hierarchy,...
void GetComponents(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanComponents=false) const
Function GetComponents adds a SCH_REFERENCE() object to aReferences for each component in the list of...
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
SCHEMATIC & Schematic() const
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this symbol.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
unsigned GetCount() const
Function GetCount.
SCH_BASE_FRAME * GetParent()
Schematic symbol object.
Definition: sch_component.h:80
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:119

References SCHEMATIC::CurrentSheet(), SCINTILLA_TRICKS::DoAutocomplete(), SCH_SHEET_LIST::GetComponents(), SCH_COMPONENT::GetContextualTextVars(), SCH_SHEET::GetContextualTextVars(), SCH_REFERENCE_LIST::GetCount(), DIALOG_EDIT_ONE_FIELD::GetParent(), EDA_ITEM::GetParent(), SCHEMATIC::GetSheets(), SCH_SHEET_PATH::Last(), m_field, DIALOG_EDIT_ONE_FIELD::m_scintillaTricks, DIALOG_LIB_EDIT_TEXT_BASE::m_StyledTextCtrl, KIWAY_HOLDER::Prj(), SCH_EDIT_FRAME::Schematic(), and SCH_ITEM::Schematic().

Referenced by DIALOG_SCH_EDIT_ONE_FIELD().

◆ OnSetFocusText()

void DIALOG_EDIT_ONE_FIELD::OnSetFocusText ( wxFocusEvent &  event)
overrideprotectedvirtualinherited

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

Parameters
event

Reimplemented from DIALOG_LIB_EDIT_TEXT_BASE.

Definition at line 163 of file dialog_edit_one_field.cpp.

164 {
165 #ifdef __WXGTK__
166  // Force an update of the text control before setting the text selection
167  // This is needed because GTK seems to ignore the selection on first update
168  //
169  // Note that we can't do this on OSX as it tends to provoke Apple's
170  // "[NSAlert runModal] may not be invoked inside of transaction begin/commit pair"
171  // bug. See: https://bugs.launchpad.net/kicad/+bug/1837225
173  m_TextCtrl->Update();
174 #endif
175 
176  if( m_fieldId == REFERENCE )
177  SelectReferenceNumber( static_cast<wxTextEntry*>( m_TextCtrl ) );
178  else if( m_fieldId == VALUE || m_fieldId == SHEETNAME_V )
179  m_TextCtrl->SetSelection( -1, -1 );
180 
181  event.Skip();
182 }
#define SHEETNAME_V
Field Reference of part, i.e. "IC21".
void SelectReferenceNumber(wxTextEntry *aTextEntry)
Select the number (or "?") in a reference for ease of editing.
Definition: common.cpp:312
Field Value of part, i.e. "3.3K".

References DIALOG_EDIT_ONE_FIELD::m_fieldId, DIALOG_LIB_EDIT_TEXT_BASE::m_TextCtrl, REFERENCE, SelectReferenceNumber(), SHEETNAME_V, and VALUE.

◆ OnTextValueSelectButtonClick()

void DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick ( wxCommandEvent &  aEvent)
overrideprotectedvirtualinherited

Function OnTextValueSelectButtonClick Handles 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 the wX event thrown when the button is clicked, this isn't used

Reimplemented from DIALOG_LIB_EDIT_TEXT_BASE.

Definition at line 139 of file dialog_edit_one_field.cpp.

140 {
141  // pick a footprint using the footprint picker.
142  wxString fpid;
143 
144  if( m_StyledTextCtrl->IsShown() )
145  fpid = m_StyledTextCtrl->GetValue();
146  else
147  fpid = m_TextCtrl->GetValue();
148 
150 
151  if( frame->ShowModal( &fpid, this ) )
152  {
153  if( m_StyledTextCtrl->IsShown() )
154  m_StyledTextCtrl->SetValue( fpid );
155  else
156  m_TextCtrl->SetValue( fpid );
157  }
158 
159  frame->Destroy();
160 }
KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of ...
Definition: kiway_player.h:59
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:343
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
virtual 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...

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

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_INSPECTION_TOOL::InspectConstraints(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), PCB_INSPECTION_TOOL::reportCopperClearance(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ ResetSize()

void DIALOG_SHIM::ResetSize ( )
protectedinherited

Clear the existing dialog size and position.

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

Definition at line 244 of file dialog_shim.cpp.

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

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

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

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

Definition at line 114 of file dialog_shim.h.

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

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetSizeInDU()

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

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

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

Definition at line 158 of file dialog_shim.cpp.

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

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 185 of file dialog_shim.cpp.

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

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 338 of file dialog_shim.cpp.

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

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 LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ TransferDataFromWindow()

bool DIALOG_EDIT_ONE_FIELD::TransferDataFromWindow ( )
overrideinherited

Definition at line 206 of file dialog_edit_one_field.cpp.

207 {
208  if( m_TextCtrl->IsShown() )
209  m_text = m_TextCtrl->GetValue();
210  else if( m_StyledTextCtrl->IsShown() )
211  m_text = m_StyledTextCtrl->GetValue();
212 
213  if( m_fieldId == REFERENCE )
214  {
215  // Test if the reference string is valid:
217  {
218  DisplayError( this, _( "Illegal reference designator value!" ) );
219  return false;
220  }
221  }
222  else if( m_fieldId == VALUE )
223  {
224  if( m_text.IsEmpty() )
225  {
226  DisplayError( this, _( "Value may not be empty." ) );
227  return false;
228  }
229  }
230 
231  m_isVertical = m_orientChoice->GetSelection() == 1;
234  m_horizontalJustification = m_hAlignChoice->GetSelection();
235  m_verticalJustification = m_vAlignChoice->GetSelection();
236  m_isVisible = m_visible->GetValue();
237  m_isItalic = m_italic->GetValue();
238  m_isBold = m_bold->GetValue();
239 
240  return true;
241 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
Field Reference of part, i.e. "IC21".
Field Value of part, i.e. "3.3K".
#define _(s)
Definition: 3d_actions.cpp:33
virtual long long int GetValue()
Function GetValue Returns the current value in Internal Units.
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.

References _, DisplayError(), UNIT_BINDER::GetValue(), SCH_COMPONENT::IsReferenceStringValid(), DIALOG_LIB_EDIT_TEXT_BASE::m_bold, DIALOG_EDIT_ONE_FIELD::m_fieldId, DIALOG_LIB_EDIT_TEXT_BASE::m_hAlignChoice, DIALOG_EDIT_ONE_FIELD::m_horizontalJustification, DIALOG_EDIT_ONE_FIELD::m_isBold, DIALOG_EDIT_ONE_FIELD::m_isItalic, DIALOG_EDIT_ONE_FIELD::m_isVertical, DIALOG_EDIT_ONE_FIELD::m_isVisible, DIALOG_LIB_EDIT_TEXT_BASE::m_italic, DIALOG_LIB_EDIT_TEXT_BASE::m_orientChoice, DIALOG_EDIT_ONE_FIELD::m_position, DIALOG_EDIT_ONE_FIELD::m_posX, DIALOG_EDIT_ONE_FIELD::m_posY, DIALOG_EDIT_ONE_FIELD::m_size, DIALOG_LIB_EDIT_TEXT_BASE::m_StyledTextCtrl, DIALOG_EDIT_ONE_FIELD::m_text, DIALOG_LIB_EDIT_TEXT_BASE::m_TextCtrl, DIALOG_EDIT_ONE_FIELD::m_textSize, DIALOG_LIB_EDIT_TEXT_BASE::m_vAlignChoice, DIALOG_EDIT_ONE_FIELD::m_verticalJustification, DIALOG_LIB_EDIT_TEXT_BASE::m_visible, REFERENCE, and VALUE.

◆ TransferDataToWindow()

bool DIALOG_EDIT_ONE_FIELD::TransferDataToWindow ( )
overrideinherited

Definition at line 185 of file dialog_edit_one_field.cpp.

186 {
187  if( m_TextCtrl->IsShown() )
188  m_TextCtrl->SetValue( m_text );
189  else if( m_StyledTextCtrl->IsShown() )
190  m_StyledTextCtrl->SetValue( m_text );
191 
195  m_orientChoice->SetSelection( m_isVertical ? 1 : 0 );
196  m_hAlignChoice->SetSelection( m_horizontalJustification );
197  m_vAlignChoice->SetSelection( m_verticalJustification );
198  m_visible->SetValue( m_isVisible );
199  m_italic->SetValue( m_isItalic );
200  m_bold->SetValue( m_isBold );
201 
202  return true;
203 }
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...

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

◆ UpdateField()

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

Definition at line 390 of file dialog_edit_one_field.cpp.

391 {
392  SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
393  SCH_ITEM* parent = dynamic_cast<SCH_ITEM*>( aField->GetParent() );
394  int fieldType = aField->GetId();
395 
396  if( parent && parent->Type() == SCH_COMPONENT_T )
397  {
398  SCH_COMPONENT* comp = static_cast<SCH_COMPONENT*>( parent );
399 
400  if( fieldType == REFERENCE )
401  comp->SetRef( aSheetPath, m_text );
402  else if( fieldType == VALUE )
403  comp->SetValue( m_text );
404  else if( fieldType == FOOTPRINT )
405  comp->SetFootprint( m_text );
406  }
407 
408  bool positioningModified = false;
409 
410  if( aField->GetTextPos() != m_position )
411  positioningModified = true;
412 
413  if( ( aField->GetTextAngle() == TEXT_ANGLE_VERT ) != m_isVertical )
414  positioningModified = true;
415 
417  positioningModified = true;
418 
420  positioningModified = true;
421 
422  // convert any text variable cross-references to their UUIDs
423  m_text = aField->Schematic()->ConvertRefsToKIIDs( m_text );
424 
425  aField->SetText( m_text );
426  updateText( aField );
427 
428  // The value, footprint and datasheet fields should be kept in sync in multi-unit parts.
429  // Of course the component must be annotated to collect other units.
430  if( editFrame && parent && parent->Type() == SCH_COMPONENT_T
431  && ( fieldType == VALUE || fieldType == FOOTPRINT || fieldType == DATASHEET ) )
432  {
433  SCH_COMPONENT* thisUnit = static_cast<SCH_COMPONENT*>( parent );
434 
435  for( SCH_SHEET_PATH& sheet : editFrame->Schematic().GetSheets() )
436  {
437  SCH_SCREEN* screen = sheet.LastScreen();
438  std::vector<SCH_COMPONENT*> otherUnits;
439 
440  CollectOtherUnits( sheet, thisUnit, &otherUnits );
441 
442  for( SCH_COMPONENT* otherUnit : otherUnits )
443  {
444  editFrame->SaveCopyInUndoList( screen, otherUnit, UNDO_REDO::CHANGED, true /* append */);
445  otherUnit->GetField( fieldType )->SetText( m_text );
446  editFrame->UpdateItem( otherUnit );
447  }
448  }
449  }
450 
451  if( positioningModified && parent )
452  parent->ClearFieldsAutoplaced();
453 }
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:200
name of datasheet
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
double GetTextAngle() const
Definition: eda_text.h:174
int GetId() const
Definition: sch_field.h:114
Schematic editor (Eeschema) main window.
#define TEXT_ANGLE_VERT
Definition: common.h:186
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:199
static EDA_TEXT_HJUSTIFY_T MapHorizJustify(int aHorizJustify)
Definition: eda_text.cpp:63
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
wxString ConvertRefsToKIIDs(const wxString &aSource) const
Definition: schematic.cpp:198
SCHEMATIC & Schematic() const
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
void ClearFieldsAutoplaced()
Set fields automatically placed flag false.
Definition: sch_item.h:447
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
SCH_SHEET_PATH.
static EDA_TEXT_VJUSTIFY_T MapVertJustify(int aVertJustify)
Definition: eda_text.cpp:77
void updateText(EDA_TEXT *aText)
SCH_BASE_FRAME * GetParent()
Field Value of part, i.e. "3.3K".
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
Schematic symbol object.
Definition: sch_component.h:80
const wxPoint & GetTextPos() const
Definition: eda_text.h:248
void CollectOtherUnits(SCH_SHEET_PATH &aSheet, SCH_COMPONENT *aUnit, std::vector< SCH_COMPONENT * > *otherUnits)
void SetValue(const SCH_SHEET_PATH *sheet, const wxString &aValue)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
void SetFootprint(const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References CHANGED, SCH_ITEM::ClearFieldsAutoplaced(), CollectOtherUnits(), SCHEMATIC::ConvertRefsToKIIDs(), DATASHEET, FOOTPRINT, EDA_TEXT::GetHorizJustify(), SCH_FIELD::GetId(), DIALOG_EDIT_ONE_FIELD::GetParent(), EDA_ITEM::GetParent(), SCHEMATIC::GetSheets(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetVertJustify(), DIALOG_EDIT_ONE_FIELD::m_horizontalJustification, DIALOG_EDIT_ONE_FIELD::m_isVertical, DIALOG_EDIT_ONE_FIELD::m_position, DIALOG_EDIT_ONE_FIELD::m_text, DIALOG_EDIT_ONE_FIELD::m_verticalJustification, EDA_TEXT::MapHorizJustify(), EDA_TEXT::MapVertJustify(), REFERENCE, SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_COMPONENT_T, SCH_EDIT_FRAME::Schematic(), SCH_ITEM::Schematic(), SCH_COMPONENT::SetFootprint(), SCH_COMPONENT::SetRef(), EDA_TEXT::SetText(), SCH_COMPONENT::SetValue(), TEXT_ANGLE_VERT, EDA_ITEM::Type(), SCH_BASE_FRAME::UpdateItem(), DIALOG_EDIT_ONE_FIELD::updateText(), and VALUE.

◆ updateText()

void DIALOG_EDIT_ONE_FIELD::updateText ( EDA_TEXT aText)
protectedinherited

Definition at line 244 of file dialog_edit_one_field.cpp.

245 {
246  aText->SetTextPos( m_position );
247  aText->SetTextSize( wxSize( m_size, m_size ) );
248  aText->SetVisible( m_isVisible );
250  aText->SetItalic( m_isItalic );
251  aText->SetBold( m_isBold );
254 }
#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:185
void SetItalic(bool isItalic)
Definition: eda_text.h:179
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:247
void SetVisible(bool aVisible)
Definition: eda_text.h:185
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:238
#define TEXT_ANGLE_VERT
Definition: common.h:186
static EDA_TEXT_HJUSTIFY_T MapHorizJustify(int aHorizJustify)
Definition: eda_text.cpp:63
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:203
static EDA_TEXT_VJUSTIFY_T MapVertJustify(int aVertJustify)
Definition: eda_text.cpp:77
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:202
virtual void SetTextAngle(double aAngle)
Definition: eda_text.h:167
void SetBold(bool aBold)
Definition: eda_text.h:182

References DIALOG_EDIT_ONE_FIELD::m_horizontalJustification, DIALOG_EDIT_ONE_FIELD::m_isBold, DIALOG_EDIT_ONE_FIELD::m_isItalic, DIALOG_EDIT_ONE_FIELD::m_isVertical, DIALOG_EDIT_ONE_FIELD::m_isVisible, DIALOG_EDIT_ONE_FIELD::m_position, DIALOG_EDIT_ONE_FIELD::m_size, DIALOG_EDIT_ONE_FIELD::m_verticalJustification, EDA_TEXT::MapHorizJustify(), EDA_TEXT::MapVertJustify(), EDA_TEXT::SetBold(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

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

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 172 of file dialog_shim.cpp.

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

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

Member Data Documentation

◆ m_bold

◆ m_CommonConvert

◆ m_CommonUnit

◆ m_field

const SCH_FIELD* DIALOG_SCH_EDIT_ONE_FIELD::m_field
private

Definition at line 157 of file dialog_edit_one_field.h.

Referenced by DIALOG_SCH_EDIT_ONE_FIELD(), and onScintillaCharAdded().

◆ m_fieldId

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 203 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hAlignChoice

◆ m_hAlignLabel

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_hAlignLabel
protectedinherited

◆ m_hash_key

◆ m_horizontalJustification

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 204 of file dialog_shim.h.

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

◆ m_isBold

◆ m_isItalic

◆ m_isPower

◆ m_isVertical

◆ m_isVisible

◆ m_italic

◆ m_orientChoice

◆ m_orientLabel

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_orientLabel
protectedinherited

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 211 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook(), and DIALOG_DRC::OnRunDRCClick().

◆ m_position

◆ m_posX

UNIT_BINDER DIALOG_EDIT_ONE_FIELD::m_posX
protectedinherited

◆ m_posY

UNIT_BINDER DIALOG_EDIT_ONE_FIELD::m_posY
protectedinherited

◆ m_PowerComponentValues

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_PowerComponentValues
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_scintillaTricks

SCINTILLA_TRICKS* DIALOG_EDIT_ONE_FIELD::m_scintillaTricks
protectedinherited

◆ m_sdbSizerButtons

wxStdDialogButtonSizer* DIALOG_LIB_EDIT_TEXT_BASE::m_sdbSizerButtons
protectedinherited

◆ m_sdbSizerButtonsCancel

wxButton* DIALOG_LIB_EDIT_TEXT_BASE::m_sdbSizerButtonsCancel
protectedinherited

◆ m_sdbSizerButtonsOK

wxButton* DIALOG_LIB_EDIT_TEXT_BASE::m_sdbSizerButtonsOK
protectedinherited

◆ m_size

◆ m_staticline2

wxStaticLine* DIALOG_LIB_EDIT_TEXT_BASE::m_staticline2
protectedinherited

◆ m_StyledTextCtrl

◆ m_tabOrder

◆ m_text

◆ m_TextCtrl

◆ m_textLabel

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_textLabel
protectedinherited

◆ m_textSize

UNIT_BINDER DIALOG_EDIT_ONE_FIELD::m_textSize
protectedinherited

◆ m_textSizeCtrl

wxTextCtrl* DIALOG_LIB_EDIT_TEXT_BASE::m_textSizeCtrl
protectedinherited

◆ m_textSizeLabel

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_textSizeLabel
protectedinherited

◆ m_textSizeUnits

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_textSizeUnits
protectedinherited

◆ m_TextValueSelectButton

wxBitmapButton* DIALOG_LIB_EDIT_TEXT_BASE::m_TextValueSelectButton
protectedinherited

◆ m_units

◆ m_vAlignChoice

◆ m_vAlignLabel

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_vAlignLabel
protectedinherited

◆ m_verticalJustification

◆ m_visible

◆ m_xPosCtrl

wxTextCtrl* DIALOG_LIB_EDIT_TEXT_BASE::m_xPosCtrl
protectedinherited

◆ m_xPosLabel

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_xPosLabel
protectedinherited

◆ m_xPosUnits

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_xPosUnits
protectedinherited

◆ m_yPosCtrl

wxTextCtrl* DIALOG_LIB_EDIT_TEXT_BASE::m_yPosCtrl
protectedinherited

◆ m_yPosLabel

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_yPosLabel
protectedinherited

◆ m_yPosUnits

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_yPosUnits
protectedinherited

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