KiCad PCB EDA Suite
DIALOG_POSITION_RELATIVE Class Reference

#include <dialog_position_relative.h>

Inheritance diagram for DIALOG_POSITION_RELATIVE:
DIALOG_POSITION_RELATIVE_BASE DIALOG_SHIM KIWAY_HOLDER

Classes

struct  POSITION_RELATIVE_OPTIONS
 Persistent dialog options. More...
 

Public Member Functions

 DIALOG_POSITION_RELATIVE (PCB_BASE_FRAME *aParent, wxPoint &translation, wxPoint &anchor)
 
 ~DIALOG_POSITION_RELATIVE ()
 
void UpdateAnchor (EDA_ITEM *aItem)
 
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

virtual void OnClose (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

wxStaticText * m_referenceInfo
 
wxButton * m_user_origin_button
 
wxButton * m_grid_origin_button
 
wxButton * m_select_anchor_button
 
wxStaticLine * m_staticline2
 
wxStaticText * m_xLabel
 
wxTextCtrl * m_xEntry
 
wxStaticText * m_xUnit
 
wxButton * m_clearX
 
wxStaticText * m_yLabel
 
wxTextCtrl * m_yEntry
 
wxStaticText * m_yUnit
 
wxButton * m_clearY
 
wxStaticLine * m_staticline1
 
wxCheckBox * m_polarCoords
 
wxStdDialogButtonSizer * m_stdButtons
 
wxButton * m_stdButtonsOK
 
wxButton * m_stdButtonsCancel
 
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
 

Private Member Functions

void OnTextFocusLost (wxFocusEvent &event) override
 
void OnPolarChanged (wxCommandEvent &event) override
 
void OnClear (wxCommandEvent &event) override
 
void OnSelectItemClick (wxCommandEvent &event) override
 
void OnUseGridOriginClick (wxCommandEvent &event) override
 
void OnUseUserOriginClick (wxCommandEvent &event) override
 
void OnOkClick (wxCommandEvent &event) override
 
void ToPolarDeg (double x, double y, double &r, double &q)
 Convert a given Cartesian point into a polar representation. More...
 
bool GetTranslationInIU (wxPoint &val, bool polar)
 Get the (Cartesian) translation described by the text entries. More...
 
void updateDialogControls (bool aPolar)
 

Private Attributes

TOOL_MANAGERm_toolMgr
 
wxPoint & m_translation
 
wxPoint & m_anchor_position
 
UNIT_BINDER m_xOffset
 
UNIT_BINDER m_yOffset
 

Static Private Attributes

static POSITION_RELATIVE_OPTIONS m_options
 

Detailed Description

Definition at line 35 of file dialog_position_relative.h.

Constructor & Destructor Documentation

◆ DIALOG_POSITION_RELATIVE()

DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE ( PCB_BASE_FRAME aParent,
wxPoint &  translation,
wxPoint &  anchor 
)

Definition at line 33 of file dialog_position_relative.cpp.

References DIALOG_POSITION_RELATIVE::POSITION_RELATIVE_OPTIONS::entry1, DIALOG_POSITION_RELATIVE::POSITION_RELATIVE_OPTIONS::entry2, DIALOG_SHIM::FinishDialogSettings(), m_options, DIALOG_POSITION_RELATIVE_BASE::m_polarCoords, DIALOG_POSITION_RELATIVE_BASE::m_stdButtonsOK, DIALOG_POSITION_RELATIVE_BASE::m_xEntry, m_xOffset, DIALOG_POSITION_RELATIVE_BASE::m_yEntry, m_yOffset, DIALOG_POSITION_RELATIVE::POSITION_RELATIVE_OPTIONS::polarCoords, UNIT_BINDER::SetValue(), and updateDialogControls().

34  :
36  m_toolMgr( aParent->GetToolManager() ),
37  m_translation( translation ),
38  m_anchor_position( anchor ),
39  m_xOffset( aParent, m_xLabel, m_xEntry, m_xUnit ),
40  m_yOffset( aParent, m_yLabel, m_yEntry, m_yUnit )
41 {
42  // tabbing goes through the entries in sequence
43  m_yEntry->MoveAfterInTabOrder( m_xEntry );
44 
45  // and set up the entries according to the saved options
46  m_polarCoords->SetValue( m_options.polarCoords );
47  updateDialogControls( m_polarCoords->IsChecked() );
48 
51 
52  m_stdButtonsOK->SetDefault();
53 
55 }
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
TOOL_MANAGER * GetToolManager() const
Return the tool manager instance, if any.
Definition: draw_frame.h:940
DIALOG_POSITION_RELATIVE_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Position Relative To Reference Item"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
static POSITION_RELATIVE_OPTIONS m_options

◆ ~DIALOG_POSITION_RELATIVE()

DIALOG_POSITION_RELATIVE::~DIALOG_POSITION_RELATIVE ( )
inline

Definition at line 49 of file dialog_position_relative.h.

49 { };

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 #endif
238 
239  return wxDialog::Enable( enable );
240 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 390 of file dialog_shim.cpp.

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_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().

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

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

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_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_SIM_SETTINGS::onInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

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 }

