KiCad PCB EDA Suite
DIALOG_LIB_EDIT_ONE_FIELD Class Reference

Class DIALOG_LIB_EDIT_ONE_FIELD is a the class to handle editing a single component field in the library editor. More...

#include <dialog_edit_one_field.h>

Inheritance diagram for DIALOG_LIB_EDIT_ONE_FIELD:
DIALOG_EDIT_ONE_FIELD DIALOG_LIB_EDIT_TEXT_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_LIB_EDIT_ONE_FIELD (SCH_BASE_FRAME *aParent, const wxString &aTitle, const LIB_FIELD *aField)
 
 ~DIALOG_LIB_EDIT_ONE_FIELD ()
 
void UpdateField (LIB_FIELD *aField)
 
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_T GetUserUnits () const override
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Member Functions

void 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...
 

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
 
wxStaticText * m_staticText1
 
wxTextCtrl * m_TextValue
 
wxStaticText * m_PowerComponentValues
 
wxButton * 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_T 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
 

Detailed Description

Class DIALOG_LIB_EDIT_ONE_FIELD is a the class to handle editing a single component field in the library editor.

Note
Use ShowQuasiModal when calling this class!

Definition at line 114 of file dialog_edit_one_field.h.

Constructor & Destructor Documentation

◆ DIALOG_LIB_EDIT_ONE_FIELD()

DIALOG_LIB_EDIT_ONE_FIELD::DIALOG_LIB_EDIT_ONE_FIELD ( SCH_BASE_FRAME aParent,
const wxString &  aTitle,
const LIB_FIELD aField 
)

Definition at line 229 of file dialog_edit_one_field.cpp.

231  :
232  DIALOG_EDIT_ONE_FIELD( aParent, aTitle, dynamic_cast< const EDA_TEXT* >( aField ) )
233 {
234  m_fieldId = aField->GetId();
235 
236  // When in the library editor, power components can be renamed.
237  m_isPower = false;
238  init();
239 }
int GetId() const
Definition: lib_field.h:140
DIALOG_EDIT_ONE_FIELD(SCH_BASE_FRAME *aParent, const wxString &aTitle, const EDA_TEXT *aTextItem)

References LIB_FIELD::GetId(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_ONE_FIELD::m_fieldId, and DIALOG_EDIT_ONE_FIELD::m_isPower.

◆ ~DIALOG_LIB_EDIT_ONE_FIELD()

DIALOG_LIB_EDIT_ONE_FIELD::~DIALOG_LIB_EDIT_ONE_FIELD ( )
inline

Definition at line 120 of file dialog_edit_one_field.h.

120 {}

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 230 of file dialog_shim.cpp.

231 {
232  // so we can do logging of this state change:
233 
234 #if defined(DEBUG)
235  const char* type_id = typeid( *this ).name();
236  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
237  fflush(0); //Needed on msys2 to immediately print the message
238 #endif
239 
240  return wxDialog::Enable( enable );
241 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 391 of file dialog_shim.cpp.

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

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, 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_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 129 of file dialog_shim.cpp.

130 {
131  // must be called from the constructor of derived classes,
132  // when all widgets are initialized, and therefore their size fixed
133 
134  // SetSizeHints fixes the minimal size of sizers in the dialog
135  // (SetSizeHints calls Fit(), so no need to call it)
136  GetSizer()->SetSizeHints( this );
137 
138  // the default position, when calling the first time the dlg
139  Center();
140 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), 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_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXIT::DIALOG_EXIT(), 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_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_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_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), 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_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_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_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), 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_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetParent()

SCH_BASE_FRAME* DIALOG_EDIT_ONE_FIELD::GetParent ( )
inlineinherited

Definition at line 61 of file dialog_edit_one_field.h.

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

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

◆ GetText()

const wxString& DIALOG_EDIT_ONE_FIELD::GetText ( ) const
inlineinherited

Definition at line 63 of file dialog_edit_one_field.h.

63 { return m_text; }

References DIALOG_EDIT_ONE_FIELD::m_text.

Referenced by LIB_EDIT_FRAME::EditField().

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

151 {
152  wxSize sz( x, 0 );
153  return ConvertDialogToPixels( sz ).x;
154 }

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 102 of file dialog_edit_one_field.cpp.

