29#include <wx/tooltip.h>
47#include "wx/dcclient.h"
50 bool* aClearAnnotationNewItems,
51 bool* aUpdateHierarchyNavigator ) :
54 m_clearAnnotationNewItems( aClearAnnotationNewItems ),
55 m_updateHierarchyNavigator( aUpdateHierarchyNavigator ),
56 m_borderWidth( aParent, m_borderWidthLabel, m_borderWidthCtrl, m_borderWidthUnits ),
57 m_dummySheet( *aSheet ),
66 m_grid->SetDefaultRowSize(
m_grid->GetDefaultRowSize() + 4 );
70 [&]( wxCommandEvent& aEvent )
74 m_grid->SetSelectionMode( wxGrid::wxGridSelectRows );
91 wxToolTip::Enable(
true );
105 m_grid->Connect( wxEVT_GRID_CELL_CHANGING,
116 cfg->m_Appearance.edit_sheet_width = GetSize().x;
117 cfg->m_Appearance.edit_sheet_height = GetSize().y;
123 m_grid->Disconnect( wxEVT_GRID_CELL_CHANGING,
128 m_grid->PopEventHandler(
true );
134 if( !wxDialog::TransferDataToWindow() )
146 wxString filename = field_copy.
GetText();
147 filename.Replace( wxT(
"/" ), wxT(
"\\" ) );
148 field_copy.
SetText( filename );
159 wxGridTableMessage msg(
m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
m_fields->size() );
160 m_grid->ProcessTableMessage( msg );
191 pageNumber.Printf( wxT(
"%d" ),
static_cast<int>( hierarchy.size() ) + 1 );
266 if( !wxDialog::TransferDataFromWindow() )
273 bool isUndoable =
true;
280 if( sheetFileName.IsEmpty() )
282 DisplayError(
this,
_(
"A sheet must have a valid file name." ) );
290 wxFileName fn( sheetFileName );
291 wxString newRelativeFilename = fn.GetFullPath();
294 newRelativeFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
297 oldFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
299 bool filename_changed = oldFilename != newRelativeFilename;
305 wxCHECK( currentScreen,
false );
307 bool clearFileName =
false;
312 clearFileName =
true;
316 wxFileName tmp( fn );
317 wxFileName screenFileName = currentScreen->
GetFileName();
319 if( fn.IsAbsolute() && fn.MakeRelativeTo( screenFileName.GetPath() ) )
321 wxMessageDialog makeRelDlg(
this,
_(
"Use relative path for sheet file?" ),
322 _(
"Sheet File Path" ),
323 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION | wxCENTER );
325 makeRelDlg.SetExtendedMessage(
_(
"Using relative hierarchical sheet file name paths "
326 "improves schematic portability across systems and "
327 "platforms. Using absolute paths can result in "
328 "portability issues." ) );
329 makeRelDlg.SetYesNoLabels( wxMessageDialog::ButtonLabel(
_(
"Use Relative Path" ) ),
330 wxMessageDialog::ButtonLabel(
_(
"Use Absolute Path" ) ) );
332 if( makeRelDlg.ShowModal() == wxID_YES )
335 "\n to relative path: '%s'",
339 newRelativeFilename = fn.GetFullPath();
367 if( newSheetname.IsEmpty() )
368 newSheetname =
_(
"Untitled Sheet" );
373 for(
unsigned i = 0; i <
m_fields->size(); ++i )
386 else if( fieldName.IsEmpty() )
400 wxPanel temp(
this );
405 KIDIALOG dlg(
this,
_(
"Note: item colors are overridden in the current color theme." ),
407 dlg.ShowDetailedText( wxString::Format(
_(
"To see individual item colors uncheck '%s'\n"
408 "in Preferences > Schematic Editor > Colors." ),
431 commit.
Push(
_(
"Edit Sheet Properties" ) );
447 wxCHECK( aIsUndoable,
false );
450 wxFileName sheetFileName(
457 wxFileName screenFileName( sheetFileName );
458 wxFileName tmp( sheetFileName );
462 wxCHECK( currentScreen,
false );
465 wxFileName currentScreenFileName = currentScreen->
GetFileName();
468 currentScreenFileName.GetPath() ) )
470 msg = wxString::Format(
_(
"Cannot normalize new sheet schematic file path:\n"
472 "against parent sheet schematic file path:\n"
474 sheetFileName.GetPath(),
475 currentScreenFileName.GetPath() );
480 wxString newAbsoluteFilename = screenFileName.GetFullPath();
483 newAbsoluteFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
485 bool renameFile =
false;
486 bool loadFromFile =
false;
487 bool clearAnnotation =
false;
488 bool isExistingSheet =
false;
496 loadFromFile = wxFileExists( newAbsoluteFilename );
500 loadFromFile ?
"found" :
"not found" );
508 if( useScreen || loadFromFile )
510 clearAnnotation =
true;
512 if( !
IsOK(
this, wxString::Format(
_(
"'%s' already exists." ),
513 sheetFileName.GetFullName() )
515 + wxString::Format(
_(
"Link '%s' to this file?" ),
516 newAbsoluteFilename ) ) )
528 isExistingSheet =
true;
543 oldAbsoluteFilename.Replace( wxT(
"\\" ), wxT(
"/" ) );
545 if( newAbsoluteFilename.Cmp( oldAbsoluteFilename ) != 0 )
548 *aIsUndoable =
false;
550 if( useScreen || loadFromFile )
552 clearAnnotation =
true;
554 if( !
IsOK(
this, wxString::Format(
_(
"Change '%s' link from '%s' to '%s'?" ),
557 sheetFileName.GetFullName() )
559 +
_(
"This action cannot be undone." ) ) )
571 if( !
IsOK(
this, wxString::Format(
_(
"Create new file '%s' with contents "
573 sheetFileName.GetFullName(),
576 +
_(
"This action cannot be undone." ) ) )
599 pi->SaveSchematicFile( newAbsoluteFilename,
m_sheet, &schematic );
603 msg = wxString::Format(
_(
"Error occurred saving schematic file '%s'." ),
604 newAbsoluteFilename );
607 msg = wxString::Format(
_(
"Failed to save schematic '%s'" ),
608 newAbsoluteFilename );
630 std::unique_ptr< SCH_SHEET> tmpSheet = std::make_unique<SCH_SHEET>( &schematic );
632 tmpSheet->GetFields()[
SHEETFILENAME].SetText( sheetFileName.GetFullPath() );
633 tmpSheet->SetScreen( useScreen );
648 else if( loadFromFile )
650 bool restoreSheet =
false;
652 if( isExistingSheet )
692 wxGridCellEditor*
editor =
m_grid->GetCellEditor( event.GetRow(), event.GetCol() );
693 wxControl* control =
editor->GetControl();
694 wxTextEntry* textControl =
dynamic_cast<wxTextEntry*
>( control );
700 if( textControl && textControl->IsEmpty() )
702 wxMessageBox(
_(
"A sheet must have a name." ) );
708 if( textControl->IsEmpty() )
710 wxMessageBox(
_(
"A sheet must have a file specified." ) );
715 if( success && control && control->GetValidator() )
716 success = control->GetValidator()->Validate( control );
743 wxGridTableMessage msg(
m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
744 m_grid->ProcessTableMessage( msg );
749 m_grid->EnableCellEditControl();
750 m_grid->ShowCellEditControl();
756 wxArrayInt selectedRows =
m_grid->GetSelectedRows();
758 if( selectedRows.empty() &&
m_grid->GetGridCursorRow() >= 0 )
759 selectedRows.push_back(
m_grid->GetGridCursorRow() );
761 if( selectedRows.empty() )
764 for(
int row : selectedRows )
768 DisplayError(
this, wxString::Format(
_(
"The first %d fields are mandatory." ),
777 selectedRows.Sort( [](
int* first,
int* second ) {
return *second - *first; } );
779 for(
int row : selectedRows )
784 wxGridTableMessage msg(
m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, row, 1 );
785 m_grid->ProcessTableMessage( msg );
787 if(
m_grid->GetNumberRows() > 0 )
789 m_grid->MakeCellVisible( std::max( 0, row-1 ),
m_grid->GetGridCursorCol() );
790 m_grid->SetGridCursor( std::max( 0, row-1 ),
m_grid->GetGridCursorCol() );
801 int i =
m_grid->GetGridCursorRow();
810 m_grid->SetGridCursor( i - 1,
m_grid->GetGridCursorCol() );
825 int i =
m_grid->GetGridCursorRow();
834 m_grid->SetGridCursor( i + 1,
m_grid->GetGridCursorCol() );
849 m_grid->AutoSizeColumn( 0 );
850 m_grid->SetColSize( 0, std::max( 72,
m_grid->GetColSize( 0 ) ) );
852 int fixedColsWidth =
m_grid->GetColSize( 0 );
854 for(
int i = 2; i <
m_grid->GetNumberCols(); i++ )
855 fixedColsWidth +=
m_grid->GetColSize( i );
857 m_grid->SetColSize( 1, std::max( 120, width - fixedColsWidth ) );
869 if( !
m_grid->IsCellEditControlShown() )
876 if(
path.Last() !=
'/' )
880 wxControl* control =
editor->GetControl();
881 wxTextEntry* textControl =
dynamic_cast<wxTextEntry*
>( control );
885 sheetName = textControl->GetValue();
900 path = wxControl::Ellipsize(
path, dc, wxELLIPSIZE_START, width, wxELLIPSIZE_FLAGS_NONE );
912 m_grid->EnableCellEditControl(
true );
913 m_grid->ShowCellEditControl();
923 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.
bool AllowCaseSensitiveFileNameClashes(const wxString &aOldName, const wxString &aSchematicFileName)
Check aSchematicFileName for a potential file name case sensitivity clashes.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
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.
This file is part of the common library.
@ 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().