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  m_isPower = false;
291 
292  m_textLabel->SetLabel( m_field->GetName() + ":" );
293 
294  // The library symbol may have been removed so using SCH_COMPONENT::GetPartRef() here
295  // could result in a segfault. If the library symbol is no longer available, the
296  // schematic fields can still edit so set the power symbol flag to false. This may not
297  // be entirely accurate if the power library is missing but it's better then a segfault.
298  if( aField->GetParent() && aField->GetParent()->Type() == SCH_COMPONENT_T )
299  {
300  const SCH_COMPONENT* component = (SCH_COMPONENT*) aField->GetParent();
301  const LIB_PART* part = GetParent()->GetLibPart( component->GetLibId(), true );
302 
303  if( part && part->IsPower() )
304  m_isPower = true;
305  }
306 
307  m_StyledTextCtrl->Bind( wxEVT_STC_CHARADDED, &DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded, this );
308 
309  init();
310 }
void onScintillaCharAdded(wxStyledTextEvent &aEvent)
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
SCH_BASE_FRAME * GetParent()
bool IsPower() const
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:420
Schematic symbol object.
Definition: sch_component.h:88
const LIB_ID & GetLibId() const
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCH_FIELD::GetId(), SCH_COMPONENT::GetLibId(), SCH_BASE_FRAME::GetLibPart(), SCH_FIELD::GetName(), DIALOG_EDIT_ONE_FIELD::GetParent(), EDA_ITEM::GetParent(), 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_LIB_EDIT_TEXT_BASE::m_textLabel, onScintillaCharAdded(), SCH_COMPONENT_T, SCH_SHEET_T, 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 267 of file dialog_shim.cpp.

268 {
269  // so we can do logging of this state change:
270 
271 #if 0 && defined(DEBUG)
272  const char* type_id = typeid( *this ).name();
273  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
274  fflush(0); //Needed on msys2 to immediately print the message
275 #endif
276 
277  return wxDialog::Enable( enable );
278 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 397 of file dialog_shim.cpp.

398 {
399  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
400  // handle validation in the same way as other dialogs.
401  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
402  return;
403 
404  SetReturnCode( retCode );
405 
406  if( !IsQuasiModal() )
407  {
408  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
409  "wasn't called" );
410  return;
411  }
412 
413  if( m_qmodal_loop )
414  {
415  if( m_qmodal_loop->IsRunning() )
416  m_qmodal_loop->Exit( 0 );
417  else
418  m_qmodal_loop->ScheduleExit( 0 );
419 
421  }
422 
425 
426  Show( false );
427 }
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(), HTML_MESSAGE_BOX::OnOKButtonClick(), 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 142 of file dialog_shim.cpp.

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

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_COPPER_ZONE::DIALOG_COPPER_ZONE(), 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_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), 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_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_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_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), 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_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::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 163 of file dialog_shim.cpp.

164 {
165  wxSize sz( x, 0 );
166  return ConvertDialogToPixels( sz ).x;
167 }

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
#define VALUE
const BITMAP_OPAQUE small_library_xpm[1]
SCH_BASE_FRAME * GetParent()
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(), 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(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), 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(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), KIWAY_HOLDER::Prj(), 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(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), 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 300 of file dialog_shim.cpp.

