KiCad PCB EDA Suite
DIALOG_SET_GRID Class Reference
Inheritance diagram for DIALOG_SET_GRID:
DIALOG_SET_GRID_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_SET_GRID (PCB_BASE_FRAME *aParent, const wxArrayString &aGridChoices)
 This has no dependencies on calling wxFrame derivative, such as PCB_BASE_FRAME. More...
 
bool TransferDataFromWindow () override
 
bool TransferDataToWindow () override
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
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 OnCancelClick (wxCommandEvent &event)
 
virtual void OnOkClick (wxCommandEvent &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_staticTextGridPosX
 
wxTextCtrl * m_GridOriginXCtrl
 
wxStaticText * m_TextPosXUnits
 
wxStaticText * m_staticTextGridPosY
 
wxTextCtrl * m_GridOriginYCtrl
 
wxStaticText * m_TextPosYUnits
 
wxButton * m_buttonReset
 
wxStaticText * m_staticTextSizeX
 
wxTextCtrl * m_OptGridSizeX
 
wxStaticText * m_TextSizeXUnits
 
wxStaticText * m_staticTextSizeY
 
wxTextCtrl * m_OptGridSizeY
 
wxStaticText * m_TextSizeYUnits
 
wxStaticText * m_staticTextGrid1
 
wxComboBox * m_comboBoxGrid1
 
wxStaticText * m_staticTextGrid2
 
wxComboBox * m_comboBoxGrid2
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
bool m_fixupsRun
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

void OnResetGridOrgClick (wxCommandEvent &event) override
 
void OnInitDlg (wxInitDialogEvent &event) override
 
void setGridSize (const wxPoint &grid)
 
bool getGridSize (wxPoint &aGrisSize)
 
void setGridOrigin (const wxPoint &grid)
 
bool getGridOrigin (wxPoint &aGridOrigin)
 
void setGridForFastSwitching (const wxArrayString &aGrids, int aGrid1, int aGrid2)
 
void getGridForFastSwitching (int &aGrid1, int &aGrid2)
 

Private Attributes

PCB_BASE_FRAMEm_parent
 
wxArrayString m_fast_grid_opts
 

Detailed Description

Definition at line 52 of file dialog_set_grid.cpp.

Constructor & Destructor Documentation

DIALOG_SET_GRID::DIALOG_SET_GRID ( PCB_BASE_FRAME aParent,
const wxArrayString &  aGridChoices 
)

This has no dependencies on calling wxFrame derivative, such as PCB_BASE_FRAME.

Definition at line 86 of file dialog_set_grid.cpp.

References g_UserUnit, GetAbbreviatedUnitsLabel(), DIALOG_SET_GRID_BASE::m_sdbSizerOK, DIALOG_SET_GRID_BASE::m_TextPosXUnits, DIALOG_SET_GRID_BASE::m_TextPosYUnits, DIALOG_SET_GRID_BASE::m_TextSizeXUnits, and DIALOG_SET_GRID_BASE::m_TextSizeYUnits.

86  :
87  DIALOG_SET_GRID_BASE( aParent ),
88  m_parent( aParent ),
89  m_fast_grid_opts( aGridChoices )
90 {
91  m_sdbSizerOK->SetDefault(); // set OK button as default response to 'Enter' key
92 
95 
98 }
wxArrayString m_fast_grid_opts
wxStaticText * m_TextSizeXUnits
DIALOG_SET_GRID_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Grid Settings"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
PCB_BASE_FRAME * m_parent
wxStaticText * m_TextSizeYUnits
wxStaticText * m_TextPosXUnits
wxStaticText * m_TextPosYUnits
wxString GetAbbreviatedUnitsLabel(EDA_UNITS_T aUnit)
Definition: base_units.cpp:485
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:57

Member Function Documentation

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 205 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues(), and DIALOG_SHIM::IsQuasiModal().

206 {
207  // so we can do logging of this state change:
208 
209 #if defined(DEBUG)
210  const char* type_id = typeid( *this ).name();
211  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
212 #endif
213 
214  return wxDialog::Enable( enable );
215 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 610 of file dialog_shim.cpp.

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

Referenced by DIALOG_SHIM::OnButton(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCloseDialog(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCloseDialog(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), DIALOG_EXCHANGE_FOOTPRINTS::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

611 {
612  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
613  // handle validation in the same way as other dialogs.
614  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
615  return;
616 
617  SetReturnCode( retCode );
618 
619  if( !IsQuasiModal() )
620  {
621  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
622  return;
623  }
624 
625  m_qmodal_showing = false;
626 
627  if( m_qmodal_loop )
628  {
629  if( m_qmodal_loop->IsRunning() )
630  m_qmodal_loop->Exit( 0 );
631  else
632  m_qmodal_loop->ScheduleExit( 0 );
633 
634  m_qmodal_loop = NULL;
635  }
636 
639 
640  Show( false );
641 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool IsQuasiModal()
Definition: dialog_shim.h:103
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
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 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by COLOR4D_PICKER_DLG::COLOR4D_PICKER_DLG(), DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DESIGN_RULES::DIALOG_DESIGN_RULES(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG(), 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_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIBEDIT_OPTIONS::DIALOG_LIBEDIT_OPTIONS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PADS_MASK_CLEARANCE::DIALOG_PADS_MASK_CLEARANCE(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_PRETTY_LIB::DIALOG_SELECT_PRETTY_LIB(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_SHIM::IsQuasiModal(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_LIB_EDIT_PIN::OnInitDialog(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog(), DIALOG_TRACK_VIA_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnInitDlg(), DIALOG_EDIT_FPTEXT::OnInitDlg(), OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_FOOTPRINT_FP_EDITOR::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), and DIALOG_UPDATE_FIELDS::TransferDataToWindow().

105 {
106  // must be called from the constructor of derived classes,
107  // when all widgets are initialized, and therefore their size fixed
108 
109  // SetSizeHints fixes the minimal size of sizers in the dialog
110  // (SetSizeHints calls Fit(), so no need to call it)
111  GetSizer()->SetSizeHints( this );
112 
113  // the default position, when calling the first time the dlg
114  Center();
115 }
void DIALOG_SET_GRID::getGridForFastSwitching ( int &  aGrid1,
int &  aGrid2 
)
private

Definition at line 270 of file dialog_set_grid.cpp.

References DIALOG_SET_GRID_BASE::m_comboBoxGrid1, and DIALOG_SET_GRID_BASE::m_comboBoxGrid2.

Referenced by OnInitDlg(), and TransferDataFromWindow().

271 {
272  aGrid1 = m_comboBoxGrid1->GetSelection();
273  aGrid2 = m_comboBoxGrid2->GetSelection();
274 }
bool DIALOG_SET_GRID::getGridOrigin ( wxPoint aGridOrigin)
private

Definition at line 219 of file dialog_set_grid.cpp.

References DoubleValueFromString(), g_UserUnit, KiROUND(), DIALOG_SET_GRID_BASE::m_GridOriginXCtrl, DIALOG_SET_GRID_BASE::m_GridOriginYCtrl, MAX_GRID_OFFSET, wxPoint::x, and wxPoint::y.

Referenced by OnInitDlg(), and TransferDataFromWindow().

220 {
221  double x, y;
222 
223  const wxString& x_str = m_GridOriginXCtrl->GetValue();
224 
225  if( !x_str.ToDouble( &x ) )
226  return false;
227 
228  x = DoubleValueFromString( g_UserUnit, x_str );
229 
230  // Some error checking here is a good thing.
231  if( x < -MAX_GRID_OFFSET || x > MAX_GRID_OFFSET )
232  return false;
233 
234 
235  const wxString& y_str = m_GridOriginYCtrl->GetValue();
236 
237  if( !y_str.ToDouble( &y ) )
238  return false;
239 
240  y = DoubleValueFromString( g_UserUnit, y_str );
241 
242  if( y < -MAX_GRID_OFFSET || y > MAX_GRID_OFFSET )
243  return false;
244 
245 
246  aGridOrigin.x = KiROUND( x );
247  aGridOrigin.y = KiROUND( y );
248 
249  return true;
250 }
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:57
static const double MAX_GRID_OFFSET
double DoubleValueFromString(EDA_UNITS_T aUnits, const wxString &aTextValue)
Function DoubleValueFromString converts aTextValue to a double.
Definition: base_units.cpp:303
bool DIALOG_SET_GRID::getGridSize ( wxPoint aGrisSize)
private

Definition at line 186 of file dialog_set_grid.cpp.

References DoubleValueFromString(), g_UserUnit, KiROUND(), DIALOG_SET_GRID_BASE::m_OptGridSizeX, DIALOG_SET_GRID_BASE::m_OptGridSizeY, MAX_GRID_SIZE, wxPoint::x, and wxPoint::y.

Referenced by OnInitDlg(), and TransferDataFromWindow().

187 {
188  double x, y;
189 
190  const wxString& x_str = m_OptGridSizeX->GetValue();
191 
192  if( !x_str.ToDouble( &x ) )
193  return false;
194 
195  x = DoubleValueFromString( g_UserUnit, x_str );
196 
197  // Some error checking here is a good thing.
198  if( x < MIN_GRID_SIZE || x > MAX_GRID_SIZE )
199  return false;
200 
201  const wxString& y_str = m_OptGridSizeY->GetValue();
202 
203  if( !y_str.ToDouble( &y ) )
204  return false;
205 
206  y = DoubleValueFromString( g_UserUnit, y_str );
207 
208  // Some error checking here is a good thing.
209  if( y < MIN_GRID_SIZE || y > MAX_GRID_SIZE )
210  return false;
211 
212  aGridSize.x = KiROUND( x );
213  aGridSize.y = KiROUND( y );
214 
215  return true;
216 }
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
static const double MAX_GRID_SIZE
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:57
double DoubleValueFromString(EDA_UNITS_T aUnits, const wxString &aTextValue)
Function DoubleValueFromString converts aTextValue to a double.
Definition: base_units.cpp:303
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 125 of file dialog_shim.cpp.

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

126 {
127  wxSize sz( x, 0 );
128  return ConvertDialogToPixels( sz ).x;
129 }
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, KIWAY_HOLDER::Prj(), and KIWAY_HOLDER::SetKiway().

Referenced by SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), FOOTPRINT_EDIT_FRAME::GetIconScale(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), SCH_EDIT_FRAME::KiwayMailIn(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_CHOOSE_COMPONENT::OnIdle(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), 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(), FOOTPRINT_WIZARD_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), 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(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), 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:85
virtual void DIALOG_SET_GRID_BASE::OnCancelClick ( wxCommandEvent &  event)
inlineprotectedvirtualinherited
void DIALOG_SET_GRID::OnInitDlg ( wxInitDialogEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from DIALOG_SET_GRID_BASE.

Definition at line 66 of file dialog_set_grid.cpp.

References DIALOG_SHIM::FinishDialogSettings(), getGridForFastSwitching(), getGridOrigin(), getGridSize(), setGridForFastSwitching(), setGridOrigin(), setGridSize(), and TransferDataToWindow().

67  {
68  // Call the default wxDialog handler of a wxInitDialogEvent
70 
71  // Now all widgets have the size fixed, call FinishDialogSettings
73  }
bool TransferDataToWindow() override
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual void DIALOG_SET_GRID_BASE::OnOkClick ( wxCommandEvent &  event)
inlineprotectedvirtualinherited
void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 271 of file dialog_shim.cpp.

References DIALOG_SHIM::m_fixupsRun, and recursiveDescent().

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

272 {
273  if( !m_fixupsRun )
274  {
275 #if DLGSHIM_SELECT_ALL_IN_TEXT_CONTROLS
276  const bool selectAllInTextCtrls = true;
277 #else
278  const bool selectAllInTextCtrls = false;
279 #endif
280  wxWindow* firstTextCtrl = NULL;
281  wxWindow* windowWithFocus = NULL;
282 
283  recursiveDescent( GetChildren(), selectAllInTextCtrls, firstTextCtrl,
284  windowWithFocus );
285 
286 #if DLGSHIM_USE_SETFOCUS
287  // While it would be nice to honour any focus already set (which was
288  // recorded in windowWithFocus), the reality is that it's currently wrong
289  // far more often than it's right.
290  // So just focus on the first text control if we have one; otherwise the
291  // focus on the dialog itself, which will at least allow esc, return, etc.
292  // to function.
293  if( firstTextCtrl )
294  firstTextCtrl->SetFocus();
295  else
296  SetFocus();
297 #endif
298 
299 #ifdef __WXMAC__
300  fixOSXCancelButtonIssue( this );
301 #endif
302 
303  m_fixupsRun = true;
304  }
305 
306  event.Skip();
307 }
static void recursiveDescent(wxWindowList &children, const bool selectTextInTextCtrls, wxWindow *&firstTextCtrl, wxWindow *&windowWithFocus)
bool m_fixupsRun
Definition: dialog_shim.h:149
void DIALOG_SET_GRID::OnResetGridOrgClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SET_GRID_BASE.

Definition at line 277 of file dialog_set_grid.cpp.

References setGridOrigin().

278 {
279  setGridOrigin( wxPoint( 0, 0 ) );
280 }
void setGridOrigin(const wxPoint &grid)
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 SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), DIALOG_FOOTPRINT_FP_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkNewAlias(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), 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_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_FOOTPRINT_FP_EDITOR::Edit3DShapeFileName(), DIALOG_FOOTPRINT_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::Files_io_from_id(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), FOOTPRINT_EDIT_FRAME::getLibPath(), LIB_EDIT_FRAME::getLibraryFileName(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), DIALOG_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), KIWAY_HOLDER::Kiway(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_CHOOSE_COMPONENT::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_NETLIST::OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), EDA_3D_VIEWER::takeScreenshot(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), and DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR().

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
void DIALOG_SET_GRID::setGridForFastSwitching ( const wxArrayString &  aGrids,
int  aGrid1,
int  aGrid2 
)
private

Definition at line 260 of file dialog_set_grid.cpp.

References DIALOG_SET_GRID_BASE::m_comboBoxGrid1, and DIALOG_SET_GRID_BASE::m_comboBoxGrid2.

Referenced by OnInitDlg(), and TransferDataToWindow().

261 {
262  m_comboBoxGrid1->Append( aGrids );
263  m_comboBoxGrid2->Append( aGrids );
264 
265  m_comboBoxGrid1->SetSelection( aGrid1 );
266  m_comboBoxGrid2->SetSelection( aGrid2 );
267 }
void DIALOG_SET_GRID::setGridOrigin ( const wxPoint grid)
private

Definition at line 253 of file dialog_set_grid.cpp.

References DIALOG_SET_GRID_BASE::m_GridOriginXCtrl, DIALOG_SET_GRID_BASE::m_GridOriginYCtrl, PutValueInLocalUnits(), wxPoint::x, and wxPoint::y.

Referenced by OnInitDlg(), OnResetGridOrgClick(), and TransferDataToWindow().

254 {
257 }
void PutValueInLocalUnits(wxTextCtrl &aTextCtr, int aValue)
Function PutValueInLocalUnits converts aValue from internal units to user units and append the units ...
Definition: base_units.cpp:267
void DIALOG_SET_GRID::setGridSize ( const wxPoint grid)
private

Definition at line 174 of file dialog_set_grid.cpp.

References g_UserUnit, DIALOG_SET_GRID_BASE::m_OptGridSizeX, DIALOG_SET_GRID_BASE::m_OptGridSizeY, To_User_Unit(), wxPoint::x, and wxPoint::y.

Referenced by OnInitDlg(), and TransferDataToWindow().

175 {
176  wxString msg;
177 
178  msg.Printf( wxT( "%.10g" ), To_User_Unit( g_UserUnit, grid.x ) );
179  m_OptGridSizeX->SetValue( msg );
180 
181  msg.Printf( wxT( "%.10g" ), To_User_Unit( g_UserUnit, grid.y ) );
182  m_OptGridSizeY->SetValue( msg );
183 }
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:57
double To_User_Unit(EDA_UNITS_T aUnit, double aValue)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:91
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 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), KIWAY_HOLDER::Kiway(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_player.h:85
const char * name
Definition: DXF_plotter.cpp:61
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 118 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), HOTKEYS_EDITOR_DIALOG::HOTKEYS_EDITOR_DIALOG(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_SHIM::IsQuasiModal(), DIALOG_LAYERS_SETUP::OnInitDialog(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

119 {
120  wxSize sz( x, y );
121  SetSize( ConvertDialogToPixels( sz ) );
122 }
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 146 of file dialog_shim.cpp.

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

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_SHIM::IsQuasiModal(), DIALOG_SCH_FIND::OnCancel(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_FOOTPRINTS::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), SCH_COMPONENT::SetPosition(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

147 {
148  bool ret;
149  const char* hash_key;
150 
151  if( m_hash_key.size() )
152  {
153  // a special case like EDA_LIST_DIALOG, which has multiple uses.
154  hash_key = m_hash_key.c_str();
155  }
156  else
157  {
158  hash_key = typeid(*this).name();
159  }
160 
161  // Show or hide the window. If hiding, save current position and size.
162  // If showing, use previous position and size.
163  if( show )
164  {
165 #ifndef __WINDOWS__
166  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
167 #endif
168  ret = wxDialog::Show( show );
169 
170  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
171  EDA_RECT savedDialogRect = class_map[ hash_key ];
172 
173  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
174  {
175  SetSize( savedDialogRect.GetPosition().x,
176  savedDialogRect.GetPosition().y,
177  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
178  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
179  0 );
180  }
181 
182  // Be sure that the dialog appears in a visible area
183  // (the dialog position might have been stored at the time when it was
184  // shown on another display)
185  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
186  Centre();
187  }
188  else
189  {
190  // Save the dialog's position & size before hiding, using classname as key
191  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
192 
193 #ifdef __WXMAC__
194  if ( m_eventLoop )
195  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
196 #endif
197 
198  ret = wxDialog::Show( show );
199  }
200 
201  return ret;
202 }
const wxSize GetSize() const
Definition: eda_rect.h:101
std::string m_hash_key
Definition: dialog_shim.h:151
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
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 558 of file dialog_shim.cpp.

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

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), SCH_EDIT_FRAME::InstallHierarchyFrame(), InvokeDialogCreateBOMEditor(), InvokeDialogEditComponentsLibId(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

559 {
560  // This is an exception safe way to zero a pointer before returning.
561  // Yes, even though DismissModal() clears this first normally, this is
562  // here in case there's an exception before the dialog is dismissed.
563  struct NULLER
564  {
565  void*& m_what;
566  NULLER( void*& aPtr ) : m_what( aPtr ) {}
567  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
568  } clear_this( (void*&) m_qmodal_loop );
569 
570  // release the mouse if it's currently captured as the window having it
571  // will be disabled when this dialog is shown -- but will still keep the
572  // capture making it impossible to do anything in the modal dialog itself
573  wxWindow* win = wxWindow::GetCapture();
574  if( win )
575  win->ReleaseMouse();
576 
577  // Get the optimal parent
578  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
579 
580  // Show the optimal parent
581  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
582 
583  wxASSERT_MSG( !m_qmodal_parent_disabler,
584  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
585 
586  // quasi-modal: disable only my "optimal" parent
588 
589 #ifdef __WXMAC__
590  // Apple in its infinite wisdom will raise a disabled window before even passing
591  // us the event, so we have no way to stop it. Instead, we must set an order on
592  // the windows so that the quasi-modal will be pushed in front of the disabled
593  // window when it is raised.
594  ReparentQuasiModal();
595 #endif
596  Show( true );
597 
598  m_qmodal_showing = true;
599 
600  EVENT_LOOP event_loop;
601 
602  m_qmodal_loop = &event_loop;
603 
604  event_loop.Run();
605 
606  return GetReturnCode();
607 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
Toggle a window&#39;s "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:33
#define DBG(x)
Definition: fctsys.h:33
bool DIALOG_SET_GRID::TransferDataFromWindow ( )
override

Definition at line 101 of file dialog_set_grid.cpp.

References BASE_SCREEN::AddGrid(), Format(), BASE_SCREEN::GetGridCmdId(), getGridForFastSwitching(), getGridOrigin(), getGridSize(), PCB_BASE_FRAME::GetScreen(), EDA_DRAW_FRAME::GetToolManager(), ACTIONS::gridSetOrigin, ID_POPUP_GRID_LEVEL_1000, ID_POPUP_GRID_USER, EDA_DRAW_FRAME::IsGalCanvasActive(), PCB_BASE_FRAME::m_FastGrid1, PCB_BASE_FRAME::m_FastGrid2, m_parent, PCB_BASE_FRAME::m_UserGridSize, TOOL_ACTION::MakeEvent(), MAX_GRID_OFFSET, MAX_GRID_SIZE, MIN_GRID_SIZE, PCB_BASE_FRAME::OnModify(), TOOL_MANAGER::ProcessEvent(), TOOL_MANAGER::RunAction(), BASE_SCREEN::SetGrid(), PCB_BASE_FRAME::SetGridOrigin(), TOOL_EVENT::SetParameter(), and UNSCALED_UNITS.

102 {
103  // Validate new settings
104  wxPoint gridOrigin;
105 
106  if( !getGridOrigin( gridOrigin ) )
107  {
108  wxMessageBox( wxString::Format( _( "Incorrect grid origin "
109  "(coordinates must be >= %.3f mm and <= %.3f mm)" ),
110  -MAX_GRID_OFFSET/IU_PER_MM, MAX_GRID_OFFSET/IU_PER_MM ) );
111 
112  return false;
113  }
114 
115  wxPoint gridSize;
116 
117  if( !getGridSize( gridSize ) )
118  {
119  wxMessageBox( wxString::Format( _( "Incorrect grid size "
120  "(size must be >= %.3f mm and <= %.3f mm)" ),
121  MIN_GRID_SIZE/IU_PER_MM, MAX_GRID_SIZE/IU_PER_MM ) );
122 
123  return false;
124  }
125 
126  int fastGrid1, fastGrid2;
127  getGridForFastSwitching( fastGrid1, fastGrid2 );
128 
129  // Apply the new settings
130 
131  // Because grid origin is saved in board, show as modified
132  m_parent->OnModify();
133  m_parent->SetGridOrigin( gridOrigin );
134  m_parent->m_UserGridSize = gridSize;
135  m_parent->m_FastGrid1 = fastGrid1;
136  m_parent->m_FastGrid2 = fastGrid2;
137 
138  // User grid
139  BASE_SCREEN* screen = m_parent->GetScreen();
141 
142  // If the user grid is the current option, recall SetGrid()
143  // to force new values put in list as current grid value
144  if( screen->GetGridCmdId() == ID_POPUP_GRID_USER )
145  screen->SetGrid( ID_POPUP_GRID_USER );
146 
147  // Notify GAL
149 
150  if( mgr && m_parent->IsGalCanvasActive() )
151  {
152  mgr->RunAction( "common.Control.gridPreset", true,
154 
155  TOOL_EVENT gridOriginUpdate = ACTIONS::gridSetOrigin.MakeEvent();
156  gridOriginUpdate.SetParameter( new VECTOR2D( gridOrigin ) );
157  mgr->ProcessEvent( gridOriginUpdate );
158  }
159 
160  return wxDialog::TransferDataFromWindow();
161 }
void SetGridOrigin(const wxPoint &aPoint) override
int GetGridCmdId() const
Return the command ID of the currently selected grid.
Definition: base_screen.h:403
PCB_BASE_FRAME * m_parent
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
static const double MAX_GRID_SIZE
bool getGridOrigin(wxPoint &aGridOrigin)
Class TOOL_MANAGER.
Definition: tool_manager.h:49
void SetParameter(T aParam)
Function SetParameter() Sets a non-standard parameter assigned to the event.
Definition: tool_event.h:390
VECTOR2< double > VECTOR2D
Definition: vector2d.h:588
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:76
Class TOOL_EVENT.
Definition: tool_event.h:162
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:887
ID_POPUP_GRID_USER
Definition: draw_frame.cpp:110
wxPoint m_UserGridSize
bool getGridSize(wxPoint &aGrisSize)
virtual void OnModify()
Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the curr...
TOOL_MANAGER * GetToolManager() const
Function GetToolManager returns the tool manager instance, if any.
Definition: draw_frame.h:902
void AddGrid(const GRID_TYPE &grid)
TOOL_EVENT MakeEvent() const
Function HasHotKey() Checks if the action has a hot key assigned.
Definition: tool_action.h:104
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
static const double MAX_GRID_OFFSET
PCB_SCREEN * GetScreen() const override
Function GetScreen returns a pointer to a BASE_SCREEN or one of its derivatives.
void getGridForFastSwitching(int &aGrid1, int &aGrid2)
static TOOL_ACTION gridSetOrigin
Definition: actions.h:65
int SetGrid(const wxRealPoint &size)
set the current grid size m_Grid.
static const double MIN_GRID_SIZE
bool DIALOG_SET_GRID::TransferDataToWindow ( )
override

Definition at line 164 of file dialog_set_grid.cpp.

References PCB_BASE_FRAME::GetGridOrigin(), m_fast_grid_opts, PCB_BASE_FRAME::m_FastGrid1, PCB_BASE_FRAME::m_FastGrid2, m_parent, PCB_BASE_FRAME::m_UserGridSize, setGridForFastSwitching(), setGridOrigin(), and setGridSize().

Referenced by OnInitDlg().

165 {
169 
170  return wxDialog::TransferDataToWindow();
171 }
wxArrayString m_fast_grid_opts
void setGridSize(const wxPoint &grid)
PCB_BASE_FRAME * m_parent
const wxPoint & GetGridOrigin() const override
Function GetGridOrigin returns the absolute coordinates of the origin of the snap grid...
void setGridOrigin(const wxPoint &grid)
void setGridForFastSwitching(const wxArrayString &aGrids, int aGrid1, int aGrid2)
wxPoint m_UserGridSize
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 132 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_SHIM::IsQuasiModal(), and DIALOG_LAYERS_SETUP::OnInitDialog().

133 {
134  wxSize sz( 0, y );
135  return ConvertDialogToPixels( sz ).y;
136 }

Member Data Documentation

wxButton* DIALOG_SET_GRID_BASE::m_buttonReset
protectedinherited
wxComboBox* DIALOG_SET_GRID_BASE::m_comboBoxGrid1
protectedinherited
wxComboBox* DIALOG_SET_GRID_BASE::m_comboBoxGrid2
protectedinherited
wxArrayString DIALOG_SET_GRID::m_fast_grid_opts
private

Definition at line 55 of file dialog_set_grid.cpp.

Referenced by TransferDataToWindow().

bool DIALOG_SHIM::m_fixupsRun
protectedinherited

Definition at line 149 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

wxTextCtrl* DIALOG_SET_GRID_BASE::m_GridOriginXCtrl
protectedinherited
wxTextCtrl* DIALOG_SET_GRID_BASE::m_GridOriginYCtrl
protectedinherited
std::string DIALOG_SHIM::m_hash_key
protectedinherited
wxTextCtrl* DIALOG_SET_GRID_BASE::m_OptGridSizeX
protectedinherited
wxTextCtrl* DIALOG_SET_GRID_BASE::m_OptGridSizeY
protectedinherited
PCB_BASE_FRAME* DIALOG_SET_GRID::m_parent
private

Definition at line 54 of file dialog_set_grid.cpp.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 154 of file dialog_shim.h.

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

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited
bool DIALOG_SHIM::m_qmodal_showing
protectedinherited
wxStdDialogButtonSizer* DIALOG_SET_GRID_BASE::m_sdbSizer
protectedinherited

Definition at line 56 of file dialog_set_grid_base.h.

Referenced by DIALOG_SET_GRID_BASE::DIALOG_SET_GRID_BASE().

wxButton* DIALOG_SET_GRID_BASE::m_sdbSizerCancel
protectedinherited
wxButton* DIALOG_SET_GRID_BASE::m_sdbSizerOK
protectedinherited
wxStaticText* DIALOG_SET_GRID_BASE::m_staticTextGrid1
protectedinherited

Definition at line 52 of file dialog_set_grid_base.h.

Referenced by DIALOG_SET_GRID_BASE::DIALOG_SET_GRID_BASE().

wxStaticText* DIALOG_SET_GRID_BASE::m_staticTextGrid2
protectedinherited

Definition at line 54 of file dialog_set_grid_base.h.

Referenced by DIALOG_SET_GRID_BASE::DIALOG_SET_GRID_BASE().

wxStaticText* DIALOG_SET_GRID_BASE::m_staticTextGridPosX
protectedinherited

Definition at line 39 of file dialog_set_grid_base.h.

Referenced by DIALOG_SET_GRID_BASE::DIALOG_SET_GRID_BASE().

wxStaticText* DIALOG_SET_GRID_BASE::m_staticTextGridPosY
protectedinherited

Definition at line 42 of file dialog_set_grid_base.h.

Referenced by DIALOG_SET_GRID_BASE::DIALOG_SET_GRID_BASE().

wxStaticText* DIALOG_SET_GRID_BASE::m_staticTextSizeX
protectedinherited

Definition at line 46 of file dialog_set_grid_base.h.

Referenced by DIALOG_SET_GRID_BASE::DIALOG_SET_GRID_BASE().

wxStaticText* DIALOG_SET_GRID_BASE::m_staticTextSizeY
protectedinherited

Definition at line 49 of file dialog_set_grid_base.h.

Referenced by DIALOG_SET_GRID_BASE::DIALOG_SET_GRID_BASE().

wxStaticText* DIALOG_SET_GRID_BASE::m_TextPosXUnits
protectedinherited
wxStaticText* DIALOG_SET_GRID_BASE::m_TextPosYUnits
protectedinherited
wxStaticText* DIALOG_SET_GRID_BASE::m_TextSizeXUnits
protectedinherited
wxStaticText* DIALOG_SET_GRID_BASE::m_TextSizeYUnits
protectedinherited

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