29#include <wx/tooltip.h>
46#include "wx/dcclient.h"
49 bool* aClearAnnotationNewItems,
50 bool* aUpdateHierarchyNavigator ) :
53 m_clearAnnotationNewItems( aClearAnnotationNewItems ),
54 m_updateHierarchyNavigator( aUpdateHierarchyNavigator ),
55 m_borderWidth( aParent, m_borderWidthLabel, m_borderWidthCtrl, m_borderWidthUnits ),
56 m_dummySheet( *aSheet ),
65 m_grid->SetDefaultRowSize(
m_grid->GetDefaultRowSize() + 4 );
69 [&]( wxCommandEvent& aEvent )
73 m_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
90 wxToolTip::Enable(
true );
104 m_grid->Connect( wxEVT_GRID_CELL_CHANGING,
115 cfg->m_Appearance.edit_sheet_width = GetSize().x;
116 cfg->m_Appearance.edit_sheet_height = GetSize().y;
122 m_grid->Disconnect( wxEVT_GRID_CELL_CHANGING,
127 m_grid->PopEventHandler(
true );
133 if( !wxDialog::TransferDataToWindow() )
145 wxString filename = field_copy.
GetText();
146 filename.Replace( wxT(
"/" ), wxT(
"\\" ) );
147 field_copy.
SetText( filename );
158 wxGridTableMessage msg(
m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
m_fields->size() );
159 m_grid->ProcessTableMessage( msg );
190 pageNumber.Printf( wxT(
"%d" ),
static_cast<int>( hierarchy.size() ) + 1 );
265 if( !wxDialog::TransferDataFromWindow() )
272 bool isUndoable =
true;
279 if( sheetFileName.IsEmpty() )
281 DisplayError(
this,
_(
"A sheet must have a valid file name." ) );
289 wxFileName fn( sheetFileName );
290 wxString newRelativeFilename = fn.GetFullPath();
293 newRelativeFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
296 oldFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
298 bool filename_changed = oldFilename != newRelativeFilename;
304 wxCHECK( currentScreen,
false );
306 bool clearFileName =
false;
311 clearFileName =
true;
315 wxFileName tmp( fn );
316 wxFileName screenFileName = currentScreen->
GetFileName();
318 if( fn.IsAbsolute() && fn.MakeRelativeTo( screenFileName.GetPath() ) )
320 wxMessageDialog makeRelDlg(
this,
_(
"Use relative path for sheet file?" ),
321 _(
"Sheet File Path" ),
322 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION | wxCENTER );
324 makeRelDlg.SetExtendedMessage(
_(
"Using relative hierarchical sheet file name paths "
325 "improves schematic portability across systems and "
326 "platforms. Using absolute paths can result in "
327 "portability issues." ) );
328 makeRelDlg.SetYesNoLabels( wxMessageDialog::ButtonLabel(
_(
"Use Relative Path" ) ),
329 wxMessageDialog::ButtonLabel(
_(
"Use Absolute Path" ) ) );
331 if( makeRelDlg.ShowModal() == wxID_YES )
334 "\n to relative path: '%s'",
338 newRelativeFilename = fn.GetFullPath();
366 if( newSheetname.IsEmpty() )
367 newSheetname =
_(
"Untitled Sheet" );
372 for(
unsigned i = 0; i <
m_fields->size(); ++i )
385 else if( fieldName.IsEmpty() )
399 wxPanel temp(
this );
404 KIDIALOG dlg(
this,
_(
"Note: item colors are overridden in the current color theme." ),
406 dlg.ShowDetailedText( wxString::Format(
_(
"To see individual item colors uncheck '%s'\n"
407 "in Preferences > Schematic Editor > Colors." ),
430 commit.
Push(
_(
"Edit Sheet Properties" ) );
446 wxCHECK( aIsUndoable,
false );
449 wxFileName sheetFileName(
456 wxFileName screenFileName( sheetFileName );
457 wxFileName tmp( sheetFileName );
461 wxCHECK( currentScreen,
false );
464 wxFileName currentScreenFileName = currentScreen->
GetFileName();
467 currentScreenFileName.GetPath() ) )
469 msg = wxString::Format(
_(
"Cannot normalize new sheet schematic file path:\n"
471 "against parent sheet schematic file path:\n"
473 sheetFileName.GetPath(),
474 currentScreenFileName.GetPath() );
479 wxString newAbsoluteFilename = screenFileName.GetFullPath();
482 newAbsoluteFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
484 bool renameFile =
false;
485 bool loadFromFile =
false;
486 bool clearAnnotation =
false;
487 bool isExistingSheet =
false;
495 loadFromFile = wxFileExists( newAbsoluteFilename );
499 loadFromFile ?
"found" :
"not found" );
507 if( useScreen || loadFromFile )
509 clearAnnotation =
true;
511 if( !
IsOK(
this, wxString::Format(
_(
"'%s' already exists." ),
512 sheetFileName.GetFullName() )
514 + wxString::Format(
_(
"Link '%s' to this file?" ),
515 newAbsoluteFilename ) ) )
527 isExistingSheet =
true;
542 oldAbsoluteFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
544 if( newAbsoluteFilename.Cmp( oldAbsoluteFilename ) != 0 )
547 *aIsUndoable =
false;
549 if( useScreen || loadFromFile )
551 clearAnnotation =
true;
553 if( !
IsOK(
this, wxString::Format(
_(
"Change '%s' link from '%s' to '%s'?" ),
556 sheetFileName.GetFullName() )
558 +
_(
"This action cannot be undone." ) ) )
570 if( !
IsOK(
this, wxString::Format(
_(
"Create new file '%s' with contents "
572 sheetFileName.GetFullName(),
575 +
_(
"This action cannot be undone." ) ) )
598 pi->SaveSchematicFile( newAbsoluteFilename,
m_sheet, &schematic );
602 msg = wxString::Format(
_(
"Error occurred saving schematic file '%s'." ),
603 newAbsoluteFilename );
606 msg = wxString::Format(
_(
"Failed to save schematic '%s'" ),
607 newAbsoluteFilename );
629 std::unique_ptr< SCH_SHEET> tmpSheet = std::make_unique<SCH_SHEET>( &schematic );
631 tmpSheet->GetFields()[
SHEETFILENAME].SetText( sheetFileName.GetFullPath() );
632 tmpSheet->SetScreen( useScreen );
647 else if( loadFromFile )
649 bool restoreSheet =
false;
651 if( isExistingSheet )
691 wxGridCellEditor*
editor =
m_grid->GetCellEditor( event.GetRow(), event.GetCol() );
692 wxControl* control =
editor->GetControl();
693 wxTextEntry* textControl =
dynamic_cast<wxTextEntry*
>( control );
699 if( textControl && textControl->IsEmpty() )
701 wxMessageBox(
_(
"A sheet must have a name." ) );
707 if( textControl->IsEmpty() )
709 wxMessageBox(
_(
"A sheet must have a file specified." ) );
714 if( success && control && control->GetValidator() )
715 success = control->GetValidator()->Validate( control );
742 wxGridTableMessage msg(
m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
743 m_grid->ProcessTableMessage( msg );
748 m_grid->EnableCellEditControl();
749 m_grid->ShowCellEditControl();
755 wxArrayInt selectedRows =
m_grid->GetSelectedRows();
757 if( selectedRows.empty() &&
m_grid->GetGridCursorRow() >= 0 )
758 selectedRows.push_back(
m_grid->GetGridCursorRow() );
760 if( selectedRows.empty() )
763 for(
int row : selectedRows )
767 DisplayError(
this, wxString::Format(
_(
"The first %d fields are mandatory." ),
776 selectedRows.Sort( [](
int* first,
int* second ) {
return *second - *first; } );
778 for(
int row : selectedRows )
783 wxGridTableMessage msg(
m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, row, 1 );
784 m_grid->ProcessTableMessage( msg );
786 if(
m_grid->GetNumberRows() > 0 )
788 m_grid->MakeCellVisible( std::max( 0, row-1 ),
m_grid->GetGridCursorCol() );
789 m_grid->SetGridCursor( std::max( 0, row-1 ),
m_grid->GetGridCursorCol() );
800 int i =
m_grid->GetGridCursorRow();
809 m_grid->SetGridCursor( i - 1,
m_grid->GetGridCursorCol() );
824 int i =
m_grid->GetGridCursorRow();
833 m_grid->SetGridCursor( i + 1,
m_grid->GetGridCursorCol() );
848 m_grid->AutoSizeColumn( 0 );
849 m_grid->SetColSize( 0, std::max( 72,
m_grid->GetColSize( 0 ) ) );
851 int fixedColsWidth =
m_grid->GetColSize( 0 );
853 for(
int i = 2; i <
m_grid->GetNumberCols(); i++ )
854 fixedColsWidth +=
m_grid->GetColSize( i );
856 m_grid->SetColSize( 1, std::max( 120, width - fixedColsWidth ) );
868 if( !
m_grid->IsCellEditControlShown() )
875 if(
path.Last() !=
'/' )
879 wxControl* control =
editor->GetControl();
880 wxTextEntry* textControl =
dynamic_cast<wxTextEntry*
>( control );
884 sheetName = textControl->GetValue();
899 path = wxControl::Ellipsize(
path, dc, wxELLIPSIZE_START, width, wxELLIPSIZE_FLAGS_NONE );
911 m_grid->EnableCellEditControl(
true );
912 m_grid->ShowCellEditControl();
922 auto new_size =
event.GetSize();
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap)
Color settings are a bit different than most of the settings objects in that there can be more than o...
bool GetOverrideSchItemColors() const
COLOR4D GetColor(int aLayer) const
void SetSwatchColor(const KIGFX::COLOR4D &aColor, bool aSendEvent)
Set the current swatch color directly.
KIGFX::COLOR4D GetSwatchColor() const
void SetDefaultColor(const KIGFX::COLOR4D &aColor)
Sets the color that will be chosen with the "Reset to Default" button in the chooser.
void SetSwatchBackground(const KIGFX::COLOR4D &aBackground)
Set the swatch background color.
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Create an undo entry for an item that has been already modified.
Class DIALOG_SHEET_PROPERTIES_BASE.
STD_BITMAP_BUTTON * m_bpMoveUp
wxTextCtrl * m_pageNumberTextCtrl
COLOR_SWATCH * m_backgroundSwatch
wxStaticText * m_hierarchicalPath
STD_BITMAP_BUTTON * m_bpAdd
wxStdDialogButtonSizer * m_stdDialogButtonSizer
wxBoxSizer * m_sizerBottom
STD_BITMAP_BUTTON * m_bpDelete
COLOR_SWATCH * m_borderSwatch
wxStaticText * m_hierarchicalPathLabel
STD_BITMAP_BUTTON * m_bpMoveDown
bool TransferDataToWindow() override
void OnAddField(wxCommandEvent &event) override
void OnMoveDown(wxCommandEvent &event) override
UNIT_BINDER m_borderWidth
std::bitset< 64 > m_shownColumns
SCH_FIELD m_dummySheetNameField
bool TransferDataFromWindow() override
void OnGridCellChanging(wxGridEvent &event)
void OnDeleteField(wxCommandEvent &event) override
DIALOG_SHEET_PROPERTIES(SCH_EDIT_FRAME *aParent, SCH_SHEET *aSheet, bool *aClearAnnotationNewItems, bool *aUpdateHierarchyNavigator)
void OnSizeGrid(wxSizeEvent &event) override
bool * m_updateHierarchyNavigator
bool onSheetFilenameChanged(const wxString &aNewFilename, bool *aIsUndoable)
void OnInitDlg(wxInitDialogEvent &event) override
void OnUpdateUI(wxUpdateUIEvent &event) override
bool * m_clearAnnotationNewItems
FIELDS_GRID_TABLE * m_fields
void OnMoveUp(wxCommandEvent &event) override
~DIALOG_SHEET_PROPERTIES() override
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
const EDA_ANGLE & GetTextAngle() const
virtual const wxString & GetText() const
Return the string associated with the text object.
void Offset(const VECTOR2I &aOffset)
GR_TEXT_H_ALIGN_T GetHorizJustify() const
GR_TEXT_V_ALIGN_T GetVertJustify() const
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
EE_TYPE OfType(KICAD_T aType) const
int GetNumberRows() override
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
void DoNotShowCheckbox(wxString file, int line)
Checks the 'do not show again' setting for the dialog.
APP_SETTINGS_BASE * KifaceSettings() const
A color representation with 4 components: red, green, blue, alpha.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A logical library item identifier and consists of various portions much like a URI.
wxCheckBox * m_optOverrideColors
virtual const wxString GetProjectName() const
Return the short name of the project.
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Holds all the data relating to one schematic.
SCH_SHEET_LIST & GetFullHierarchy() const
Return the full schematic flattened hierarchical sheet list.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
Schematic editor (Eeschema) main window.
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet, const wxString &aFileName)
Load a the KiCad schematic file aFileName into the sheet aSheet.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
bool AllowCaseSensitiveFileNameClashes(const wxString &aSchematicFileName)
Check aSchematicFileName for a potential file name case sensitivity clashes.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void InitSheet(SCH_SHEET *aSheet, const wxString &aNewFilename)
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
bool CheckSheetForRecursion(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet)
Verify that aSheet will not cause a recursion error in aCurrentSheet.
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
Mark an item for refresh.
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
VECTOR2I GetPosition() const override
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
bool IsEmpty()
Return true if both the name and value of the field are empty.
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
void SetName(const wxString &aName)
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
void SetText(const wxString &aText) override
Base class for any item which can be embedded within the SCHEMATIC container class,...
void ClearFieldsAutoplaced()
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
const wxString & GetFileName() const
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
bool Remove(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Remove aItem from the schematic associated with this screen.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void AddNewSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath, const wxString &aProjectName)
Attempt to add new symbol instances for all symbols in this list of sheet paths prefixed with aPrefix...
int GetLastVirtualPageNumber() const
void AddNewSheetInstances(const SCH_SHEET_PATH &aPrefixSheetPath, int aLastVirtualPageNumber)
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
wxString PathHumanReadable(bool aUseShortRootName=true, bool aStripTrailingSeparator=false) const
Return the sheet path in a human readable form made from the sheet names.
SCH_SCREEN * LastScreen()
wxString GetPageNumber() const
void SetPageNumber(const wxString &aPageNumber)
Set the sheet instance user definable page number.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
void SetBorderColor(KIGFX::COLOR4D aColor)
wxString GetFileName() const
Return the filename corresponding to this sheet.
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslated=true)
std::vector< SCH_FIELD > & GetFields()
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
void SetBackgroundColor(KIGFX::COLOR4D aColor)
SCH_SCREEN * GetScreen() const
VECTOR2I GetPosition() const override
void SetFields(const std::vector< SCH_FIELD > &aFields)
Set multiple schematic fields.
int GetScreenCount() const
Return the number of times the associated screen for the sheet is being used.
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
KIGFX::COLOR4D GetBorderColor() const
void SetBorderWidth(int aWidth)
int GetBorderWidth() const
KIGFX::COLOR4D GetBackgroundColor() const
virtual long long int GetValue()
Return the current value in Internal Units.
virtual void SetValue(long long int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
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...
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
wxString GetShownColumnsAsString()
Get a tokenized string containing the shown column indexes.
std::bitset< 64 > GetShownColumns()
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
wxString EnsureFileExtension(const wxString &aFilename, const wxString &aExtension)
It's annoying to throw up nag dialogs when the extension isn't right.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
static bool positioningChanged(const SCH_FIELD &a, const SCH_FIELD &b)
static bool positioningChanged(const SCH_FIELD &a, const SCH_FIELD &b)
const int minSize
Push and Shove router track width and via size dialog.
static const std::string KiCadSchematicFileExtension
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
@ LAYER_SCHEMATIC_BACKGROUND
KICOMMON_API wxFont GetInfoFont(wxWindow *aWindow)
@ SHEET_MANDATORY_FIELDS
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
wxLogTrace helper definitions.
Custom text control validator definitions.
Definition of file extensions used in Kicad.
#define FN_NORMALIZE_FLAGS
Default flags to pass to wxFileName::Normalize().