KiCad PCB EDA Suite
DIALOG_SHEET_PROPERTIES Class Reference

#include <dialog_sheet_properties.h>

Inheritance diagram for DIALOG_SHEET_PROPERTIES:
DIALOG_SHEET_PROPERTIES_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_SHEET_PROPERTIES (SCH_EDIT_FRAME *aParent, SCH_SHEET *aSheet, bool *aClearAnnotationNewItems)
 
 ~DIALOG_SHEET_PROPERTIES () override
 
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)
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. 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 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...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

wxBoxSizer * m_longForm
 
WX_GRIDm_grid
 
wxBitmapButton * m_bpAdd
 
wxBitmapButton * m_bpMoveUp
 
wxBitmapButton * m_bpMoveDown
 
wxBitmapButton * m_bpDelete
 
wxStaticText * m_borderWidthLabel
 
wxTextCtrl * m_borderWidthCtrl
 
wxStaticText * m_borderWidthUnits
 
wxStaticText * m_borderColorLabel
 
COLOR_SWATCHm_borderSwatch
 
wxStaticText * m_backgroundColorLabel
 
COLOR_SWATCHm_backgroundSwatch
 
wxStaticText * m_pageNumberStaticText
 
wxTextCtrl * m_pageNumberTextCtrl
 
wxStaticLine * m_staticline1
 
wxStaticText * m_hierarchicalPathLabel
 
wxStdDialogButtonSizer * m_stdDialogButtonSizer
 
wxButton * m_stdDialogButtonSizerOK
 
wxButton * m_stdDialogButtonSizerCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
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 Member Functions

bool onSheetFilenameChanged (const wxString &aNewFilename)
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
bool Validate () override
 
void OnAddField (wxCommandEvent &event) override
 
void OnDeleteField (wxCommandEvent &event) override
 
void OnMoveUp (wxCommandEvent &event) override
 
void OnMoveDown (wxCommandEvent &event) override
 
void OnSizeGrid (wxSizeEvent &event) override
 
void OnGridCellChanging (wxGridEvent &event)
 
void OnUpdateUI (wxUpdateUIEvent &event) override
 
void OnInitDlg (wxInitDialogEvent &event) override
 
void AdjustGridColumns (int aWidth)
 

Private Attributes

SCH_EDIT_FRAMEm_frame
 
SCH_SHEETm_sheet
 
bool * m_clearAnnotationNewItems
 
int m_width
 
int m_delayedFocusRow
 
int m_delayedFocusColumn
 
wxString m_shownColumns
 
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields
 
UNIT_BINDER m_borderWidth
 
SCH_SHEET m_dummySheet
 
SCH_FIELD m_dummySheetNameField
 

Detailed Description

Definition at line 37 of file dialog_sheet_properties.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_SHEET_PROPERTIES()

DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES ( SCH_EDIT_FRAME aParent,
SCH_SHEET aSheet,
bool *  aClearAnnotationNewItems 
)

Definition at line 42 of file dialog_sheet_properties.cpp.

43  :
45  m_frame( aParent ),
46  m_clearAnnotationNewItems( aClearAnnotationNewItems ),
48  m_dummySheet( *aSheet ),
49  m_dummySheetNameField( wxDefaultPosition, SHEETNAME, &m_dummySheet )
50 {
51  m_sheet = aSheet;
52  m_fields = new FIELDS_GRID_TABLE<SCH_FIELD>( this, aParent, m_grid, m_sheet );
53  m_width = 100; // Will be later set to a better value
56 
57  // Give a bit more room for combobox editors
58  m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
59 
61  m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this ) );
62 
63  // Show/hide columns according to user's preference
64  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
65  wxASSERT( cfg );
66 
67  if( cfg )
68  {
69  m_shownColumns = cfg->m_Appearance.edit_sheet_visible_columns;
71  }
72 
73  wxToolTip::Enable( true );
74  m_stdDialogButtonSizerOK->SetDefault();
75 
76  // Configure button logos
77  m_bpAdd->SetBitmap( KiBitmap( BITMAPS::small_plus ) );
78  m_bpDelete->SetBitmap( KiBitmap( BITMAPS::small_trash ) );
79  m_bpMoveUp->SetBitmap( KiBitmap( BITMAPS::small_up ) );
80  m_bpMoveDown->SetBitmap( KiBitmap( BITMAPS::small_down ) );
81 
82  // Set font sizes
83  wxFont infoFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
84  infoFont.SetSymbolicSize( wxFONTSIZE_SMALL );
85  m_hierarchicalPathLabel->SetFont( infoFont );
86 
87  // wxFormBuilder doesn't include this event...
88  m_grid->Connect( wxEVT_GRID_CELL_CHANGING,
89  wxGridEventHandler( DIALOG_SHEET_PROPERTIES::OnGridCellChanging ),
90  NULL, this );
91 
93 }
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:129
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:65
DIALOG_SHEET_PROPERTIES_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Sheet Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxCAPTION|wxCLOSE_BOX|wxDEFAULT_DIALOG_STYLE|wxMAXIMIZE_BOX|wxMINIMIZE_BOX|wxRESIZE_BORDER|wxSYSTEM_MENU)
#define NULL
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void OnGridCellChanging(wxGridEvent &event)
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields
wxBitmap KiBitmap(BITMAPS aBitmap)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104

References FDC_VALUE, DIALOG_SHIM::finishDialogSettings(), KiBitmap(), Kiface(), DIALOG_SHEET_PROPERTIES_BASE::m_bpAdd, DIALOG_SHEET_PROPERTIES_BASE::m_bpDelete, DIALOG_SHEET_PROPERTIES_BASE::m_bpMoveDown, DIALOG_SHEET_PROPERTIES_BASE::m_bpMoveUp, m_delayedFocusColumn, m_delayedFocusRow, m_fields, DIALOG_SHEET_PROPERTIES_BASE::m_grid, DIALOG_SHEET_PROPERTIES_BASE::m_hierarchicalPathLabel, m_sheet, m_shownColumns, DIALOG_SHEET_PROPERTIES_BASE::m_stdDialogButtonSizerOK, m_width, NULL, OnGridCellChanging(), WX_GRID::SetTable(), SHEETNAME, WX_GRID::ShowHideColumns(), small_down, small_plus, small_trash, and small_up.

◆ ~DIALOG_SHEET_PROPERTIES()

DIALOG_SHEET_PROPERTIES::~DIALOG_SHEET_PROPERTIES ( )
override

Definition at line 96 of file dialog_sheet_properties.cpp.

97 {
98  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
99  wxASSERT( cfg );
100 
101  if( cfg )
102  cfg->m_Appearance.edit_sheet_visible_columns = m_grid->GetShownColumns();
103 
104  // Prevents crash bug in wxGrid's d'tor
106 
107  m_grid->Disconnect( wxEVT_GRID_CELL_CHANGING,
108  wxGridEventHandler( DIALOG_SHEET_PROPERTIES::OnGridCellChanging ),
109  NULL, this );
110 
111  // Delete the GRID_TRICKS.
112  m_grid->PopEventHandler( true );
113 }
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:97
#define NULL
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void OnGridCellChanging(wxGridEvent &event)
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:110
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields

