KiCad PCB EDA Suite
PAGED_DIALOG Class Reference

#include <paged_dialog.h>

Inheritance diagram for PAGED_DIALOG:
DIALOG_SHIM KIWAY_HOLDER DIALOG_BOARD_SETUP DIALOG_SCHEMATIC_SETUP

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 PAGED_DIALOG (wxWindow *aParent, const wxString &aTitle, bool aUseReset=false, const wxString &aAuxiliaryAction=wxEmptyString)
 
 ~PAGED_DIALOG () override
 
wxTreebook * GetTreebook ()
 
void SetInitialPage (const wxString &aPage, const wxString &aParentPage=wxEmptyString)
 
void SetModified ()
 
void SetError (const wxString &aMessage, const wxString &aPageName, int aCtrlId, int aRow=-1, int aCol=-1)
 
void SetError (const wxString &aMessage, wxWindow *aPage, wxWindow *aCtrl, int aRow=-1, int aCol=-1)
 
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 () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 

Protected Member Functions

void finishInitialization ()
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void OnClose (wxCloseEvent &event)
 
void OnCancel (wxCommandEvent &event)
 
virtual void OnAuxiliaryAction (wxCommandEvent &event)
 
void OnResetButton (wxCommandEvent &aEvent)
 
void OnUpdateUI (wxUpdateUIEvent &event)
 
void OnPageChange (wxBookCtrlEvent &event)
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 
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) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 

Protected Attributes

wxTreebook * m_treebook
 
wxButton * m_auxiliaryButton
 
wxButton * m_resetButton
 
wxButton * m_cancelButton
 
WX_INFOBARm_infoBar
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private Attributes

wxString m_title
 
bool m_dirty
 
wxString m_errorMessage
 
wxWindow * m_errorCtrl
 
int m_errorRow
 
int m_errorCol
 
std::vector< bool > m_macHack
 

Detailed Description

Definition at line 31 of file paged_dialog.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ PAGED_DIALOG()

PAGED_DIALOG::PAGED_DIALOG ( wxWindow *  aParent,
const wxString &  aTitle,
bool  aUseReset = false,
const wxString &  aAuxiliaryAction = wxEmptyString 
)

Definition at line 39 of file paged_dialog.cpp.