103 {
105  SCH_BASE_FRAME* parent = GetParent();
106  bool libedit = parent->IsType( FRAME_SCH_LIB_EDITOR );
107  m_TextValue->SetValidator( SCH_FIELD_VALIDATOR( libedit, m_fieldId, &m_text ) );
108 
109  // Disable options for graphic text editing which are not needed for fields.
110  m_CommonConvert->Show( false );
111  m_CommonUnit->Show( false );
112 
113  // Show the footprint selection dialog if this is the footprint field.
115 
116  // Value fields of power components cannot be modified. This will grey out
117  // the text box and display an explanation.
118  if( m_fieldId == VALUE && m_isPower )
119  {
120  m_PowerComponentValues->Show( true );
121  m_TextValue->Enable( false );
122  }
123  else
124  {
125  m_PowerComponentValues->Show( false );
126  m_TextValue->Enable( true );
127  }
128 
129  m_sdbSizerButtonsOK->SetDefault();
130 
131  // Now all widgets have the size fixed, call FinishDialogSettings
133 }
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:116
Field Name Module PCB, i.e. "16DIP300".
#define VALUE
SCH_BASE_FRAME * GetParent()
bool IsType(FRAME_T aType) const
class SCH_FILED_VALIDATOR
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(), 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_EDIT_ONE_FIELD::m_text, DIALOG_LIB_EDIT_TEXT_BASE::m_TextValue, DIALOG_LIB_EDIT_TEXT_BASE::m_TextValueSelectButton, DIALOG_SHIM::SetInitialFocus(), and VALUE.

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

◆ IsQuasiModal()