301 {
302  if( m_firstPaintEvent )
303  {
305 
306  selectAllInTextCtrls( GetChildren() );
307 
309  m_initialFocusTarget->SetFocus();
310  else
311  SetFocus(); // Focus the dialog itself
312 
313  m_firstPaintEvent = false;
314  }
315 
316  event.Skip();
317 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:204
bool m_firstPaintEvent
Definition: dialog_shim.h:203
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:38
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 313 of file dialog_edit_one_field.cpp.

314 {
315  SCH_EDIT_FRAME* editFrame = static_cast<SCH_EDIT_FRAME*>( GetParent() );
316  wxArrayString autocompleteTokens;
317  int pos = m_StyledTextCtrl->GetCurrentPos();
318  int start = m_StyledTextCtrl->WordStartPosition( pos, true );
319  wxString partial;
320 
321  auto textVarRef =
322  [&]( int pt )
323  {
324  return pt >= 2
325  && m_StyledTextCtrl->GetCharAt( pt - 2 ) == '$'
326  && m_StyledTextCtrl->GetCharAt( pt - 1 ) == '{';
327  };
328 
329  // Check for cross-reference
330  if( start > 1 && m_StyledTextCtrl->GetCharAt( start - 1 ) == ':' )
331  {
332  int refStart = m_StyledTextCtrl->WordStartPosition( start - 1, true );
333 
334  if( textVarRef( refStart ) )
335  {
336  partial = m_StyledTextCtrl->GetRange( start, pos );
337 
338  wxString ref = m_StyledTextCtrl->GetRange( refStart, start - 1 );
339  SCH_SHEET_LIST sheets = editFrame->Schematic().GetSheets();
340  SCH_REFERENCE_LIST refs;
341  SCH_COMPONENT* refComponent = nullptr;
342 
343  sheets.GetComponents( refs );
344 
345  for( size_t jj = 0; jj < refs.GetCount(); jj++ )
346  {
347  if( refs[ jj ].GetComp()->GetRef( &refs[ jj ].GetSheetPath(), true ) == ref )
348  {
349  refComponent = refs[ jj ].GetComp();
350  break;
351  }
352  }
353 
354  if( refComponent )
355  refComponent->GetContextualTextVars( &autocompleteTokens );
356  }
357  }
358  else if( textVarRef( start ) )
359  {
360  partial = m_StyledTextCtrl->GetTextRange( start, pos );
361 
362  SCH_COMPONENT* comp = dynamic_cast<SCH_COMPONENT*>( m_field->GetParent() );
363  SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( m_field->GetParent() );
364 
365  if( comp )
366  comp->GetContextualTextVars( &autocompleteTokens );
367  else if( sheet )
368  sheet->GetContextualTextVars( &autocompleteTokens );
369 
370  for( std::pair<wxString, wxString> entry : Prj().GetTextVars() )
371  autocompleteTokens.push_back( entry.first );
372  }
373 
374  m_scintillaTricks->DoAutocomplete( partial, autocompleteTokens );
375  m_StyledTextCtrl->SetFocus();
376 }
SCH_SHEET_LIST.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:92
SCINTILLA_TRICKS * m_scintillaTricks
void DoAutocomplete(const wxString &aPartial, const wxArrayString &aTokens)
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:88

References SCINTILLA_TRICKS::DoAutocomplete(), SCH_SHEET_LIST::GetComponents(), SCH_COMPONENT::GetContextualTextVars(), SCH_REFERENCE_LIST::GetCount(), DIALOG_EDIT_ONE_FIELD::GetParent(), EDA_ITEM::GetParent(), SCHEMATIC::GetSheets(), m_field, DIALOG_EDIT_ONE_FIELD::m_scintillaTricks, DIALOG_LIB_EDIT_TEXT_BASE::m_StyledTextCtrl, KIWAY_HOLDER::Prj(), and SCH_EDIT_FRAME::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
#define VALUE

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:342
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:172

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(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), 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(), 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(), 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(), 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(), DRC::LoadRules(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), 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(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), 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::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), 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(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_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 242 of file dialog_shim.cpp.

243 {
244  const char* hash_key;
245 
246  if( m_hash_key.size() )
247  {
248  // a special case like EDA_LIST_DIALOG, which has multiple uses.
249  hash_key = m_hash_key.c_str();
250  }
251  else
252  {
253  hash_key = typeid(*this).name();
254  }
255 
256  RECT_MAP::iterator it = class_map.find( hash_key );
257 
258  if( it == class_map.end() )
259  return;
260 
261  EDA_RECT rect = it->second;
262  rect.SetSize( 0, 0 );
263  class_map[ hash_key ] = rect;
264 }
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_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_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(), 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_KEEPOUT_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 156 of file dialog_shim.cpp.

157 {
158  wxSize sz( x, y );
159  SetSize( ConvertDialogToPixels( sz ) );
160 }

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 183 of file dialog_shim.cpp.

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 343 of file dialog_shim.cpp.

344 {
345  // This is an exception safe way to zero a pointer before returning.
346  // Yes, even though DismissModal() clears this first normally, this is
347  // here in case there's an exception before the dialog is dismissed.
348  struct NULLER
349  {
350  void*& m_what;
351  NULLER( void*& aPtr ) : m_what( aPtr ) {}
352  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
353  } clear_this( (void*&) m_qmodal_loop );
354 
355  // release the mouse if it's currently captured as the window having it
356  // will be disabled when this dialog is shown -- but will still keep the
357  // capture making it impossible to do anything in the modal dialog itself
358  wxWindow* win = wxWindow::GetCapture();
359  if( win )
360  win->ReleaseMouse();
361 
362  // Get the optimal parent
363  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
364 
365  // Show the optimal parent
366  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
367 
368  wxASSERT_MSG( !m_qmodal_parent_disabler,
369  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
370 
371  // quasi-modal: disable only my "optimal" parent
373 
374 
375  // Apple in its infinite wisdom will raise a disabled window before even passing
376  // us the event, so we have no way to stop it. Instead, we must set an order on
377  // the windows so that the quasi-modal will be pushed in front of the disabled
378  // window when it is raised.
380 
381  Show( true );
382 
383  m_qmodal_showing = true;
384 
385  WX_EVENT_LOOP event_loop;
386 
387  m_qmodal_loop = &event_loop;
388 
389  event_loop.Run();
390 
391  m_qmodal_showing = false;
392 
393  return GetReturnCode();
394 }
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:38
#define DBG(x)
Definition: fctsys.h:33
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:32

References DBG, 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(), SCH_BASE_FRAME::SelectCompFromLibTree(), 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".
#define VALUE
#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 379 of file dialog_edit_one_field.cpp.

380 {
381  SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( GetParent() );
382  SCH_ITEM* parent = dynamic_cast<SCH_ITEM*>( aField->GetParent() );
383  int fieldType = aField->GetId();
384 
385  if( parent && parent->Type() == SCH_COMPONENT_T && fieldType == REFERENCE )
386  {
387  wxASSERT( aSheetPath );
388  static_cast<SCH_COMPONENT*>( parent )->SetRef( aSheetPath, m_text );
389  }
390 
391  bool positioningModified = false;
392 
393  if( aField->GetTextPos() != m_position )
394  positioningModified = true;
395 
396  if( ( aField->GetTextAngle() == TEXT_ANGLE_VERT ) != m_isVertical )
397  positioningModified = true;
398 
400  positioningModified = true;
401 
403  positioningModified = true;
404 
405  aField->SetText( m_text );
406  updateText( aField );
407 
408  // The value, footprint and datasheet fields should be kept in sync in multi-unit
409  // parts.
410  // Of course the component must be annotated to collect other units.
411  if( editFrame && parent && parent->Type() == SCH_COMPONENT_T
412  && ( fieldType == VALUE || fieldType == FOOTPRINT || fieldType == DATASHEET ) )
413  {
414  SCH_COMPONENT* thisUnit = static_cast<SCH_COMPONENT*>( parent );
415  std::vector<SCH_COMPONENT*> otherUnits;
416 
417  CollectOtherUnits( editFrame->GetCurrentSheet(), thisUnit, &otherUnits );
418 
419  for( SCH_COMPONENT* otherUnit : otherUnits )
420  {
421  editFrame->SaveCopyInUndoList( otherUnit, UR_CHANGED, true /* append */);
422  otherUnit->GetField( fieldType )->SetText( m_text );
423  editFrame->RefreshItem( otherUnit );
424  }
425  }
426 
427  if( positioningModified && parent )
428  parent->ClearFieldsAutoplaced();
429 }
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:199
name of datasheet
#define TEXT_ANGLE_VERT
double GetTextAngle() const
Definition: eda_text.h:173
int GetId() const
Definition: sch_field.h:114
Schematic editor (Eeschema) main window.
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
#define VALUE
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:198
static EDA_TEXT_HJUSTIFY_T MapHorizJustify(int aHorizJustify)
Definition: eda_text.cpp:58
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:116
void SaveCopyInUndoList(SCH_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand, bool aAppend=false, 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:440
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
static EDA_TEXT_VJUSTIFY_T MapVertJustify(int aVertJustify)
Definition: eda_text.cpp:72
void updateText(EDA_TEXT *aText)
SCH_BASE_FRAME * GetParent()
void RefreshItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
Schematic symbol object.
Definition: sch_component.h:88
const wxPoint & GetTextPos() const
Definition: eda_text.h:247
SCH_SHEET_PATH & GetCurrentSheet() const
void CollectOtherUnits(SCH_SHEET_PATH &aSheet, SCH_COMPONENT *aUnit, std::vector< SCH_COMPONENT * > *otherUnits)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:187
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCH_ITEM::ClearFieldsAutoplaced(), CollectOtherUnits(), DATASHEET, FOOTPRINT, SCH_EDIT_FRAME::GetCurrentSheet(), EDA_TEXT::GetHorizJustify(), SCH_FIELD::GetId(), DIALOG_EDIT_ONE_FIELD::GetParent(), EDA_ITEM::GetParent(), 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_BASE_FRAME::RefreshItem(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_COMPONENT_T, EDA_TEXT::SetText(), TEXT_ANGLE_VERT, EDA_ITEM::Type(), DIALOG_EDIT_ONE_FIELD::updateText(), UR_CHANGED, 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
#define TEXT_ANGLE_VERT
void SetItalic(bool isItalic)
Definition: eda_text.h:178
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:246
void SetVisible(bool aVisible)
Definition: eda_text.h:184
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:237
static EDA_TEXT_HJUSTIFY_T MapHorizJustify(int aHorizJustify)
Definition: eda_text.cpp:58
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:202
static EDA_TEXT_VJUSTIFY_T MapVertJustify(int aVertJustify)
Definition: eda_text.cpp:72
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:201
virtual void SetTextAngle(double aAngle)
Definition: eda_text.h:166
void SetBold(bool aBold)
Definition: eda_text.h:181

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 170 of file dialog_shim.cpp.

171 {
172  wxSize sz( 0, y );
173  return ConvertDialogToPixels( sz ).y;
174 }

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::OnDRCItemRClick().

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