◆ GetTranslationInIU()

bool DIALOG_POSITION_RELATIVE::GetTranslationInIU ( wxPoint &  val,
bool  polar 
)
private

Get the (Cartesian) translation described by the text entries.

Parameters
valoutput translation vector
polarinterpret as polar coords
Returns
false if error (though the text conversion functions don't report errors)

Definition at line 67 of file dialog_position_relative.cpp.

References DEG2RAD(), UNIT_BINDER::GetValue(), m_xOffset, and m_yOffset.

Referenced by OnOkClick(), and OnPolarChanged().

68 {
69  if( polar )
70  {
71  const int r = m_xOffset.GetValue();
72  const double q = m_yOffset.GetValue();
73 
74  val.x = r * cos( DEG2RAD( q / 10.0 ) );
75  val.y = r * sin( DEG2RAD( q / 10.0 ) );
76  }
77  else
78  {
79  // direct read
80  val.x = m_xOffset.GetValue();
81  val.y = m_yOffset.GetValue();
82  }
83 
84  // no validation to do here, but in future, you could return false here
85  return true;
86 }
virtual int GetValue()
Function GetValue Returns the current value in Internal Units.
double DEG2RAD(double deg)
Definition: trigo.h:199

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

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

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

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

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(), 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().

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

◆ OnClear()

void DIALOG_POSITION_RELATIVE::OnClear ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_POSITION_RELATIVE_BASE.

Definition at line 138 of file dialog_position_relative.cpp.

References DIALOG_POSITION_RELATIVE_BASE::m_clearX, DIALOG_POSITION_RELATIVE_BASE::m_clearY, m_xOffset, m_yOffset, and UNIT_BINDER::SetValue().

139 {
140  wxObject* obj = event.GetEventObject();
141 
142  if( obj == m_clearX )
143  {
144  m_xOffset.SetValue( 0 );
145  }
146  else if( obj == m_clearY )
147  {
148  m_yOffset.SetValue( 0 );
149  }
150 }
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...

◆ OnClose()

virtual void DIALOG_POSITION_RELATIVE_BASE::OnClose ( wxCloseEvent &  event)
inlineprotectedvirtualinherited

◆ OnOkClick()

void DIALOG_POSITION_RELATIVE::OnOkClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_POSITION_RELATIVE_BASE.

Definition at line 200 of file dialog_position_relative.cpp.

References DIALOG_POSITION_RELATIVE::POSITION_RELATIVE_OPTIONS::entry1, DIALOG_POSITION_RELATIVE::POSITION_RELATIVE_OPTIONS::entry2, TOOL_MANAGER::GetTool(), GetTranslationInIU(), UNIT_BINDER::GetValue(), m_anchor_position, m_options, DIALOG_POSITION_RELATIVE_BASE::m_polarCoords, m_toolMgr, m_translation, m_xOffset, m_yOffset, DIALOG_POSITION_RELATIVE::POSITION_RELATIVE_OPTIONS::polarCoords, and POSITION_RELATIVE_TOOL::RelativeItemSelectionMove().

201 {
202  // for the output, we only deliver a Cartesian vector
203  bool ok = GetTranslationInIU( m_translation, m_polarCoords->IsChecked() );
204 
205  if( ok )
206  {
207  // save the settings
208  m_options.polarCoords = m_polarCoords->GetValue();
212  wxASSERT( posrelTool );
213 
215 
216  event.Skip();
217  }
218 }
Class POSITION_RELATIVE_TOOL.
virtual int GetValue()
Function GetValue Returns the current value in Internal Units.
int RelativeItemSelectionMove(wxPoint anchor, wxPoint translation)
Function RelativeItemSelectionMove()
bool GetTranslationInIU(wxPoint &val, bool polar)
Get the (Cartesian) translation described by the text entries.
static POSITION_RELATIVE_OPTIONS m_options

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 292 of file dialog_shim.cpp.

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

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

◆ OnPolarChanged()

void DIALOG_POSITION_RELATIVE::OnPolarChanged ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_POSITION_RELATIVE_BASE.

Definition at line 89 of file dialog_position_relative.cpp.

References GetTranslationInIU(), KiROUND(), DIALOG_POSITION_RELATIVE_BASE::m_polarCoords, m_xOffset, m_yOffset, UNIT_BINDER::SetValue(), ToPolarDeg(), and updateDialogControls().

90 {
91  bool newPolar = m_polarCoords->IsChecked();
92  wxPoint val;
93 
94  // get the value as previously stored
95  GetTranslationInIU( val, !newPolar );
96 
97  // now switch the controls to the new representations
98  updateDialogControls( newPolar );
99 
100  if( newPolar )
101  {
102  // convert to polar coordinates
103  double r, q;
104  ToPolarDeg( val.x, val.y, r, q );
105 
106  m_xOffset.SetValue( KiROUND( r / 10.0) * 10 );
107  m_yOffset.SetValue( q * 10 );
108  }
109  else
110  {
111  // vector is already in Cartesian, so just render out
112  // note - round off the last decimal place (10nm) to prevent
113  // (some) rounding causing errors when round-tripping
114  // you can never eliminate entirely, however
115  m_xOffset.SetValue( KiROUND( val.x / 10.0 ) * 10 );
116  m_yOffset.SetValue( KiROUND( val.y / 10.0 ) * 10 );
117  }
118 }
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:121
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
bool GetTranslationInIU(wxPoint &val, bool polar)
Get the (Cartesian) translation described by the text entries.
void ToPolarDeg(double x, double y, double &r, double &q)
Convert a given Cartesian point into a polar representation.

◆ OnSelectItemClick()

void DIALOG_POSITION_RELATIVE::OnSelectItemClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_POSITION_RELATIVE_BASE.

Definition at line 153 of file dialog_position_relative.cpp.

References TOOL_MANAGER::GetTool(), m_toolMgr, TOOL_MANAGER::RunAction(), and PCB_ACTIONS::selectpositionRelativeItem.

154 {
155  event.Skip();
156 
158  wxASSERT( posrelTool );
160 
161  Hide();
162 }
Class POSITION_RELATIVE_TOOL.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
static TOOL_ACTION selectpositionRelativeItem
Selection of anchor item for position relative tool.
Definition: pcb_actions.h:262

◆ OnTextFocusLost()

void DIALOG_POSITION_RELATIVE::OnTextFocusLost ( wxFocusEvent &  event)
overrideprivatevirtual

Reset a text field to be 0 if it was exited while blank

Reimplemented from DIALOG_POSITION_RELATIVE_BASE.

Definition at line 221 of file dialog_position_relative.cpp.

222 {
223  wxTextCtrl* obj = static_cast<wxTextCtrl*>( event.GetEventObject() );
224 
225  if( obj->GetValue().IsEmpty() )
226  obj->SetValue( "0" );
227 
228  event.Skip();
229 }

◆ OnUseGridOriginClick()

void DIALOG_POSITION_RELATIVE::OnUseGridOriginClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_POSITION_RELATIVE_BASE.

Definition at line 165 of file dialog_position_relative.cpp.

References BOARD::GetGridOrigin(), TOOL_MANAGER::GetModel(), m_anchor_position, DIALOG_POSITION_RELATIVE_BASE::m_referenceInfo, and m_toolMgr.

166 {
167  BOARD* board = (BOARD*) m_toolMgr->GetModel();
168 
169  m_anchor_position = board->GetGridOrigin();
170  m_referenceInfo->SetLabel( _( "Reference location: grid origin" ) );
171 }
EDA_ITEM * GetModel() const
Definition: tool_manager.h:262
const wxPoint & GetGridOrigin() const
Definition: class_board.h:357
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:171

◆ OnUseUserOriginClick()

void DIALOG_POSITION_RELATIVE::OnUseUserOriginClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_POSITION_RELATIVE_BASE.

Definition at line 174 of file dialog_position_relative.cpp.

References TOOL_MANAGER::GetEditFrame(), PCB_BASE_FRAME::GetScreen(), m_anchor_position, BASE_SCREEN::m_O_Curseur, DIALOG_POSITION_RELATIVE_BASE::m_referenceInfo, and m_toolMgr.

175 {
177 
179  m_referenceInfo->SetLabel( _( "Reference location: local coordinates origin" ) );
180 }
wxPoint m_O_Curseur
Relative Screen cursor coordinate (on grid) in user units.
Definition: base_screen.h:185
wxWindow * GetEditFrame() const
Definition: tool_manager.h:267
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...

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

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_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::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(), 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().

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

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

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_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(), and LIB_EDIT_FRAME::savePartAs().

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

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by InvokePcbLibTableEditor(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

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

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

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

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 171 of file dialog_shim.cpp.

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 UpdateAnchor().

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 336 of file dialog_shim.cpp.

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(), 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().

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

◆ ToPolarDeg()

void DIALOG_POSITION_RELATIVE::ToPolarDeg ( double  x,
double  y,
double &  r,
double &  q 
)
private

Convert a given Cartesian point into a polar representation.

Linear units are not considered, the answer is in the same units as given Angle is returned in degrees

Definition at line 58 of file dialog_position_relative.cpp.

References RAD2DEG().

Referenced by OnPolarChanged().

59 {
60  // convert to polar coordinates
61  r = hypot( x, y );
62 
63  q = ( r != 0) ? RAD2DEG( atan2( y, x ) ) : 0;
64 }
double RAD2DEG(double rad)
Definition: trigo.h:200

◆ UpdateAnchor()

void DIALOG_POSITION_RELATIVE::UpdateAnchor ( EDA_ITEM aItem)

Definition at line 183 of file dialog_position_relative.cpp.

References Format(), BOARD_ITEM::GetPosition(), EDA_ITEM::GetSelectMenuText(), DIALOG_SHIM::GetUserUnits(), m_anchor_position, DIALOG_POSITION_RELATIVE_BASE::m_referenceInfo, and DIALOG_SHIM::Show().

Referenced by POSITION_RELATIVE_TOOL::SelectPositionRelativeItem().

184 {
185  wxString reference = _( "<none selected>" );
186  BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( aItem );
187 
188  if( item )
189  {
190  m_anchor_position = item->GetPosition();
191  reference = item->GetSelectMenuText( GetUserUnits() );
192  }
193 
194  m_referenceInfo->SetLabel( wxString::Format( "Reference item: %s", reference ) );
195 
196  Show( true );
197 }
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
bool Show(bool show) override
virtual const wxPoint GetPosition() const =0
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
virtual wxString GetSelectMenuText(EDA_UNITS_T aUnits) const
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
EDA_UNITS_T GetUserUnits() const override
Definition: dialog_shim.h:133

◆ updateDialogControls()

void DIALOG_POSITION_RELATIVE::updateDialogControls ( bool  aPolar)
private

Definition at line 121 of file dialog_position_relative.cpp.

References DEGREES, DIALOG_SHIM::GetUserUnits(), m_xOffset, m_yOffset, UNIT_BINDER::SetLabel(), and UNIT_BINDER::SetUnits().

Referenced by DIALOG_POSITION_RELATIVE(), and OnPolarChanged().

122 {
123  if( aPolar )
124  {
125  m_xOffset.SetLabel( _( "Distance:" ) ); // Polar radius
126  m_yOffset.SetLabel( _( "Angle:" ) ); // Polar theta or angle
128  }
129  else
130  {
131  m_xOffset.SetLabel( _( "Offset X:" ) );
132  m_yOffset.SetLabel( _( "Offset Y:" ) );
134  }
135 }
virtual void SetUnits(EDA_UNITS_T aUnits, bool aUseMils=false)
Function SetUnits Normally not needed (as the UNIT_BINDER inherits from the parent frame)...
Definition: unit_binder.cpp:65
void SetLabel(const wxString &aLabel)
EDA_UNITS_T GetUserUnits() const override
Definition: dialog_shim.h:133

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

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

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

Member Data Documentation

◆ m_anchor_position

wxPoint& DIALOG_POSITION_RELATIVE::m_anchor_position
private

◆ m_clearX

wxButton* DIALOG_POSITION_RELATIVE_BASE::m_clearX
protectedinherited

◆ m_clearY

wxButton* DIALOG_POSITION_RELATIVE_BASE::m_clearY
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 179 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_grid_origin_button

wxButton* DIALOG_POSITION_RELATIVE_BASE::m_grid_origin_button
protectedinherited

◆ m_hash_key

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

DIALOG_POSITION_RELATIVE::POSITION_RELATIVE_OPTIONS DIALOG_POSITION_RELATIVE::m_options
staticprivate

Definition at line 105 of file dialog_position_relative.h.

Referenced by DIALOG_POSITION_RELATIVE(), and OnOkClick().

◆ m_polarCoords

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

wxStaticText* DIALOG_POSITION_RELATIVE_BASE::m_referenceInfo
protectedinherited

◆ m_select_anchor_button

wxButton* DIALOG_POSITION_RELATIVE_BASE::m_select_anchor_button
protectedinherited

◆ m_staticline1

wxStaticLine* DIALOG_POSITION_RELATIVE_BASE::m_staticline1
protectedinherited

◆ m_staticline2

wxStaticLine* DIALOG_POSITION_RELATIVE_BASE::m_staticline2
protectedinherited

◆ m_stdButtons

wxStdDialogButtonSizer* DIALOG_POSITION_RELATIVE_BASE::m_stdButtons
protectedinherited

◆ m_stdButtonsCancel

wxButton* DIALOG_POSITION_RELATIVE_BASE::m_stdButtonsCancel
protectedinherited

◆ m_stdButtonsOK

wxButton* DIALOG_POSITION_RELATIVE_BASE::m_stdButtonsOK
protectedinherited

◆ m_toolMgr

TOOL_MANAGER* DIALOG_POSITION_RELATIVE::m_toolMgr
private

◆ m_translation

wxPoint& DIALOG_POSITION_RELATIVE::m_translation
private

Definition at line 40 of file dialog_position_relative.h.

Referenced by OnOkClick().

◆ m_units

◆ m_user_origin_button

wxButton* DIALOG_POSITION_RELATIVE_BASE::m_user_origin_button
protectedinherited

◆ m_xEntry

wxTextCtrl* DIALOG_POSITION_RELATIVE_BASE::m_xEntry
protectedinherited

◆ m_xLabel

wxStaticText* DIALOG_POSITION_RELATIVE_BASE::m_xLabel
protectedinherited

◆ m_xOffset

UNIT_BINDER DIALOG_POSITION_RELATIVE::m_xOffset
private

◆ m_xUnit

wxStaticText* DIALOG_POSITION_RELATIVE_BASE::m_xUnit
protectedinherited

◆ m_yEntry

wxTextCtrl* DIALOG_POSITION_RELATIVE_BASE::m_yEntry
protectedinherited

◆ m_yLabel

wxStaticText* DIALOG_POSITION_RELATIVE_BASE::m_yLabel
protectedinherited

◆ m_yOffset

UNIT_BINDER DIALOG_POSITION_RELATIVE::m_yOffset
private

◆ m_yUnit

wxStaticText* DIALOG_POSITION_RELATIVE_BASE::m_yUnit
protectedinherited

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