40  :
41  DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
42  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
43  m_title( aTitle ),
44  m_dirty( false ),
45  m_errorCtrl( nullptr ),
46  m_errorRow( 0 ),
47  m_errorCol( 0 ),
48  m_auxiliaryButton( nullptr ),
49  m_resetButton( nullptr ),
50  m_cancelButton( nullptr )
51 {
52  auto mainSizer = new wxBoxSizer( wxVERTICAL );
53  SetSizer( mainSizer );
54 
55  m_infoBar = new WX_INFOBAR( this );
56  mainSizer->Add( m_infoBar, 0, wxEXPAND, 0 );
57 
58  m_treebook = new wxTreebook( this, wxID_ANY );
59  mainSizer->Add( m_treebook, 1, wxEXPAND|wxLEFT|wxTOP, 10 );
60 
61  auto line = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
62  wxLI_HORIZONTAL );
63  mainSizer->Add( line, 0, wxEXPAND|wxLEFT|wxTOP|wxRIGHT, 10 );
64 
65  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
66 
67  if( aUseReset )
68  {
69  m_resetButton = new wxButton( this, wxID_ANY, _( "Reset to Defaults" ) );
70  buttonsSizer->Add( m_resetButton, 0, wxRIGHT|wxLEFT, 5 );
71  }
72 
73  if( !aAuxiliaryAction.IsEmpty() )
74  {
75  m_auxiliaryButton = new wxButton( this, wxID_ANY, aAuxiliaryAction );
76  buttonsSizer->Add( m_auxiliaryButton, 0, wxRIGHT|wxLEFT, 5 );
77  }
78 
79  buttonsSizer->AddStretchSpacer();
80 
81  auto sdbSizer = new wxStdDialogButtonSizer();
82  wxButton* sdbSizerOK = new wxButton( this, wxID_OK );
83  sdbSizer->AddButton( sdbSizerOK );
84  wxButton* sdbSizerCancel = new wxButton( this, wxID_CANCEL );
85  sdbSizer->AddButton( sdbSizerCancel );
86  sdbSizer->Realize();
87 
88  buttonsSizer->Add( sdbSizer, 1, 0, 5 );
89  mainSizer->Add( buttonsSizer, 0, wxALL|wxEXPAND, 5 );
90 
91  sdbSizerOK->SetDefault();
92 
93  // We normally save the dialog size and position based on its class-name. This class
94  // substitutes the title so that each distinctly-titled dialog can have its own saved
95  // size and position.
96  m_hash_key = aTitle;
97 
98  if( m_auxiliaryButton )
99  m_auxiliaryButton->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
100  wxCommandEventHandler( PAGED_DIALOG::OnAuxiliaryAction ),
101  nullptr, this );
102 
103  if( m_resetButton )
104  m_resetButton->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
105  wxCommandEventHandler( PAGED_DIALOG::OnResetButton ),
106  nullptr, this );
107 
108  m_treebook->Connect( wxEVT_TREEBOOK_PAGE_CHANGED,
109  wxBookCtrlEventHandler( PAGED_DIALOG::OnPageChange ), NULL, this );
110  Connect( wxEVT_UPDATE_UI, wxUpdateUIEventHandler( PAGED_DIALOG::OnUpdateUI ), nullptr, this );
111 }
std::string m_hash_key
Definition: dialog_shim.h:191
void OnPageChange(wxBookCtrlEvent &event)
wxWindow * m_errorCtrl
Definition: paged_dialog.h:39
DIALOG_SHIM(wxWindow *aParent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxRESIZE_BORDER, const wxString &name=wxDialogNameStr)
Definition: dialog_shim.cpp:76
wxButton * m_auxiliaryButton
Definition: paged_dialog.h:76
#define NULL
void OnUpdateUI(wxUpdateUIEvent &event)
WX_INFOBAR * m_infoBar
Definition: paged_dialog.h:79
wxTreebook * m_treebook
Definition: paged_dialog.h:75
wxButton * m_cancelButton
Definition: paged_dialog.h:78
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:70
virtual void OnAuxiliaryAction(wxCommandEvent &event)
Definition: paged_dialog.h:70
#define _(s)
Definition: 3d_actions.cpp:33
wxButton * m_resetButton
Definition: paged_dialog.h:77
void OnResetButton(wxCommandEvent &aEvent)
wxString m_title
Definition: paged_dialog.h:34

References _, m_auxiliaryButton, DIALOG_SHIM::m_hash_key, m_infoBar, m_resetButton, m_treebook, NULL, OnAuxiliaryAction(), OnPageChange(), OnResetButton(), and OnUpdateUI().

◆ ~PAGED_DIALOG()

PAGED_DIALOG::~PAGED_DIALOG ( )
override

Definition at line 144 of file paged_dialog.cpp.

145 {
146  // Store the current parentPageTitle/pageTitle hierarchy so we can re-select it
147  // next time.
148  wxString lastPage = wxEmptyString;
149  wxString lastParentPage = wxEmptyString;
150 
151  int selected = m_treebook->GetSelection();
152 
153  if( selected != wxNOT_FOUND )
154  {
155  lastPage = m_treebook->GetPageText( (unsigned) selected );
156 
157  int parent = m_treebook->GetPageParent( (unsigned) selected );
158 
159  if( parent != wxNOT_FOUND )
160  lastParentPage = m_treebook->GetPageText( (unsigned) parent );
161  }
162 
163  g_lastPage[ m_title ] = lastPage;
164  g_lastParentPage[ m_title ] = lastParentPage;
165 
166  if( m_auxiliaryButton )
167  m_auxiliaryButton->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED,
168  wxCommandEventHandler( PAGED_DIALOG::OnAuxiliaryAction ),
169  nullptr, this );
170 
171  if( m_resetButton )
172  m_resetButton->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED,
173  wxCommandEventHandler( PAGED_DIALOG::OnResetButton ),
174  nullptr, this );
175 
176  m_treebook->Disconnect( wxEVT_TREEBOOK_PAGE_CHANGED,
177  wxBookCtrlEventHandler( PAGED_DIALOG::OnPageChange ), NULL, this );
178  Disconnect( wxEVT_UPDATE_UI, wxUpdateUIEventHandler( PAGED_DIALOG::OnUpdateUI ),
179  nullptr, this );
180 }
std::map< wxString, wxString > g_lastPage
std::map< wxString, wxString > g_lastParentPage
void OnPageChange(wxBookCtrlEvent &event)
wxButton * m_auxiliaryButton
Definition: paged_dialog.h:76
#define NULL
void OnUpdateUI(wxUpdateUIEvent &event)
wxTreebook * m_treebook
Definition: paged_dialog.h:75
virtual void OnAuxiliaryAction(wxCommandEvent &event)
Definition: paged_dialog.h:70
wxButton * m_resetButton
Definition: paged_dialog.h:77
void OnResetButton(wxCommandEvent &aEvent)
wxString m_title
Definition: paged_dialog.h:34

