59#include <dialogs/dialog_text_properties.h>
60#include <dialogs/dialog_tablecell_properties.h>
61#include <dialogs/dialog_table_properties.h>
67#include <wx/textdlg.h>
77 SetIcon( BITMAPS::component_select_unit );
98 const int unit = symbol->
GetUnit();
102 for(
int ii = 0; ii < nUnits; ii++ )
109 unit_text.Printf(
_(
"Unit %s" ), symbol->
SubReference( ii + 1,
false ) );
111 if( missingUnits.count( ii + 1 ) == 0 )
112 unit_text +=
_(
" (already placed)" );
130 item->Enable( missingUnits.size() );
142 SetIcon( BITMAPS::body_style );
165 item->Check( symbol->
GetBodyStyle() == BODY_STYLE::BASE );
168 item->Check( symbol->
GetBodyStyle() != BODY_STYLE::BASE );
179 SetIcon( BITMAPS::component_select_unit );
204 if(
pin->GetAlt().IsEmpty() )
247 if( !
pin && !sheetPin )
275 wxASSERT_MSG( drawingTools,
"eeshema.InteractiveDrawing tool is not available" );
283 auto sheetHasUndefinedPins =
286 if( aSel.Size() == 1 && aSel.Front()->Type() ==
SCH_SHEET_T )
287 return static_cast<SCH_SHEET*
>( aSel.Front() )->HasUndefinedPins();
295 return std::all_of( aSel.Items().begin(), aSel.Items().end(),
298 return !item->IsType( { SCH_SYMBOL_T } )
299 ||
static_cast<const SCH_SYMBOL*
>( item )->GetDNP();
303 auto attribExcludeFromSimCond =
306 return std::all_of( aSel.Items().begin(), aSel.Items().end(),
309 return !item->IsType( { SCH_SYMBOL_T } )
310 ||
static_cast<const SCH_SYMBOL*
>( item )->GetExcludedFromSim();
314 auto attribExcludeFromBOMCond =
317 return std::all_of( aSel.Items().begin(), aSel.Items().end(),
320 return !item->IsType( { SCH_SYMBOL_T } )
321 ||
static_cast<const SCH_SYMBOL*
>( item )->GetExcludedFromBOM();
326 auto attribExcludeFromBoardCond =
329 return std::all_of( aSel.Items().begin(), aSel.Items().end(),
332 return !item->IsType( { SCH_SYMBOL_T } )
333 ||
static_cast<const SCH_SYMBOL*
>( item )->GetExcludedFromBoard();
359 auto duplicateCondition =
368 auto orientCondition =
377 auto propertiesCondition =
380 if( aSel.GetSize() == 0 )
397 if( !firstItem || !eeSelection )
400 switch( firstItem->
Type() )
417 return aSel.GetSize() == 1;
422 if( std::all_of( aSel.Items().begin(), aSel.Items().end(),
426 &&
static_cast<const SCH_LINE*
>( item )->IsGraphicLine();
431 else if( std::all_of( aSel.Items().begin(), aSel.Items().end(),
439 else if( std::all_of( aSel.Items().begin(), aSel.Items().end(),
444 wxCHECK( schItem,
false );
460 auto autoplaceCondition =
474 static const std::vector<KICAD_T> allTextTypes = {
SCH_LABEL_T,
492 static const std::vector<KICAD_T> toCLabelTypes = {
SCH_LABEL_T,
501 static const std::vector<KICAD_T> toHLabelTypes = {
SCH_LABEL_T,
510 static const std::vector<KICAD_T> toGLabelTypes = {
SCH_LABEL_T,
519 static const std::vector<KICAD_T> toTextTypes = {
SCH_LABEL_T,
528 static const std::vector<KICAD_T> toTextBoxTypes = {
SCH_LABEL_T,
543 auto makeSymbolUnitMenu =
546 std::shared_ptr<SYMBOL_UNIT_MENU> menu = std::make_shared<SYMBOL_UNIT_MENU>();
547 menu->SetTool( tool );
548 tool->GetToolMenu().RegisterSubMenu( menu );
552 auto makeBodyStyleMenu =
555 std::shared_ptr<BODY_STYLE_MENU> menu = std::make_shared<BODY_STYLE_MENU>();
556 menu->SetTool( tool );
557 tool->GetToolMenu().RegisterSubMenu( menu );
561 auto makePinFunctionMenu =
564 std::shared_ptr<ALT_PIN_FUNCTION_MENU> menu = std::make_shared<ALT_PIN_FUNCTION_MENU>();
565 menu->SetTool( tool );
566 tool->GetToolMenu().RegisterSubMenu( menu );
570 auto makePinTricksMenu =
573 std::shared_ptr<PIN_TRICKS_MENU> menu = std::make_shared<PIN_TRICKS_MENU>();
574 menu->SetTool( tool );
575 tool->GetToolMenu().RegisterSubMenu( menu );
579 auto makeTransformMenu =
583 menu->
SetTitle(
_(
"Transform Selection" ) );
593 auto makeAttributesMenu =
607 auto makeEditFieldsMenu =
611 menu->
SetTitle(
_(
"Edit Main Fields" ) );
620 auto makeConvertToMenu =
660 moveMenu.AddMenu( makeTransformMenu(), orientCondition, 200 );
666 moveMenu.AddSeparator();
687 drawMenu.
AddMenu( makeTransformMenu(), orientCondition, 200 );
711 selToolMenu.
AddMenu( makeTransformMenu(), orientCondition, 200 );
723 selToolMenu.
AddMenu( makeConvertToMenu(), toChangeCondition, 200 );
785 int principalItemCount = 0;
792 commit = &localCommit;
794 for(
unsigned ii = 0; ii < selection.
GetSize(); ii++ )
801 principalItemCount++;
810 if( principalItemCount == 1 )
822 switch( head->
Type() )
828 symbol->
Rotate( rotPoint, !clockwise );
891 head->
Rotate( rotPoint, !clockwise );
913 head->
Rotate( rotPoint, !clockwise );
923 table->Rotate( rotPoint, !clockwise );
931 head->
Rotate( rotPoint, !clockwise );
943 sheet->
Rotate( rotPoint, !clockwise );
962 for(
EDA_ITEM* edaItem : selection )
978 line->
Rotate( rotPoint, !clockwise );
1005 field->
Rotate( rotPoint, !clockwise );
1021 table->Rotate( rotPoint, !clockwise );
1024 table->Move( beforeCenter -
table->GetCenter() );
1028 item->
Rotate( rotPoint, !clockwise );
1052 if( !localCommit.
Empty() )
1053 localCommit.
Push(
_(
"Rotate" ) );
1064 if( selection.
GetSize() == 0 )
1069 bool connections =
false;
1075 commit = &localCommit;
1077 if( selection.
GetSize() == 1 )
1082 switch( item->
Type() )
1172 else if( selection.
GetSize() > 1 )
1176 for(
EDA_ITEM* edaItem : selection )
1178 item =
static_cast<SCH_ITEM*
>( edaItem );
1227 for(
EDA_ITEM* selected : selection )
1250 if( !localCommit.
Empty() )
1251 localCommit.
Push(
_(
"Mirror" ) );
1288 std::vector<SCH_FIELD>& aBFields,
1289 unsigned aFallbackRotationsCCW )
1291 std::set<wxString> handledKeys;
1300 const VECTOR2I bRelPos = bField.GetPosition() - bField.GetParentPosition();
1303 const EDA_ANGLE bTextAngle = bField.GetTextAngle();
1310 bField.SetPosition( bField.GetParentPosition() + aRelPos );
1311 bField.SetHorizJustify( aTextJustifyH );
1312 bField.SetVertJustify( aTextJustifyV );
1313 bField.SetTextAngle( aTextAngle );
1320 auto it = std::find_if( aBFields.begin(), aBFields.end(),
1323 return bField.GetCanonicalName() == name;
1326 if( it != aBFields.end() )
1330 swapFieldTextProps( aField, bField );
1335 for(
unsigned ii = 0; ii < aFallbackRotationsCCW; ii++ )
1342 handledKeys.insert(
name );
1349 const wxString bName = bField.GetCanonicalName();
1350 if( handledKeys.find( bName ) == handledKeys.end() )
1352 for(
unsigned ii = 0; ii < aFallbackRotationsCCW; ii++ )
1354 bField.Rotate( bField.GetParentPosition(),
false );
1380 if(
pin->GetParent() != parent )
1385 if( selection.
Size() < 2 )
1389 bool appendUndo = isMoving;
1390 bool connections =
false;
1392 for(
size_t i = 0; i < sorted.size() - 1; i++ )
1398 std::swap( aPos, bPos );
1411 std::swap( aSide, bSide );
1439 std::vector<SCH_FIELD>& aFields = aLabelBase.
GetFields();
1440 std::vector<SCH_FIELD>& bFields = bLabelBase.
GetFields();
1442 const unsigned rotationsAtoB = aSpinStyle.
CCWRotationsTo( bSpinStyle );
1452 std::swap( aOrient, bOrient );
1468 for(
EDA_ITEM* selected : selection )
1494 if( sourceItems.empty() )
1502 for(
const std::unique_ptr<SCH_ITEM>& item : sourceItems )
1507 bool restore_state =
false;
1542 const wxString originalFileName = sheet->
GetFileName();
1570 static_cast<SCH_SYMBOL*
>( newItem )->ClearAnnotation(
nullptr,
false );
1575 annotateStartNum,
false,
false, reporter );
1590 newItems.
Add( newItem );
1597 commit.
Push(
_(
"Repeat Item" ) );
1602 if( !newItems.
Empty() )
1605 for(
size_t ii = 1; ii < newItems.
GetSize(); ++ii )
1643 std::vector<VECTOR2I> pts;
1644 bool updateHierarchy =
false;
1665 pts.insert( pts.end(), tmp_pts.begin(), tmp_pts.end() );
1688 static_cast<SCH_FIELD*
>( sch_item )->SetVisible(
false );
1694 static_cast<SCH_TABLECELL*
>( sch_item )->SetText( wxEmptyString );
1720 commit.
Push(
_(
"Delete" ) );
1722 if( updateHierarchy )
1729#define HITTEST_THRESHOLD_PIXELS 5
1746 [
this](
const VECTOR2D& aPosition ) ->
bool
1785 [
this](
const int& aFinalState )
1818 caption.Printf(
_(
"Edit %s Field" ),
TitleCaps( fieldName ) );
1822 caption.Printf(
_(
"Edit '%s' Field" ), aField->
GetName() );
1842 if( !commit.
Empty() )
1843 commit.
Push( caption );
1853 if( sel.
Size() != 1 )
1856 bool clearSelection = sel.
IsHover();
1898 clearSelection =
true;
1922 if( clearSelection )
1934 bool moving = head && head->
IsMoving();
1936 if( selection.
Empty() )
1939 std::vector<SCH_ITEM*> autoplaceItems;
1941 for(
unsigned ii = 0; ii < selection.
GetSize(); ii++ )
1946 autoplaceItems.push_back( item );
1951 for(
SCH_ITEM* sch_item : autoplaceItems )
1953 if( !moving && !sch_item->IsNew() )
1967 if( !commit.
Empty() )
1968 commit.
Push(
_(
"Autoplace Fields" ) );
1983 if( !selection.
Empty() )
2010 if( selection.
Empty() )
2029 if( !symbol->
IsNew() )
2034 if( symbol->
IsNew() )
2037 if( !commit.
Empty() )
2038 commit.
Push(
_(
"Change Body Style" ) );
2050 bool clearSelection = selection.
IsHover();
2052 if( selection.
Empty() )
2077 switch( curr_item->
Type() )
2086 if( selection.
Size() > 1 )
2092 switch( curr_item->
Type() )
2129 if( wxWindow* blocking_win =
editor->Kiway().GetBlockingDialog() )
2130 blocking_win->Close(
true );
2136 editor->LoadSymbolFromSchematic( symbol );
2147 if( wxWindow* blocking_win =
editor->Kiway().GetBlockingDialog() )
2148 blocking_win->Close(
true );
2172 bool isUndoable =
false;
2173 bool doClearAnnotation =
false;
2174 bool okPressed =
false;
2175 bool updateHierarchyNavigator =
false;
2186 &doClearAnnotation, &updateHierarchyNavigator );
2192 commit.
Push(
_(
"Edit Sheet Properties" ) );
2196 std::vector<SCH_ITEM*> items;
2198 items.emplace_back( sheet );
2216 if( doClearAnnotation )
2232 if( updateHierarchyNavigator )
2261 std::vector<SCH_TABLECELL*> cells;
2309 clearSelection =
true;
2339 dlg.SetTitle(
_(
"Rule Area Properties" ) );
2350 std::deque<SCH_LINE*> lines;
2353 lines.push_back(
static_cast<SCH_LINE*
>( selItem ) );
2361 std::deque<SCH_JUNCTION*> junctions;
2364 junctions.push_back(
static_cast<SCH_JUNCTION*
>( selItem ) );
2375 std::deque<SCH_ITEM*> items;
2378 items.push_back(
static_cast<SCH_ITEM*
>( selItem ) );
2396 if( inspectionTool )
2406 wxFAIL_MSG( wxString(
"Cannot edit schematic item type " ) + curr_item->
GetClass() );
2411 if( clearSelection )
2426 for(
unsigned int i = 0; i < selection.GetSize(); ++i )
2430 if( item && item->
Type() != convertTo )
2441 switch( item->
Type() )
2461 txt =
_(
"<empty>" );
2472 txt =
text->GetText();
2473 href =
text->GetHyperlink();
2493 int textSize =
text->GetTextSize().y;
2536 auto getValidNetname =
2537 [](
const wxString& aText )
2539 wxString local_txt = aText;
2540 local_txt.Replace(
"\n",
"_" );
2541 local_txt.Replace(
"\r",
"_" );
2542 local_txt.Replace(
"\t",
"_" );
2546 local_txt.Replace(
" ",
"_" );
2551 if( local_txt.IsEmpty() )
2552 return _(
"<empty>" );
2580 newtext = new_label;
2605 newtext = new_label;
2630 newtext = new_label;
2644 SCH_FIELD netclass( position, FIELD_T::USER, new_label, wxT(
"Netclass" ) );
2647 new_label->
GetFields().push_back( netclass );
2650 new_label->
SetShape( LABEL_FLAG_SHAPE::F_ROUND );
2654 newtext = new_label;
2674 bbox.
Inflate( -label->GetLabelBoxExpansion() );
2705 new_textbox->
SetEnd( botRight );
2708 newtext = new_textbox;
2717 wxCHECK2( newtext,
continue );
2728 wxCHECK2( eda_text && new_eda_text,
continue );
2743 if( label && new_label )
2752 return field.GetId() == FIELD_T::INTERSHEET_REFS
2753 && new_label->Type() != SCH_GLOBAL_LABEL_T;
2760 if( !item->
IsNew() )
2778 if( !commit.
Empty() )
2779 commit.
Push(
_(
"Change To" ) );
2781 if( selection.IsHover() )
2790 static std::vector<KICAD_T> justifiableItems = {
2799 if( selection.
GetSize() == 0 )
2808 commit = &localCommit;
2821 for(
EDA_ITEM* edaItem : selection )
2823 item =
static_cast<SCH_ITEM*
>( edaItem );
2830 setJustify(
static_cast<SCH_FIELD*
>( item ) );
2837 setJustify(
static_cast<SCH_TEXT*
>( item ) );
2848 setJustify( label );
2855 for(
EDA_ITEM* selected : selection )
2869 if( !localCommit.
Empty() )
2872 localCommit.
Push(
_(
"Left Justify" ) );
2874 localCommit.
Push(
_(
"Center Justify" ) );
2876 localCommit.
Push(
_(
"Right Justify" ) );
2891 std::vector<SCH_LINE*> lines;
2900 lines.push_back( line );
2911 if( lines.size() == 1 && line->HitTest( cursorPos ) )
2934 if( !lines.empty() )
2939 commit.
Push( isSlice ?
_(
"Slice Wire" ) :
_(
"Break Wire" ) );
2960 if( !
IsOK(
m_frame,
_(
"Do you wish to delete the unreferenced pins from this sheet?" ) ) )
2969 commit.
Push(
_(
"Cleanup Sheet Pins" ) );
3003 if( prevInstance.
size() )
3021 msg.Printf(
_(
"Enter page number for sheet path%s" ),
3022 ( sheetPath.Length() > 20 ) ?
"\n" + sheetPath :
" " + sheetPath );
3024 wxTextEntryDialog dlg(
m_frame, msg,
_(
"Edit Sheet Page Number" ), pageNumber );
3026 dlg.SetTextValidator( wxFILTER_ALPHANUMERIC );
3028 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetValue() == instance.
GetPageNumber() )
3033 commit.
Modify( sheet, screen );
3043 commit.
Push( wxS(
"Change Sheet Page Number" ) );
3059 if( selection.
Empty() )
3063 bool allSameType =
true;
3067 if( item->Type() != type )
3069 allSameType =
false;
3089 commit = &localCommit;
3091 const auto modifyItem =
3102 switch( item->Type() )
3117 modifyItem( label );
3128 commit->
Push(
_(
"Increment" ) );
3144 std::set<std::pair<SCH_SYMBOL*, SCH_SCREEN*>>& aCollectedUnits )
3165 std::vector<SCH_SYMBOL*> otherUnits;
3170 aCollectedUnits.insert( { otherUnit, screen } );
3183 std::set<std::pair<SCH_SYMBOL*, SCH_SCREEN*>> collectedUnits;
3186 bool new_state =
false;
3188 for(
const auto& [symbol,
_] : collectedUnits )
3200 for(
const auto& [symbol, screen] : collectedUnits )
3202 commit.
Modify( symbol, screen );
3205 symbol->SetDNP( new_state );
3208 symbol->SetExcludedFromSim( new_state );
3211 symbol->SetExcludedFromBOM( new_state );
3214 symbol->SetExcludedFromBoard( new_state );
3217 if( !commit.
Empty() )
3218 commit.
Push(
_(
"Toggle Attribute" ) );
constexpr EDA_IU_SCALE schIUScale
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
static TOOL_ACTION decrementPrimary
static TOOL_ACTION unselectAll
static TOOL_ACTION decrementSecondary
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
static TOOL_ACTION unselectItem
static TOOL_ACTION pickerTool
static TOOL_ACTION pasteSpecial
static TOOL_ACTION rightJustify
static TOOL_ACTION pageSettings
static TOOL_ACTION selectionActivate
Activation of the selection tool.
static TOOL_ACTION incrementSecondary
static TOOL_ACTION duplicate
static TOOL_ACTION incrementPrimary
static TOOL_ACTION doDelete
static TOOL_ACTION deleteTool
static TOOL_ACTION increment
static TOOL_ACTION selectionClear
Clear the current selection.
static TOOL_ACTION leftJustify
static TOOL_ACTION copyAsText
static TOOL_ACTION refreshPreview
static TOOL_ACTION selectAll
static TOOL_ACTION centerJustify
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
void SetPageNumber(const wxString &aPageNumber)
void update() override
Update menu state stub.
ACTION_MENU * create() const override
Return an instance of this class. It has to be overridden in inheriting classes.
constexpr const Vec & GetPosition() const
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
constexpr const Vec GetEnd() const
constexpr void SetOrigin(const Vec &pos)
constexpr Vec Centre() const
constexpr const Vec GetCenter() const
constexpr coord_type GetLeft() const
constexpr const Vec & GetOrigin() const
constexpr coord_type GetRight() const
constexpr void SetEnd(coord_type x, coord_type y)
constexpr coord_type GetTop() const
constexpr coord_type GetBottom() const
int GetCount() const
Return the number of objects in the list.
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Remove a new item from the model.
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Modify a given item in the model.
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
COMMIT & Removed(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Dialog to update or change schematic library symbols.
This class is setup in expectation of its children possibly using Kiway player so DIALOG_SHIM::ShowQu...
void UpdateField(SCH_FIELD *aField)
Dialog used to edit SCH_SYMBOL objects in a schematic.
@ TABLECELL_PROPS_EDIT_TABLE
enum TABLECELL_PROPS_RETVALUE GetReturnValue()
bool HitTestDrawingSheetItems(KIGFX::VIEW *aView, const VECTOR2I &aPosition)
bool IsHorizontal() const
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
void ShowInfoBarWarning(const wxString &aWarningMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left ...
VECTOR2I GetNearestGridPosition(const VECTOR2I &aPosition) const
Return the nearest aGridSize location to aPosition.
VECTOR2I GetNearestHalfGridPosition(const VECTOR2I &aPosition) const
Return the nearest aGridSize / 2 location to aPosition.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
A base class for most all the KiCad significant classes used in schematics and boards.
virtual VECTOR2I GetPosition() const
virtual void SetPosition(const VECTOR2I &aPos)
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
EDA_ITEM_FLAGS GetEditFlags() const
void SetFlags(EDA_ITEM_FLAGS aMask)
KICAD_T Type() const
Returns the type of object.
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
virtual bool IsType(const std::vector< KICAD_T > &aScanTypes) const
Check whether the item is one of the listed types.
virtual void SetParent(EDA_ITEM *aParent)
EDA_ITEM * GetParent() const
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
virtual wxString GetClass() const =0
Return the class name.
void SetEnd(const VECTOR2I &aEnd)
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
const EDA_ANGLE & GetTextAngle() const
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual bool IsVisible() const
KIFONT::FONT * GetFont() const
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
wxString GetHyperlink() const
GR_TEXT_H_ALIGN_T GetHorizJustify() const
virtual void SetVisible(bool aVisible)
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
void SetBold(bool aBold)
Set the text to be bold - this will also update the font if needed.
void SetHyperlink(wxString aLink)
GR_TEXT_V_ALIGN_T GetVertJustify() const
virtual void SetText(const wxString &aText)
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
int GetTextThickness() const
void SetItalic(bool aItalic)
Set the text to be italic - this will also update the font if needed.
void SetFont(KIFONT::FONT *aFont)
VECTOR2I GetTextSize() const
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
PANEL_ANNOTATE m_AnnotatePanel
AUTOPLACE_FIELDS m_AutoplaceFields
DS_PROXY_VIEW_ITEM * GetDrawingSheet() const
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
void RecacheAllItems()
Rebuild GAL display lists.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
A logical library item identifier and consists of various portions much like a URI.
static bool ParseBusGroup(const wxString &aGroup, wxString *name, std::vector< wxString > *aMemberList)
Parse a bus group label into the name and a list of components.
A singleton reporter that reports to nowhere.
virtual SETTINGS_MANAGER & GetSettingsManager() const
These are loaded from Eeschema settings but then overwritten by the project settings.
void OnItemsAdded(std::vector< SCH_ITEM * > &aNewItems)
Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners.
void OnItemsRemoved(std::vector< SCH_ITEM * > &aRemovedItems)
Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners.
SCHEMATIC_SETTINGS & Settings() const
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
static TOOL_ACTION rotateCCW
static TOOL_ACTION placeClassLabel
static TOOL_ACTION placeNextSymbolUnit
static TOOL_ACTION editValue
static TOOL_ACTION setExcludeFromBOM
static TOOL_ACTION mirrorV
static TOOL_ACTION clearHighlight
static TOOL_ACTION placeGlobalLabel
static TOOL_ACTION changeSymbols
static TOOL_ACTION updateSymbol
static TOOL_ACTION autoplaceFields
static TOOL_ACTION changeSymbol
static TOOL_ACTION showDeMorganAlternate
static TOOL_ACTION toCLabel
static TOOL_ACTION properties
static TOOL_ACTION editReference
static TOOL_ACTION breakWire
static TOOL_ACTION toggleDeMorgan
static TOOL_ACTION placeHierLabel
static TOOL_ACTION placeLabel
static TOOL_ACTION toText
static TOOL_ACTION toHLabel
static TOOL_ACTION rotateCW
static TOOL_ACTION importSheet
static TOOL_ACTION toLabel
static TOOL_ACTION setDNP
static TOOL_ACTION editWithLibEdit
static TOOL_ACTION cleanupSheetPins
static TOOL_ACTION mirrorH
static TOOL_ACTION setExcludeFromSimulation
static TOOL_ACTION ddAppendFile
static TOOL_ACTION placeSchematicText
static TOOL_ACTION toTextBox
static TOOL_ACTION updateSymbols
static TOOL_ACTION enterSheet
static TOOL_ACTION editFootprint
static TOOL_ACTION repeatDrawItem
static TOOL_ACTION editTextAndGraphics
static TOOL_ACTION editPageNumber
static TOOL_ACTION showDeMorganStandard
static TOOL_ACTION toGLabel
static TOOL_ACTION setExcludeFromBoard
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EESCHEMA_SETTINGS * eeconfig() const
void RemoveFromScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Remove an item from the screen (and view) aScreen is the screen the item is located on,...
Object to handle a bitmap image that can be inserted in a schematic.
static const std::vector< KICAD_T > FieldOwners
void Collect(SCH_SCREEN *aScreen, const std::vector< KICAD_T > &aScanTypes, const VECTOR2I &aPos, int aUnit=0, int aConvert=0)
Scan a EDA_ITEM using this class's Inspector method which does the collection.
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Execute the changes.
virtual void Revert() override
Revert the commit by restoring the modified items state.
static SELECTION_CONDITION SingleMultiFunctionPin
static SELECTION_CONDITION SingleSymbol
static SELECTION_CONDITION MultipleSymbolsOrPower
static SELECTION_CONDITION AllPinsOrSheetPins
static SELECTION_CONDITION SingleDeMorganSymbol
static SELECTION_CONDITION SingleSymbolOrPower
static SELECTION_CONDITION SingleMultiUnitSymbol
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Schematic editor (Eeschema) main window.
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 SchematicCleanUp(SCH_COMMIT *aCommit, SCH_SCREEN *aScreen=nullptr)
Perform routine schematic cleaning including breaking wire and buses and deleting identical objects s...
void AnnotateSymbols(SCH_COMMIT *aCommit, ANNOTATE_SCOPE_T aAnnotateScope, ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption, bool aRecursive, int aStartNumber, bool aResetAnnotation, bool aRepairTimestamps, REPORTER &aReporter)
Annotate the symbols in the schematic that are not currently annotated.
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
const std::vector< std::unique_ptr< SCH_ITEM > > & GetRepeatItems() const
Return the items which are to be repeated with the insert key.
bool EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aIsUndoable=nullptr, bool *aClearAnnotationNewItems=nullptr, bool *aUpdateHierarchyNavigator=nullptr, wxString *aSourceSheetFilename=nullptr)
Edit an existing sheet or add a new sheet to the schematic.
void UpdateHierarchyNavigator(bool aRefreshNetNavigator=true, bool aClear=false)
Update the hierarchy navigation tree and history.
void FlipBodyStyle(SCH_SYMBOL *aSymbol)
void OnPageSettingsChange() override
Called when modifying the page settings.
bool CheckSheetForRecursion(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet)
Verify that aSheet will not cause a recursion error in aCurrentSheet.
void BreakSegment(SCH_COMMIT *aCommit, SCH_LINE *aSegment, const VECTOR2I &aPoint, SCH_LINE **aNewSegment, SCH_SCREEN *aScreen)
Break a single segment into two at the specified point.
const wxString & GetHighlightedConnection() const
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
Mark an item for refresh.
void AddCopyForRepeatItem(const SCH_ITEM *aItem)
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
void DeleteJunction(SCH_COMMIT *aCommit, SCH_ITEM *aItem)
Remove a given junction and heals any wire segments under the junction.
void SaveCopyForRepeatItem(const SCH_ITEM *aItem)
Clone aItem and owns that clone in this container.
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
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,...
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
void SetPosition(const VECTOR2I &aPosition) override
void SetText(const wxString &aText) override
VECTOR2I GetParentPosition() const
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual bool IsConnectable() const
virtual void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo)
const SYMBOL * GetParentSymbol() const
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
virtual void MirrorHorizontally(int aCenter)
Mirror item horizontally about aCenter.
virtual void Move(const VECTOR2I &aMoveVector)
Move the item by aMoveVector to a new position.
void SetFieldsAutoplaced(AUTOPLACE_ALGO aAlgo)
virtual void Rotate(const VECTOR2I &aCenter, bool aRotateCCW)
Rotate the item around aCenter 90 degrees in the clockwise direction.
AUTOPLACE_ALGO GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
wxString GetClass() const override
Return the class name.
virtual bool HasLineStroke() const
Check if this schematic item has line stoke properties.
virtual std::vector< VECTOR2I > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
SCH_ITEM * Duplicate(bool doClone=false) const
Routine to create a new copy of given item.
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
virtual void MirrorVertically(int aCenter)
Mirror item vertically about aCenter.
void AddFields(const std::vector< SCH_FIELD > &aFields)
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
SPIN_STYLE GetSpinStyle() const
void SetShape(LABEL_FLAG_SHAPE aShape)
LABEL_FLAG_SHAPE GetShape() const
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
std::vector< SCH_FIELD > & GetFields()
virtual void SetSpinStyle(SPIN_STYLE aSpinStyle)
Segment description base class to describe items which have 2 end points (track, wire,...
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
VECTOR2I GetEndPoint() const
VECTOR2I GetStartPoint() const
bool IsEndPoint(const VECTOR2I &aPoint) const
const std::map< wxString, ALT > & GetAlternates() const
const wxString & GetName() const
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
void ClearAnnotationOfNewSheetPaths(SCH_SHEET_LIST &aInitialSheetPathList)
Clear the annotation for the symbols inside new sheetpaths when a complex hierarchy is modified and n...
bool IsExplicitJunction(const VECTOR2I &aPosition) const
Indicate that a junction dot is necessary at the given location.
EE_RTREE & Items()
Get the full RTree, usually for iterating.
const wxString & GetFileName() const
SCH_ITEM * GetItem(const VECTOR2I &aPosition, int aAccuracy=0, KICAD_T aType=SCH_LOCATE_ANY_T) const
Check aPosition within a distance of aAccuracy for items of type aFilter.
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
void ClearAnnotation(SCH_SHEET_PATH *aSheetPath, bool aResetPrefix)
Clear the annotation for the symbols in aSheetPath on the screen.
void SetPosition(const VECTOR2I &aPos) override
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void BuildSheetList(SCH_SHEET *aSheet, bool aCheckIntegrity)
Build the list of sheets and their sheet path from aSheet.
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.
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
size_t size() const
Forwarded method from std::vector.
void pop_back()
Forwarded method from std::vector.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
SHEET_SIDE GetSide() const
SCH_SHEET * GetParent() const
Get the parent sheet object of this sheet pin.
void SetSide(SHEET_SIDE aEdge)
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
void SetFileName(const wxString &aFilename)
wxString GetFileName() const
Return the filename corresponding to this sheet.
VECTOR2I GetRotationCenter() const
Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer t...
void CleanupSheet()
Delete sheet label which do not have a corresponding hierarchical label.
void RemovePin(const SCH_SHEET_PIN *aSheetPin)
Remove aSheetPin from the sheet.
bool HasUndefinedPins() const
Check all sheet labels against schematic for undefined hierarchical labels.
SCH_SCREEN * GetScreen() const
const BOX2I GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
wxString SubReference(int aUnit, bool aAddSeparator=true) const
bool IsAnnotated(const SCH_SHEET_PATH *aSheet) const
Check if the symbol has a valid annotation (reference) for the given sheet path.
void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
Automatically orient all the fields in the symbol.
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
bool IsMissingLibSymbol() const
Check to see if the library symbol is set to the dummy library symbol.
const LIB_ID & GetLibId() const override
int GetOrientation() const override
Get the display symbol orientation.
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
bool IsPower() const override
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this symbol.
int GetMarginBottom() const
int GetLegacyTextMargin() const
int GetMarginLeft() const
int GetMarginRight() const
virtual void Rotate90(bool aClockwise)
virtual void MirrorSpinStyle(bool aLeftRight)
static SELECTION_CONDITION HasTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if among the selected items there is at least one of a given types.
static SELECTION_CONDITION HasType(KICAD_T aType)
Create a functor that tests if among the selected items there is at least one of a given type.
static bool NotEmpty(const SELECTION &aSelection)
Test if there are any items selected.
static SELECTION_CONDITION MoreThan(int aNumber)
Create a functor that tests if the number of selected items is greater than the value given as parame...
static bool Idle(const SELECTION &aSelection)
Test if there no items selected or being edited.
static bool IdleSelection(const SELECTION &aSelection)
Test if all selected items are not being edited.
static SELECTION_CONDITION Count(int aNumber)
Create a functor that tests if the number of selected items is equal to the value given as parameter.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
static SELECTION_CONDITION OnlyTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if the selected items are only of given types.
virtual void Add(EDA_ITEM *aItem)
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
const std::deque< EDA_ITEM * > GetItems() const
VECTOR2I GetReferencePoint() const
virtual VECTOR2I GetCenter() const
Returns the center point of the selection area bounding box.
virtual unsigned int GetSize() const override
Return the number of stored items.
int Size() const
Returns the number of selected parts.
std::deque< EDA_ITEM * > & Items()
std::vector< EDA_ITEM * > GetItemsSortedBySelectionOrder() const
bool OnlyContains(std::vector< KICAD_T > aList) const
Checks if all items in the selection have a type in aList.
bool Empty() const
Checks if there is anything selected.
bool HasReferencePoint() const
size_t CountType(KICAD_T aType) const
T * GetAppSettings(const char *aFilename)
Return a handle to the a given settings by type.
unsigned CCWRotationsTo(const SPIN_STYLE &aOther) const
Get CCW rotation needed to get to the given spin style.
Heuristically increment a string's n'th part from the right.
void SetSkipIOSQXZ(bool aSkip)
If a alphabetic part is found, skip the letters I, O, S, Q, X, Z.
std::optional< wxString > Increment(const wxString &aStr, int aDelta, size_t aRightIndex) const
Increment the n-th part from the right of the given string.
The symbol library editor main window.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
This file is part of the common library.
@ SYMBOL_PROPS_EDIT_SCHEMATIC_SYMBOL
@ SYMBOL_PROPS_WANT_EXCHANGE_SYMBOL
@ SYMBOL_PROPS_WANT_UPDATE_SYMBOL
@ SYMBOL_PROPS_EDIT_LIBRARY_SYMBOL
static constexpr EDA_ANGLE ANGLE_90
static constexpr EDA_ANGLE ANGLE_VERTICAL
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
#define IS_NEW
New item, just created.
#define SELECTED_BY_DRAG
Item was algorithmically selected as a dragged item.
#define STRUCT_DELETED
flag indication structures to be erased
#define ENDPOINT
ends. (Used to support dragging.)
#define STARTPOINT
When a line is selected, these flags indicate which.
@ ID_POPUP_SCH_PIN_TRICKS_HIER_LABEL
@ ID_POPUP_SCH_PIN_TRICKS_WIRE
@ ID_POPUP_SCH_ALT_PIN_FUNCTION
@ ID_POPUP_SCH_SELECT_UNIT1
@ ID_POPUP_SCH_SELECT_UNIT
@ ID_POPUP_SCH_SELECT_BASE
@ ID_POPUP_SCH_SELECT_ALT
@ ID_POPUP_SCH_PIN_TRICKS_NET_LABEL
@ ID_POPUP_SCH_PIN_TRICKS_NO_CONNECT
@ ID_POPUP_SCH_SELECT_UNIT_END
@ ID_POPUP_SCH_ALT_PIN_FUNCTION_END
@ ID_POPUP_SCH_PIN_TRICKS_GLOBAL_LABEL
@ FRAME_SCH_SYMBOL_EDITOR
@ LAYER_SCHEMATIC_DRAWINGSHEET
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
#define UNIMPLEMENTED_FOR(type)
void delete_if(_Container &__c, _Function &&__f)
Deletes all values from __c for which __f returns true.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
PGM_BASE & Pgm()
The global program "get" accessor.
void CollectOtherUnits(const wxString &aRef, int aUnit, const LIB_ID &aLibId, SCH_SHEET_PATH &aSheet, std::vector< SCH_SYMBOL * > *otherUnits)
ANNOTATE_ORDER_T
Schematic annotation order options.
@ ANNOTATE_SELECTION
Annotate the selection.
ANNOTATE_ALGO_T
Schematic annotation type options.
SHEET_SIDE
Define the edge of the sheet that the sheet pin is positioned.
wxString UnescapeString(const wxString &aSource)
wxString TitleCaps(const wxString &aString)
Capitalize the first letter in each word.
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
constexpr int MilsToIU(int mils) const
int default_repeat_offset_x
int default_repeat_offset_y
int repeat_label_increment
wxString GetDefaultFieldName(FIELD_T aFieldId, bool aTranslateForHI)
Return a default symbol field name for a mandatory field type.
GR_TEXT_H_ALIGN_T
This is API surface mapped to common.types.HorizontalAlignment.
GR_TEXT_V_ALIGN_T
This is API surface mapped to common.types.VertialAlignment.
constexpr GR_TEXT_H_ALIGN_T GetFlippedAlignment(GR_TEXT_H_ALIGN_T aAlign)
Get the reverse alignment: left-right are swapped, others are unchanged.
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
VECTOR2< int32_t > VECTOR2I