References WX_GRID::DestroyTable(), WX_GRID::GetShownColumns(), Kiface(), m_fields, DIALOG_SHEET_PROPERTIES_BASE::m_grid, NULL, and OnGridCellChanging().

Member Function Documentation

◆ AdjustGridColumns()

void DIALOG_SHEET_PROPERTIES::AdjustGridColumns ( int  aWidth)
private

Definition at line 729 of file dialog_sheet_properties.cpp.

730 {
731  m_width = aWidth;
732  // Account for scroll bars
733  aWidth -= ( m_grid->GetSize().x - m_grid->GetClientSize().x );
734 
735  m_grid->AutoSizeColumn( 0 );
736 
737  int fixedColsWidth = m_grid->GetColSize( 0 );
738 
739  for( int i = 2; i < m_grid->GetNumberCols(); i++ )
740  fixedColsWidth += m_grid->GetColSize( i );
741 
742  m_grid->SetColSize( 1, aWidth - fixedColsWidth );
743 }

References DIALOG_SHEET_PROPERTIES_BASE::m_grid, and m_width.

Referenced by OnSizeGrid(), OnUpdateUI(), and TransferDataToWindow().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 307 of file dialog_shim.cpp.

308 {
309  // so we can do logging of this state change:
310  return wxDialog::Enable( enable );
311 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 445 of file dialog_shim.cpp.

446 {
447  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
448  // handle validation in the same way as other dialogs.
449  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
450  return;
451 
452  SetReturnCode( retCode );
453 
454  if( !IsQuasiModal() )
455  {
456  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
457  "wasn't called" );
458  return;
459  }
460 
461  if( m_qmodal_loop )
462  {
463  if( m_qmodal_loop->IsRunning() )
464  m_qmodal_loop->Exit( 0 );
465  else
466  m_qmodal_loop->ScheduleExit( 0 );
467 
469  }
470 
473 
474  Show( false );
475 }
bool IsQuasiModal() const
Definition: dialog_shim.h:107
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
#define NULL
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215

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_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_SYMBOL::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_SYMBOL::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 148 of file dialog_shim.cpp.

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

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_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_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_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), 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_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(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

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

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

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

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

◆ IsCtrl()

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

Definition at line 125 of file dialog_shim.h.

126  {
127  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
128  !e.ShiftDown() && !e.MetaDown();
129  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 131 of file dialog_shim.h.

132  {
133  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
134  e.ShiftDown() && !e.MetaDown();
135  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return 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:78

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::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(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), 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_SYMBOL::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(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), 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(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAddField()

void DIALOG_SHEET_PROPERTIES::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SHEET_PROPERTIES_BASE.

Definition at line 631 of file dialog_sheet_properties.cpp.

632 {
633  if( !m_grid->CommitPendingChanges() )
634  return;
635 
636  int fieldID = m_fields->size();
637  SCH_FIELD newField( wxPoint( 0, 0 ), fieldID, m_sheet,
638  SCH_SHEET::GetDefaultFieldName( fieldID ) );
639 
640  newField.SetTextAngle( m_fields->at( SHEETNAME ).GetTextAngle() );
641 
642  m_fields->push_back( newField );
643 
644  // notify the grid
645  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
646  m_grid->ProcessTableMessage( msg );
647 
648  m_grid->MakeCellVisible( m_fields->size() - 1, 0 );
649  m_grid->SetGridCursor( m_fields->size() - 1, 0 );
650 
651  m_grid->EnableCellEditControl();
652  m_grid->ShowCellEditControl();
653 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
static const wxString GetDefaultFieldName(int aFieldNdx)
Definition: sch_sheet.cpp:46
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields

References WX_GRID::CommitPendingChanges(), SCH_SHEET::GetDefaultFieldName(), m_fields, DIALOG_SHEET_PROPERTIES_BASE::m_grid, m_sheet, EDA_TEXT::SetTextAngle(), and SHEETNAME.

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 536 of file dialog_shim.cpp.

537 {
538  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
539  {
540  if( m_parentFrame )
541  {
543  return;
544  }
545  }
546  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
547  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
548  {
549  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
550  return;
551  }
552  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
553  {
554  wxWindow* currentWindow = wxWindow::FindFocus();
555  int currentIdx = -1;
556  int delta = aEvt.ShiftDown() ? -1 : 1;
557 
558  auto advance = [&]( int& idx )
559  {
560  // Wrap-around modulus
561  int size = m_tabOrder.size();
562  idx = ( ( idx + delta ) % size + size ) % size;
563  };
564 
565  for( size_t i = 0; i < m_tabOrder.size(); ++i )
566  {
567  if( m_tabOrder[i] == currentWindow )
568  {
569  currentIdx = (int) i;
570  break;
571  }
572  }
573 
574  if( currentIdx >= 0 )
575  {
576  advance( currentIdx );
577 
578  //todo: We don't currently have non-textentry dialog boxes but this will break if
579  // we add them.
580 #ifdef __APPLE__
581  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
582  advance( currentIdx );
583 #endif
584 
585  m_tabOrder[ currentIdx ]->SetFocus();
586  return;
587  }
588  }
589 
590  aEvt.Skip();
591 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:219
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:217
virtual void ToggleUserUnits()

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

◆ OnDeleteField()

void DIALOG_SHEET_PROPERTIES::OnDeleteField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SHEET_PROPERTIES_BASE.

Definition at line 656 of file dialog_sheet_properties.cpp.

657 {
658  int curRow = m_grid->GetGridCursorRow();
659 
660  if( curRow < 0 )
661  return;
662  else if( curRow < SHEET_MANDATORY_FIELDS )
663  {
664  DisplayError( this, wxString::Format( _( "The first %d fields are mandatory." ),
666  return;
667  }
668 
669  m_grid->CommitPendingChanges( true /* quiet mode */ );
670 
671  m_fields->erase( m_fields->begin() + curRow );
672 
673  // notify the grid
674  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, curRow, 1 );
675  m_grid->ProcessTableMessage( msg );
676 
677  if( m_grid->GetNumberRows() > 0 )
678  {
679  m_grid->MakeCellVisible( std::max( 0, curRow-1 ), m_grid->GetGridCursorCol() );
680  m_grid->SetGridCursor( std::max( 0, curRow-1 ), m_grid->GetGridCursorCol() );
681  }
682 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields

References _, WX_GRID::CommitPendingChanges(), DisplayError(), Format(), m_fields, DIALOG_SHEET_PROPERTIES_BASE::m_grid, and SHEET_MANDATORY_FIELDS.

◆ OnGridCellChanging()

void DIALOG_SHEET_PROPERTIES::OnGridCellChanging ( wxGridEvent &  event)
private

Definition at line 591 of file dialog_sheet_properties.cpp.

592 {
593  bool success = true;
594  wxGridCellEditor* editor = m_grid->GetCellEditor( event.GetRow(), event.GetCol() );
595  wxControl* control = editor->GetControl();
596  wxTextEntry* textControl = dynamic_cast<wxTextEntry*>( control );
597 
598  // Short-circuit the validator's more generic "can't be empty" message for the
599  // two mandatory fields:
600  if( event.GetRow() == SHEETNAME && event.GetCol() == FDC_VALUE )
601  {
602  if( textControl && textControl->IsEmpty() )
603  {
604  wxMessageBox( _( "A sheet must have a name." ) );
605  success = false;
606  }
607  }
608  else if( event.GetRow() == SHEETFILENAME && event.GetCol() == FDC_VALUE && textControl )
609  {
610  if( textControl->IsEmpty() )
611  {
612  wxMessageBox( _( "A sheet must have a file specified." ) );
613  success = false;
614  }
615  }
616 
617  if( success && control && control->GetValidator() )
618  success = control->GetValidator()->Validate( control );
619 
620  if( !success )
621  {
622  event.Veto();
623  m_delayedFocusRow = event.GetRow();
624  m_delayedFocusColumn = event.GetCol();
625  }
626 
627  editor->DecRef();
628 }
#define _(s)
Definition: 3d_actions.cpp:33

References _, editor, FDC_VALUE, m_delayedFocusColumn, m_delayedFocusRow, DIALOG_SHEET_PROPERTIES_BASE::m_grid, SHEETFILENAME, and SHEETNAME.

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

◆ OnInitDlg()

void DIALOG_SHEET_PROPERTIES::OnInitDlg ( wxInitDialogEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SHEET_PROPERTIES_BASE.

Definition at line 816 of file dialog_sheet_properties.cpp.

817 {
819 
820  // Now all widgets have the size fixed, call FinishDialogSettings
822 }
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(), and TransferDataToWindow().

◆ OnMoveDown()

void DIALOG_SHEET_PROPERTIES::OnMoveDown ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SHEET_PROPERTIES_BASE.

Definition at line 707 of file dialog_sheet_properties.cpp.

708 {
709  if( !m_grid->CommitPendingChanges() )
710  return;
711 
712  int i = m_grid->GetGridCursorRow();
713 
714  if( i >= SHEET_MANDATORY_FIELDS && i < m_grid->GetNumberRows() - 1 )
715  {
716  SCH_FIELD tmp = m_fields->at( (unsigned) i );
717  m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
718  m_fields->insert( m_fields->begin() + i + 1, tmp );
719  m_grid->ForceRefresh();
720 
721  m_grid->SetGridCursor( i + 1, m_grid->GetGridCursorCol() );
722  m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
723  }
724  else
725  wxBell();
726 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields

References WX_GRID::CommitPendingChanges(), m_fields, DIALOG_SHEET_PROPERTIES_BASE::m_grid, and SHEET_MANDATORY_FIELDS.

◆ OnMoveUp()

void DIALOG_SHEET_PROPERTIES::OnMoveUp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SHEET_PROPERTIES_BASE.

Definition at line 685 of file dialog_sheet_properties.cpp.

686 {
687  if( !m_grid->CommitPendingChanges() )
688  return;
689 
690  int i = m_grid->GetGridCursorRow();
691 
692  if( i > SHEET_MANDATORY_FIELDS )
693  {
694  SCH_FIELD tmp = m_fields->at( (unsigned) i );
695  m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
696  m_fields->insert( m_fields->begin() + i - 1, tmp );
697  m_grid->ForceRefresh();
698 
699  m_grid->SetGridCursor( i - 1, m_grid->GetGridCursorCol() );
700  m_grid->MakeCellVisible( m_grid->GetGridCursorRow(), m_grid->GetGridCursorCol() );
701  }
702  else
703  wxBell();
704 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields

References WX_GRID::CommitPendingChanges(), m_fields, DIALOG_SHEET_PROPERTIES_BASE::m_grid, and SHEET_MANDATORY_FIELDS.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 352 of file dialog_shim.cpp.

353 {
354  if( m_firstPaintEvent )
355  {
357 
358  selectAllInTextCtrls( GetChildren() );
359 
362  else
363  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
364 
365  m_firstPaintEvent = false;
366  }
367 
368  event.Skip();
369 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210
bool m_firstPaintEvent
Definition: dialog_shim.h:209
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:68
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onSheetFilenameChanged()

bool DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged ( const wxString &  aNewFilename)
private

Definition at line 350 of file dialog_sheet_properties.cpp.

351 {
352  wxString msg;
353 
354  // Relative file names are relative to the path of the current sheet. This allows for
355  // nesting of schematic files in subfolders.
356  wxFileName fileName( aNewFilename );
357 
358  if( fileName.GetExt().IsEmpty() )
359  {
360  fileName.SetExt( KiCadSchematicFileExtension );
361  }
362  else if( fileName.GetExt().CmpNoCase( KiCadSchematicFileExtension ) != 0 )
363  {
364  msg.Printf( _( "The file \"%s\" does not appear to be a valid schematic file." ),
365  fileName.GetFullName() );
366  wxMessageDialog badSchFileDialog( this, msg, _( "Invalid Schematic File" ),
367  wxOK | wxCENTRE | wxICON_EXCLAMATION );
368  badSchFileDialog.ShowModal();
369  return false;
370  }
371 
372  if( !fileName.IsAbsolute() )
373  {
374  const SCH_SCREEN* currentScreen = m_frame->GetCurrentSheet().LastScreen();
375  wxCHECK_MSG( currentScreen, false, "Invalid sheet path object." );
376 
377  wxFileName currentSheetFileName = currentScreen->GetFileName();
378 
379  if( !fileName.Normalize( wxPATH_NORM_ALL, currentSheetFileName.GetPath() ) )
380  {
381  wxFAIL_MSG( "Cannot normalize new sheet schematic file path." );
382  return false;
383  }
384  }
385 
386  wxString newAbsoluteFilename = fileName.GetFullPath();
387 
388  // Inside Eeschema, filenames are stored using unix notation
389  newAbsoluteFilename.Replace( wxT( "\\" ), wxT( "/" ) );
390 
391  bool renameFile = false;
392  bool loadFromFile = false;
393  bool clearAnnotation = false;
394  bool restoreSheet = false;
395  bool isExistingSheet = false;
396  SCH_SCREEN* useScreen = NULL;
397 
398  // Search for a schematic file having the same filename already in use in the hierarchy
399  // or on disk, in order to reuse it.
400  if( !m_frame->Schematic().Root().SearchHierarchy( newAbsoluteFilename, &useScreen ) )
401  {
402  loadFromFile = wxFileExists( newAbsoluteFilename );
403 
404  wxLogTrace( tracePathsAndFiles, "Sheet requested file \"%s\", %s",
405  newAbsoluteFilename,
406  ( loadFromFile ) ? "found" : "not found" );
407  }
408 
409  if( m_sheet->GetScreen() == NULL ) // New just created sheet.
410  {
411  if( !m_frame->AllowCaseSensitiveFileNameClashes( newAbsoluteFilename ) )
412  return false;
413 
414  if( useScreen || loadFromFile ) // Load from existing file.
415  {
416  clearAnnotation = true;
417  wxString existsMsg;
418  wxString linkMsg;
419  existsMsg.Printf( _( "\"%s\" already exists." ), fileName.GetFullName() );
420  linkMsg.Printf( _( "Link \"%s\" to this file?" ), newAbsoluteFilename );
421  msg.Printf( wxT( "%s\n\n%s" ), existsMsg, linkMsg );
422 
423  if( !IsOK( this, msg ) )
424  return false;
425  }
426  else // New file.
427  {
428  m_frame->InitSheet( m_sheet, newAbsoluteFilename );
429  }
430  }
431  else // Existing sheet.
432  {
433  bool isUndoable = true;
434  wxString replaceMsg;
435  wxString newMsg;
436  wxString noUndoMsg;
437  isExistingSheet = true;
438 
439  if( !m_frame->AllowCaseSensitiveFileNameClashes( newAbsoluteFilename ) )
440  return false;
441 
442  // Changing the filename of a sheet can modify the full hierarchy structure
443  // and can be not always undoable.
444  // So prepare messages for user notifications:
445  replaceMsg.Printf( _( "Change \"%s\" link from \"%s\" to \"%s\"?" ),
446  newAbsoluteFilename,
447  m_sheet->GetFileName(),
448  fileName.GetFullName() );
449  newMsg.Printf( _( "Create new file \"%s\" with contents of \"%s\"?" ),
450  fileName.GetFullName(),
451  m_sheet->GetFileName() );
452  noUndoMsg = _( "This action cannot be undone." );
453 
454  // We are always using here a case insensitive comparison to avoid issues
455  // under Windows, although under Unix filenames are case sensitive.
456  // But many users create schematic under both Unix and Windows
457  // **
458  // N.B. 1: aSheet->GetFileName() will return a relative path
459  // aSheet->GetScreen()->GetFileName() returns a full path
460  //
461  // N.B. 2: newFilename uses the unix notation for separator.
462  // so we must use it also to compare the old and new filenames
463  wxString oldAbsoluteFilename = m_sheet->GetScreen()->GetFileName();
464  oldAbsoluteFilename.Replace( wxT( "\\" ), wxT( "/" ) );
465 
466  if( newAbsoluteFilename.Cmp( oldAbsoluteFilename ) != 0 )
467  {
468  // Sheet file name changes cannot be undone.
469  isUndoable = false;
470 
471  if( useScreen || loadFromFile ) // Load from existing file.
472  {
473  clearAnnotation = true;
474 
475  msg.Printf( wxT( "%s\n\n%s" ), replaceMsg, noUndoMsg );
476 
477  if( !IsOK( this, msg ) )
478  return false;
479 
480  if( loadFromFile )
481  m_sheet->SetScreen( NULL );
482  }
483  else // Save to new file name.
484  {
485  if( m_sheet->GetScreenCount() > 1 )
486  {
487  msg.Printf( wxT( "%s\n\n%s" ), newMsg, noUndoMsg );
488 
489  if( !IsOK( this, msg ) )
490  return false;
491  }
492 
493  renameFile = true;
494  }
495  }
496 
497  if( isUndoable )
499 
500  if( renameFile )
501  {
502  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
503 
504  // If the the associated screen is shared by more than one sheet, do not
505  // change the filename of the corresponding screen here.
506  // (a new screen will be created later)
507  // if it is not shared, update the filename
508  if( m_sheet->GetScreenCount() <= 1 )
509  m_sheet->GetScreen()->SetFileName( newAbsoluteFilename );
510 
511  try
512  {
513  pi->Save( newAbsoluteFilename, m_sheet, &m_frame->Schematic() );
514  }
515  catch( const IO_ERROR& ioe )
516  {
517  msg.Printf( _( "Error occurred saving schematic file \"%s\"." ),
518  newAbsoluteFilename );
519  DisplayErrorMessage( this, msg, ioe.What() );
520 
521  msg.Printf( _( "Failed to save schematic \"%s\"" ), newAbsoluteFilename );
522  m_frame->SetMsgPanel( wxEmptyString, msg );
523 
524  return false;
525  }
526 
527  // If the the associated screen is shared by more than one sheet, remove the
528  // screen and reload the file to a new screen. Failure to do this will trash
529  // the screen reference counting in complex hierarchies.
530  if( m_sheet->GetScreenCount() > 1 )
531  {
532  m_sheet->SetScreen( NULL );
533  loadFromFile = true;
534  }
535  }
536  }
537 
538  wxFileName nativeFileName( aNewFilename );
539  SCH_SHEET_PATH& currentSheet = m_frame->GetCurrentSheet();
540 
541  if( useScreen )
542  {
543  // Create a temporary sheet for recursion testing to prevent a possible recursion error.
544  std::unique_ptr< SCH_SHEET> tmpSheet = std::make_unique<SCH_SHEET>();
545  tmpSheet->GetFields()[SHEETNAME] = m_fields->at( SHEETNAME );
546  tmpSheet->GetFields()[SHEETFILENAME].SetText( nativeFileName.GetFullPath() );
547  tmpSheet->SetScreen( useScreen );
548 
549  // No need to check for valid library IDs if we are using an existing screen.
550  if( m_frame->CheckSheetForRecursion( tmpSheet.get(), &currentSheet ) )
551  {
552  if( restoreSheet )
553  currentSheet.LastScreen()->Append( m_sheet );
554 
555  return false;
556  }
557 
558  // It's safe to set the sheet screen now.
559  m_sheet->SetScreen( useScreen );
560  }
561  else if( loadFromFile )
562  {
563  if( isExistingSheet )
564  {
565  // Temporarily remove the sheet from the current schematic page so that recursion
566  // and symbol library link tests can be performed with the modified sheet settings.
567  restoreSheet = true;
568  currentSheet.LastScreen()->Remove( m_sheet );
569  }
570 
571  if( !m_frame->LoadSheetFromFile( m_sheet, &currentSheet, newAbsoluteFilename )
572  || m_frame->CheckSheetForRecursion( m_sheet, &currentSheet ) )
573  {
574  if( restoreSheet )
575  currentSheet.LastScreen()->Append( m_sheet );
576 
577  return false;
578  }
579 
580  if( restoreSheet )
581  currentSheet.LastScreen()->Append( m_sheet );
582  }
583 
585  *m_clearAnnotationNewItems = clearAnnotation;
586 
587  return true;
588 }
bool CheckSheetForRecursion(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy)
Verify that aSheet will not cause a recursion error in aHierarchy.
Definition: sheet.cpp:44
const wxString & GetFileName() const
Definition: sch_screen.h:133
bool Remove(SCH_ITEM *aItem)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:244
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:629
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
Definition: sch_sheet.cpp:156
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
void InitSheet(SCH_SHEET *aSheet, const wxString &aNewFilename)
Definition: sheet.cpp:93
SCH_SCREEN * GetScreen() const
Definition: sch_sheet.h:103
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
int GetScreenCount() const
Return the number of times the associated screen for the sheet is being used.
Definition: sch_sheet.cpp:179
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, const wxString &aFileName)
Load a the KiCad schematic file aFileName into the sheet aSheet.
Definition: sheet.cpp:101
bool AllowCaseSensitiveFileNameClashes(const wxString &aSchematicFileName)
Check aSchematicFileName for a potential file name case sensitivity clashes.
Definition: sheet.cpp:556
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
SCHEMATIC & Schematic() const
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
wxString GetFileName() const
Return the filename corresponding to this sheet.
Definition: sch_sheet.h:315
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:473
SCH_SHEET & Root() const
Definition: schematic.h:92
SCH_SCREEN * LastScreen()
void Append(SCH_ITEM *aItem)
Definition: sch_screen.cpp:128
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
#define _(s)
Definition: 3d_actions.cpp:33
const std::string KiCadSchematicFileExtension
SCH_SHEET_PATH & GetCurrentSheet() const
void SetFileName(const wxString &aFileName)
Definition: sch_screen.h:131
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:296

References _, SCH_EDIT_FRAME::AllowCaseSensitiveFileNameClashes(), SCH_SCREEN::Append(), CHANGED, SCH_EDIT_FRAME::CheckSheetForRecursion(), DisplayErrorMessage(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), SCH_SHEET::GetScreen(), SCH_EDIT_FRAME::GetScreen(), SCH_SHEET::GetScreenCount(), SCH_EDIT_FRAME::InitSheet(), IsOK(), KiCadSchematicFileExtension, SCH_SHEET_PATH::LastScreen(), SCH_EDIT_FRAME::LoadSheetFromFile(), m_clearAnnotationNewItems, m_fields, m_frame, m_sheet, NULL, SCH_SCREEN::Remove(), SCHEMATIC::Root(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::Schematic(), SCH_SHEET::SearchHierarchy(), SCH_SCREEN::SetFileName(), EDA_DRAW_FRAME::SetMsgPanel(), SCH_SHEET::SetScreen(), SHEETFILENAME, SHEETNAME, tracePathsAndFiles, and IO_ERROR::What().

Referenced by TransferDataFromWindow().

◆ OnSizeGrid()

void DIALOG_SHEET_PROPERTIES::OnSizeGrid ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SHEET_PROPERTIES_BASE.

Definition at line 802 of file dialog_sheet_properties.cpp.

803 {
804  auto new_size = event.GetSize().GetX();
805 
806  if( m_width != new_size )
807  {
808  AdjustGridColumns( new_size );
809  }
810 
811  // Always propagate for a grid repaint (needed if the height changes, as well as width)
812  event.Skip();
813 }

References AdjustGridColumns(), and m_width.

◆ OnUpdateUI()

void DIALOG_SHEET_PROPERTIES::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SHEET_PROPERTIES_BASE.

Definition at line 746 of file dialog_sheet_properties.cpp.

747 {
748  wxString shownColumns = m_grid->GetShownColumns();
749 
750  if( shownColumns != m_shownColumns )
751  {
752  m_shownColumns = shownColumns;
753 
754  if( !m_grid->IsCellEditControlShown() )
755  AdjustGridColumns( m_grid->GetRect().GetWidth() );
756  }
757 
758  // Propagate changes in sheetname to displayed hierarchical path
759  wxString hierarchicalPath = _( "Hierarchical path: " );
760 
761  hierarchicalPath += m_frame->GetCurrentSheet().PathHumanReadable( false );
762 
763  if( hierarchicalPath.Last() != '/' )
764  hierarchicalPath.Append( '/' );
765 
766  wxGridCellEditor* editor = m_grid->GetCellEditor( SHEETNAME, FDC_VALUE );
767  wxControl* control = editor->GetControl();
768  wxTextEntry* textControl = dynamic_cast<wxTextEntry*>( control );
769  wxString sheetName;
770 
771  if( textControl )
772  sheetName = textControl->GetValue();
773  else
774  sheetName = m_grid->GetCellValue( SHEETNAME, FDC_VALUE );
775 
777  m_dummySheetNameField.SetText( sheetName );
778  hierarchicalPath += m_dummySheetNameField.GetShownText();
779 
780  editor->DecRef();
781 
782  if( m_hierarchicalPathLabel->GetLabel() != hierarchicalPath )
783  m_hierarchicalPathLabel->SetLabel( hierarchicalPath );
784 
785  // Handle a delayed focus
786  if( m_delayedFocusRow >= 0 )
787  {
788  m_grid->SetFocus();
789  m_grid->MakeCellVisible( m_delayedFocusRow, m_delayedFocusColumn );
790  m_grid->SetGridCursor( m_delayedFocusRow, m_delayedFocusColumn );
791 
792 
793  m_grid->EnableCellEditControl( true );
794  m_grid->ShowCellEditControl();
795 
796  m_delayedFocusRow = -1;
798  }
799 }
void SetFields(const std::vector< SCH_FIELD > &aFields)
Set multiple schematic fields.
Definition: sch_sheet.h:96
wxString PathHumanReadable(bool aUseShortRootName=true) const
Return the sheet path in a human readable form made from the sheet names.
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:105
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:110
#define _(s)
Definition: 3d_actions.cpp:33
SCH_SHEET_PATH & GetCurrentSheet() const
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields

References _, AdjustGridColumns(), editor, FDC_VALUE, SCH_EDIT_FRAME::GetCurrentSheet(), WX_GRID::GetShownColumns(), SCH_FIELD::GetShownText(), m_delayedFocusColumn, m_delayedFocusRow, m_dummySheet, m_dummySheetNameField, m_fields, m_frame, DIALOG_SHEET_PROPERTIES_BASE::m_grid, DIALOG_SHEET_PROPERTIES_BASE::m_hierarchicalPathLabel, m_shownColumns, SCH_SHEET_PATH::PathHumanReadable(), SCH_SHEET::SetFields(), EDA_TEXT::SetText(), and SHEETNAME.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return 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
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), 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_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_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(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_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(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), 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(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_PROPERTIES_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_SYMBOL::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_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), 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_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_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_PROPERTIES_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_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), 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 282 of file dialog_shim.cpp.

283 {
284  const char* hash_key;
285 
286  if( m_hash_key.size() )
287  {
288  // a special case like EDA_LIST_DIALOG, which has multiple uses.
289  hash_key = m_hash_key.c_str();
290  }
291  else
292  {
293  hash_key = typeid(*this).name();
294  }
295 
296  RECT_MAP::iterator it = class_map.find( hash_key );
297 
298  if( it == class_map.end() )
299  return;
300 
301  EDA_RECT rect = it->second;
302  rect.SetSize( 0, 0 );
303  class_map[ hash_key ] = rect;
304 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:139
Handle the component boundary box.
Definition: eda_rect.h:42

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

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

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

99  {
100  m_initialFocusTarget = aWindow;
101  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), 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_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_INSPECTION_REPORTER::DIALOG_INSPECTION_REPORTER(), 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(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), 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_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
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:78
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(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 187 of file dialog_shim.cpp.

188 {
189  wxDialog::SetPosition( aNewPosition );
190 
191  // Now update the stored position:
192  const char* hash_key;
193 
194  if( m_hash_key.size() )
195  {
196  // a special case like EDA_LIST_DIALOG, which has multiple uses.
197  hash_key = m_hash_key.c_str();
198  }
199  else
200  {
201  hash_key = typeid(*this).name();
202  }
203 
204  RECT_MAP::iterator it = class_map.find( hash_key );
205 
206  if( it == class_map.end() )
207  return;
208 
209  EDA_RECT rect = it->second;
210  rect.SetOrigin( aNewPosition );
211 
212  class_map[ hash_key ] = rect;
213 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
std::string m_hash_key
Definition: dialog_shim.h:200
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:126
static RECT_MAP class_map
Handle the component boundary box.
Definition: eda_rect.h:42

References class_map, DIALOG_SHIM::m_hash_key, EDA_RECT::SetOrigin(), and PCAD2KICAD::SetPosition().

Referenced by DIALOG_SCH_FIND::DIALOG_SCH_FIND(), and PCB_BASE_FRAME::SelectOneLayer().

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

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

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

217 {
218  bool ret;
219  const char* hash_key;
220 
221  if( m_hash_key.size() )
222  {
223  // a special case like EDA_LIST_DIALOG, which has multiple uses.
224  hash_key = m_hash_key.c_str();
225  }
226  else
227  {
228  hash_key = typeid(*this).name();
229  }
230 
231  // Show or hide the window. If hiding, save current position and size.
232  // If showing, use previous position and size.
233  if( show )
234  {
235 #ifndef __WINDOWS__
236  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
237 #endif
238  ret = wxDialog::Show( show );
239 
240  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
241  EDA_RECT savedDialogRect = class_map[ hash_key ];
242 
243  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
244  {
245  if( m_useCalculatedSize )
246  {
247  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
248  wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
249  }
250  else
251  {
252  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
253  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
254  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
255  0 );
256  }
257  }
258 
259  // Be sure that the dialog appears in a visible area
260  // (the dialog position might have been stored at the time when it was
261  // shown on another display)
262  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
263  Centre();
264  }
265  else
266  {
267  // Save the dialog's position & size before hiding, using classname as key
268  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
269 
270 #ifdef __WXMAC__
271  if ( m_eventLoop )
272  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
273 #endif
274 
275  ret = wxDialog::Show( show );
276  }
277 
278  return ret;
279 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:107
Handle the component boundary box.
Definition: eda_rect.h:42
bool m_useCalculatedSize
Definition: dialog_shim.h:204
const wxSize GetSize() const
Definition: eda_rect.h:96

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

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), 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 395 of file dialog_shim.cpp.

396 {
397  // This is an exception safe way to zero a pointer before returning.
398  // Yes, even though DismissModal() clears this first normally, this is
399  // here in case there's an exception before the dialog is dismissed.
400  struct NULLER
401  {
402  void*& m_what;
403  NULLER( void*& aPtr ) : m_what( aPtr ) {}
404  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
405  } clear_this( (void*&) m_qmodal_loop );
406 
407  // release the mouse if it's currently captured as the window having it
408  // will be disabled when this dialog is shown -- but will still keep the
409  // capture making it impossible to do anything in the modal dialog itself
410  wxWindow* win = wxWindow::GetCapture();
411  if( win )
412  win->ReleaseMouse();
413 
414  // Get the optimal parent
415  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
416 
417  wxASSERT_MSG( !m_qmodal_parent_disabler,
418  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
419 
420  // quasi-modal: disable only my "optimal" parent
422 
423  // Apple in its infinite wisdom will raise a disabled window before even passing
424  // us the event, so we have no way to stop it. Instead, we must set an order on
425  // the windows so that the quasi-modal will be pushed in front of the disabled
426  // window when it is raised.
428 
429  Show( true );
430 
431  m_qmodal_showing = true;
432 
433  WX_EVENT_LOOP event_loop;
434 
435  m_qmodal_loop = &event_loop;
436 
437  event_loop.Run();
438 
439  m_qmodal_showing = false;
440 
441  return GetReturnCode();
442 }
bool m_qmodal_showing
Definition: dialog_shim.h:214
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:42
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:62

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 SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ TransferDataFromWindow()

bool DIALOG_SHEET_PROPERTIES::TransferDataFromWindow ( )
overrideprivate

Definition at line 243 of file dialog_sheet_properties.cpp.

244 {
245  if( !wxDialog::TransferDataFromWindow() ) // Calls our Validate() method.
246  return false;
247 
248  wxString newRelativeNativeFilename = m_fields->at( SHEETFILENAME ).GetText();
249 
250  // Ensure filepath is not empty. (In normal use will be caught by grid validators,
251  // but unedited data from existing files can be bad.)
252  if( newRelativeNativeFilename.IsEmpty() )
253  {
254  wxMessageBox( _( "A sheet must have a valid file name." ) );
255  return false;
256  }
257 
258  // Ensure the filename extension is OK. (In normaly use will be caught by grid
259  // validators, but unedited data from existing files can be bad.)
260  wxFileName fn( newRelativeNativeFilename );
261 
262  if( fn.GetExt().CmpNoCase( KiCadSchematicFileExtension ) != 0 )
263  {
264  wxMessageBox( _( "Sheet file must have a '.kicad_sch' extension." ) );
265  return false;
266  }
267 
268  wxString newRelativeFilename = fn.GetFullPath();
269 
270  // Inside Eeschema, filenames are stored using unix notation
271  newRelativeFilename.Replace( wxT( "\\" ), wxT( "/" ) );
272 
273  wxString oldFilename = m_sheet->GetFields()[ SHEETFILENAME ].GetText();
274  oldFilename.Replace( wxT( "\\" ), wxT( "/" ) );
275 
276  bool filename_changed = oldFilename != newRelativeFilename;
277 
278  if( filename_changed || m_sheet->IsNew() )
279  {
280  if( !onSheetFilenameChanged( newRelativeFilename ) )
281  return false;
282 
283  // One last validity check (and potential repair) just to be sure to be sure
284  SCH_SHEET_LIST repairedList( &m_frame->Schematic().Root(), true );
285  }
286 
287  wxString newSheetname = m_fields->at( SHEETNAME ).GetText();
288 
289  if( newSheetname.IsEmpty() )
290  newSheetname = _( "Untitled Sheet" );
291 
292  m_fields->at( SHEETNAME ).SetText( newSheetname );
293 
294  // change all field positions from relative to absolute
295  for( unsigned i = 0; i < m_fields->size(); ++i )
296  m_fields->at( i ).Offset( m_sheet->GetPosition() );
297 
300 
302 
304 
305  COLOR_SETTINGS* colorSettings = m_frame->GetColorSettings();
306 
307  if( colorSettings->GetOverrideSchItemColors()
310  {
311  wxPanel temp( this );
312  temp.Hide();
313  PANEL_EESCHEMA_COLOR_SETTINGS prefs( m_frame, &temp );
314  wxString checkboxLabel = prefs.m_optOverrideColors->GetLabel();
315 
316  KIDIALOG dlg( this, _( "Note: item colors are overridden in the current color theme." ),
318  dlg.ShowDetailedText( wxString::Format( _( "To see individual item colors uncheck '%s'\n"
319  "in Preferences > Eeschema > Colors." ),
320  checkboxLabel ) );
321  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
322  dlg.ShowModal();
323  }
324 
327 
329  SCH_SHEET_PATH instance = m_frame->GetCurrentSheet();
330 
331  instance.push_back( m_sheet );
332 
333  if( m_sheet->IsNew() )
334  m_sheet->AddInstance( instance.Path() );
335 
336  m_sheet->SetPageNumber( instance, m_pageNumberTextCtrl->GetValue() );
337 
339 
340  // Refresh all sheets in case ordering changed.
341  for( SCH_ITEM* item : m_frame->GetScreen()->Items().OfType( SCH_SHEET_T ) )
342  m_frame->UpdateItem( item );
343 
344  m_frame->OnModify();
345 
346  return true;
347 }
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
KIGFX::COLOR4D GetSwatchColor() const
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:45
void SetFields(const std::vector< SCH_FIELD > &aFields)
Set multiple schematic fields.
Definition: sch_sheet.h:96
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:111
void SetPageNumber(const SCH_SHEET_PATH &aInstance, const wxString &aPageNumber)
Set the page number for the sheet instance aInstance.
Definition: sch_sheet.cpp:1135
bool IsNew() const
Definition: eda_item.h:169
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:114
void SetBorderWidth(int aWidth)
Definition: sch_sheet.h:109
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:88
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SetBackgroundColor(KIGFX::COLOR4D aColor)
Definition: sch_sheet.h:115
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
SCHEMATIC & Schematic() const
void SetBorderColor(KIGFX::COLOR4D aColor)
Definition: sch_sheet.h:112
static bool positioningChanged(const SCH_FIELD &a, const SCH_FIELD &b)
void ClearFieldsAutoplaced()
Definition: sch_item.h:436
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
wxPoint GetPosition() const override
Definition: sch_sheet.h:378
COLOR_SETTINGS * GetColorSettings() const override
Returns a pointer to the active color theme settings.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
SCH_SHEET & Root() const
Definition: schematic.h:92
#define _(s)
Definition: 3d_actions.cpp:33
EE_RTREE & Items()
Definition: sch_screen.h:103
const std::string KiCadSchematicFileExtension
virtual long long int GetValue()
Return the current value in Internal Units.
Color settings are a bit different than most of the settings objects in that there can be more than o...
SCH_SHEET_PATH & GetCurrentSheet() const
bool GetOverrideSchItemColors() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
bool onSheetFilenameChanged(const wxString &aNewFilename)
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197
SCH_SHEET_LIST & GetFullHierarchy() const
Return the full schematic flattened hierarchical sheet list.
Definition: schematic.cpp:356
bool AddInstance(const KIID_PATH &aInstance)
Add a new instance aSheetPath to the instance list.
Definition: sch_sheet.cpp:1093

References _, SCH_SHEET::AddInstance(), SCH_ITEM::ClearFieldsAutoplaced(), KIDIALOG::DoNotShowCheckbox(), Format(), SCH_SHEET::GetBackgroundColor(), SCH_SHEET::GetBorderColor(), SCH_BASE_FRAME::GetColorSettings(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SHEET::GetFields(), SCHEMATIC::GetFullHierarchy(), COLOR_SETTINGS::GetOverrideSchItemColors(), SCH_SHEET::GetPosition(), SCH_EDIT_FRAME::GetScreen(), COLOR_SWATCH::GetSwatchColor(), UNIT_BINDER::GetValue(), EDA_ITEM::IsNew(), SCH_SCREEN::Items(), KIDIALOG::KD_WARNING, KiCadSchematicFileExtension, DIALOG_SHEET_PROPERTIES_BASE::m_backgroundSwatch, DIALOG_SHEET_PROPERTIES_BASE::m_borderSwatch, m_borderWidth, m_fields, m_frame, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, DIALOG_SHEET_PROPERTIES_BASE::m_pageNumberTextCtrl, m_sheet, EE_RTREE::OfType(), SCH_EDIT_FRAME::OnModify(), onSheetFilenameChanged(), SCH_SHEET_PATH::Path(), positioningChanged(), SCH_SHEET_PATH::push_back(), SCHEMATIC::Root(), SCH_SHEET_T, SCH_EDIT_FRAME::Schematic(), SCH_SHEET::SetBackgroundColor(), SCH_SHEET::SetBorderColor(), SCH_SHEET::SetBorderWidth(), SCH_SHEET::SetFields(), SCH_SHEET::SetPageNumber(), SHEETFILENAME, SHEETNAME, KIDIALOG::ShowModal(), SCH_EDIT_FRAME::TestDanglingEnds(), and SCH_BASE_FRAME::UpdateItem().

◆ TransferDataToWindow()

bool DIALOG_SHEET_PROPERTIES::TransferDataToWindow ( )
overrideprivate

Definition at line 116 of file dialog_sheet_properties.cpp.

117 {
118  if( !wxDialog::TransferDataToWindow() )
119  return false;
120 
121  // Push a copy of each field into m_updateFields
122  for( SCH_FIELD& field : m_sheet->GetFields() )
123  {
124  SCH_FIELD field_copy( field );
125 
126 #ifdef __WINDOWS__
127  // Filenames are stored using unix notation
128  if( field_copy.GetId() == SHEETFILENAME )
129  {
130  wxString filename = field_copy.GetText();
131  filename.Replace( wxT("/"), wxT("\\") );
132  field_copy.SetText( filename );
133  }
134 #endif
135 
136  // change offset to be symbol-relative
137  field_copy.Offset( -m_sheet->GetPosition() );
138 
139  m_fields->push_back( field_copy );
140  }
141 
142  // notify the grid
143  wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_fields->size() );
144  m_grid->ProcessTableMessage( msg );
145  AdjustGridColumns( m_grid->GetRect().GetWidth() );
146 
147  // border width
149 
150  // set up color swatches
151  KIGFX::COLOR4D borderColor = m_sheet->GetBorderColor();
152  KIGFX::COLOR4D backgroundColor = m_sheet->GetBackgroundColor();
153 
154  m_borderSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
155  m_backgroundSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
156 
157  m_borderSwatch->SetSwatchColor( borderColor, false );
158  m_backgroundSwatch->SetSwatchColor( backgroundColor, false );
159 
163 
165  SCH_SHEET_PATH instance = m_frame->GetCurrentSheet();
166 
167  instance.push_back( m_sheet );
168 
169  wxString nextPageNumber;
170 
171  if( m_sheet->IsNew() )
172  nextPageNumber.Printf( "%d", static_cast<int>( hierarchy.size() ) + 1 );
173  else
174  nextPageNumber = m_sheet->GetPageNumber( instance );
175 
176  m_pageNumberTextCtrl->ChangeValue( nextPageNumber );
177 
178  Layout();
179 
180  return true;
181 }
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void SetSwatchColor(KIGFX::COLOR4D aColor, bool aSendEvent)
Set the current swatch color directly.
void SetDefaultColor(KIGFX::COLOR4D aColor)
Sets the color that will be chosen with the "Reset to Default" button in the chooser.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:111
void SetSwatchBackground(KIGFX::COLOR4D aBackground)
Set the swatch background color.
bool IsNew() const
Definition: eda_item.h:169
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:114
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:88
int GetBorderWidth() const
Definition: sch_sheet.h:108
SCHEMATIC & Schematic() const
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
wxPoint GetPosition() const override
Definition: sch_sheet.h:378
COLOR_SETTINGS * GetColorSettings() const override
Returns a pointer to the active color theme settings.
COLOR4D GetColor(int aLayer) const
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
SCH_SHEET_PATH & GetCurrentSheet() const
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields
SCH_SHEET_LIST & GetFullHierarchy() const
Return the full schematic flattened hierarchical sheet list.
Definition: schematic.cpp:356
wxString GetPageNumber(const SCH_SHEET_PATH &aInstance) const
Return the sheet page number for aInstance.
Definition: sch_sheet.cpp:1117
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References AdjustGridColumns(), SCH_SHEET::GetBackgroundColor(), SCH_SHEET::GetBorderColor(), SCH_SHEET::GetBorderWidth(), COLOR_SETTINGS::GetColor(), SCH_BASE_FRAME::GetColorSettings(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SHEET::GetFields(), SCHEMATIC::GetFullHierarchy(), SCH_FIELD::GetId(), SCH_SHEET::GetPageNumber(), SCH_SHEET::GetPosition(), EDA_TEXT::GetText(), EDA_ITEM::IsNew(), LAYER_SCHEMATIC_BACKGROUND, DIALOG_SHEET_PROPERTIES_BASE::m_backgroundSwatch, DIALOG_SHEET_PROPERTIES_BASE::m_borderSwatch, m_borderWidth, m_fields, m_frame, DIALOG_SHEET_PROPERTIES_BASE::m_grid, DIALOG_SHEET_PROPERTIES_BASE::m_pageNumberTextCtrl, m_sheet, EDA_TEXT::Offset(), SCH_SHEET_PATH::push_back(), SCH_EDIT_FRAME::Schematic(), COLOR_SWATCH::SetDefaultColor(), COLOR_SWATCH::SetSwatchBackground(), COLOR_SWATCH::SetSwatchColor(), EDA_TEXT::SetText(), UNIT_BINDER::SetValue(), and SHEETFILENAME.

Referenced by OnInitDlg().

◆ Validate()

bool DIALOG_SHEET_PROPERTIES::Validate ( )
overrideprivate

Definition at line 184 of file dialog_sheet_properties.cpp.

185 {
186  wxString msg;
187  LIB_ID id;
188 
189  if( !m_grid->CommitPendingChanges() || !m_grid->Validate() )
190  return false;
191 
192  // Check for missing field names.
193  for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields->size(); ++i )
194  {
195  SCH_FIELD& field = m_fields->at( i );
196  wxString fieldName = field.GetName( false );
197 
198  if( fieldName.IsEmpty() )
199  {
200  DisplayErrorMessage( this, _( "Fields must have a name." ) );
201 
203  m_delayedFocusRow = i;
204 
205  return false;
206  }
207  }
208 
209  return true;
210 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:182
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetName(bool aUseDefaultName=true) const
Return the field name.
Definition: sch_field.cpp:519
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields

References _, WX_GRID::CommitPendingChanges(), DisplayErrorMessage(), FDC_NAME, SCH_FIELD::GetName(), m_delayedFocusColumn, m_delayedFocusRow, m_fields, DIALOG_SHEET_PROPERTIES_BASE::m_grid, and SHEET_MANDATORY_FIELDS.

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

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

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_backgroundColorLabel

wxStaticText* DIALOG_SHEET_PROPERTIES_BASE::m_backgroundColorLabel
protectedinherited

◆ m_backgroundSwatch

COLOR_SWATCH* DIALOG_SHEET_PROPERTIES_BASE::m_backgroundSwatch
protectedinherited

◆ m_borderColorLabel

wxStaticText* DIALOG_SHEET_PROPERTIES_BASE::m_borderColorLabel
protectedinherited

◆ m_borderSwatch

COLOR_SWATCH* DIALOG_SHEET_PROPERTIES_BASE::m_borderSwatch
protectedinherited

◆ m_borderWidth

UNIT_BINDER DIALOG_SHEET_PROPERTIES::m_borderWidth
private

Definition at line 56 of file dialog_sheet_properties.h.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

◆ m_borderWidthCtrl

wxTextCtrl* DIALOG_SHEET_PROPERTIES_BASE::m_borderWidthCtrl
protectedinherited

◆ m_borderWidthLabel

wxStaticText* DIALOG_SHEET_PROPERTIES_BASE::m_borderWidthLabel
protectedinherited

◆ m_borderWidthUnits

wxStaticText* DIALOG_SHEET_PROPERTIES_BASE::m_borderWidthUnits
protectedinherited

◆ m_bpAdd

wxBitmapButton* DIALOG_SHEET_PROPERTIES_BASE::m_bpAdd
protectedinherited

◆ m_bpDelete

wxBitmapButton* DIALOG_SHEET_PROPERTIES_BASE::m_bpDelete
protectedinherited

◆ m_bpMoveDown

wxBitmapButton* DIALOG_SHEET_PROPERTIES_BASE::m_bpMoveDown
protectedinherited

◆ m_bpMoveUp

wxBitmapButton* DIALOG_SHEET_PROPERTIES_BASE::m_bpMoveUp
protectedinherited

◆ m_clearAnnotationNewItems

bool* DIALOG_SHEET_PROPERTIES::m_clearAnnotationNewItems
private

Definition at line 48 of file dialog_sheet_properties.h.

Referenced by onSheetFilenameChanged().

◆ m_delayedFocusColumn

int DIALOG_SHEET_PROPERTIES::m_delayedFocusColumn
private

◆ m_delayedFocusRow

int DIALOG_SHEET_PROPERTIES::m_delayedFocusRow
private

◆ m_dummySheet

SCH_SHEET DIALOG_SHEET_PROPERTIES::m_dummySheet
private

Definition at line 58 of file dialog_sheet_properties.h.

Referenced by OnUpdateUI().

◆ m_dummySheetNameField

SCH_FIELD DIALOG_SHEET_PROPERTIES::m_dummySheetNameField
private

Definition at line 59 of file dialog_sheet_properties.h.

Referenced by OnUpdateUI().

◆ m_fields

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 209 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_frame

SCH_EDIT_FRAME* DIALOG_SHEET_PROPERTIES::m_frame
private

◆ m_grid

◆ m_hash_key

◆ m_hierarchicalPathLabel

wxStaticText* DIALOG_SHEET_PROPERTIES_BASE::m_hierarchicalPathLabel
protectedinherited

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 210 of file dialog_shim.h.

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

◆ m_longForm

wxBoxSizer* DIALOG_SHEET_PROPERTIES_BASE::m_longForm
protectedinherited

◆ m_pageNumberStaticText

wxStaticText* DIALOG_SHEET_PROPERTIES_BASE::m_pageNumberStaticText
protectedinherited

◆ m_pageNumberTextCtrl

wxTextCtrl* DIALOG_SHEET_PROPERTIES_BASE::m_pageNumberTextCtrl
protectedinherited

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 217 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 212 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 214 of file dialog_shim.h.

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

◆ m_sheet

SCH_SHEET* DIALOG_SHEET_PROPERTIES::m_sheet
private

◆ m_shownColumns

wxString DIALOG_SHEET_PROPERTIES::m_shownColumns
private

Definition at line 53 of file dialog_sheet_properties.h.

Referenced by DIALOG_SHEET_PROPERTIES(), and OnUpdateUI().

◆ m_staticline1

wxStaticLine* DIALOG_SHEET_PROPERTIES_BASE::m_staticline1
protectedinherited

◆ m_stdDialogButtonSizer

wxStdDialogButtonSizer* DIALOG_SHEET_PROPERTIES_BASE::m_stdDialogButtonSizer
protectedinherited

◆ m_stdDialogButtonSizerCancel

wxButton* DIALOG_SHEET_PROPERTIES_BASE::m_stdDialogButtonSizerCancel
protectedinherited

◆ m_stdDialogButtonSizerOK

wxButton* DIALOG_SHEET_PROPERTIES_BASE::m_stdDialogButtonSizerOK
protectedinherited

◆ m_tabOrder

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_width

int DIALOG_SHEET_PROPERTIES::m_width
private

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