References g_lastPage, g_lastParentPage, m_auxiliaryButton, m_resetButton, m_title, m_treebook, NULL, OnAuxiliaryAction(), OnPageChange(), OnResetButton(), and OnUpdateUI().

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 269 of file dialog_shim.cpp.

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 406 of file dialog_shim.cpp.

407 {
408  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
409  // handle validation in the same way as other dialogs.
410  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
411  return;
412 
413  SetReturnCode( retCode );
414 
415  if( !IsQuasiModal() )
416  {
417  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
418  "wasn't called" );
419  return;
420  }
421 
422  if( m_qmodal_loop )
423  {
424  if( m_qmodal_loop->IsRunning() )
425  m_qmodal_loop->Exit( 0 );
426  else
427  m_qmodal_loop->ScheduleExit( 0 );
428 
430  }
431 
434 
435  Show( false );
436 }
bool IsQuasiModal() const
Definition: dialog_shim.h:123
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:199
#define NULL
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:202

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

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

◆ finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )
protectedinherited

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

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 147 of file dialog_shim.cpp.

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

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ finishInitialization()

void PAGED_DIALOG::finishInitialization ( )
protected

Definition at line 115 of file paged_dialog.cpp.

116 {
117  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
118  m_macHack.push_back( true );
119 
120  // For some reason adding page labels to the treeCtrl doesn't invalidate its bestSize
121  // cache so we have to do it by hand
122  m_treebook->GetTreeCtrl()->InvalidateBestSize();
123 
124  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
125  {
126  m_treebook->ExpandNode( i );
127  m_treebook->GetPage( i )->Layout();
128  }
129 
130  m_treebook->Fit();
131  m_treebook->Layout();
132 
134 }
std::vector< bool > m_macHack
Definition: paged_dialog.h:43
wxTreebook * m_treebook
Definition: paged_dialog.h:75
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...

References DIALOG_SHIM::finishDialogSettings(), m_macHack, and m_treebook.

Referenced by TransferDataToWindow().

◆ GetTreebook()

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 165 of file dialog_shim.cpp.

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

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

◆ IsCtrl()

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

Definition at line 136 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

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

◆ OnAuxiliaryAction()

virtual void PAGED_DIALOG::OnAuxiliaryAction ( wxCommandEvent &  event)
inlineprotectedvirtual

Reimplemented in DIALOG_BOARD_SETUP, and DIALOG_SCHEMATIC_SETUP.

Definition at line 70 of file paged_dialog.h.

70 { event.Skip(); }

Referenced by PAGED_DIALOG(), and ~PAGED_DIALOG().

◆ OnCancel()

void PAGED_DIALOG::OnCancel ( wxCommandEvent &  event)
protected

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_COMPONENT, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 497 of file dialog_shim.cpp.