◆ 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 60 of file kiway_player.h.

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:94

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), SCH_EDIT_FRAME::doUpdatePcb(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::KiwayMailIn(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), 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(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), 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 293 of file dialog_shim.cpp.

294 {
295  if( m_firstPaintEvent )
296  {
297 #ifdef __WXMAC__
298  fixOSXCancelButtonIssue( this );
299  selectAllInTextCtrls( GetChildren() );
300 #endif
301 
303  m_initialFocusTarget->SetFocus();
304  else
305  SetFocus(); // Focus the dialog itself
306 
307  m_firstPaintEvent = false;
308  }
309 
310  event.Skip();
311 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180
bool m_firstPaintEvent
Definition: dialog_shim.h:179

References DIALOG_SHIM::m_firstPaintEvent, and DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ 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 152 of file dialog_edit_one_field.cpp.

153 {
154  if( m_fieldId == REFERENCE )
155  SelectReferenceNumber( static_cast<wxTextEntry*>( m_TextValue ) );
156  else
157  m_TextValue->SetSelection( -1, -1 );
158 
159  event.Skip();
160 }
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:158

References DIALOG_EDIT_ONE_FIELD::m_fieldId, DIALOG_LIB_EDIT_TEXT_BASE::m_TextValue, REFERENCE, and SelectReferenceNumber().

◆ 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 136 of file dialog_edit_one_field.cpp.

137 {
138  // pick a footprint using the footprint picker.
139  wxString fpid = m_TextValue->GetValue();
140 
142 
143  if( frame->ShowModal( &fpid, this ) )
144  {
145  m_TextValue->SetValue( fpid );
146  }
147 
148  frame->Destroy();
149 }
Class KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a porti...
Definition: kiway_player.h:120
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY 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:300
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
VTBL_ENTRY bool ShowModal(wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxF...

References KIWAY_PLAYER::Destroy(), FRAME_PCB_MODULE_VIEWER_MODAL, KIWAY_HOLDER::Kiway(), DIALOG_LIB_EDIT_TEXT_BASE::m_TextValue, 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 34 of file kiway_holder.cpp.

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

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(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), 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_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doUpdatePcb(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), 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_GENCAD_EXPORT_OPTIONS::onBrowse(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLoadProject(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnPrint(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), KICAD_MANAGER_FRAME::OnRunGerbview(), DIALOG_BOM::OnRunPlugin(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), KICAD_MANAGER_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::Process_Config(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), 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(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), 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().

◆ 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 116 of file dialog_shim.h.

117  {
118  m_initialFocusTarget = aWindow;
119  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180

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_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), 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_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_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), 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_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::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 47 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by InvokePcbLibTableEditor(), 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 143 of file dialog_shim.cpp.

144 {
145  wxSize sz( x, y );
146  SetSize( ConvertDialogToPixels( sz ) );
147 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), 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 171 of file dialog_shim.cpp.

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

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, and max.

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_SCH_FIND::OnCancel(), SCH_EDIT_FRAME::OnFindItems(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 337 of file dialog_shim.cpp.

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

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

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), SCH_EDIT_FRAME::InstallHierarchyFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), LIB_EDIT_FRAME::OnEditComponentProperties(), PCB_EDIT_FRAME::OnEditTracksAndVias(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectComponentFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ TransferDataFromWindow()

bool DIALOG_EDIT_ONE_FIELD::TransferDataFromWindow ( )
overrideinherited

Definition at line 181 of file dialog_edit_one_field.cpp.

182 {
183  m_text = EscapeString( m_TextValue->GetValue() );
184 
185  if( m_fieldId == REFERENCE )
186  {
187  // Test if the reference string is valid:
189  {
190  DisplayError( this, _( "Illegal reference field value!" ) );
191  return false;
192  }
193  }
194  else if( m_fieldId == VALUE )
195  {
196  if( m_text.IsEmpty() )
197  {
198  DisplayError( this, _( "Value may not be empty." ) );
199  return false;
200  }
201  }
202 
203  m_isVertical = m_orientChoice->GetSelection() == 1;
204  m_position = wxPoint( m_posX.GetValue(), m_posY.GetValue() );
206  m_horizontalJustification = m_hAlignChoice->GetSelection();
207  m_verticalJustification = m_vAlignChoice->GetSelection();
208  m_isVisible = m_visible->GetValue();
209  m_isItalic = m_italic->GetValue();
210  m_isBold = m_bold->GetValue();
211 
212  return true;
213 }
Field Reference of part, i.e. "IC21".
virtual int GetValue()
Function GetValue Returns the current value in Internal Units.
wxString EscapeString(const wxString &aSource)
These Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which ar...
Definition: string.cpp:43
#define VALUE
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243

References DisplayError(), EscapeString(), 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_EDIT_ONE_FIELD::m_text, DIALOG_EDIT_ONE_FIELD::m_textSize, DIALOG_LIB_EDIT_TEXT_BASE::m_TextValue, 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 163 of file dialog_edit_one_field.cpp.

164 {
165  m_TextValue->SetValue( UnescapeString( m_text ) );
166 
170  m_orientChoice->SetSelection( m_isVertical ? 1 : 0 );
171  m_hAlignChoice->SetSelection( m_horizontalJustification );
172  m_vAlignChoice->SetSelection( m_verticalJustification );
173  m_visible->SetValue( m_isVisible );
174  m_italic->SetValue( m_isItalic );
175  m_bold->SetValue( m_isBold );
176 
177  return true;
178 }
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:89
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_EDIT_ONE_FIELD::m_text, DIALOG_EDIT_ONE_FIELD::m_textSize, DIALOG_LIB_EDIT_TEXT_BASE::m_TextValue, DIALOG_LIB_EDIT_TEXT_BASE::m_vAlignChoice, DIALOG_EDIT_ONE_FIELD::m_verticalJustification, DIALOG_LIB_EDIT_TEXT_BASE::m_visible, UNIT_BINDER::SetValue(), and UnescapeString().

◆ UpdateField()

void DIALOG_LIB_EDIT_ONE_FIELD::UpdateField ( LIB_FIELD aField)
inline

Definition at line 122 of file dialog_edit_one_field.h.

123  {
124  aField->SetText( m_text );
125 
126  // VALUE === component name, so update the parent component if it changes.
127  if( aField->GetId() == VALUE && aField->GetParent() )
128  aField->GetParent()->SetName( m_text );
129 
130  updateText( aField );
131  }
LIB_PART * GetParent() const
int GetId() const
Definition: lib_field.h:140
#define VALUE
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:518
void updateText(EDA_TEXT *aText)
virtual void SetName(const wxString &aName)

References LIB_FIELD::GetId(), LIB_ITEM::GetParent(), DIALOG_EDIT_ONE_FIELD::m_text, LIB_PART::SetName(), LIB_FIELD::SetText(), DIALOG_EDIT_ONE_FIELD::updateText(), and VALUE.

Referenced by LIB_EDIT_FRAME::EditField().

◆ updateText()

void DIALOG_EDIT_ONE_FIELD::updateText ( EDA_TEXT aText)
protectedinherited

Definition at line 216 of file dialog_edit_one_field.cpp.

217 {
218  aText->SetTextPos( m_position );
219  aText->SetTextSize( wxSize( m_size, m_size ) );
220  aText->SetVisible( m_isVisible );
222  aText->SetItalic( m_isItalic );
223  aText->SetBold( m_isBold );
226 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:169
#define TEXT_ANGLE_HORIZ
#define TEXT_ANGLE_VERT
void SetItalic(bool isItalic)
Definition: eda_text.h:182
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:236
void SetVisible(bool aVisible)
Definition: eda_text.h:188
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:227
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:207
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:206
EDA_TEXT_HJUSTIFY_T IntToEdaTextHorizJustify(int aHorizJustify)
void SetBold(bool aBold)
Definition: eda_text.h:185
EDA_TEXT_VJUSTIFY_T IntToEdaTextVertJustify(int aVertJustify)

References IntToEdaTextHorizJustify(), IntToEdaTextVertJustify(), 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::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 UpdateField(), and DIALOG_SCH_EDIT_ONE_FIELD::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 157 of file dialog_shim.cpp.

158 {
159  wxSize sz( 0, y );
160  return ConvertDialogToPixels( sz ).y;
161 }

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

Member Data Documentation

◆ m_bold

◆ m_CommonConvert

◆ m_CommonUnit

◆ m_fieldId

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 179 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 180 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_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 183 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 184 of file dialog_shim.h.

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

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

wxStaticText* DIALOG_LIB_EDIT_TEXT_BASE::m_staticText1
protectedinherited

◆ m_text

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

◆ m_TextValueSelectButton

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