498 {
499  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
500  {
501  if( m_parentFrame )
502  {
504  return;
505  }
506  }
507  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
508  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
509  {
510  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
511  return;
512  }
513  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
514  {
515  wxWindow* currentWindow = wxWindow::FindFocus();
516  int currentIdx = -1;
517  int delta = aEvt.ShiftDown() ? -1 : 1;
518 
519  auto advance = [&]( int& idx )
520  {
521  // Wrap-around modulus
522  int size = m_tabOrder.size();
523  idx = ( ( idx + delta ) % size + size ) % size;
524  };
525 
526  for( size_t i = 0; i < m_tabOrder.size(); ++i )
527  {
528  if( m_tabOrder[i] == currentWindow )
529  {
530  currentIdx = (int) i;
531  break;
532  }
533  }
534 
535  if( currentIdx >= 0 )
536  {
537  advance( currentIdx );
538 
539  //todo: We don't currently have non-textentry dialog boxes but this will break if
540  // we add them.
541 #ifdef __APPLE__
542  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
543  advance( currentIdx );
544 #endif
545 
546  m_tabOrder[ currentIdx ]->SetFocus();
547  return;
548  }
549  }
550 
551  aEvt.Skip();
552 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:206
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:204
virtual void ToggleUserUnits()

References DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

◆ OnClose()

void PAGED_DIALOG::OnClose ( wxCloseEvent &  event)
protected

◆ OnPageChange()

void PAGED_DIALOG::OnPageChange ( wxBookCtrlEvent &  event)
protected

Definition at line 341 of file paged_dialog.cpp.

342 {
343  size_t page = event.GetSelection();
344 
345  // Enable the reset button only if the page is resettable
346  if( m_resetButton )
347  {
348  if( auto panel = dynamic_cast<RESETTABLE_PANEL*>( m_treebook->GetPage( page ) ) )
349  {
350  m_resetButton->SetToolTip( panel->GetResetTooltip() );
351  m_resetButton->Enable( true );
352  }
353  else
354  {
355  m_resetButton->SetToolTip( wxString() );
356  m_resetButton->Enable( false );
357  }
358 
359  }
360 
361  // Work around an OSX bug where the wxGrid children don't get placed correctly until
362  // the first resize event
363 #ifdef __WXMAC__
364  if( page + 1 <= m_macHack.size() && m_macHack[ page ] )
365  {
366  wxSize pageSize = m_treebook->GetPage( page )->GetSize();
367  pageSize.x -= 5;
368  pageSize.y += 2;
369 
370  m_treebook->GetPage( page )->SetSize( pageSize );
371  m_macHack[ page ] = false;
372  }
373 #endif
374 
375  Layout();
376 }
std::vector< bool > m_macHack
Definition: paged_dialog.h:43
wxTreebook * m_treebook
Definition: paged_dialog.h:75
wxButton * m_resetButton
Definition: paged_dialog.h:77

References m_macHack, m_resetButton, and m_treebook.

Referenced by PAGED_DIALOG(), and ~PAGED_DIALOG().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 313 of file dialog_shim.cpp.

314 {
315  if( m_firstPaintEvent )
316  {
318 
319  selectAllInTextCtrls( GetChildren() );
320 
322  m_initialFocusTarget->SetFocus();
323  else
324  SetFocus(); // Focus the dialog itself
325 
326  m_firstPaintEvent = false;
327  }
328 
329  event.Skip();
330 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:197
bool m_firstPaintEvent
Definition: dialog_shim.h:196
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:56
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnResetButton()

void PAGED_DIALOG::OnResetButton ( wxCommandEvent &  aEvent)
protected

Definition at line 379 of file paged_dialog.cpp.

380 {
381  int sel = m_treebook->GetSelection();
382 
383  if( sel == wxNOT_FOUND )
384  return;
385 
386  RESETTABLE_PANEL* panel = dynamic_cast<RESETTABLE_PANEL*>( m_treebook->GetPage( sel ) );
387 
388  if( panel )
389  panel->ResetPanel();
390 }
wxTreebook * m_treebook
Definition: paged_dialog.h:75
virtual void ResetPanel()=0
Reset the contents of this panel.
A wxPanel that is designed to be reset in a standard manor.

References m_treebook, and RESETTABLE_PANEL::ResetPanel().

Referenced by PAGED_DIALOG(), and ~PAGED_DIALOG().

◆ OnUpdateUI()

void PAGED_DIALOG::OnUpdateUI ( wxUpdateUIEvent &  event)
protected

Definition at line 285 of file paged_dialog.cpp.

286 {
287  // Handle an error. This is delayed to OnUpdateUI so that we can change the focus
288  // even when the original validation was triggered from a killFocus event, and so
289  // that the corresponding notebook page can be shown in the background when triggered
290  // from an OK.
291  if( m_errorCtrl )
292  {
293  // We will re-enter this routine when the error dialog is displayed, so make
294  // sure we don't keep putting up more dialogs.
295  wxWindow* ctrl = m_errorCtrl;
296  m_errorCtrl = nullptr;
297 
299 
300  if( wxTextCtrl* textCtrl = dynamic_cast<wxTextCtrl*>( ctrl ) )
301  {
302  textCtrl->SetSelection( -1, -1 );
303  textCtrl->SetFocus();
304  return;
305  }
306 
307  if( wxStyledTextCtrl* scintilla = dynamic_cast<wxStyledTextCtrl*>( ctrl ) )
308  {
309  if( m_errorRow > 0 )
310  {
311  int pos = scintilla->PositionFromLine( m_errorRow - 1 ) + ( m_errorCol - 1 );
312  scintilla->GotoPos( pos );
313  }
314 
315  scintilla->SetFocus();
316  return;
317  }
318 
319  if( wxGrid* grid = dynamic_cast<wxGrid*>( ctrl ) )
320  {
321  grid->SetFocus();
322  grid->MakeCellVisible( m_errorRow, m_errorCol );
323  grid->SetGridCursor( m_errorRow, m_errorCol );
324 
325  grid->EnableCellEditControl( true );
326  grid->ShowCellEditControl();
327  return;
328  }
329  }
330 
331  if( m_treebook->GetCurrentPage()->GetChildren().IsEmpty() )
332  {
333  unsigned next = m_treebook->GetSelection() + 1;
334 
335  if( next < m_treebook->GetPageCount() )
336  m_treebook->SetSelection( next );
337  }
338 }
CITER next(CITER it)
Definition: ptree.cpp:126
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:253
wxWindow * m_errorCtrl
Definition: paged_dialog.h:39
wxTreebook * m_treebook
Definition: paged_dialog.h:75
wxString m_errorMessage
Definition: paged_dialog.h:38

References DisplayErrorMessage(), m_errorCol, m_errorCtrl, m_errorMessage, m_errorRow, m_treebook, and next().

Referenced by PAGED_DIALOG(), and ~PAGED_DIALOG().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

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

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

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

◆ resetSize()

void DIALOG_SHIM::resetSize ( )
protectedinherited

Clear the existing dialog size and position.

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

Definition at line 244 of file dialog_shim.cpp.

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

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

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ SetError() [1/2]

void PAGED_DIALOG::SetError ( const wxString &  aMessage,
const wxString &  aPageName,
int  aCtrlId,
int  aRow = -1,
int  aCol = -1 
)

Definition at line 257 of file paged_dialog.cpp.

259 {
260  SetError( aMessage, FindWindow( aPageName ), FindWindow( aCtrlId ), aRow, aCol );
261 }
void SetError(const wxString &aMessage, const wxString &aPageName, int aCtrlId, int aRow=-1, int aCol=-1)

Referenced by PANEL_SETUP_LAYERS::testLayerNames(), PANEL_SETUP_TEXT_AND_GRAPHICS::validateData(), PANEL_FP_EDITOR_DEFAULTS::validateData(), PANEL_SETUP_TRACKS_AND_VIAS::validateData(), and PANEL_SETUP_NETCLASSES::validateNetclassName().

◆ SetError() [2/2]

void PAGED_DIALOG::SetError ( const wxString &  aMessage,
wxWindow *  aPage,
wxWindow *  aCtrl,
int  aRow = -1,
int  aCol = -1 
)

Definition at line 264 of file paged_dialog.cpp.

266 {
267  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
268  {
269  if( m_treebook->GetPage( i ) == aPage )
270  {
271  m_treebook->SetSelection( i );
272  break;
273  }
274  }
275 
276  // Once the page has been changed we want to wait for it to update before displaying
277  // the error dialog. So store the rest of the error info and wait for OnUpdateUI.
278  m_errorMessage = aMessage;
279  m_errorCtrl = aCtrl;
280  m_errorRow = aRow;
281  m_errorCol = aCol;
282 }
wxWindow * m_errorCtrl
Definition: paged_dialog.h:39
wxTreebook * m_treebook
Definition: paged_dialog.h:75
wxString m_errorMessage
Definition: paged_dialog.h:38

References m_errorCol, m_errorCtrl, m_errorMessage, m_errorRow, and m_treebook.

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

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

Definition at line 114 of file dialog_shim.h.

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

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_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetInitialPage()

void PAGED_DIALOG::SetInitialPage ( const wxString &  aPage,
const wxString &  aParentPage = wxEmptyString 
)

Definition at line 137 of file paged_dialog.cpp.

138 {
139  g_lastPage[ m_title ] = aPage;
140  g_lastParentPage[ m_title ] = aParentPage;
141 }
std::map< wxString, wxString > g_lastPage
std::map< wxString, wxString > g_lastParentPage
wxString m_title
Definition: paged_dialog.h:34

References g_lastPage, g_lastParentPage, and m_title.

Referenced by PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetModified()

void PAGED_DIALOG::SetModified ( )
inline

Definition at line 54 of file paged_dialog.h.

54 { m_modified = true; }

Referenced by PANEL_SETUP_RULES::onScintillaCharAdded().

◆ setSizeInDU()

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

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

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

Definition at line 158 of file dialog_shim.cpp.

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

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 185 of file dialog_shim.cpp.

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

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

Referenced by FOOTPRINT_EDITOR_TOOLS::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EE_INSPECTION_TOOL::RunERC(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 356 of file dialog_shim.cpp.

357 {
358  // This is an exception safe way to zero a pointer before returning.
359  // Yes, even though DismissModal() clears this first normally, this is
360  // here in case there's an exception before the dialog is dismissed.
361  struct NULLER
362  {
363  void*& m_what;
364  NULLER( void*& aPtr ) : m_what( aPtr ) {}
365  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
366  } clear_this( (void*&) m_qmodal_loop );
367 
368  // release the mouse if it's currently captured as the window having it
369  // will be disabled when this dialog is shown -- but will still keep the
370  // capture making it impossible to do anything in the modal dialog itself
371  wxWindow* win = wxWindow::GetCapture();
372  if( win )
373  win->ReleaseMouse();
374 
375  // Get the optimal parent
376  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
377 
378  wxASSERT_MSG( !m_qmodal_parent_disabler,
379  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
380 
381  // quasi-modal: disable only my "optimal" parent
383 
384  // Apple in its infinite wisdom will raise a disabled window before even passing
385  // us the event, so we have no way to stop it. Instead, we must set an order on
386  // the windows so that the quasi-modal will be pushed in front of the disabled
387  // window when it is raised.
389 
390  Show( true );
391 
392  m_qmodal_showing = true;
393 
394  WX_EVENT_LOOP event_loop;
395 
396  m_qmodal_loop = &event_loop;
397 
398  event_loop.Run();
399 
400  m_qmodal_showing = false;
401 
402  return GetReturnCode();
403 }
bool m_qmodal_showing
Definition: dialog_shim.h:201
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:199
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:202
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:43
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:50

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), SCH_DRAWING_TOOLS::createNewText(), LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ TransferDataFromWindow()

bool PAGED_DIALOG::TransferDataFromWindow ( )
overrideprotected

Definition at line 234 of file paged_dialog.cpp.

235 {
236  // Call TransferDataFromWindow() only once:
237  // this is enough on wxWidgets 3.1
238  if( !DIALOG_SHIM::TransferDataFromWindow() )
239  return false;
240 
241  // On wxWidgets 3.0, TransferDataFromWindow() is not called recursively
242  // so we have to call it for each page
243 #if !wxCHECK_VERSION( 3, 1, 0 )
244  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
245  {
246  wxWindow* page = m_treebook->GetPage( i );
247 
248  if( !page->TransferDataFromWindow() )
249  return false;
250  }
251 #endif
252 
253  return true;
254 }
wxTreebook * m_treebook
Definition: paged_dialog.h:75

References m_treebook.

◆ TransferDataToWindow()

bool PAGED_DIALOG::TransferDataToWindow ( )
overrideprotected

Definition at line 183 of file paged_dialog.cpp.

184 {
186 
187  // Call TransferDataToWindow() only once:
188  // this is enough on wxWidgets 3.1
189  if( !DIALOG_SHIM::TransferDataToWindow() )
190  return false;
191 
192  // On wxWidgets 3.0, TransferDataFromWindow() is not called recursively
193  // so we have to call it for each page
194 #if !wxCHECK_VERSION( 3, 1, 0 )
195  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
196  {
197  wxWindow* page = m_treebook->GetPage( i );
198 
199  if( !page->TransferDataToWindow() )
200  return false;
201  }
202 #endif
203 
204  // Search for a page matching the lastParentPageTitle/lastPageTitle hierarchy
205  wxString lastPage = g_lastPage[ m_title ];
206  wxString lastParentPage = g_lastParentPage[ m_title ];
207  int lastPageIndex = wxNOT_FOUND;
208 
209  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
210  {
211  if( m_treebook->GetPageText( i ) == lastPage )
212  {
213  if( lastParentPage.IsEmpty() )
214  {
215  lastPageIndex = i;
216  break;
217  }
218 
219  if( m_treebook->GetPageParent( i ) >= 0
220  && m_treebook->GetPageText( (unsigned) m_treebook->GetPageParent( i ) ) == lastParentPage )
221  {
222  lastPageIndex = i;
223  break;
224  }
225  }
226  }
227 
228  m_treebook->SetSelection( (unsigned) std::max( 0, lastPageIndex ) );
229 
230  return true;
231 }
std::map< wxString, wxString > g_lastPage
std::map< wxString, wxString > g_lastParentPage
wxTreebook * m_treebook
Definition: paged_dialog.h:75
void finishInitialization()
wxString m_title
Definition: paged_dialog.h:34

References finishInitialization(), g_lastPage, g_lastParentPage, m_title, and m_treebook.

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 172 of file dialog_shim.cpp.

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

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

Member Data Documentation

◆ m_auxiliaryButton

wxButton* PAGED_DIALOG::m_auxiliaryButton
protected

Definition at line 76 of file paged_dialog.h.

Referenced by PAGED_DIALOG(), and ~PAGED_DIALOG().

◆ m_cancelButton

wxButton* PAGED_DIALOG::m_cancelButton
protected

Definition at line 78 of file paged_dialog.h.

◆ m_dirty

bool PAGED_DIALOG::m_dirty
private

Definition at line 36 of file paged_dialog.h.

◆ m_errorCol

int PAGED_DIALOG::m_errorCol
private

Definition at line 41 of file paged_dialog.h.

Referenced by OnUpdateUI(), and SetError().

◆ m_errorCtrl

wxWindow* PAGED_DIALOG::m_errorCtrl
private

Definition at line 39 of file paged_dialog.h.

Referenced by OnUpdateUI(), and SetError().

◆ m_errorMessage

wxString PAGED_DIALOG::m_errorMessage
private

Definition at line 38 of file paged_dialog.h.

Referenced by OnUpdateUI(), and SetError().

◆ m_errorRow

int PAGED_DIALOG::m_errorRow
private

Definition at line 40 of file paged_dialog.h.

Referenced by OnUpdateUI(), and SetError().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 196 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_infoBar

WX_INFOBAR* PAGED_DIALOG::m_infoBar
protected

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 197 of file dialog_shim.h.

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

◆ m_macHack

std::vector<bool> PAGED_DIALOG::m_macHack
private

Definition at line 43 of file paged_dialog.h.

Referenced by finishInitialization(), and OnPageChange().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 204 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_resetButton

wxButton* PAGED_DIALOG::m_resetButton
protected

◆ m_tabOrder

◆ m_title

wxString PAGED_DIALOG::m_title
private

Definition at line 34 of file paged_dialog.h.

Referenced by SetInitialPage(), TransferDataToWindow(), and ~PAGED_DIALOG().

◆ m_treebook

◆ m_units


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