KiCad PCB EDA Suite
SCH_EDIT_FRAME Class Reference

Schematic editor (Eeschema) main window. More...

#include <sch_edit_frame.h>

Inheritance diagram for SCH_EDIT_FRAME:
SCH_BASE_FRAME EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

Public Types

enum  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Function ClearUndoORRedoList (virtual). More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 SCH_EDIT_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~SCH_EDIT_FRAME () override
 
SCH_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
SCHEMATICSchematic () const
 
bool GetShowAllPins () const override
 Allow edit frame to show/hide hidden pins. More...
 
void SaveProjectSettings () override
 Save changes to the project settings to the project (.pro) file. More...
 
bool LoadProjectSettings ()
 Loads the KiCad project file (*.pro) settings specific to Eeschema. More...
 
void ShowSchematicSetupDialog (const wxString &aInitialPage=wxEmptyString)
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
void CreateScreens ()
 
void ReCreateHToolbar () override
 
void ReCreateVToolbar () override
 
void ReCreateOptToolbar () override
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
bool IsContentModified () override
 Get if the current schematic has been modified but not saved. More...
 
void OnModify () override
 Must be called after a schematic change in order to set the "modify" flag of the current screen and update the date in frame reference. More...
 
wxString GetScreenDesc () const override
 Return a human-readable description of the current screen. More...
 
void ExecuteRemoteCommand (const char *cmdline) override
 Execute a remote command sent by Pcbnew via a socket connection. More...
 
void KiwayMailIn (KIWAY_EXPRESS &aEvent) override
 Function KiwayMailIn receives KIWAY_EXPRESS messages from other players. More...
 
void AddItemToScreenAndUndoList (SCH_SCREEN *aScreen, SCH_ITEM *aItem, bool aUndoAppend)
 Add an item to the schematic and adds the changes to the undo/redo container. More...
 
void ShowFindReplaceDialog (bool aReplace)
 Run the Find or Find & Replace dialog. More...
 
void UpdateHierarchyNavigator (bool aForceUpdate=false)
 Run the Hierarchy Navigator dialog. More...
 
HIERARCHY_NAVIG_DLGFindHierarchyNavigator ()
 
void ShowFindReplaceStatus (const wxString &aMsg, int aStatusTime)
 
void ClearFindReplaceStatus ()
 
wxFindReplaceData * GetFindReplaceData ()
 Get the find criteria (as set by the dialog). More...
 
void OnFindDialogClose ()
 Notification that the Find dialog has closed. More...
 
bool BreakSegment (SCH_LINE *aSegment, const wxPoint &aPoint, SCH_LINE **aNewSegment=NULL, SCH_SCREEN *aScreen=nullptr)
 Breaks a single segment into two at the specified point. More...
 
bool BreakSegments (const wxPoint &aPoint, SCH_SCREEN *aScreen=nullptr)
 Checks every wire and bus for a intersection at aPoint and break into two segments at aPoint if an intersection is found. More...
 
bool BreakSegmentsOnJunctions (SCH_SCREEN *aScreen=nullptr)
 Tests all junctions and bus entries in the schematic for intersections with wires and buses and breaks any intersections into multiple segments. More...
 
bool TestDanglingEnds ()
 Test all of the connectable objects in the schematic for unused connection points. More...
 
void SendMessageToPCBNEW (EDA_ITEM *aObjectToSync, SCH_COMPONENT *aPart)
 Send a message to Pcbnew via a socket connection. More...
 
void SendCrossProbeNetName (const wxString &aNetName)
 Sends a net name to pcbnew for highlighting. More...
 
void SetCrossProbeConnection (const SCH_CONNECTION *aConnection)
 Sends a connection (net or bus) to pcbnew for highlighting. More...
 
void SendCrossProbeClearHighlight ()
 Tells PcbNew to clear the existing highlighted net, if one exists. More...
 
const SCH_CONNECTIONGetHighlightedConnection () const
 
void SetHighlightedConnection (const SCH_CONNECTION *aConnection)
 
bool ReadyToNetlist (bool aSilent=false, bool aSilentAnnotate=false)
 Checks if we are ready to write a netlist file for the current schematic. More...
 
bool WriteNetListFile (int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=NULL)
 Create a netlist file. More...
 
void DeleteAnnotation (bool aCurrentSheetOnly, bool *appendUndo)
 Clear the current component annotation. More...
 
void AnnotateComponents (bool aAnnotateSchematic, ANNOTATE_ORDER_T aSortOption, ANNOTATE_OPTION_T aAlgoOption, int aStartNumber, bool aResetAnnotation, bool aRepairTimestamps, bool aLockUnits, REPORTER &aReporter)
 Annotate the components in the schematic that are not currently annotated. More...
 
int CheckAnnotate (REPORTER &aReporter, bool aOneSheetOnly)
 Check for annotation errors. More...
 
int ModalAnnotate (const wxString &aMessage)
 Run a modal version of the Annotate dialog for a specific purpose. More...
 
SCH_SHEET_PATHGetCurrentSheet () const
 
void SetCurrentSheet (const SCH_SHEET_PATH &aSheet)
 
void HardRedraw () override
 Rebuild the GAL and redraw the screen. More...
 
void DisplayCurrentSheet ()
 Draw the current sheet on the display. More...
 
void DrawCurrentSheetToClipboard ()
 Use the wxWidgets print code to draw an image of the current sheet onto the clipboard. More...
 
void OnPageSettingsChange () override
 Called when modifying the page settings. More...
 
wxString GetUniqueFilenameForCurrentSheet ()
 
void SetSheetNumberAndCount ()
 Set the m_ScreenNumber and m_NumberOfScreens members for screens. More...
 
wxPageSetupDialogData & GetPageSetupData ()
 
void NewProject ()
 
void LoadProject ()
 
void Save_File (bool doSaveAs=false)
 
bool SaveProject ()
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
wxString GetCurrentFileName () const override
 Get the full filename + path of the currently opened file in the frame. More...
 
bool AppendSchematic ()
 Import a KiCad schematic into the current sheet. More...
 
bool SaveEEFile (SCH_SHEET *aSheet, bool aSaveUnderNewName=false)
 Save aSheet to a schematic file. More...
 
bool AskToSaveChanges ()
 Checks if any of the screens has unsaved changes and asks the user whether to save or drop them. More...
 
SCH_JUNCTIONAddJunction (SCH_SCREEN *aScreen, const wxPoint &aPos, bool aAppendToUndo, bool aFinal=true)
 
bool SchematicCleanUp (SCH_SCREEN *aScreen=nullptr)
 Performs routine schematic cleaning including breaking wire and buses and deleting identical objects superimposed on top of each other. More...
 
bool TrimWire (const wxPoint &aStart, const wxPoint &aEnd)
 If any single wire passes through both points, remove the portion between the two points, potentially splitting the wire into two. More...
 
std::vector< wxPointGetSchematicConnections ()
 Collects a unique list of all possible connection points in the schematic. More...
 
void OnOpenPcbnew (wxCommandEvent &event)
 
void OnOpenCvpcb (wxCommandEvent &event)
 
void OnUpdatePCB (wxCommandEvent &event)
 
void OnAnnotate (wxCommandEvent &event)
 
bool CheckSheetForRecursion (SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy)
 Verify that aSheet will not cause a recursion error in aHierarchy. More...
 
bool AllowCaseSensitiveFileNameClashes (const wxString &aSchematicFileName)
 Check aSchematicFileName for a potential file name case sensitivity clashes. More...
 
bool EditSheetProperties (SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aClearAnnotationNewItems)
 Edit an existing sheet or add a new sheet to the schematic. More...
 
void InitSheet (SCH_SHEET *aSheet, const wxString &aNewFilename)
 
bool LoadSheetFromFile (SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, const wxString &aFileName)
 Load a the KiCad schematic file aFileName into the sheet aSheet. More...
 
SCH_SHEET_PINCreateSheetPin (SCH_SHEET *aSheet, SCH_HIERLABEL *aLabel)
 Create a new SCH_SHEET_PIN object and add it to aSheet at the current cursor position. More...
 
SCH_HIERLABELImportHierLabel (SCH_SHEET *aSheet)
 Import a hierarchical label with no attached sheet pin. More...
 
void DeleteJunction (SCH_ITEM *aItem, bool aAppend=false)
 Removes a given junction and heals any wire segments under the junction. More...
 
void ConvertPart (SCH_COMPONENT *aComponent)
 
void SelectUnit (SCH_COMPONENT *aComponent, int aUnit)
 
void SaveCopyInUndoList (SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
 Create a copy of the current schematic item, and put it in the undo list. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
 Create a new entry in undo list of commands. More...
 
void PutDataInPreviousState (PICKED_ITEMS_LIST *aList, bool aRedoCommand)
 Restore an undo or redo command to put data pointed by aList in the previous state. More...
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Free the undo or redo list from aList element. More...
 
void SaveCopyForRepeatItem (SCH_ITEM *aItem)
 Clone aItem and owns that clone in this container. More...
 
SCH_ITEMGetRepeatItem () const
 Return the item which is to be repeated with the insert key. More...
 
EDA_ITEMGetItem (const KIID &aId) override
 Fetch an item by KIID. More...
 
void RollbackSchematicFromUndo ()
 Performs an undo of the last edit WITHOUT logging a corresponding redo. More...
 
bool CreateArchiveLibraryCacheFile (bool aUseCurrentSheetFilename=false)
 Create a symbol library file with the name of the root document plus the '-cache' suffix,. More...
 
bool CreateArchiveLibrary (const wxString &aFileName)
 Create a library aFileName that contains all components used in the current schematic. More...
 
virtual void PrintPage (RENDER_SETTINGS *aSettings) override
 Plot or print the current sheet to the clipboard. More...
 
void SetNetListerCommand (const wxString &aCommand)
 
void DefaultExecFlags ()
 Reset the execution flags to defaults for external netlist and bom generators. More...
 
void SetExecFlags (const int aFlags)
 Set (adds) specified flags for next execution of external generator of the netlist or bom. More...
 
void ClearExecFlags (const int aFlags)
 Clear (removes) specified flags that not needed for next execution of external generator of the netlist or bom. More...
 
wxString GetNetListerCommand () const
 
void RecalculateConnections (SCH_CLEANUP_FLAGS aCleanupFlags)
 Generates the connection data for the entire schematic hierarchy. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allows Eeschema to install its preferences panels into the preferences dialog. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Called after the preferences dialog is run. More...
 
void UpdateNetHighlightStatus ()
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
void SetScreen (BASE_SCREEN *aScreen) override
 
const BOX2I GetDocumentExtents () const override
 
void FixupJunctions ()
 
void FocusOnItem (SCH_ITEM *aItem)
 
void ConvertTimeStampUuids ()
 Convert sheet and symbol legacy time stamp UUIDs to full UUIDs. More...
 
void UpdateSymbolFromEditor (const LIB_PART &aSymbol)
 Update the LIB_PART of the currently selected symbol. More...
 
void createCanvas ()
 
SCH_DRAW_PANELGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
EESCHEMA_SETTINGSeeconfig () const
 
LIBEDIT_SETTINGSlibeditconfig () const
 
KIGFX::SCH_RENDER_SETTINGSGetRenderSettings ()
 
SCHEMATIC_SETTINGSGetDefaults ()
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPointGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
void UpdateStatusBar () override
 Update the status bar information. More...
 
COMPONENT_SELECTION SelectCompFromLibTree (const SCHLIB_FILTER *aFilter, std::vector< COMPONENT_SELECTION > &aHistoryList, bool aUseLibBrowser, int aUnit, int aConvert, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
 Function SelectComponentFromLib Calls the library viewer to select component to import into schematic. More...
 
LIB_PARTGetLibPart (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
 Load symbol from symbol library table. More...
 
LIB_PARTGetFlattenedLibPart (const LIB_ID &aLibId, bool aShowErrorMsg=false)
 
COMPONENT_SELECTION SelectComponentFromLibBrowser (wxTopLevelWindow *aParent, const SCHLIB_FILTER *aFilter, const LIB_ID &aPreselectedLibid, int aUnit, int aConvert)
 Function SelectComponentFromLibBrowser Calls the library viewer to select component to import into schematic. More...
 
virtual void RedrawScreen (const wxPoint &aCenterPoint, bool aWarpPointer)
 
virtual void CenterScreen (const wxPoint &aCenterPoint, bool aWarpPointer)
 
void AddToScreen (EDA_ITEM *aItem, SCH_SCREEN *aScreen)
 Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen. More...
 
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, if not the current screen. More...
 
void UpdateItem (EDA_ITEM *aItem, bool isAddOrDelete=false)
 Mark an item for refresh. More...
 
void RefreshSelection ()
 Mark selected items for refresh. More...
 
void SyncView ()
 Mark all items for refresh. More...
 
COLOR4D GetLayerColor (SCH_LAYER_ID aLayer)
 Helper to retrieve a layer color from the global color settings. More...
 
COLOR_SETTINGSGetColorSettings () override
 Returns a pointer to the active color theme settings. More...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
virtual ORIGIN_TRANSFORMSGetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
virtual COLOR4D GetGridColor ()
 
virtual void SetGridColor (COLOR4D aColor)
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid combobox. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom combobox. More...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the page layout with the frame and the basic inscriptions. More...
 
void DisplayToolMsg (const wxString &msg) override
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
virtual void DisplayGridMsg ()
 Display current grid size in the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
virtual void ActivateGalCanvas ()
 Use to start up the GAL drawing canvas. More...
 
virtual void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Changes the current rendering backend. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of ckeck tools. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handles command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual int GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions) override
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions)
 Register a UI update handler for the control with ID aID. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction) override
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (int aID)
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg)
 
void ShowInfoBarWarning (const wxString &aWarningMsg)
 
void ShowInfoBarMsg (const wxString &aMsg)
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handles events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More...
 

Protected Member Functions

bool doAutoSave () override
 Save the schematic files that have been modified and not yet saved. More...
 
bool isAutoSaveRequired () const override
 Returns true if the schematic has been modified. More...
 
void sendNetlistToCvpcb ()
 Send the kicad netlist over to CVPCB. More...
 
void onSize (wxSizeEvent &aEvent)
 
bool saveSymbolLibTables (bool aGlobal, bool aProject)
 Saves Symbol Library Tables to disk. More...
 
void unitsChangeRefresh () override
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 Function language_change is an event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

SCHEMATIC_SETTINGS m_base_frame_defaults
 These are only used by libedit. Eeschema should be using the one inside the SCHEMATIC. More...
 
SCHEMATIC_SETTINGSm_defaults
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
 prevents opening same file multiple times. More...
 
bool m_showPageLimits
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
int m_UndoRedoCountMax
 
bool m_PolarCoords
 
bool m_showBorderAndTitleBlock
 
long m_firstRunDialogSetting
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
ACTION_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
wxFindReplaceData * m_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_MsgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 The current canvas type. More...
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_Ident
 
wxPoint m_FramePos
 
wxSize m_FrameSize
 
wxPoint m_NormalFramePos
 
wxSize m_NormalFrameSize
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 
bool m_isClosing
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Private Member Functions

void setupTools ()
 
void OnExit (wxCommandEvent &event)
 
void OnLoadFile (wxCommandEvent &event)
 
void OnAppendProject (wxCommandEvent &event)
 
void OnImportProject (wxCommandEvent &event)
 
void OnClearFileHistory (wxCommandEvent &aEvent)
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
void doCloseWindow () override
 
void UpdateTitle ()
 Set the main window title bar text. More...
 
bool checkForNoFullyDefinedLibIds (SCH_SHEET *aSheet)
 Verify that the symbol library links aSheet and all of it's child sheets have been remapped to the symbol library table. More...
 
bool importFile (const wxString &aFileName, int aFileType)
 Load the given filename but sets the path to the current project path. More...
 
void mapExistingAnnotation (std::map< wxString, wxString > &aMap)
 Fills a map of uuid -> reference from the currently loaded schematic. More...
 

Private Attributes

SCHEMATICm_schematic
 The currently loaded schematic. More...
 
const SCH_CONNECTIONm_highlightedConn
 The highlighted net or bus, or nullptr. More...
 
wxPageSetupDialogData m_pageSetupData
 
SCH_ITEMm_item_to_repeat
 Last item to insert by the repeat command. More...
 
wxString m_netListerCommand
 Command line to call a custom net list generator. More...
 
int m_exec_flags
 Flags of the wxExecute() function to call a custom net list generator. More...
 
DIALOG_SCH_FINDm_findReplaceDialog
 

Static Private Attributes

static PINSHEETLABEL_SHAPE m_lastSheetPinType = PINSHEETLABEL_SHAPE::PS_INPUT
 Last sheet pin type. More...
 

Friends

class SCH_EDITOR_CONTROL
 

Detailed Description

Schematic editor (Eeschema) main window.

Definition at line 118 of file sch_edit_frame.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.

◆ UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

this function must remove the aItemCount old commands from aList and delete commands, pickers and picked items if needed Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN

Parameters
aList= the UNDO_REDO_CONTAINER of commands
aItemCount= number of old commands to delete. -1 to remove all old commands this will empty the list of commands. Commands are deleted from the older to the last.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 605 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ SCH_EDIT_FRAME()

SCH_EDIT_FRAME::SCH_EDIT_FRAME ( KIWAY aKiway,
wxWindow *  aParent 
)

Definition at line 206 of file sch_edit_frame.cpp.

206  :
207  SCH_BASE_FRAME( aKiway, aParent, FRAME_SCH, wxT( "Eeschema" ),
208  wxDefaultPosition, wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, SCH_EDIT_FRAME_NAME ),
209  m_highlightedConn( nullptr ),
210  m_item_to_repeat( nullptr )
211 {
212  m_schematic = new SCHEMATIC( nullptr );
213 
214  m_showBorderAndTitleBlock = true; // true to show sheet references
215  m_hasAutoSave = true;
216  m_AboutTitle = "Eeschema";
217 
218  m_findReplaceDialog = nullptr;
219 
220  // Give an icon
221  wxIcon icon;
222  icon.CopyFromBitmap( KiBitmap( icon_eeschema_xpm ) );
223  SetIcon( icon );
224 
225  LoadSettings( eeconfig() );
226 
227  // Also links the schematic to the loaded project
228  CreateScreens();
229 
230  // After schematic has been linked to project, SCHEMATIC_SETTINGS works
233 
234  setupTools();
236  ReCreateMenuBar();
240 
241  // Create the infobar
242  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
243 
244  // Initialize common print setup dialog settings.
245  m_pageSetupData.GetPrintData().SetPrintMode( wxPRINT_MODE_PRINTER );
246  m_pageSetupData.GetPrintData().SetQuality( wxPRINT_QUALITY_MEDIUM );
247  m_pageSetupData.GetPrintData().SetBin( wxPRINTBIN_AUTO );
248  m_pageSetupData.GetPrintData().SetNoCopies( 1 );
249 
250  m_auimgr.SetManagedWindow( this );
251 
252  m_auimgr.AddPane( m_mainToolBar,
253  EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
254  m_auimgr.AddPane( m_optionsToolBar,
255  EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) );
256  m_auimgr.AddPane( m_drawToolBar,
257  EDA_PANE().VToolbar().Name( "ToolsToolbar" ).Right().Layer(2) );
258  m_auimgr.AddPane( m_infoBar,
259  EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
260  m_auimgr.AddPane( GetCanvas(),
261  EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
262  m_auimgr.AddPane( m_messagePanel,
263  EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
264 
265  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
266  // hidding it.
267  m_auimgr.Update();
268 
269  // We don't want the infobar displayed right away
270  m_auimgr.GetPane( "InfoBar" ).Hide();
271  m_auimgr.Update();
272 
274 
275  // This is used temporarily to fix a client size issue on GTK that causes zoom to fit
276  // to calculate the wrong zoom size. See SCH_EDIT_FRAME::onSize().
277  Bind( wxEVT_SIZE, &SCH_EDIT_FRAME::onSize, this );
278 
279  if( GetCanvas() )
280  {
281  GetCanvas()->GetGAL()->SetAxesEnabled( false );
282 
283  if( auto p = dynamic_cast<KIGFX::SCH_PAINTER*>( GetCanvas()->GetView()->GetPainter() ) )
284  p->SetSchematic( m_schematic );
285  }
286 
287  InitExitKey();
288 
289  // Net list generator
291 
292  UpdateTitle();
293 
294  // Default shutdown reason until a file is loaded
295  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New schematic file is unsaved" ) );
296 
297  // Ensure the window is on top
298  Raise();
299 }
void onSize(wxSizeEvent &aEvent)
SCHEMATIC * m_schematic
The currently loaded schematic.
void DefaultExecFlags()
Reset the execution flags to defaults for external netlist and bom generators.
SCH_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aWindowType, const wxString &aTitle, const wxPoint &aPosition, const wxSize &aSize, long aStyle, const wxString &aFrameName)
Holds all the data relating to one schematic A schematic may consist of one or more sheets (and one r...
Definition: schematic.h:42
ACTION_TOOLBAR * m_optionsToolBar
void ReCreateMenuBar() override
Recreates the menu bar.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:124
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
void UpdateTitle()
Set the main window title bar text.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
wxString m_AboutTitle
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
EESCHEMA_SETTINGS * eeconfig() const
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:51
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
const BITMAP_OPAQUE icon_eeschema_xpm[1]
void ReCreateHToolbar() override
#define SCH_EDIT_FRAME_NAME
wxPageSetupDialogData m_pageSetupData
EDA_MSG_PANEL * m_messagePanel
bool m_showBorderAndTitleBlock
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
SCH_ITEM * m_item_to_repeat
Last item to insert by the repeat command.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
DIALOG_SCH_FIND * m_findReplaceDialog
#define KICAD_DEFAULT_DRAWFRAME_STYLE
SCHEMATIC_SETTINGS * m_defaults
void InitExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
void SetAxesEnabled(bool aAxesEnabled)
Enables drawing the axes.
Specialization of the wxAuiPaneInfo class for KiCad panels.
void ReCreateOptToolbar() override
bool LoadProjectSettings()
Loads the KiCad project file (*.pro) settings specific to Eeschema.
const SCH_CONNECTION * m_highlightedConn
The highlighted net or bus, or nullptr.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:68
WX_INFOBAR * m_infoBar
#define _(s)
Definition: 3d_actions.cpp:33
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:78
void ReCreateVToolbar() override
ACTION_TOOLBAR * m_drawToolBar

References _, PCAD2KICAD::Center, KIGFX::eeconfig(), icon_eeschema_xpm, KiBitmap(), PCAD2KICAD::Left, onSize(), PCAD2KICAD::Right, KIPLATFORM::APP::SetShutdownBlockReason(), and ACTIONS::zoomFitScreen.

◆ ~SCH_EDIT_FRAME()

SCH_EDIT_FRAME::~SCH_EDIT_FRAME ( )
override

Definition at line 302 of file sch_edit_frame.cpp.

303 {
304  // Shutdown all running tools
305  if( m_toolManager )
307 
308  delete m_item_to_repeat; // we own the cloned object, see this->SaveCopyForRepeatItem()
309 
310  SetScreen( NULL );
311 
312  delete m_schematic;
313 
314  // Close the project if we are standalone, so it gets cleaned up properly
315  if( Kiface().IsSingle() )
317 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
SCHEMATIC * m_schematic
The currently loaded schematic.
SETTINGS_MANAGER * GetSettingsManager() const
void SetScreen(BASE_SCREEN *aScreen) override
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
SCH_ITEM * m_item_to_repeat
Last item to insert by the repeat command.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.

References EDA_BASE_FRAME::GetSettingsManager(), Kiface(), m_item_to_repeat, m_schematic, TOOLS_HOLDER::m_toolManager, NULL, KIWAY_HOLDER::Prj(), SetScreen(), TOOL_MANAGER::ShutdownAllTools(), and SETTINGS_MANAGER::UnloadProject().

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )
virtualinherited

Use to start up the GAL drawing canvas.

Reimplemented in GERBVIEW_FRAME, PCB_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 635 of file eda_draw_frame.cpp.

636 {
637  GetCanvas()->SetEvtHandlerEnabled( true );
638  GetCanvas()->StartDrawing();
639 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void StartDrawing()
Function StartDrawing() Begins drawing if it was stopped previously.

References EDA_DRAW_FRAME::GetCanvas(), and EDA_DRAW_PANEL_GAL::StartDrawing().

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::createCanvas(), SCH_DRAW_PANEL::OnShow(), and EDA_DRAW_FRAME::SwitchCanvas().

◆ AddItemToScreenAndUndoList()

void SCH_EDIT_FRAME::AddItemToScreenAndUndoList ( SCH_SCREEN aScreen,
SCH_ITEM aItem,
bool  aUndoAppend 
)

Add an item to the schematic and adds the changes to the undo/redo container.

Parameters
aUndoAppendTrue if the action should be appended to the current undo record.

Definition at line 1010 of file sch_edit_frame.cpp.

1012 {
1013  wxCHECK_RET( aItem != NULL, wxT( "Cannot add null item to list." ) );
1014 
1015  SCH_SHEET* parentSheet = nullptr;
1016  SCH_COMPONENT* parentComponent = nullptr;
1017  SCH_ITEM* undoItem = aItem;
1018 
1019  if( aItem->Type() == SCH_SHEET_PIN_T )
1020  {
1021  parentSheet = (SCH_SHEET*) aItem->GetParent();
1022 
1023  wxCHECK_RET( parentSheet && parentSheet->Type() == SCH_SHEET_T,
1024  wxT( "Cannot place sheet pin in invalid schematic sheet object." ) );
1025 
1026  undoItem = parentSheet;
1027  }
1028 
1029  else if( aItem->Type() == SCH_FIELD_T )
1030  {
1031  parentComponent = (SCH_COMPONENT*) aItem->GetParent();
1032 
1033  wxCHECK_RET( parentComponent && parentComponent->Type() == SCH_COMPONENT_T,
1034  wxT( "Cannot place field in invalid schematic component object." ) );
1035 
1036  undoItem = parentComponent;
1037  }
1038 
1039  if( aItem->IsNew() )
1040  {
1041  if( aItem->Type() == SCH_SHEET_PIN_T )
1042  {
1043  // Sheet pins are owned by their parent sheet.
1044  SaveCopyInUndoList( aScreen, undoItem, UNDO_REDO::CHANGED, aUndoAppend );
1045 
1046  parentSheet->AddPin( (SCH_SHEET_PIN*) aItem );
1047  }
1048  else if( aItem->Type() == SCH_FIELD_T )
1049  {
1050  // Component fields are also owned by their parent, but new component fields
1051  // are handled elsewhere.
1052  wxLogMessage( wxT( "addCurrentItemToScreen: unexpected new SCH_FIELD" ) );
1053  }
1054  else
1055  {
1056  if( !aScreen->CheckIfOnDrawList( aItem ) ) // don't want a loop!
1057  AddToScreen( aItem, aScreen );
1058 
1059  SaveCopyForRepeatItem( aItem );
1060  SaveCopyInUndoList( aScreen, undoItem, UNDO_REDO::NEWITEM, aUndoAppend );
1061  }
1062 
1063  // Update connectivity info for new item
1064  if( !aItem->IsMoving() )
1066  }
1067 
1068  aItem->ClearFlags( IS_NEW );
1069 
1070  aScreen->SetModify();
1071  UpdateItem( aItem );
1072 
1073  if( !aItem->IsMoving() && aItem->IsConnectable() )
1074  {
1075  std::vector< wxPoint > pts = aItem->GetConnectionPoints();
1076 
1077  for( auto i = pts.begin(); i != pts.end(); i++ )
1078  {
1079  for( auto j = i + 1; j != pts.end(); j++ )
1080  TrimWire( *i, *j );
1081 
1082  if( aScreen->IsJunctionNeeded( *i, true ) )
1083  AddJunction( aScreen, *i, true, false );
1084  }
1085 
1086  TestDanglingEnds();
1087 
1088  for( SCH_ITEM* item : aItem->ConnectedItems( GetCurrentSheet() ) )
1089  UpdateItem( item );
1090  }
1091 
1092  aItem->ClearEditFlags();
1093  GetCanvas()->Refresh();
1094 }
virtual bool IsConnectable() const
Definition: sch_item.h:377
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
virtual std::vector< wxPoint > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
Definition: sch_item.h:386
void RecalculateConnections(SCH_CLEANUP_FLAGS aCleanupFlags)
Generates the connection data for the entire schematic hierarchy.
bool IsJunctionNeeded(const wxPoint &aPosition, bool aNew=false)
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:373
bool IsMoving() const
Definition: base_struct.h:200
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
void AddPin(SCH_SHEET_PIN *aSheetPin)
Add aSheetPin to the sheet.
Definition: sch_sheet.cpp:278
bool IsNew() const
Definition: base_struct.h:199
SCH_JUNCTION * AddJunction(SCH_SCREEN *aScreen, const wxPoint &aPos, bool aAppendToUndo, bool aFinal=true)
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
#define NULL
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
void SaveCopyForRepeatItem(SCH_ITEM *aItem)
Clone aItem and owns that clone in this container.
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
SCH_ITEM_SET & ConnectedItems(const SCH_SHEET_PATH &aPath)
Retrieves the set of items connected to this item on the given sheet.
Definition: sch_item.cpp:178
Schematic symbol object.
Definition: sch_component.h:80
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
SCH_SHEET_PATH & GetCurrentSheet() const
bool TrimWire(const wxPoint &aStart, const wxPoint &aEnd)
If any single wire passes through both points, remove the portion between the two points,...
void SetModify()
Definition: base_screen.h:100
void ClearEditFlags()
Definition: base_struct.h:251
bool CheckIfOnDrawList(SCH_ITEM *st)
Definition: sch_screen.cpp:306
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References AddJunction(), SCH_SHEET::AddPin(), SCH_BASE_FRAME::AddToScreen(), CHANGED, SCH_SCREEN::CheckIfOnDrawList(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearFlags(), SCH_ITEM::ConnectedItems(), SCH_BASE_FRAME::GetCanvas(), SCH_ITEM::GetConnectionPoints(), GetCurrentSheet(), EDA_ITEM::GetParent(), IS_NEW, SCH_ITEM::IsConnectable(), SCH_SCREEN::IsJunctionNeeded(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), LOCAL_CLEANUP, NEWITEM, NULL, RecalculateConnections(), EDA_DRAW_PANEL_GAL::Refresh(), SaveCopyForRepeatItem(), SaveCopyInUndoList(), SCH_COMPONENT_T, SCH_FIELD_T, SCH_SHEET_PIN_T, SCH_SHEET_T, BASE_SCREEN::SetModify(), TestDanglingEnds(), TrimWire(), EDA_ITEM::Type(), and SCH_BASE_FRAME::UpdateItem().

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), BACK_ANNOTATE::processNetNameChange(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ AddJunction()

SCH_JUNCTION * SCH_EDIT_FRAME::AddJunction ( SCH_SCREEN aScreen,
const wxPoint aPos,
bool  aAppendToUndo,
bool  aFinal = true 
)

Definition at line 456 of file bus-wire-junction.cpp.

458 {
459  SCH_JUNCTION* junction = new SCH_JUNCTION( aPos );
460 
461  AddToScreen( junction, aScreen );
462  SaveCopyInUndoList( aScreen, junction, UNDO_REDO::NEWITEM, aUndoAppend );
463  BreakSegments( aPos );
464 
465  if( aFinal )
466  {
468 
470  OnModify();
471 
472  auto view = GetCanvas()->GetView();
473  view->ClearPreview();
474  view->ShowPreview( false );
475  view->ClearHiddenFlags();
476  }
477 
478  return junction;
479 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
bool BreakSegments(const wxPoint &aPoint, SCH_SCREEN *aScreen=nullptr)
Checks every wire and bus for a intersection at aPoint and break into two segments at aPoint if an in...
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:211
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void ClearPreview()
Definition: view.cpp:1553
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:273

References SCH_BASE_FRAME::AddToScreen(), BreakSegments(), KIGFX::VIEW::ClearPreview(), SCH_BASE_FRAME::GetCanvas(), SCH_DRAW_PANEL::GetView(), TOOLS_HOLDER::m_toolManager, NEWITEM, OnModify(), TOOL_MANAGER::PostEvent(), SaveCopyInUndoList(), EVENTS::SelectedItemsModified, and TestDanglingEnds().

Referenced by AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TOOL::BreakWire(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), FixupJunctions(), SCH_MOVE_TOOL::Main(), and SCH_DRAWING_TOOLS::SingleClickPlace().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 372 of file eda_base_frame.cpp.

373 {
374  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
375  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
376 
377  helpMenu->Add( ACTIONS::help );
378  helpMenu->Add( ACTIONS::gettingStarted );
379  helpMenu->Add( ACTIONS::listHotKeys );
380  helpMenu->Add( ACTIONS::getInvolved );
381  helpMenu->Add( ACTIONS::reportBug );
382 
383  helpMenu->AppendSeparator();
384  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
385 
386  aMenuBar->Append( helpMenu, _( "&Help" ) );
387 }
static TOOL_ACTION listHotKeys
Definition: actions.h:175
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:177
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:174
static TOOL_ACTION getInvolved
Definition: actions.h:176
static TOOL_ACTION gettingStarted
Definition: actions.h:173

References _, about_xpm, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by EDA_3D_VIEWER::CreateMenuBar(), LIB_VIEW_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. zoom and grid)

Definition at line 430 of file eda_draw_frame.cpp.

431 {
432  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
433  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
434 
435  aMenu.AddSeparator( 1000 );
437  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
438  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
440 
441  aMenu.AddSeparator( 1000 );
442 
443  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
444  zoomMenu->SetTool( commonTools );
445  aToolMenu.AddSubMenu( zoomMenu );
446 
447  auto gridMenu = std::make_shared<GRID_MENU>( this );
448  gridMenu->SetTool( commonTools );
449  aToolMenu.AddSubMenu( gridMenu );
450 
451  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
452  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
453 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
COMMON_TOOLS.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Adds a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
static TOOL_ACTION zoomCenter
Definition: actions.h:93
static TOOL_ACTION zoomIn
Definition: actions.h:89
static TOOL_ACTION zoomOut
Definition: actions.h:90

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, SELECTION_CONDITIONS::ShowAlways(), ACTIONS::zoomCenter, ACTIONS::zoomFitScreen, ACTIONS::zoomIn, and ACTIONS::zoomOut.

Referenced by ROUTER_TOOL::Init(), PICKER_TOOL::Init(), PL_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PCB_VIEWER_TOOLS::Init(), PL_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), and SELECTION_TOOL::Init().

◆ AddToScreen()

void SCH_BASE_FRAME::AddToScreen ( EDA_ITEM aItem,
SCH_SCREEN aScreen 
)
inherited

Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen.

Definition at line 379 of file sch_base_frame.cpp.

380 {
381  auto screen = aScreen;
382 
383  if( aScreen == nullptr )
384  screen = GetScreen();
385 
386  screen->Append( (SCH_ITEM*) aItem );
387 
388  if( screen == GetScreen() )
389  {
390  GetCanvas()->GetView()->Add( aItem );
391  UpdateItem( aItem, true ); // handle any additional parent semantics
392  }
393 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:345
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194

References KIGFX::VIEW::Add(), SCH_BASE_FRAME::GetCanvas(), SCH_BASE_FRAME::GetScreen(), SCH_DRAW_PANEL::GetView(), and SCH_BASE_FRAME::UpdateItem().

Referenced by AddItemToScreenAndUndoList(), AddJunction(), BreakSegment(), SCH_EDIT_TOOL::ChangeTextType(), DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), and SchematicCleanUp().

◆ AllowCaseSensitiveFileNameClashes()

bool SCH_EDIT_FRAME::AllowCaseSensitiveFileNameClashes ( const wxString &  aSchematicFileName)

Check aSchematicFileName for a potential file name case sensitivity clashes.

On platforms where file names are case sensitive, it is possible to schematic sheet file names that would cause issues on platforms where file name are case insensitive. File names foo.sch and Foo.sch are unique files on Linux and MacOS but on Windows this would result in a broken schematic.

Parameters
aSchematicFileNameis the absolute path and file name of the file to test.
Returns
true if the user accepts the potential file name clase risk.

Definition at line 605 of file sheet.cpp.

606 {
607  wxString msg;
608  SCH_SCREENS screens( Schematic().Root() );
609  wxFileName fn = aSchematicFileName;
610 
611  wxCHECK( fn.IsAbsolute(), false );
612 
614  && screens.CanCauseCaseSensitivityIssue( aSchematicFileName ) )
615  {
616  msg.Printf( _( "The file name \"%s\" can cause issues with an existing file name\n"
617  "already defined in the schematic on systems that support case\n"
618  "insensitive file names. This will cause issues if you copy this\n"
619  "project to an operating system that supports case insensitive file\n"
620  "names.\n\nDo you wish to continue?" ),
621  fn.GetName() );
622 
623  wxRichMessageDialog dlg( this, msg, _( "Warning" ),
624  wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
625  dlg.ShowCheckBox( _( "Do not show this message again." ) );
626  dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Create New Sheet" ) ),
627  wxMessageDialog::ButtonLabel( _( "Discard New Sheet" ) ) );
628 
629  if( dlg.ShowModal() == wxID_NO )
630  return false;
631 
633  !dlg.IsCheckBoxChecked();
634  }
635 
636  return true;
637 }
EESCHEMA_SETTINGS * eeconfig() const
SCHEMATIC & Schematic() const
#define _(s)
Definition: 3d_actions.cpp:33
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References _, SCH_SCREENS::CanCauseCaseSensitivityIssue(), SCH_BASE_FRAME::eeconfig(), EESCHEMA_SETTINGS::m_Appearance, Schematic(), and EESCHEMA_SETTINGS::APPEARANCE::show_sheet_filename_case_sensitivity_dialog.

Referenced by DIALOG_SCH_SHEET_PROPS::onSheetFilenameChanged().

◆ AnnotateComponents()

void SCH_EDIT_FRAME::AnnotateComponents ( bool  aAnnotateSchematic,
ANNOTATE_ORDER_T  aSortOption,
ANNOTATE_OPTION_T  aAlgoOption,
int  aStartNumber,
bool  aResetAnnotation,
bool  aRepairTimestamps,
bool  aLockUnits,
REPORTER aReporter 
)

Annotate the components in the schematic that are not currently annotated.

Parameters
aAnnotateSchematicAnnotate the entire schematic if true. Otherwise annotate the current sheet only.
aSortOptionDefine the annotation order. See ANNOTATE_ORDER_T.
aAlgoOptionDefine the annotation style. See ANNOTATE_OPTION_T.
aStartNumberThe start number for non-sheet-based annotation styles.
aResetAnnotationClear any previous annotation if true. Otherwise, keep the existing component annotation.
aRepairTimestampsTest for and repair any duplicate time stamps if true. Otherwise, keep the existing time stamps. This option could change previous annotation because time stamps are used to handle annotation in complex hierarchies.
aLockUnitsWhen both aLockUnits and aResetAnnotation are true, all unit associations should be kept when reannotating. That is, if two components were R8A and R8B, they may become R3A and R3B, but not R3A and R3C or R3C and R4D. When aResetAnnotation is true but aLockUnits is false, the usual behavior of annotating each part individually is performed. When aResetAnnotation is false, this option has no effect.
aReporterA sink for error messages. Use NULL_REPORTER if you don't need errors.

When the sheet number is used in annotation, each sheet annotation starts from sheet number * 100. In other words the first sheet uses 100 to 199, the second sheet uses 200 to 299, and so on.

Definition at line 98 of file eeschema/annotate.cpp.

106 {
107  SCH_REFERENCE_LIST references;
108  SCH_SCREENS screens( Schematic().Root() );
109  SCH_SHEET_LIST sheets = Schematic().GetSheets();
110  bool appendUndo = false;
111 
112  // Map of locked components
113  SCH_MULTI_UNIT_REFERENCE_MAP lockedComponents;
114 
115  // Map of previous annotation for building info messages
116  std::map<wxString, wxString> previousAnnotation;
117 
118  // Test for and replace duplicate time stamps in components and sheets. Duplicate
119  // time stamps can happen with old schematics, schematic conversions, or manual
120  // editing of files.
121  if( aRepairTimestamps )
122  {
123  int count = screens.ReplaceDuplicateTimeStamps();
124 
125  if( count )
126  {
127  wxString msg;
128  msg.Printf( _( "%d duplicate time stamps were found and replaced." ), count );
129  aReporter.ReportTail( msg, RPT_SEVERITY_WARNING );
130  }
131  }
132 
133  // If units must be locked, collect all the sets that must be annotated together.
134  if( aLockUnits )
135  {
136  if( aAnnotateSchematic )
137  sheets.GetMultiUnitComponents( lockedComponents );
138  else
139  GetCurrentSheet().GetMultiUnitComponents( lockedComponents );
140  }
141 
142  // Store previous annotations for building info messages
143  mapExistingAnnotation( previousAnnotation );
144 
145  // If it is an annotation for all the components, reset previous annotation.
146  if( aResetAnnotation )
147  DeleteAnnotation( !aAnnotateSchematic, &appendUndo );
148 
149  // Set sheet number and number of sheets.
151 
152  // Build component list
153  if( aAnnotateSchematic )
154  sheets.GetComponents( references );
155  else
156  GetCurrentSheet().GetComponents( references );
157 
158  // Break full components reference in name (prefix) and number:
159  // example: IC1 become IC, and 1
160  references.SplitReferences();
161 
162  switch( aSortOption )
163  {
164  default:
165  case SORT_BY_X_POSITION: references.SortByXCoordinate(); break;
166  case SORT_BY_Y_POSITION: references.SortByYCoordinate(); break;
167  }
168 
169  bool useSheetNum = false;
170  int idStep = 100;
171 
172  switch( aAlgoOption )
173  {
174  default:
175  case INCREMENTAL_BY_REF:
176  break;
177 
178  case SHEET_NUMBER_X_100:
179  useSheetNum = true;
180  break;
181 
182  case SHEET_NUMBER_X_1000:
183  useSheetNum = true;
184  idStep = 1000;
185  break;
186  }
187 
188  // Recalculate and update reference numbers in schematic
189  references.Annotate( useSheetNum, idStep, aStartNumber, lockedComponents );
190 
191  for( size_t i = 0; i < references.GetCount(); i++ )
192  {
193  SCH_REFERENCE& ref = references[i];
194  SCH_COMPONENT* comp = ref.GetComp();
195  SCH_SHEET_PATH* sheet = &ref.GetSheetPath();
196 
197  SaveCopyInUndoList( sheet->LastScreen(), comp, UNDO_REDO::CHANGED, appendUndo );
198  appendUndo = true;
199  ref.Annotate();
200 
201  KIID_PATH full_uuid = sheet->Path();
202  full_uuid.push_back( comp->m_Uuid );
203 
204  wxString prevRef = previousAnnotation[ full_uuid.AsString() ];
205  wxString newRef = comp->GetRef( sheet );
206 
207  if( comp->GetUnitCount() > 1 )
208  newRef << LIB_PART::SubReference( comp->GetUnitSelection( sheet ) );
209 
210  wxString msg;
211 
212  if( prevRef.Length() )
213  {
214  if( newRef == prevRef )
215  continue;
216 
217  if( comp->GetUnitCount() > 1 )
218  msg.Printf( _( "Updated %s (unit %s) from %s to %s" ),
219  comp->GetValue( sheet ),
220  LIB_PART::SubReference( comp->GetUnit(), false ),
221  prevRef,
222  newRef );
223  else
224  msg.Printf( _( "Updated %s from %s to %s" ),
225  comp->GetValue( sheet ),
226  prevRef,
227  newRef );
228  }
229  else
230  {
231  if( comp->GetUnitCount() > 1 )
232  msg.Printf( _( "Annotated %s (unit %s) as %s" ),
233  comp->GetValue( sheet ),
234  LIB_PART::SubReference( comp->GetUnit(), false ),
235  newRef );
236  else
237  msg.Printf( _( "Annotated %s as %s" ),
238  comp->GetValue( sheet ),
239  newRef );
240  }
241 
242  aReporter.Report( msg, RPT_SEVERITY_ACTION );
243  }
244 
245  // Final control (just in case ... ).
246  if( !CheckAnnotate( aReporter, !aAnnotateSchematic ) )
247  aReporter.ReportTail( _( "Annotation complete." ), RPT_SEVERITY_ACTION );
248 
249  // Update on screen references, that can be modified by previous calculations:
252 
253  SyncView();
254  GetCanvas()->Refresh();
255  OnModify();
256 
257  // Must go after OnModify() so the connectivity graph has been updated
259 }
SCH_SHEET_LIST.
void SortByYCoordinate()
Function sortByYCoordinate sorts the list of references by Y position.
void UpdateNetHighlightStatus()
void GetComponents(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanComponents=false) const
Function GetComponents adds a SCH_REFERENCE() object to aReferences for each component in the sheet.
void mapExistingAnnotation(std::map< wxString, wxString > &aMap)
Fills a map of uuid -> reference from the currently loaded schematic.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
const SCH_SHEET_PATH & GetSheetPath() const
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
SCH_COMPONENT * GetComp() const
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Function ReportTail Places the report at the end of the list, for objects that support report orderin...
Definition: reporter.h:94
int GetUnitCount() const
Return the number of units per package of the symbol.
Annotate incrementally using the first free reference number.
const wxString GetValue(const SCH_SHEET_PATH *sheet) const
void UpdateAllScreenReferences()
Function UpdateAllScreenReferences updates the reference and the m_Multi parameter (part selection) f...
void DeleteAnnotation(bool aCurrentSheetOnly, bool *appendUndo)
Clear the current component annotation.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
void GetMultiUnitComponents(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Function GetMultiUnitComponents adds a SCH_REFERENCE_LIST object to aRefList for each same-reference ...
void GetMultiUnitComponents(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Function GetMultiUnitComponents adds a SCH_REFERENCE_LIST object to aRefList for each same-reference ...
SCH_REFERENCE_LIST is used to create a flattened list of components because in a complex hierarchy,...
int GetUnit() const
void SortByXCoordinate()
Function sortByXCoordinate sorts the list of references by X position.
void GetComponents(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanComponents=false) const
Function GetComponents adds a SCH_REFERENCE() object to aReferences for each component in the list of...
void SyncView()
Mark all items for refresh.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void Annotate()
Function Annotate updates the annotation of the component according the the current object state.
SCHEMATIC & Schematic() const
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
void Annotate(bool aUseSheetNum, int aSheetIntervalId, int aStartNumber, SCH_MULTI_UNIT_REFERENCE_MAP aLockedUnitMap)
Function Annotate set the reference designators in the list that have not been annotated.
SCH_SHEET_PATH.
std::map< wxString, SCH_REFERENCE_LIST > SCH_MULTI_UNIT_REFERENCE_MAP
Type SCH_MULTI_UNIT_REFERENCE_MAP is used to create a map of reference designators for multi-unit par...
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
int CheckAnnotate(REPORTER &aReporter, bool aOneSheetOnly)
Check for annotation errors.
const KIID m_Uuid
Definition: base_struct.h:162
Annotate by Y position from top to bottom.
unsigned GetCount() const
Function GetCount.
Annotate using the first free reference number starting at the sheet number * 100.
SCH_SCREEN * LastScreen()
Function LastScreen.
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
void SplitReferences()
Function SplitReferences attempts to split all reference designators into a name (U) and number (1).
#define _(s)
Definition: 3d_actions.cpp:33
wxString AsString() const
Definition: common.h:137
Annotate by X position from left to right.
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Annotate using the first free reference number starting at the sheet number * 1000.
Schematic symbol object.
Definition: sch_component.h:80
SCH_SHEET_PATH & GetCurrentSheet() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
SCH_REFERENCE is used as a helper to define a component's reference designator in a schematic.
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.

References _, SCH_REFERENCE::Annotate(), SCH_REFERENCE_LIST::Annotate(), KIID_PATH::AsString(), CHANGED, CheckAnnotate(), DeleteAnnotation(), SCH_BASE_FRAME::GetCanvas(), SCH_REFERENCE::GetComp(), SCH_SHEET_PATH::GetComponents(), SCH_SHEET_LIST::GetComponents(), SCH_REFERENCE_LIST::GetCount(), GetCurrentSheet(), SCH_SHEET_PATH::GetMultiUnitComponents(), SCH_SHEET_LIST::GetMultiUnitComponents(), SCH_COMPONENT::GetRef(), SCH_REFERENCE::GetSheetPath(), SCHEMATIC::GetSheets(), SCH_COMPONENT::GetUnit(), SCH_COMPONENT::GetUnitCount(), SCH_COMPONENT::GetUnitSelection(), SCH_COMPONENT::GetValue(), INCREMENTAL_BY_REF, SCH_SHEET_PATH::LastScreen(), EDA_ITEM::m_Uuid, mapExistingAnnotation(), OnModify(), SCH_SHEET_PATH::Path(), EDA_DRAW_PANEL_GAL::Refresh(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), REPORTER::Report(), REPORTER::ReportTail(), RPT_SEVERITY_ACTION, RPT_SEVERITY_WARNING, SaveCopyInUndoList(), Schematic(), SetSheetNumberAndCount(), SHEET_NUMBER_X_100, SHEET_NUMBER_X_1000, SORT_BY_X_POSITION, SORT_BY_Y_POSITION, SCH_REFERENCE_LIST::SortByXCoordinate(), SCH_REFERENCE_LIST::SortByYCoordinate(), SCH_REFERENCE_LIST::SplitReferences(), LIB_PART::SubReference(), SCH_BASE_FRAME::SyncView(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and UpdateNetHighlightStatus().

Referenced by KiwayMailIn(), DIALOG_ANNOTATE::OnApplyClick(), and ReadyToNetlist().

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  textUpper,
const wxString &  textLower,
COLOR4D  color,
int  pad = 6 
)
inherited

Append a message to the message panel.

This helper method checks to make sure the message panel exists in the frame and appends a message to it using the message panel AppendMessage() method.

Parameters
textUpper- The message upper text.
textLower- The message lower text.
color- A color ID from the KiCad color list (see colors.h).
pad- Number of spaces to pad between messages (default = 4).

Definition at line 592 of file eda_draw_frame.cpp.

594 {
595  if( m_messagePanel )
596  m_messagePanel->AppendMessage( textUpper, textLower, color, pad );
597 }
int color
Definition: DXF_plotter.cpp:61
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, COLOR4D aColor, int aPad=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:110

References EDA_MSG_PANEL::AppendMessage(), color, and EDA_DRAW_FRAME::m_messagePanel.

Referenced by PCB_BASE_FRAME::Compile_Ratsnest(), LIB_EDIT_FRAME::DisplayCmpDoc(), GERBER_FILE_IMAGE::DisplayImageInfo(), importFile(), LoadSheetFromFile(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SCH_SHEET_PROPS::onSheetFilenameChanged(), OpenProjectFiles(), SaveEEFile(), PCB_EDIT_FRAME::SavePcbFile(), and LIB_VIEW_FRAME::updatePreviewSymbol().

◆ AppendSchematic()

bool SCH_EDIT_FRAME::AppendSchematic ( )

Import a KiCad schematic into the current sheet.

Returns
True if the schematic was imported properly.

Definition at line 545 of file eeschema/files-io.cpp.

546 {
547  wxString fullFileName;
548  SCH_SCREEN* screen = GetScreen();
549 
550  if( !screen )
551  {
552  wxLogError( wxT( "Document not ready, cannot import" ) );
553  return false;
554  }
555 
556  // open file chooser dialog
557  wxString path = wxPathOnly( Prj().GetProjectFullName() );
558 
559  wxFileDialog dlg( this, _( "Append Schematic" ), path, wxEmptyString,
560  KiCadSchematicFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
561 
562  if( dlg.ShowModal() == wxID_CANCEL )
563  return false;
564 
565  fullFileName = dlg.GetPath();
566 
567  if( !LoadSheetFromFile( GetCurrentSheet().Last(), &GetCurrentSheet(), fullFileName ) )
568  return false;
569 
570  SCH_SCREENS screens( GetCurrentSheet().Last() );
571  screens.TestDanglingEnds();
572 
575 
576  SyncView();
577  HardRedraw(); // Full reinit of the current screen and the display.
578  OnModify();
579 
580  return true;
581 }
wxString KiCadSchematicFileWildcard()
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
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:103
void HardRedraw() override
Rebuild the GAL and redraw the screen.
void SyncView()
Mark all items for refresh.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
#define _(s)
Definition: 3d_actions.cpp:33
SCH_SHEET_PATH & GetCurrentSheet() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References _, GetCurrentSheet(), GetScreen(), HardRedraw(), KiCadSchematicFileWildcard(), LoadSheetFromFile(), TOOLS_HOLDER::m_toolManager, OnModify(), KIWAY_HOLDER::Prj(), TOOL_MANAGER::RunAction(), SetSheetNumberAndCount(), SCH_BASE_FRAME::SyncView(), SCH_SCREENS::TestDanglingEnds(), and ACTIONS::zoomFitScreen.

Referenced by OnAppendProject().

◆ AskToSaveChanges()

bool SCH_EDIT_FRAME::AskToSaveChanges ( )

Checks if any of the screens has unsaved changes and asks the user whether to save or drop them.

Returns
True if user decided to save or drop changes, false if the operation should be canceled.

Definition at line 976 of file eeschema/files-io.cpp.

977 {
978  SCH_SCREENS screenList( Schematic().Root() );
979 
980  // Save any currently open and modified project files.
981  for( SCH_SCREEN* screen = screenList.GetFirst(); screen; screen = screenList.GetNext() )
982  {
983  if( screen->IsModify() )
984  {
985  if( !HandleUnsavedChanges( this, _( "The current schematic has been modified. "
986  "Save changes?" ),
987  [&]()->bool { return SaveProject(); } ) )
988  {
989  return false;
990  }
991  }
992  }
993 
994  return true;
995 }
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
SCHEMATIC & Schematic() const
#define _(s)
Definition: 3d_actions.cpp:33
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References _, SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), HandleUnsavedChanges(), SaveProject(), and Schematic().

Referenced by OnImportProject(), and OpenProjectFiles().

◆ BreakSegment()

bool SCH_EDIT_FRAME::BreakSegment ( SCH_LINE aSegment,
const wxPoint aPoint,
SCH_LINE **  aNewSegment = NULL,
SCH_SCREEN aScreen = nullptr 
)

Breaks a single segment into two at the specified point.

NOTE: always appends to the existing undo state.

Parameters
aSegmentLine segment to break
aPointPoint at which to break the segment
aNewSegmentPointer to the newly created segment (if given and created)
aScreenis the screen to examine, or nullptr to examine the current screen
Returns
True if any wires or buses were broken.

Definition at line 299 of file bus-wire-junction.cpp.

301 {
302  if( !IsPointOnSegment( aSegment->GetStartPoint(), aSegment->GetEndPoint(), aPoint )
303  || aSegment->IsEndPoint( aPoint ) )
304  return false;
305 
306  if( aScreen == nullptr )
307  aScreen = GetScreen();
308 
309  SCH_LINE* newSegment = new SCH_LINE( *aSegment );
310 
311  newSegment->SetStartPoint( aPoint );
312  AddToScreen( newSegment, aScreen );
313 
314  SaveCopyInUndoList( aScreen, newSegment, UNDO_REDO::NEWITEM, true );
315  SaveCopyInUndoList( aScreen, aSegment, UNDO_REDO::CHANGED, true );
316 
317  UpdateItem( aSegment );
318  aSegment->SetEndPoint( aPoint );
319 
320  if( aNewSegment )
321  *aNewSegment = newSegment;
322 
323  return true;
324 }
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
wxPoint GetStartPoint() const
Definition: sch_line.h:94
bool IsPointOnSegment(const wxPoint &aSegStart, const wxPoint &aSegEnd, const wxPoint &aTestPoint)
Test if aTestPoint is on line defined by aSegStart and aSegEnd.
Definition: trigo.cpp:42
void SetEndPoint(const wxPoint &aPosition)
Definition: sch_line.h:98
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SetStartPoint(const wxPoint &aPosition)
Definition: sch_line.h:95
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:87
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
wxPoint GetEndPoint() const
Definition: sch_line.h:97

References SCH_BASE_FRAME::AddToScreen(), CHANGED, SCH_LINE::GetEndPoint(), GetScreen(), SCH_LINE::GetStartPoint(), SCH_LINE::IsEndPoint(), IsPointOnSegment(), NEWITEM, SaveCopyInUndoList(), SCH_LINE::SetEndPoint(), SCH_LINE::SetStartPoint(), and SCH_BASE_FRAME::UpdateItem().

Referenced by BreakSegments(), and TrimWire().

◆ BreakSegments()

bool SCH_EDIT_FRAME::BreakSegments ( const wxPoint aPoint,
SCH_SCREEN aScreen = nullptr 
)

Checks every wire and bus for a intersection at aPoint and break into two segments at aPoint if an intersection is found.

NOTE: always appends to the existing undo state.

Parameters
aPointTest this point for an intersection.
aScreenis the screen to examine, or nullptr to examine the current screen
Returns
True if any wires or buses were broken.

Definition at line 327 of file bus-wire-junction.cpp.

328 {
329  static const KICAD_T wiresAndBuses[] = { SCH_LINE_LOCATE_WIRE_T, SCH_LINE_LOCATE_BUS_T, EOT };
330 
331  if( aScreen == nullptr )
332  aScreen = GetScreen();
333 
334  bool brokenSegments = false;
335  std::vector<SCH_LINE*> wires;
336  EDA_RECT bbox( aPoint, wxSize( 2, 2 ) );
337 
338  for( auto item : aScreen->Items().Overlapping( SCH_LINE_T, aPoint ) )
339  {
340  if( item->IsType( wiresAndBuses ) )
341  wires.push_back( static_cast<SCH_LINE*>( item ) );
342  }
343 
344  for( auto wire : wires )
345  brokenSegments |= BreakSegment( wire, aPoint, NULL, aScreen );
346 
347  return brokenSegments;
348 }
bool BreakSegment(SCH_LINE *aSegment, const wxPoint &aPoint, SCH_LINE **aNewSegment=NULL, SCH_SCREEN *aScreen=nullptr)
Breaks a single segment into two at the specified point.
EE_TYPE Overlapping(const EDA_RECT &aRect)
Definition: sch_rtree.h:224
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
#define NULL
EE_RTREE & Items()
Definition: sch_screen.h:158
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References BreakSegment(), EOT, GetScreen(), SCH_SCREEN::Items(), NULL, EE_RTREE::Overlapping(), SCH_LINE_LOCATE_BUS_T, SCH_LINE_LOCATE_WIRE_T, and SCH_LINE_T.

Referenced by AddJunction(), BreakSegmentsOnJunctions(), and SCH_EDIT_TOOL::BreakWire().

◆ BreakSegmentsOnJunctions()

bool SCH_EDIT_FRAME::BreakSegmentsOnJunctions ( SCH_SCREEN aScreen = nullptr)

Tests all junctions and bus entries in the schematic for intersections with wires and buses and breaks any intersections into multiple segments.

NOTE: always appends to the existing undo state.

Parameters
aScreenis the screen to examine, or nullptr to examine the current screen
Returns
True if any wires or buses were broken.

Definition at line 351 of file bus-wire-junction.cpp.

352 {
353  if( aScreen == nullptr )
354  aScreen = GetScreen();
355 
356  bool brokenSegments = false;
357 
358  std::set<wxPoint> point_set;
359 
360  for( SCH_ITEM* item : aScreen->Items().OfType( SCH_JUNCTION_T ) )
361  point_set.insert( item->GetPosition() );
362 
363  for( SCH_ITEM* item : aScreen->Items().OfType( SCH_BUS_WIRE_ENTRY_T ) )
364  {
365  SCH_BUS_WIRE_ENTRY* entry = static_cast<SCH_BUS_WIRE_ENTRY*>( item );
366  point_set.insert( entry->GetPosition() );
367  point_set.insert( entry->GetEnd() );
368  }
369 
370 
371  for( auto pt : point_set )
372  brokenSegments |= BreakSegments( pt, aScreen );
373 
374  return brokenSegments;
375 }
bool BreakSegments(const wxPoint &aPoint, SCH_SCREEN *aScreen=nullptr)
Checks every wire and bus for a intersection at aPoint and break into two segments at aPoint if an in...
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
EE_RTREE & Items()
Definition: sch_screen.h:158
Class for a wire to bus entry.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
wxPoint GetEnd() const
wxPoint GetPosition() const override

References BreakSegments(), SCH_BUS_ENTRY_BASE::GetEnd(), SCH_BUS_ENTRY_BASE::GetPosition(), GetScreen(), SCH_SCREEN::Items(), EE_RTREE::OfType(), SCH_BUS_WIRE_ENTRY_T, and SCH_JUNCTION_T.

Referenced by SchematicCleanUp().

◆ canCloseWindow()

bool SCH_EDIT_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 574 of file sch_edit_frame.cpp.

575 {
576  // Shutdown blocks must be determined and vetoed as early as possible
577  if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
578  && Schematic().GetSheets().IsModified() )
579  {
580  return false;
581  }
582 
583  if( Kiface().IsSingle() )
584  {
585  LIB_EDIT_FRAME* libeditFrame = (LIB_EDIT_FRAME*) Kiway().Player( FRAME_SCH_LIB_EDITOR, false );
586  if( libeditFrame && !libeditFrame->Close() ) // Can close component editor?
587  return false;
588 
589  LIB_VIEW_FRAME* viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER, false );
590  if( viewlibFrame && !viewlibFrame->Close() ) // Can close component viewer?
591  return false;
592 
593  viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER_MODAL, false );
594 
595  if( viewlibFrame && !viewlibFrame->Close() ) // Can close modal component viewer?
596  return false;
597  }
598 
599  SIM_PLOT_FRAME* simFrame = (SIM_PLOT_FRAME*) Kiway().Player( FRAME_SIMULATOR, false );
600 
601  if( simFrame && !simFrame->Close() ) // Can close the simulator?
602  return false;
603 
604  // We may have gotten multiple events; don't clean up twice
605  if( !Schematic().IsValid() )
606  return false;
607 
608  SCH_SHEET_LIST sheetlist = Schematic().GetSheets();
609 
610  if( sheetlist.IsModified() )
611  {
612  wxFileName fileName = Schematic().RootScreen()->GetFileName();
613  wxString msg = _( "Save changes to \"%s\" before closing?" );
614 
615  if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ),
616  [&]()->bool { return SaveProject(); } ) )
617  {
618  return false;
619  }
620  }
621 
622  return true;
623 }
SCH_SHEET_LIST.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
bool IsModified()
Function IsModified checks the entire hierarchy for any modifications.
const wxString & GetFileName() const
Definition: sch_screen.h:185
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
bool IsValid() const
A simple test if the schematic is loaded, not a complete one.
Definition: schematic.h:108
Symbol library viewer main window.
bool IsSingle() const
Function IsSingle is this KIFACE_I running under single_top?
Definition: kiface_i.h:117
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:343
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
SCHEMATIC & Schematic() const
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:40
Implementing SIM_PLOT_FRAME_BASE.
The symbol library editor main window.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
SCH_SCREEN * RootScreen() const
Helper to retreive the screen of the root sheet.
Definition: schematic.cpp:112

References _, Format(), FRAME_SCH_LIB_EDITOR, FRAME_SCH_VIEWER, FRAME_SCH_VIEWER_MODAL, FRAME_SIMULATOR, SCH_SCREEN::GetFileName(), SCHEMATIC::GetSheets(), HandleUnsavedChanges(), SCH_SHEET_LIST::IsModified(), KIFACE_I::IsSingle(), SCHEMATIC::IsValid(), Kiface(), KIWAY_HOLDER::Kiway(), KIWAY::Player(), SCHEMATIC::RootScreen(), SaveProject(), Schematic(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ CenterScreen()

void SCH_BASE_FRAME::CenterScreen ( const wxPoint aCenterPoint,
bool  aWarpPointer 
)
virtualinherited

Definition at line 270 of file sch_base_frame.cpp.

271 {
272  GetCanvas()->GetView()->SetCenter( aCenterPoint );
273 
274  if( aWarpPointer )
275  GetCanvas()->GetViewControls()->WarpCursor( aCenterPoint, true );
276 
277  GetCanvas()->Refresh();
278 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
Function WarpCursor() If enabled (.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:603
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...

References SCH_BASE_FRAME::GetCanvas(), SCH_DRAW_PANEL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::WarpCursor().

Referenced by SCH_EDITOR_CONTROL::FindComponentAndItem().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 948 of file eda_base_frame.cpp.

949 {
950  SetUserUnits( aUnits );
952 
953  wxCommandEvent e( UNITS_CHANGED );
954  ProcessEventLocally( e );
955 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

References EDA_BASE_FRAME::SetUserUnits(), and EDA_BASE_FRAME::unitsChangeRefresh().

Referenced by COMMON_TOOLS::ImperialUnits(), COMMON_TOOLS::MetricUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckAnnotate()

int SCH_EDIT_FRAME::CheckAnnotate ( REPORTER aReporter,
bool  aOneSheetOnly 
)

Check for annotation errors.

The following list of items are checked:

  • Components that are not annotated.
  • Duplicate component references.
  • Multiple part per package components where the part number is greater number of parts in the package.
  • Multiple part per package components where the reference designator is different between parts.
Returns
Number of annotation errors found.
Parameters
aReporterA sink for error messages. Use NULL_REPORTER if you don't need errors.
aOneSheetOnlyCheck the current sheet only if true. Otherwise check the entire schematic.

Definition at line 262 of file eeschema/annotate.cpp.

263 {
264  SCH_REFERENCE_LIST componentsList;
265 
266  // Build the list of components
267  if( !aOneSheetOnly )
268  Schematic().GetSheets().GetComponents( componentsList );
269  else
270  GetCurrentSheet().GetComponents( componentsList );
271 
272  // Empty schematic does not need annotation
273  if( componentsList.GetCount() == 0 )
274  return 0;
275 
276  return componentsList.CheckAnnotation( aReporter );
277 }
void GetComponents(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanComponents=false) const
Function GetComponents adds a SCH_REFERENCE() object to aReferences for each component in the sheet.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
SCH_REFERENCE_LIST is used to create a flattened list of components because in a complex hierarchy,...
void GetComponents(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanComponents=false) const
Function GetComponents adds a SCH_REFERENCE() object to aReferences for each component in the list of...
SCHEMATIC & Schematic() const
unsigned GetCount() const
Function GetCount.
SCH_SHEET_PATH & GetCurrentSheet() const
int CheckAnnotation(REPORTER &aReporter)
Function CheckAnnotation check for annotations errors.

References SCH_REFERENCE_LIST::CheckAnnotation(), SCH_SHEET_PATH::GetComponents(), SCH_SHEET_LIST::GetComponents(), SCH_REFERENCE_LIST::GetCount(), GetCurrentSheet(), SCHEMATIC::GetSheets(), and Schematic().

Referenced by AnnotateComponents(), DIALOG_ERC::DIALOG_ERC(), ReadyToNetlist(), and DIALOG_ERC::testErc().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName)
inherited

Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.

If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 846 of file eda_base_frame.cpp.

847 {
848  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
849 
850  wxFileName autoSaveFileName = aFileName;
851 
852  // Check for auto save file.
853  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
854 
855  wxLogTrace( traceAutoSave,
856  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
857 
858  if( !autoSaveFileName.FileExists() )
859  return;
860 
861  wxString msg = wxString::Format( _(
862  "Well this is potentially embarrassing!\n"
863  "It appears that the last time you were editing the file\n"
864  "\"%s\"\n"
865  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
866  GetChars( aFileName.GetFullName() )
867  );
868 
869  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
870 
871  // Make a backup of the current file, delete the file, and rename the auto save file to
872  // the file name.
873  if( response == wxYES )
874  {
875  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
876  {
877  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
878  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
879  }
880  }
881  else
882  {
883  wxLogTrace( traceAutoSave,
884  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
885 
886  // Remove the auto save file when using the previous file as is.
887  wxRemoveFile( autoSaveFileName.GetFullPath() );
888  }
889 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
static wxString GetAutoSaveFilePrefix()
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), GetChars(), Pgm(), and traceAutoSave.

Referenced by OpenProjectFiles(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ checkForNoFullyDefinedLibIds()

bool SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds ( SCH_SHEET aSheet)
private

Verify that the symbol library links aSheet and all of it's child sheets have been remapped to the symbol library table.

Parameters
aSheetis the SCH_SHEET object to test.
Returns
true if aSheet and it's child sheets have not been remapped.

Definition at line 74 of file sheet.cpp.

75 {
76  wxASSERT( aSheet && aSheet->GetScreen() );
77 
78  wxString msg;
79  SCH_SCREENS newScreens( aSheet );
80 
81  if( newScreens.HasNoFullyDefinedLibIds() )
82  {
83  msg.Printf( _( "The schematic \"%s\" has not had it's symbol library links remapped "
84  "to the symbol library table. The project this schematic belongs to "
85  "must first be remapped before it can be imported into the current "
86  "project." ), aSheet->GetScreen()->GetFileName() );
87  DisplayInfoMessage( this, msg );
88  return true;
89  }
90 
91  return false;
92 }
const wxString & GetFileName() const
Definition: sch_screen.h:185
SCH_SCREEN * GetScreen() const
Definition: sch_sheet.h:282
#define _(s)
Definition: 3d_actions.cpp:33
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References _, DisplayInfoMessage(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetScreen(), and SCH_SCREENS::HasNoFullyDefinedLibIds().

Referenced by LoadSheetFromFile().

◆ CheckSheetForRecursion()

bool SCH_EDIT_FRAME::CheckSheetForRecursion ( SCH_SHEET aSheet,
SCH_SHEET_PATH aHierarchy 
)

Verify that aSheet will not cause a recursion error in aHierarchy.

Parameters
aSheetis the SCH_SHEET object to test.
aHierarchyis the SCH_SHEET_PATH where aSheet is going to reside.
Returns
true if aSheet will cause a resursion error in aHierarchy.

Definition at line 46 of file sheet.cpp.

47 {
48  wxASSERT( aSheet && aHierarchy );
49 
50  wxString msg;
51  SCH_SHEET_LIST hierarchy = Schematic().GetSheets(); // The full schematic sheet hierarchy.
52  SCH_SHEET_LIST sheetHierarchy( aSheet ); // This is the hierarchy of the loaded file.
53 
54  wxFileName destFile = aHierarchy->LastScreen()->GetFileName();
55 
56  // SCH_SCREEN object file paths are expected to be absolute. If this assert fires,
57  // something is seriously broken.
58  wxASSERT( destFile.IsAbsolute() );
59 
60  if( hierarchy.TestForRecursion( sheetHierarchy, destFile.GetFullPath() ) )
61  {
62  msg.Printf( _( "The sheet changes cannot be made because the destination sheet already "
63  "has the sheet \"%s\" or one of it's subsheets as a parent somewhere in "
64  "the schematic hierarchy." ),
65  destFile.GetFullPath() );
66  DisplayError( this, msg );
67  return true;
68  }
69 
70  return false;
71 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
SCH_SHEET_LIST.
const wxString & GetFileName() const
Definition: sch_screen.h:185
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
bool TestForRecursion(const SCH_SHEET_LIST &aSrcSheetHierarchy, const wxString &aDestFileName)
Function TestForRecursion.
SCHEMATIC & Schematic() const
SCH_SCREEN * LastScreen()
Function LastScreen.
#define _(s)
Definition: 3d_actions.cpp:33

References _, DisplayError(), SCH_SCREEN::GetFileName(), SCHEMATIC::GetSheets(), SCH_SHEET_PATH::LastScreen(), Schematic(), and SCH_SHEET_LIST::TestForRecursion().

Referenced by LoadSheetFromFile(), and DIALOG_SCH_SHEET_PROPS::onSheetFilenameChanged().

◆ ClearExecFlags()

void SCH_EDIT_FRAME::ClearExecFlags ( const int  aFlags)
inline

Clear (removes) specified flags that not needed for next execution of external generator of the netlist or bom.

Parameters
aFlags= wxEXEC_* flags, see wxExecute docs.

Definition at line 898 of file sch_edit_frame.h.

898 { m_exec_flags &= ~( aFlags ); }
int m_exec_flags
Flags of the wxExecute() function to call a custom net list generator.

References m_exec_flags.

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY aFileHistory = nullptr)
inherited

Removes all files from the file history.

Parameters
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used

Definition at line 743 of file eda_base_frame.cpp.

744 {
745  if( !aFileHistory )
746  aFileHistory = m_fileHistory;
747 
748  wxASSERT( aFileHistory );
749 
750  aFileHistory->ClearFileHistory();
751 
752  // Update the menubar to update the file history menu
753  if( GetMenuBar() )
754  {
755  ReCreateMenuBar();
756  GetMenuBar()->Refresh();
757  }
758 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ ClearFindReplaceStatus()

void SCH_EDIT_FRAME::ClearFindReplaceStatus ( )

Definition at line 814 of file sch_edit_frame.cpp.

815 {
816  m_infoBar->Dismiss();
817 }
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:139
WX_INFOBAR * m_infoBar

References WX_INFOBAR::Dismiss(), and EDA_BASE_FRAME::m_infoBar.

Referenced by SCH_EDITOR_CONTROL::FindNext().

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

void SCH_EDIT_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  whichList,
int  aItemCount = -1 
)
overridevirtual

Free the undo or redo list from aList element.

  • Wrappers are deleted.
  • data pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED)
Parameters
whichList= the UNDO_REDO_CONTAINER to clear
aItemCount= the count of items to remove. < 0 for all items items are removed from the beginning of the list. So this function can be called to remove old commands

Reimplemented from EDA_BASE_FRAME.

Definition at line 372 of file schematic_undo_redo.cpp.

373 {
374  if( aItemCount == 0 )
375  return;
376 
377  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
378 
379  for( PICKED_ITEMS_LIST* command : list.m_CommandsList )
380  {
381  command->ClearListAndDeleteItems();
382  delete command;
383  }
384 
385  list.m_CommandsList.clear();
386 }
UNDO_REDO_CONTAINER m_undoList
UNDO_REDO_CONTAINER is a holder to handle alist of undo (or redo) command.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
UNDO_REDO_CONTAINER m_redoList
void ClearListAndDeleteItems()
Function ClearListAndDeleteItems deletes the list of pickers, AND the data pointed by m_PickedItem or...

References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), UNDO_REDO_CONTAINER::m_CommandsList, EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoList, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by DIALOG_SYMBOL_REMAP::OnRemapSymbols(), and SaveCopyInUndoList().

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

void SCH_EDIT_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtual

Called after the preferences dialog is run.

Reimplemented from SCH_BASE_FRAME.

Definition at line 1153 of file sch_edit_frame.cpp.

1154 {
1155  SCH_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1156 
1158  GetCanvas()->Refresh();
1159 
1160  RecreateToolbars();
1161  Layout();
1162  SendSizeEvent();
1163 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateAllItems(int aUpdateFlags)
Updates all items in the view according to the given flags.
Definition: view.cpp:1435
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of ckeck tools.
Item needs to be redrawn.
Definition: view_item.h:63
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.

References KIGFX::ALL, SCH_BASE_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::GetCanvas(), SCH_DRAW_PANEL::GetView(), EDA_DRAW_FRAME::RecreateToolbars(), EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::UpdateAllItems().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 642 of file eda_base_frame.cpp.

643 {
644  // KICAD_MANAGER_FRAME overrides this
645  return Kiface().KifaceSettings();
646 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

References Kiface(), and KIFACE_I::KifaceSettings().

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited
Returns
a base name prefix used in Load/Save settings to build the full name of keys used in config. This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single config can be used.

Reimplemented from TOOLS_HOLDER.

Definition at line 421 of file eda_base_frame.h.

422  {
423  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
424  return baseCfgName;
425  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ ConvertPart()

void SCH_EDIT_FRAME::ConvertPart ( SCH_COMPONENT aComponent)

Definition at line 235 of file getpart.cpp.

236 {
237  if( !aComponent || !aComponent->GetPartRef() )
238  return;
239 
240  wxString msg;
241 
242  if( !aComponent->GetPartRef()->HasConversion() )
243  {
244  LIB_ID id = aComponent->GetPartRef()->GetLibId();
245 
246  msg.Printf( _( "No alternate body style found for symbol \"%s\" in library \"%s\"." ),
247  id.GetLibItemName().wx_str(), id.GetLibNickname().wx_str() );
248  DisplayError( this, msg );
249  return;
250  }
251 
252  STATUS_FLAGS savedFlags = aComponent->GetFlags();
253 
254  aComponent->SetConvert( aComponent->GetConvert() + 1 );
255 
256  // ensure m_Convert = 1 or 2
257  // 1 = shape 1 = not converted
258  // 2 = shape 2 = first converted shape
259  // > 2 is not used but could be used for more shapes
260  // like multiple shapes for a programmable component
261  // When m_Convert = val max, return to the first shape
262  if( aComponent->GetConvert() > LIB_ITEM::LIB_CONVERT::DEMORGAN )
263  aComponent->SetConvert( LIB_ITEM::LIB_CONVERT::BASE );
264 
266  aComponent->ClearFlags();
267  aComponent->SetFlags( savedFlags ); // Restore m_Flags (modified by SetConvert())
268 
269  // If selected make sure all the now-included pins are selected
270  if( aComponent->IsSelected() )
271  m_toolManager->RunAction( EE_ACTIONS::addItemToSel, true, aComponent );
272 
273  UpdateItem( aComponent );
274  OnModify();
275 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
bool IsSelected() const
Definition: base_struct.h:203
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetConvert(int aConvert)
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232
static TOOL_ACTION addItemToSel
Selects an item (specified as the event parameter).
Definition: ee_actions.h:59
unsigned STATUS_FLAGS
Definition: base_struct.h:152
std::unique_ptr< LIB_PART > & GetPartRef()
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
#define _(s)
Definition: 3d_actions.cpp:33
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
int GetConvert() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:234

References _, EE_ACTIONS::addItemToSel, EDA_ITEM::ClearFlags(), DisplayError(), SCH_COMPONENT::GetConvert(), EDA_ITEM::GetFlags(), SCH_COMPONENT::GetPartRef(), EDA_ITEM::IsSelected(), TOOLS_HOLDER::m_toolManager, OnModify(), TOOL_MANAGER::RunAction(), SCH_COMPONENT::SetConvert(), EDA_ITEM::SetFlags(), TestDanglingEnds(), and SCH_BASE_FRAME::UpdateItem().

Referenced by SCH_EDIT_TOOL::ConvertDeMorgan().

◆ ConvertTimeStampUuids()

void SCH_EDIT_FRAME::ConvertTimeStampUuids ( )

Convert sheet and symbol legacy time stamp UUIDs to full UUIDs.

Warning
This is a work in progress. It only contains the original code that automatically updated the UUIDs when loading legacy schematics. This is an incomplete solution because a way to force a PCB update from schematic with the update symbol links from references setting must be executed to ensure proper synchronization between the schematic and board.

Definition at line 1315 of file sch_edit_frame.cpp.

1316 {
1317  // Remove this once this method is fully implemented. Otherwise, don't use it.
1318  wxCHECK( false, /* void */ );
1319 
1320  // Replace sheet and symbol time stamps with real UUIDs and update symbol instance
1321  // sheet paths using the new UUID based sheet paths.
1322 
1323  // Save the time stamp sheet paths.
1324  SCH_SHEET_LIST timeStampSheetPaths = Schematic().GetSheets();
1325 
1326  std::vector<KIID_PATH> oldSheetPaths = timeStampSheetPaths.GetPaths();
1327 
1328  // The root sheet now gets a permanent UUID.
1329  const_cast<KIID&>( Schematic().Root().m_Uuid ).ConvertTimestampToUuid();
1330 
1331  SCH_SCREENS schematic( Schematic().Root() );
1332 
1333  // Change the sheet and symbol time stamps to UUIDs.
1334  for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
1335  {
1336  for( auto sheet : screen->Items().OfType( SCH_SHEET_T ) )
1337  const_cast<KIID&>( sheet->m_Uuid ).ConvertTimestampToUuid();
1338 
1339  for( auto symbol : screen->Items().OfType( SCH_COMPONENT_T ) )
1340  const_cast<KIID&>( symbol->m_Uuid ).ConvertTimestampToUuid();
1341  }
1342 
1343  timeStampSheetPaths.ReplaceLegacySheetPaths( oldSheetPaths );
1344 }
SCH_SHEET_LIST.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
SCHEMATIC & Schematic() const
std::vector< KIID_PATH > GetPaths() const
void ReplaceLegacySheetPaths(const std::vector< KIID_PATH > &aOldSheetPaths)
Update all of the symbol sheet paths to the sheet paths defined in aOldSheetPaths.
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), SCH_SHEET_LIST::GetPaths(), SCHEMATIC::GetSheets(), SCH_SHEET_LIST::ReplaceLegacySheetPaths(), SCH_COMPONENT_T, SCH_SHEET_T, and Schematic().

◆ CreateArchiveLibrary()

bool SCH_EDIT_FRAME::CreateArchiveLibrary ( const wxString &  aFileName)

Create a library aFileName that contains all components used in the current schematic.

Parameters
aFileNameThe full path and file name of the archive library.
Returns
True if aFileName was written successfully.

Definition at line 66 of file libarch.cpp.

67 {
68  wxString tmp;
69  wxString errorMsg;
70  SCH_SCREENS screens( Schematic().Root() );
71 
72  // Create a new empty library to archive components:
73  std::unique_ptr<PART_LIB> archLib( new PART_LIB( LIBRARY_TYPE_EESCHEMA, aFileName ) );
74 
75  // Save symbols to file only when the library will be fully filled
76  archLib->EnableBuffering();
77 
78  /* Examine all screens (not hierarchical sheets) used in the schematic and build a
79  * library of unique symbols found in all screens. Complex hierarchies are not a
80  * problem because we just want to know the library symbols used in the schematic
81  * not their reference.
82  */
83  for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
84  {
85 
86  for( auto aItem : screen->Items().OfType( SCH_COMPONENT_T ) )
87  {
88  LIB_PART* part = nullptr;
89  auto component = static_cast<SCH_COMPONENT*>( aItem );
90 
91  try
92  {
93  if( archLib->FindPart( component->GetLibId() ) )
94  continue;
95 
96  part = GetLibPart( component->GetLibId(), true );
97  }
98  catch( const IO_ERROR& )
99  {
100  // Queue up error messages for later.
101  tmp.Printf( _( "Failed to add symbol \"%s\" to library file \"%s\"." ),
102  component->GetLibId().GetUniStringLibItemName(), aFileName );
103 
104  // Don't bail out here. Attempt to add as many of the symbols to the library
105  // as possible.
106  }
107  catch( ... )
108  {
109  tmp = _( "Unexpected exception occurred." );
110  }
111 
112  if( part )
113  {
114  std::unique_ptr<LIB_PART> flattenedPart = part->Flatten();
115 
116  // Use the full LIB_ID as the symbol name to prevent symbol name collisions.
117  flattenedPart->SetName( component->GetLibId().GetUniStringLibId() );
118 
119  // AddPart() does first clone the part before adding.
120  archLib->AddPart( flattenedPart.get() );
121  }
122  else
123  {
124  tmp.Printf( _( "Symbol %s not found in any library or cache." ),
125  component->GetLibId().GetUniStringLibId() );
126  }
127 
128  if( !tmp.empty() && !errorMsg.Contains( component->GetLibId().GetUniStringLibId() ) )
129  {
130  if( errorMsg.empty() )
131  errorMsg += tmp;
132  else
133  errorMsg += "\n" + tmp;
134  }
135  }
136  }
137 
138  if( !errorMsg.empty() )
139  {
140  tmp.Printf( _( "Errors occurred creating symbol library %s." ), aFileName );
141  DisplayErrorMessage( this, tmp, errorMsg );
142  }
143 
144  archLib->EnableBuffering( false );
145 
146  try
147  {
148  archLib->Save( false );
149  }
150  catch( const IO_ERROR& ioe )
151  {
152  errorMsg.Printf( _( "Failed to save symbol library file \"%s\"" ), aFileName );
153  DisplayErrorMessage( this, errorMsg, ioe.What() );
154  return false;
155  }
156  catch( std::exception& error )
157  {
158  errorMsg.Printf( _( "Failed to save symbol library file \"%s\"" ), aFileName );
159  DisplayErrorMessage( this, errorMsg, error.what() );
160  return false;
161  }
162 
163  return true;
164 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:252
LIB_PART * GetLibPart(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
SCHEMATIC & Schematic() const
Define a library symbol object.
std::unique_ptr< LIB_PART > Flatten() const
Return a flattened symbol inheritance to the caller.
#define _(s)
Definition: 3d_actions.cpp:33
Object used to load, save, search, and otherwise manipulate symbol library files.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References _, DisplayErrorMessage(), LIB_PART::Flatten(), SCH_SCREENS::GetFirst(), SCH_BASE_FRAME::GetLibPart(), SCH_SCREENS::GetNext(), LIBRARY_TYPE_EESCHEMA, SCH_COMPONENT_T, Schematic(), and IO_ERROR::What().

Referenced by CreateArchiveLibraryCacheFile().

◆ CreateArchiveLibraryCacheFile()

bool SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile ( bool  aUseCurrentSheetFilename = false)

Create a symbol library file with the name of the root document plus the '-cache' suffix,.

This file will contain all components used in the current schematic.

Parameters
aUseCurrentSheetFilename= false to use the root sheet filename (default) or true to use the currently opened sheet.
Returns
true if the file was written successfully.

Definition at line 43 of file libarch.cpp.

44 {
45  wxFileName fn;
46 
47  if( aUseCurrentSheetFilename )
48  fn = GetScreen()->GetFileName();
49  else
50  fn = Schematic().RootScreen()->GetFileName();
51 
52  fn.SetName( fn.GetName() + "-cache" );
53  fn.SetExt( LegacySymbolLibFileExtension );
54 
55  bool success = CreateArchiveLibrary( fn.GetFullPath() );
56 
57  // Update the schematic symbol library links.
58  // because the lib cache has changed
59  SCH_SCREENS schematic( Schematic().Root() );
60  schematic.UpdateSymbolLinks();
61 
62  return success;
63 }
const wxString & GetFileName() const
Definition: sch_screen.h:185
const std::string LegacySymbolLibFileExtension
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SCHEMATIC & Schematic() const
SCH_SCREEN * RootScreen() const
Helper to retreive the screen of the root sheet.
Definition: schematic.cpp:112
bool CreateArchiveLibrary(const wxString &aFileName)
Create a library aFileName that contains all components used in the current schematic.
Definition: libarch.cpp:66
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References CreateArchiveLibrary(), SCH_SCREEN::GetFileName(), GetScreen(), LegacySymbolLibFileExtension, SCHEMATIC::RootScreen(), and Schematic().

Referenced by Save_File().

◆ createCanvas()

void SCH_BASE_FRAME::createCanvas ( )
inherited

Definition at line 301 of file sch_base_frame.cpp.

302 {
304 
305  // Allows only a CAIRO or OPENGL canvas:
308  {
310  }
311 
312  SetCanvas( new SCH_DRAW_PANEL( this, wxID_ANY, wxPoint( 0, 0 ), m_FrameSize,
315 }
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
static constexpr GAL_TYPE GAL_FALLBACK
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)

References EDA_DRAW_FRAME::ActivateGalCanvas(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, EDA_DRAW_FRAME::GetGalDisplayOptions(), EDA_DRAW_FRAME::LoadCanvasTypeSetting(), EDA_DRAW_FRAME::m_canvasType, EDA_BASE_FRAME::m_FrameSize, and EDA_DRAW_FRAME::SetCanvas().

Referenced by SCH_BASE_FRAME::SCH_BASE_FRAME().

◆ CreateScreens()

void SCH_EDIT_FRAME::CreateScreens ( )

Definition at line 522 of file sch_edit_frame.cpp.

523 {
524  m_schematic->Reset();
525  m_schematic->SetProject( &Prj() );
526 
528 
530 
531  SCH_SCREEN* rootScreen = new SCH_SCREEN( m_schematic );
532  m_schematic->Root().SetScreen( rootScreen );
533  SetScreen( Schematic().RootScreen() );
534 
535  m_schematic->RootScreen()->SetFileName( wxEmptyString );
536 
537  if( GetScreen() == NULL )
538  {
539  SCH_SCREEN* screen = new SCH_SCREEN( m_schematic );
540  SetScreen( screen );
541  }
542 }
SCHEMATIC * m_schematic
The currently loaded schematic.
void SetScreen(BASE_SCREEN *aScreen) override
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:124
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
Definition: sch_sheet.cpp:150
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SetRoot(SCH_SHEET *aRootSheet)
Initializes the schematic with a new root sheet.
Definition: schematic.cpp:99
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
SCHEMATIC & Schematic() const
SCHEMATIC_SETTINGS * m_defaults
void SetProject(PROJECT *aPrj)
Definition: schematic.cpp:72
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
void Reset()
Initializes this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:49
SCH_SHEET & Root() const
Definition: schematic.h:94
void SetFileName(const wxString &aFileName)
Definition: sch_screen.h:183
SCH_SCREEN * RootScreen() const
Helper to retreive the screen of the root sheet.
Definition: schematic.cpp:112

References GetScreen(), SCH_BASE_FRAME::m_defaults, m_schematic, NULL, KIWAY_HOLDER::Prj(), SCHEMATIC::Reset(), SCHEMATIC::Root(), SCHEMATIC::RootScreen(), Schematic(), SCH_SCREEN::SetFileName(), SCHEMATIC::SetProject(), SCHEMATIC::SetRoot(), SCH_SHEET::SetScreen(), SetScreen(), and SCHEMATIC::Settings().

Referenced by importFile(), and OpenProjectFiles().

◆ CreateServer()

void EDA_DRAW_FRAME::CreateServer ( int  service,
bool  local = true 
)
inherited

Definition at line 49 of file eda_dde.cpp.

50 {
51  wxIPV4address addr;
52 
53  // Set the port number
54  addr.Service( service );
55 
56  // Listen on localhost only if requested
57  if( local )
58  addr.Hostname( HOSTNAME );
59 
60  delete m_socketServer;
61  m_socketServer = new wxSocketServer( addr );
62 
63  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
64  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
65  m_socketServer->Notify( true );
66 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and EDA_DRAW_FRAME::m_socketServer.

Referenced by SCH::IFACE::CreateWindow().

◆ CreateSheetPin()

SCH_SHEET_PIN * SCH_EDIT_FRAME::CreateSheetPin ( SCH_SHEET aSheet,
SCH_HIERLABEL aLabel 
)

Create a new SCH_SHEET_PIN object and add it to aSheet at the current cursor position.

Parameters
aSheetThe sheet to add the new sheet pin to.
Returns
The new sheet pin object created or NULL if the task was aborted by the user.

Definition at line 483 of file sheet.cpp.

484 {
485  SCHEMATIC_SETTINGS& settings = aSheet->Schematic()->Settings();
486  wxString text;
487  SCH_SHEET_PIN* sheetPin;
488 
489  if( aLabel )
490  {
491  text = aLabel->GetText();
492  m_lastSheetPinType = aLabel->GetShape();
493  }
494 
495  sheetPin = new SCH_SHEET_PIN( aSheet, wxPoint( 0, 0 ), text );
496  sheetPin->SetFlags( IS_NEW );
497  sheetPin->SetTextSize( wxSize( settings.m_DefaultTextSize, settings.m_DefaultTextSize ) );
498  sheetPin->SetShape( m_lastSheetPinType );
499 
500  if( !aLabel )
501  {
502  DIALOG_EDIT_SHEET_PIN dlg( this, sheetPin );
503 
504  if( dlg.ShowModal() != wxID_OK || sheetPin->GetText().IsEmpty() )
505  {
506  delete sheetPin;
507  return nullptr;
508  }
509  }
510 
511  m_lastSheetPinType = sheetPin->GetShape();
512 
513  sheetPin->SetPosition( (wxPoint) GetCanvas()->GetViewControls()->GetCursorPosition() );
514 
515  return sheetPin;
516 }
void SetShape(PINSHEETLABEL_SHAPE aShape)
Definition: sch_text.h:241
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:124
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:238
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232
static PINSHEETLABEL_SHAPE m_lastSheetPinType
Last sheet pin type.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
void SetPosition(const wxPoint &aPosition) override
Definition: sch_sheet.h:205
These settings were stored in SCH_BASE_FRAME previously.
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:127
PINSHEETLABEL_SHAPE GetShape() const
Definition: sch_text.h:239

References SCH_BASE_FRAME::GetCanvas(), SCH_TEXT::GetShape(), EDA_TEXT::GetText(), IS_NEW, SCHEMATIC_SETTINGS::m_DefaultTextSize, m_lastSheetPinType, SCH_ITEM::Schematic(), EDA_ITEM::SetFlags(), SCH_SHEET_PIN::SetPosition(), SCH_TEXT::SetShape(), EDA_TEXT::SetTextSize(), and SCHEMATIC::Settings().

Referenced by SCH_DRAWING_TOOLS::TwoClickPlace().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const
inherited

Definition at line 99 of file tools_holder.cpp.

100 {
101  if( m_toolStack.empty() )
102  return ACTIONS::selectionTool.GetName();
103  else
104  return m_toolStack.back();
105 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:56
static TOOL_ACTION selectionTool
Definition: actions.h:149

References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOL_MANAGER::processEvent().

◆ DefaultExecFlags()

void SCH_EDIT_FRAME::DefaultExecFlags ( )
inline

Reset the execution flags to defaults for external netlist and bom generators.

Definition at line 883 of file sch_edit_frame.h.

883 { m_exec_flags = wxEXEC_SYNC; }
int m_exec_flags
Flags of the wxExecute() function to call a custom net list generator.

References m_exec_flags.

Referenced by WriteNetListFile().

◆ DeleteAnnotation()

void SCH_EDIT_FRAME::DeleteAnnotation ( bool  aCurrentSheetOnly,
bool *  appendUndo 
)

Clear the current component annotation.

Parameters
aCurrentSheetOnlyClear only the annotation for the current sheet if true. Otherwise clear the entire schematic annotation.

Definition at line 61 of file eeschema/annotate.cpp.

62 {
63  auto clearAnnotation =
64  [&]( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aSheet )
65  {
66  for( SCH_ITEM* item : aScreen->Items().OfType( SCH_COMPONENT_T ) )
67  {
68  SCH_COMPONENT* component = static_cast<SCH_COMPONENT*>( item );
69 
70  SaveCopyInUndoList( aScreen, component, UNDO_REDO::CHANGED, *aAppendUndo );
71  *aAppendUndo = true;
72  component->ClearAnnotation( aSheet );
73  }
74  };
75 
76  if( aCurrentSheetOnly )
77  {
78  clearAnnotation( GetScreen(), &GetCurrentSheet() );
79  }
80  else
81  {
82  for( const SCH_SHEET_PATH& sheet : Schematic().GetSheets() )
83  clearAnnotation( sheet.LastScreen(), nullptr );
84  }
85 
86  // Update the references for the sheet that is currently being displayed.
88 
89  SyncView();
90  GetCanvas()->Refresh();
91  OnModify();
92 
93  // Must go after OnModify() so the connectivity graph has been updated
95 }
void UpdateNetHighlightStatus()
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
void UpdateAllScreenReferences()
Function UpdateAllScreenReferences updates the reference and the m_Multi parameter (part selection) f...
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SyncView()
Mark all items for refresh.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
SCHEMATIC & Schematic() const
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
SCH_SHEET_PATH.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
EE_RTREE & Items()
Definition: sch_screen.h:158
Schematic symbol object.
Definition: sch_component.h:80
SCH_SHEET_PATH & GetCurrentSheet() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
void ClearAnnotation(const SCH_SHEET_PATH *aSheetPath)
Clear exiting component annotation.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194

References CHANGED, SCH_COMPONENT::ClearAnnotation(), SCH_BASE_FRAME::GetCanvas(), GetCurrentSheet(), GetScreen(), SCH_SCREEN::Items(), EE_RTREE::OfType(), OnModify(), EDA_DRAW_PANEL_GAL::Refresh(), SaveCopyInUndoList(), SCH_COMPONENT_T, Schematic(), SCH_BASE_FRAME::SyncView(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and UpdateNetHighlightStatus().

Referenced by AnnotateComponents(), and DIALOG_ANNOTATE::OnClearAnnotationClick().

◆ DeleteJunction()

void SCH_EDIT_FRAME::DeleteJunction ( SCH_ITEM aItem,
bool  aAppend = false 
)

Removes a given junction and heals any wire segments under the junction.

Parameters
aItemThe junction to delete
aAppendTrue if we are updating an ongoing commit

Note that std::list or similar is required here as we may insert values in the loop below. This will invalidate iterators in a std::vector or std::deque

Definition at line 378 of file bus-wire-junction.cpp.

379 {
380  SCH_SCREEN* screen = GetScreen();
381  PICKED_ITEMS_LIST undoList;
384 
385  auto remove_item = [ & ]( SCH_ITEM* aItem ) -> void
386  {
387  aItem->SetFlags( STRUCT_DELETED );
388  undoList.PushItem( ITEM_PICKER( screen, aItem, UNDO_REDO::DELETED ) );
389  };
390 
391  remove_item( aJunction );
392  RemoveFromScreen( aJunction, screen );
393 
396  std::list<SCH_LINE*> lines;
397 
398  for( SCH_ITEM* item : screen->Items().Overlapping( SCH_LINE_T, aJunction->GetPosition() ) )
399  {
400  SCH_LINE* line = static_cast<SCH_LINE*>( item );
401 
402  if( line->IsType( wiresAndBuses ) && line->IsEndPoint( aJunction->GetPosition() )
403  && !( line->GetEditFlags() & STRUCT_DELETED ) )
404  lines.push_back( line );
405  }
406 
407  alg::for_all_pairs( lines.begin(), lines.end(),
408  [&]( SCH_LINE* firstLine, SCH_LINE* secondLine )
409  {
410  if( ( firstLine->GetEditFlags() & STRUCT_DELETED )
411  || ( secondLine->GetEditFlags() & STRUCT_DELETED )
412  || !secondLine->IsParallel( firstLine ) )
413  {
414  return;
415  }
416 
417  // Remove identical lines
418  if( firstLine->IsEndPoint( secondLine->GetStartPoint() )
419  && firstLine->IsEndPoint( secondLine->GetEndPoint() ) )
420  {
421  remove_item( firstLine );
422  return;
423  }
424 
425  // Try to merge the remaining lines
426  if( SCH_LINE* line = secondLine->MergeOverlap( firstLine ) )
427  {
428  remove_item( firstLine );
429  remove_item( secondLine );
430  undoList.PushItem( ITEM_PICKER( screen, line, UNDO_REDO::NEWITEM ) );
431  AddToScreen( line, screen );
432 
433  if( line->IsSelected() )
434  selectionTool->AddItemToSel( line, true /*quiet mode*/ );
435 
436  lines.push_back( line );
437  }
438  } );
439 
440  SaveCopyInUndoList( undoList, UNDO_REDO::DELETED, aAppend );
441 
442 
443  for( auto line : lines )
444  {
445  if( line->GetEditFlags() & STRUCT_DELETED )
446  {
447  if( line->IsSelected() )
448  selectionTool->RemoveItemFromSel( line, true /*quiet mode*/ );
449 
450  RemoveFromScreen( line, screen );
451  }
452  }
453 }
SCH_LINE * MergeOverlap(SCH_LINE *aLine)
Check line against aLine to see if it overlaps and merge if it does.
Definition: sch_line.cpp:403
bool IsSelected() const
Definition: base_struct.h:203
EE_TYPE Overlapping(const EDA_RECT &aRect)
Definition: sch_rtree.h:224
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,...
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void for_all_pairs(_InputIterator __first, _InputIterator __last, _Function __f)
Apply a function to every possible pair of elements of a sequence.
Definition: kicad_algo.h:63
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232
STATUS_FLAGS GetEditFlags() const
Definition: base_struct.h:237
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:87
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
int AddItemToSel(const TOOL_EVENT &aEvent)
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
EE_RTREE & Items()
Definition: sch_screen.h:158
bool IsType(const KICAD_T aScanTypes[]) const override
Function IsType Checks whether the item is one of the listed types.
Definition: sch_line.h:69
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194

References EE_SELECTION_TOOL::AddItemToSel(), SCH_BASE_FRAME::AddToScreen(), DELETED, EOT, alg::for_all_pairs(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetPosition(), GetScreen(), TOOL_MANAGER::GetTool(), SCH_LINE::IsEndPoint(), SCH_LINE::IsType(), SCH_SCREEN::Items(), TOOLS_HOLDER::m_toolManager, SCH_LINE::MergeOverlap(), NEWITEM, EE_RTREE::Overlapping(), PICKED_ITEMS_LIST::PushItem(), SCH_BASE_FRAME::RemoveFromScreen(), EE_SELECTION_TOOL::RemoveItemFromSel(), SaveCopyInUndoList(), SCH_LINE_LOCATE_BUS_T, SCH_LINE_LOCATE_WIRE_T, SCH_LINE_T, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::DoDelete().

◆ Destroy()

◆ DismissModal()

void KIWAY_PLAYER::DismissModal ( bool  aRetVal,
const wxString &  aResult = wxEmptyString 
)
inherited

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = 0; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:205
wxString m_modal_string
Definition: kiway_player.h:204
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:202

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), LIB_VIEW_FRAME::FinishModal(), and LIB_VIEW_FRAME::OnCloseWindow().

◆ DisplayCurrentSheet()

void SCH_EDIT_FRAME::DisplayCurrentSheet ( )

Draw the current sheet on the display.

Definition at line 236 of file hierarch.cpp.

237 {
240 
241  SCH_SCREEN* screen = GetCurrentSheet().LastScreen();
242 
243  wxASSERT( screen );
244 
245  SetScreen( screen );
246 
247  // update the References
250 
251  if( !screen->m_Initialized )
252  {
254  screen->m_Initialized = true;
255  }
256  else
257  {
258  // RedrawScreen() will set zoom to last used
259  RedrawScreen( (wxPoint) GetScreen()->m_ScrollCenter, false );
260  }
261 
262  UpdateTitle();
263 
266  editTool->UpdateNetHighlighting( dummy );
267 
268  HardRedraw(); // Ensure any item has its view updated, especially the worksheet items
269 }
virtual void RedrawScreen(const wxPoint &aCenterPoint, bool aWarpPointer)
void SetScreen(BASE_SCREEN *aScreen) override
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
void UpdateTitle()
Set the main window title bar text.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
void UpdateAllScreenReferences()
Function UpdateAllScreenReferences updates the reference and the m_Multi parameter (part selection) f...
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SCH_EDITOR_CONTROL.
void HardRedraw() override
Rebuild the GAL and redraw the screen.
bool m_Initialized
Definition: base_screen.h:77
TOOL_EVENT.
Definition: tool_event.h:171
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:56
int UpdateNetHighlighting(const TOOL_EVENT &aEvent)
Updates net highlighting after an edit
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
SCH_SCREEN * LastScreen()
Function LastScreen.
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
SCH_SHEET_PATH & GetCurrentSheet() const

References ACTIONS::cancelInteractive, EE_ACTIONS::clearSelection, dummy(), GetCurrentSheet(), GetScreen(), TOOL_MANAGER::GetTool(), HardRedraw(), SCH_SHEET_PATH::LastScreen(), BASE_SCREEN::m_Initialized, TOOLS_HOLDER::m_toolManager, SCH_BASE_FRAME::RedrawScreen(), TOOL_MANAGER::RunAction(), SetScreen(), SetSheetNumberAndCount(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), UpdateTitle(), and ACTIONS::zoomFitScreen.

Referenced by SCH_EDITOR_CONTROL::EnterSheet(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::LeaveSheet(), DIALOG_ERC::OnERCItemSelected(), OnPageSettingsChange(), and HIERARCHY_NAVIG_DLG::onSelectSheetPath().

◆ DisplayGridMsg()

void EDA_DRAW_FRAME::DisplayGridMsg ( )
virtualinherited

Display current grid size in the status bar.

Reimplemented in PCB_BASE_FRAME, GERBVIEW_FRAME, and PL_EDITOR_FRAME.

Definition at line 474 of file eda_draw_frame.cpp.

475 {
476  wxString line;
477  wxString gridformatter;
478 
479  switch( m_userUnits )
480  {
481  case EDA_UNITS::INCHES: gridformatter = "grid %.3f"; break;
482  case EDA_UNITS::MILLIMETRES: gridformatter = "grid %.4f"; break;
483  default: gridformatter = "grid %f"; break;
484  }
485 
486  double grid = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x );
487  line.Printf( gridformatter, grid );
488 
489  SetStatusText( line, 4 );
490 }
double To_User_Unit(EDA_UNITS aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:92
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS m_userUnits

References EDA_DRAW_FRAME::GetCanvas(), INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and To_User_Unit().

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString &  msg)
overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 465 of file eda_draw_frame.cpp.

466 {
467  SetStatusText( msg, 6 );
468 }

Referenced by EDIT_TOOL::Duplicate(), and PCBNEW_CONTROL::Paste().

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 493 of file eda_draw_frame.cpp.

494 {
495  wxString msg;
496 
497  switch( m_userUnits )
498  {
499  case EDA_UNITS::INCHES: msg = _( "Inches" ); break;
500  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
501  default: msg = _( "Units" ); break;
502  }
503 
504  SetStatusText( msg, 5 );
505 }
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits

References _, INCHES, EDA_BASE_FRAME::m_userUnits, and MILLIMETRES.

Referenced by EDA_DRAW_FRAME::UpdateGridSelectBox(), SCH_BASE_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ doAutoSave()

bool SCH_EDIT_FRAME::doAutoSave ( )
overrideprotectedvirtual

Save the schematic files that have been modified and not yet saved.

Returns
true if the auto save was successful otherwise false.

Reimplemented from EDA_BASE_FRAME.

Definition at line 809 of file eeschema/files-io.cpp.

810 {
811  wxFileName tmpFileName = Schematic().Root().GetFileName();
812  wxFileName fn = tmpFileName;
813  wxFileName tmp;
814  SCH_SCREENS screens( Schematic().Root() );
815 
816  bool autoSaveOk = true;
817 
818  tmp.AssignDir( fn.GetPath() );
819 
820  if( !tmp.IsOk() )
821  return false;
822 
823  if( !IsWritable( tmp ) )
824  return false;
825 
826  for( size_t i = 0; i < screens.GetCount(); i++ )
827  {
828  // Only create auto save files for the schematics that have been modified.
829  if( !screens.GetScreen( i )->IsSave() )
830  continue;
831 
832  tmpFileName = fn = screens.GetScreen( i )->GetFileName();
833 
834  // Auto save file name is the normal file name prefixed with GetAutoSavePrefix().
835  fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
836 
837  screens.GetScreen( i )->SetFileName( fn.GetFullPath() );
838 
839  if( SaveEEFile( screens.GetSheet( i ), false ) )
840  screens.GetScreen( i )->SetModify();
841  else
842  autoSaveOk = false;
843 
844  screens.GetScreen( i )->SetFileName( tmpFileName.GetFullPath() );
845  }
846 
847  if( autoSaveOk )
848  {
849  m_autoSaveState = false;
850 
851  if( !Kiface().IsSingle() &&
853  {
855  }
856  }
857 
858  return autoSaveOk;
859 }
SETTINGS_MANAGER * GetSettingsManager() const
AUTO_BACKUP m_Backup
bool IsWritable(const wxFileName &aFileName)
Checks if aFileName can be written.
bool SaveEEFile(SCH_SHEET *aSheet, bool aSaveUnderNewName=false)
Save aSheet to a schematic file.
bool IsSingle() const
Function IsSingle is this KIFACE_I running under single_top?
Definition: kiface_i.h:117
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
COMMON_SETTINGS * GetCommonSettings() const
Retrieves the common settings shared by all applications.
SCHEMATIC & Schematic() const
wxString GetFileName() const
Return the filename corresponding to this sheet.
Definition: sch_sheet.h:496
static wxString GetAutoSaveFilePrefix()
SCH_SHEET & Root() const
Definition: schematic.h:94
bool backup_on_autosave
Trigger a backup on autosave.
static REPORTER & GetInstance()
Definition: reporter.cpp:105
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References COMMON_SETTINGS::AUTO_BACKUP::backup_on_autosave, EDA_BASE_FRAME::GetAutoSaveFilePrefix(), SETTINGS_MANAGER::GetCommonSettings(), SCH_SCREENS::GetCount(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), NULL_REPORTER::GetInstance(), SCH_SCREENS::GetScreen(), EDA_BASE_FRAME::GetSettingsManager(), SCH_SCREENS::GetSheet(), BASE_SCREEN::IsSave(), KIFACE_I::IsSingle(), EDA_BASE_FRAME::IsWritable(), Kiface(), EDA_BASE_FRAME::m_autoSaveState, COMMON_SETTINGS::m_Backup, SCHEMATIC::Root(), SaveEEFile(), Schematic(), SCH_SCREEN::SetFileName(), BASE_SCREEN::SetModify(), and SETTINGS_MANAGER::TriggerBackupIfNeeded().

◆ doCloseWindow()

void SCH_EDIT_FRAME::doCloseWindow ( )
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 626 of file sch_edit_frame.cpp.

627 {
628  SCH_SHEET_LIST sheetlist = Schematic().GetSheets();
629 
630  // Shutdown all running tools ( and commit any pending change )
631  if( m_toolManager )
633 
634  // Close the find dialog and preserve it's setting if it is displayed.
635  if( m_findReplaceDialog )
636  {
639 
640  m_findReplaceDialog->Destroy();
641  m_findReplaceDialog = nullptr;
642  }
643 
644  if( FindHierarchyNavigator() )
645  FindHierarchyNavigator()->Close( true );
646 
647  SCH_SCREENS screens( Schematic().Root() );
648  wxFileName fn;
649 
650  for( SCH_SCREEN* screen = screens.GetFirst(); screen != NULL; screen = screens.GetNext() )
651  {
652  fn = Prj().AbsolutePath( screen->GetFileName() );
653 
654  // Auto save file name is the normal file name prepended with GetAutoSaveFilePrefix().
655  fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
656 
657  if( fn.FileExists() && fn.IsFileWritable() )
658  wxRemoveFile( fn.GetFullPath() );
659  }
660 
661  sheetlist.ClearModifyStatus();
662 
663  wxString fileName = Prj().AbsolutePath( Schematic().RootScreen()->GetFileName() );
664 
665  if( !Schematic().GetFileName().IsEmpty() && !Schematic().RootScreen()->IsEmpty() )
666  UpdateFileHistory( fileName );
667 
668  Schematic().RootScreen()->Clear();
669 
670  // all sub sheets are deleted, only the main sheet is usable
672 
673  // Clear view before destroying schematic as repaints depend on schematic being valid
674  SetScreen( nullptr );
675 
677  Schematic().Reset();
678 
679  Destroy();
680 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
SCH_SHEET_LIST.
HIERARCHY_NAVIG_DLG * FindHierarchyNavigator()
wxArrayString GetFindEntries() const
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
SETTINGS_MANAGER * GetSettingsManager() const
void SetScreen(BASE_SCREEN *aScreen) override
wxArrayString m_findStringHistoryList
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
VTBL_ENTRY const wxString AbsolutePath(const wxString &aFileName) const
Function AbsolutePath fixes up aFileName if it is relative to the project's directory to be an absolu...
Definition: project.cpp:272
void Clear(bool aFree=true)
Delete all draw items and clears the project settings.
Definition: sch_screen.cpp:198
wxArrayString GetReplaceEntries() const
#define NULL
wxArrayString m_replaceStringHistoryList
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
SCHEMATIC & Schematic() const
DIALOG_SCH_FIND * m_findReplaceDialog
void clear()
Forwarded method from std::vector.
static wxString GetAutoSaveFilePrefix()
void Reset()
Initializes this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:49
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
bool SaveProject(const wxString &aFullPath=wxEmptyString)
Saves a loaded project.
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
SCH_SHEET_PATH & GetCurrentSheet() const
SCH_SCREEN * RootScreen() const
Helper to retreive the screen of the root sheet.
Definition: schematic.cpp:112
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:515

References PROJECT::AbsolutePath(), SCH_SHEET_PATH::clear(), SCH_SCREEN::Clear(), SCH_SHEET_LIST::ClearModifyStatus(), KIWAY_PLAYER::Destroy(), FindHierarchyNavigator(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), GetCurrentSheet(), DIALOG_SCH_FIND::GetFindEntries(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), DIALOG_SCH_FIND::GetReplaceEntries(), EDA_BASE_FRAME::GetSettingsManager(), SCHEMATIC::GetSheets(), m_findReplaceDialog, EDA_DRAW_FRAME::m_findStringHistoryList, EDA_DRAW_FRAME::m_replaceStringHistoryList, TOOLS_HOLDER::m_toolManager, NULL, KIWAY_HOLDER::Prj(), SCHEMATIC::Reset(), SCHEMATIC::RootScreen(), SETTINGS_MANAGER::SaveProject(), Schematic(), SetScreen(), TOOL_MANAGER::ShutdownAllTools(), and EDA_BASE_FRAME::UpdateFileHistory().

◆ DrawCurrentSheetToClipboard()

void SCH_EDIT_FRAME::DrawCurrentSheetToClipboard ( )

Use the wxWidgets print code to draw an image of the current sheet onto the clipboard.

Definition at line 537 of file sheet.cpp.

538 {
539  wxRect DrawArea;
540  BASE_SCREEN* screen = GetScreen();
541 
542  DrawArea.SetSize( GetPageSizeIU() );
543 
544  // Calculate a reasonable dc size, in pixels, and the dc scale to fit
545  // the drawings into the dc size
546  // scale is the ratio resolution (in PPI) / internal units
547  double ppi = 300; // Use 300 pixels per inch to create bitmap images on start
548  double inch2Iu = 1000.0 * IU_PER_MILS;
549  double scale = ppi / inch2Iu;
550 
551  wxSize dcsize = DrawArea.GetSize();
552 
553  int maxdim = std::max( dcsize.x, dcsize.y );
554 
555  // the max size in pixels of the bitmap used to build the sheet copy
556  const int maxbitmapsize = 5600;
557 
558  while( int( maxdim * scale ) > maxbitmapsize )
559  {
560  ppi = ppi / 1.5;
561  scale = ppi / inch2Iu;
562  }
563 
564  dcsize.x *= scale;
565  dcsize.y *= scale;
566 
567  // Set draw offset, zoom... to values needed to draw in the memory DC
568  // after saving initial values:
569  wxPoint tmp_startvisu = screen->m_StartVisu;
570  wxPoint old_org = screen->m_DrawOrg;
571  screen->m_DrawOrg.x = screen->m_DrawOrg.y = 0;
572  screen->m_StartVisu.x = screen->m_StartVisu.y = 0;
573 
574  wxMemoryDC dc;
575  wxBitmap image( dcsize );
576  dc.SelectObject( image );
577  dc.Clear();
578 
579  GRResetPenAndBrush( &dc );
580  GRForceBlackPen( false );
581  dc.SetUserScale( scale, scale );
582 
583  GetRenderSettings()->SetPrintDC( &dc );
584 
586 
587  if( wxTheClipboard->Open() )
588  {
589  // This data objects are held by the clipboard, so do not delete them in the app.
590  wxBitmapDataObject* clipbrd_data = new wxBitmapDataObject( image );
591  wxTheClipboard->SetData( clipbrd_data );
592  wxTheClipboard->Close();
593  }
594 
595  // Deselect Bitmap from DC in order to delete the MemoryDC
596  dc.SelectObject( wxNullBitmap );
597 
598  GRForceBlackPen( false );
599 
600  screen->m_StartVisu = tmp_startvisu;
601  screen->m_DrawOrg = old_org;
602 }
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:122
KIGFX::SCH_RENDER_SETTINGS * GetRenderSettings()
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
wxPoint m_StartVisu
Coordinates in drawing units of the current view position (upper left corner of device)
Definition: base_screen.h:65
void GRForceBlackPen(bool flagforce)
Function GRForceBlackPen.
Definition: gr_basic.cpp:203
BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:43
virtual void PrintPage(RENDER_SETTINGS *aSettings) override
Plot or print the current sheet to the clipboard.
const int scale
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
Definition: base_screen.h:60
#define IU_PER_MILS
Definition: plotter.cpp:138
void SetPrintDC(wxDC *aDC)

References SCH_BASE_FRAME::GetPageSizeIU(), SCH_BASE_FRAME::GetRenderSettings(), GetScreen(), GRForceBlackPen(), GRResetPenAndBrush(), IU_PER_MILS, BASE_SCREEN::m_DrawOrg, BASE_SCREEN::m_StartVisu, PrintPage(), scale, KIGFX::RENDER_SETTINGS::SetPrintDC(), wxPoint::x, and wxPoint::y.

Referenced by SCH_EDITOR_CONTROL::DrawSheetOnClipboard().

◆ EditSheetProperties()

bool SCH_EDIT_FRAME::EditSheetProperties ( SCH_SHEET aSheet,
SCH_SHEET_PATH aHierarchy,
bool *  aClearAnnotationNewItems 
)

Edit an existing sheet or add a new sheet to the schematic.

When aSheet is a new sheet:

  • and the file name already exists in the schematic hierarchy, the screen associated with the sheet found in the hierarchy is associated with aSheet.
  • and the file name already exists on the system, then aSheet is loaded with the existing file.
  • and the file name does not exist in the schematic hierarchy or on the file system, then a new screen is created and associated with aSheet.

When aSheet is an existing sheet:

  • and the file name already exists in the schematic hierarchy, the current associated screen is replace by the one found in the hierarchy.
  • and the file name already exists on the system, the current associated screen file name is changed and the file is loaded.
  • and the file name does not exist in the schematic hierarchy or on the file system, the current associated screen file name is changed and saved to disk.

Note: the screen is not refresh. The caller is responsible to do that

Parameters
aSheetis the sheet to edit
aHierarchyis the current hierarchy containing aSheet
aClearAnnotationNewItemsis a reference to a bool to know if the items managed by this sheet need to have their annotation cleared i.e. when an existing item list is used. it can happens when the edited sheet used an existying file, or becomes a new instance of a already existing sheet.

Definition at line 464 of file sheet.cpp.

466 {
467  if( aSheet == NULL || aHierarchy == NULL )
468  return false;
469 
470  // Get the new texts
471  DIALOG_SCH_SHEET_PROPS dlg( this, aSheet, aClearAnnotationNewItems );
472 
473  if( dlg.ShowModal() == wxID_CANCEL )
474  return false;
475 
476  return true;
477 }
#define NULL

References NULL.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), and SCH_EDIT_TOOL::Properties().

◆ eeconfig()

EESCHEMA_SETTINGS * SCH_BASE_FRAME::eeconfig ( ) const
inherited

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 222 of file eda_draw_frame.cpp.

223 {
224  if( m_messagePanel )
226 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:216

References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

void SCH_EDIT_FRAME::ExecuteRemoteCommand ( const char *  cmdline)
overridevirtual

Execute a remote command sent by Pcbnew via a socket connection.

When user selects a module or pin in Pcbnew, Eeschema shows that same component or pin and moves cursor on the item. The socket port used is KICAD_SCH_PORT_SERVICE_NUMBER which defaults to 4243.

Valid commands are:

  • $PART: "reference" Put cursor on component.
  • $PART: "reference" $REF: "ref" Put cursor on component reference.
  • $PART: "reference" $VAL: "value" Put cursor on component value.
  • $PART: "reference" $PAD: "pin name" Put cursor on the component pin.
  • $NET: "netname" Highlight a specified net
  • $CLEAR: "HIGHLIGHTED" Clear components highlight

They are a keyword followed by a quoted string.

Parameters
cmdline= received command from Pcbnew

Reimplemented from EDA_DRAW_FRAME.

Definition at line 175 of file eeschema/cross-probing.cpp.

176 {
178  char line[1024];
179 
180  strncpy( line, cmdline, sizeof(line) - 1 );
181  line[ sizeof(line) - 1 ] = '\0';
182 
183  char* idcmd = strtok( line, " \n\r" );
184  char* text = strtok( NULL, "\"\n\r" );
185 
186  if( idcmd == NULL )
187  return;
188 
189  CROSS_PROBING_SETTINGS& crossProbingSettings = eeconfig()->m_CrossProbing;
190 
191  if( strcmp( idcmd, "$NET:" ) == 0 )
192  {
193  if( !crossProbingSettings.auto_highlight )
194  return;
195 
196  wxString netName = FROM_UTF8( text );
197 
198  if( auto sg = Schematic().ConnectionGraph()->FindFirstSubgraphByName( netName ) )
199  m_highlightedConn = sg->m_driver_connection;
200 
202 
203  SetStatusText( _( "Selected net: " ) + UnescapeString( netName ) );
204  return;
205  }
206 
207  if( strcmp( idcmd, "$CLEAR:" ) == 0 )
208  {
209  // Cross-probing is now done through selection so we no longer need a clear command
210  return;
211  }
212 
213  if( text == NULL )
214  return;
215 
216  if( strcmp( idcmd, "$PART:" ) != 0 )
217  return;
218 
219  wxString part_ref = FROM_UTF8( text );
220 
221  /* look for a complement */
222  idcmd = strtok( NULL, " \n\r" );
223 
224  if( idcmd == NULL ) // Highlight component only (from Cvpcb or Pcbnew)
225  {
226  // Highlight component part_ref, or clear Highlight, if part_ref is not existing
227  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, wxEmptyString );
228  return;
229  }
230 
231  text = strtok( NULL, "\"\n\r" );
232 
233  if( text == NULL )
234  return;
235 
236  wxString msg = FROM_UTF8( text );
237 
238  if( strcmp( idcmd, "$REF:" ) == 0 )
239  {
240  // Highlighting the reference itself isn't actually that useful, and it's harder to
241  // see. Highlight the parent and display the message.
242  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, msg );
243  }
244  else if( strcmp( idcmd, "$VAL:" ) == 0 )
245  {
246  // Highlighting the value itself isn't actually that useful, and it's harder to see.
247  // Highlight the parent and display the message.
248  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, msg );
249  }
250  else if( strcmp( idcmd, "$PAD:" ) == 0 )
251  {
252  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_PIN, msg );
253  }
254  else
255  {
256  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, wxEmptyString );
257  }
258 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:114
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
static TOOL_ACTION updateNetHighlighting
Definition: ee_actions.h:216
EESCHEMA_SETTINGS * eeconfig() const
SCH_EDITOR_CONTROL.
Cross-probing behavior.
Definition: app_settings.h:30
SCH_ITEM * FindComponentAndItem(const wxString &aReference, bool aSearchHierarchy, SCH_SEARCH_T aSearchType, const wxString &aSearchText)
Finds a component in the schematic and an item in this component.
#define NULL
SCHEMATIC & Schematic() const
const SCH_CONNECTION * m_highlightedConn
The highlighted net or bus, or nullptr.
bool auto_highlight
Automatically turn on highlight mode in the target frame.
Definition: app_settings.h:34
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
#define _(s)
Definition: 3d_actions.cpp:33
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:152
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:78
CROSS_PROBING_SETTINGS m_CrossProbing
Definition: app_settings.h:157

References _, CROSS_PROBING_SETTINGS::auto_highlight, SCH_BASE_FRAME::eeconfig(), SCH_EDITOR_CONTROL::FindComponentAndItem(), FROM_UTF8(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), HIGHLIGHT_COMPONENT, HIGHLIGHT_PIN, APP_SETTINGS_BASE::m_CrossProbing, m_highlightedConn, TOOLS_HOLDER::m_toolManager, NULL, TOOL_MANAGER::RunAction(), Schematic(), UnescapeString(), and EE_ACTIONS::updateNetHighlighting.

Referenced by KiwayMailIn().

◆ FindHierarchyNavigator()

HIERARCHY_NAVIG_DLG * SCH_EDIT_FRAME::FindHierarchyNavigator ( )
Returns
a reference to the Hierarchy Navigator dialog if exists, or nullptr.

Definition at line 763 of file sch_edit_frame.cpp.

764 {
765  wxWindow* navigator = wxWindow::FindWindowByName( HIERARCHY_NAVIG_DLG_WNAME );
766 
767  return static_cast< HIERARCHY_NAVIG_DLG* >( navigator );
768 }
#define HIERARCHY_NAVIG_DLG_WNAME
Definition: hierarch.h:35

References HIERARCHY_NAVIG_DLG_WNAME.

Referenced by doCloseWindow(), and UpdateHierarchyNavigator().

◆ FixupJunctions()

void SCH_EDIT_FRAME::FixupJunctions ( )

Definition at line 1224 of file sch_edit_frame.cpp.

1225 {
1226  // Save the current sheet, to retrieve it later
1227  SCH_SHEET_PATH oldsheetpath = GetCurrentSheet();
1228 
1229  bool modified = false;
1230 
1231  SCH_SHEET_LIST sheetList = Schematic().GetSheets();
1232 
1233  for( const SCH_SHEET_PATH& sheet : sheetList )
1234  {
1235  // We require a set here to avoid adding multiple junctions to the same spot
1236  std::set<wxPoint> junctions;
1237 
1238  SetCurrentSheet( sheet );
1240 
1241  SCH_SCREEN* screen = GetCurrentSheet().LastScreen();
1242 
1243  for( auto aItem : screen->Items().OfType( SCH_COMPONENT_T ) )
1244  {
1245  auto cmp = static_cast<SCH_COMPONENT*>( aItem );
1246 
1247  for( const SCH_PIN* pin : cmp->GetPins( &sheet ) )
1248  {
1249  auto pos = pin->GetPosition();
1250 
1251  // Test if a _new_ junction is needed, and add it if missing
1252  if( screen->IsJunctionNeeded( pos, true ) )
1253  junctions.insert( pos );
1254  }
1255  }
1256 
1257  for( const wxPoint& pos : junctions )
1258  AddJunction( screen, pos, false, false );
1259 
1260  if( junctions.size() )
1261  modified = true;
1262  }
1263 
1264  if( modified )
1265  OnModify();
1266 
1267  // Reselect the initial sheet:
1268  SetCurrentSheet( oldsheetpath );
1270  SetScreen( GetCurrentSheet().LastScreen() );
1271 }
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
SCH_SHEET_LIST.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
bool IsJunctionNeeded(const wxPoint &aPosition, bool aNew=false)
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:373
void SetScreen(BASE_SCREEN *aScreen) override
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
void UpdateAllScreenReferences()
Function UpdateAllScreenReferences updates the reference and the m_Multi parameter (part selection) f...
SCH_JUNCTION * AddJunction(SCH_SCREEN *aScreen, const wxPoint &aPos, bool aAppendToUndo, bool aFinal=true)
SCHEMATIC & Schematic() const
SCH_SHEET_PATH.
SCH_SCREEN * LastScreen()
Function LastScreen.
EE_RTREE & Items()
Definition: sch_screen.h:158
SCH_SHEET_PATH & GetCurrentSheet() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...

References AddJunction(), GetCurrentSheet(), SCHEMATIC::GetSheets(), SCH_SCREEN::IsJunctionNeeded(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), EE_RTREE::OfType(), OnModify(), SCH_COMPONENT_T, Schematic(), SetCurrentSheet(), SetScreen(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

Referenced by OpenProjectFiles().

◆ FocusOnItem()

void SCH_EDIT_FRAME::FocusOnItem ( SCH_ITEM aItem)

Definition at line 1287 of file sch_edit_frame.cpp.

1288 {
1289  static KIID lastBrightenedItemID( niluuid );
1290 
1291  SCH_SHEET_LIST sheetList = Schematic().GetSheets();
1293  SCH_ITEM* lastItem = sheetList.GetItem( lastBrightenedItemID, &dummy );
1294 
1295  if( lastItem && lastItem != aItem )
1296  {
1297  lastItem->ClearBrightened();
1298 
1299  UpdateItem( lastItem );
1300  lastBrightenedItemID = niluuid;
1301  }
1302 
1303  if( aItem )
1304  {
1305  aItem->SetBrightened();
1306 
1307  UpdateItem( aItem );
1308  lastBrightenedItemID = aItem->m_Uuid;
1309 
1310  FocusOnLocation( aItem->GetFocusPosition() );
1311  }
1312 }
SCH_SHEET_LIST.
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
SCH_ITEM * GetItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr)
Fetch a SCH_ITEM by ID.
virtual const wxPoint GetFocusPosition() const
Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rath...
Definition: base_struct.h:345
void SetBrightened()
Definition: base_struct.h:209
void ClearBrightened()
Definition: base_struct.h:212
Definition: common.h:68
KIID niluuid(0)
SCHEMATIC & Schematic() const
SCH_SHEET_PATH.
const KIID m_Uuid
Definition: base_struct.h:162
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor...
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194

References EDA_ITEM::ClearBrightened(), dummy(), EDA_DRAW_FRAME::FocusOnLocation(), EDA_ITEM::GetFocusPosition(), SCH_SHEET_LIST::GetItem(), SCHEMATIC::GetSheets(), EDA_ITEM::m_Uuid, niluuid, Schematic(), EDA_ITEM::SetBrightened(), and SCH_BASE_FRAME::UpdateItem().

Referenced by HardRedraw(), DIALOG_ERC::OnButtonCloseClick(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_ERC::OnERCItemSelected(), and SetCurrentSheet().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint aPos)
inherited

Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested.

Parameters
aPosis the point to go to.

Definition at line 767 of file eda_draw_frame.cpp.

768 {
769  bool centerView = false;
770  BOX2D r = GetCanvas()->GetView()->GetViewport();
771 
772  // Center if we're off the current view, or within 10% of its edge
773  r.Inflate( - (int) r.GetWidth() / 10 );
774 
775  if( !r.Contains( aPos ) )
776  centerView = true;
777 
778  // Center if we're behind an obscuring dialog, or within 10% of its edge
779  wxWindow* dialog = findDialog( GetChildren() );
780 
781  if( dialog )
782  {
783  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
784  dialog->GetSize() );
785  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
786 
787  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
788  centerView = true;
789  }
790 
791  if( centerView )
792  {
793  // If a dialog partly obscures the window, then center on the uncovered area.
794  if( dialog )
795  {
796  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
797  dialog->GetSize() );
798  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
799  }
800  else
801  GetCanvas()->GetView()->SetCenter( aPos );
802  }
803 
805 }
BOX2D GetViewport() const
Function GetViewport() Returns the current viewport visible area rectangle.
Definition: view.cpp:537
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:603
coord_type GetWidth() const
Definition: box2.h:197
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302

References BOX2< Vec >::Contains(), findDialog(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().

Referenced by SELECTION_TOOL::findCallback(), SCH_EDITOR_CONTROL::FindNext(), PCB_BASE_FRAME::FocusOnItem(), FocusOnItem(), and DIALOG_FIND::search().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 571 of file eda_base_frame.h.

571 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and COMMON_CONTROL::ReportBug().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited
Returns
the string to prepend to a file name for automatic save.

Definition at line 193 of file eda_base_frame.h.

194  {
195  return wxT( "_autosave-" );
196  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 332 of file eda_base_frame.h.

332 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetBackupSuffix()

static wxString EDA_BASE_FRAME::GetBackupSuffix ( )
inlinestaticprotectedinherited
Returns
the suffix to be appended to the file extension on backup

Definition at line 185 of file eda_base_frame.h.

186  {
187  return wxT( "-bak" );
188  }

◆ GetCanvas()

SCH_DRAW_PANEL * SCH_BASE_FRAME::GetCanvas ( ) const
overridevirtualinherited

Return a pointer to GAL-based canvas of given EDA draw frame.

Returns
Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 288 of file sch_base_frame.cpp.

289 {
290  return static_cast<SCH_DRAW_PANEL*>( EDA_DRAW_FRAME::GetCanvas() );
291 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by AddItemToScreenAndUndoList(), AddJunction(), SCH_BASE_FRAME::AddToScreen(), AnnotateComponents(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), SCH_EDIT_TOOL::BreakWire(), SCH_BASE_FRAME::CenterScreen(), LIB_VIEW_FRAME::ClickOnCmpList(), LIB_EDIT_FRAME::CommonSettingsChanged(), CommonSettingsChanged(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CreateSheetPin(), DeleteAnnotation(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EE_SELECTION_TOOL::doSelectionMenu(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_EDIT_TOOL::editTextProperties(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::HardRedraw(), HardRedraw(), SCH_EDITOR_CONTROL::ImportFPAssignments(), KiwayMailIn(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), DIALOG_ANNOTATE::OnApplyClick(), LIB_VIEW_FRAME::OnCloseWindow(), DIALOG_ERC::OnEraseDrcMarkersClick(), DIALOG_MIGRATE_BUSES::onItemSelected(), OnModify(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_EDIT_TOOL::Properties(), PutDataInPreviousState(), ReannotateFromPCBNew(), LIB_EDIT_FRAME::RebuildView(), LIB_VIEW_FRAME::ReCreateListLib(), SCH_EDITOR_CONTROL::Redo(), DIALOG_ERC::redrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RefreshSelection(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), SCH_EDITOR_CONTROL::RemapSymbols(), SCH_BASE_FRAME::RemoveFromScreen(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::rescueProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), RollbackSchematicFromUndo(), SetCurrentSheet(), EE_POINT_EDITOR::setEditedPoint(), SetScreen(), LIB_VIEW_FRAME::SetSelectedLibrary(), LIB_VIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), setupTools(), LIB_CONTROL::ShowElectricalTypes(), ShowSchematicSetupDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_EDIT_FRAME::SwitchCanvas(), SCH_BASE_FRAME::SyncView(), TestDanglingEnds(), DIALOG_ERC::testErc(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_LINE_STYLE::TransferDataFromWindow(), PANEL_LIBEDIT_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_LIBEDIT_SETTINGS::TransferDataFromWindow(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SCH_EDIT_TOOL::UpdateFields(), SCH_EDITOR_CONTROL::UpdateFind(), SCH_BASE_FRAME::UpdateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), LIB_VIEW_FRAME::updatePreviewSymbol(), SCH_BASE_FRAME::UpdateStatusBar(), UpdateSymbolFromEditor(), and LIB_VIEW_FRAME::~LIB_VIEW_FRAME().

◆ GetColorSettings()

COLOR_SETTINGS * SCH_BASE_FRAME::GetColorSettings ( )
overridevirtualinherited

Returns a pointer to the active color theme settings.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 434 of file sch_base_frame.cpp.

435 {
436  if( !m_colorSettings )
437  {
438  EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
439  m_colorSettings = Pgm().GetSettingsManager().GetColorSettings( cfg->m_ColorTheme );
440  }
441 
442  return m_colorSettings;
443 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
COLOR_SETTINGS * m_colorSettings
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:174

References EDA_DRAW_FRAME::m_colorSettings, APP_SETTINGS_BASE::m_ColorTheme, and Pgm().

Referenced by SCH_BASE_FRAME::GetLayerColor(), SCH_PRINTOUT::PrintPage(), DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), and DIALOG_SCH_SHEET_PROPS::TransferDataToWindow().

◆ GetCurrentFileName()

wxString SCH_EDIT_FRAME::GetCurrentFileName ( ) const
overridevirtual

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns
the filename and full path to the open file

Reimplemented from EDA_BASE_FRAME.

Definition at line 1347 of file sch_edit_frame.cpp.

1348 {
1349  return Schematic().GetFileName();
1350 }
wxString GetFileName() const
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:118
SCHEMATIC & Schematic() const

References SCHEMATIC::GetFileName(), and Schematic().

Referenced by OpenProjectFiles().

◆ GetCurrentSelection()

SELECTION & SCH_EDIT_FRAME::GetCurrentSelection ( )
overridevirtual

Get the current selection from the canvas area.

Returns
the current selection

Reimplemented from TOOLS_HOLDER.

Definition at line 1353 of file sch_edit_frame.cpp.

1354 {
1355  return m_toolManager->GetTool<EE_SELECTION_TOOL>()->GetSelection();
1356 }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50

References TOOL_MANAGER::GetTool(), and TOOLS_HOLDER::m_toolManager.

◆ GetCurrentSheet()

SCH_SHEET_PATH & SCH_EDIT_FRAME::GetCurrentSheet ( ) const

Definition at line 545 of file sch_edit_frame.cpp.

546 {
547  return m_schematic->CurrentSheet();
548 }
SCHEMATIC * m_schematic
The currently loaded schematic.
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:119

References SCHEMATIC::CurrentSheet(), and m_schematic.

Referenced by AddItemToScreenAndUndoList(), LIB_CONTROL::AddSymbolToSchematic(), AnnotateComponents(), AppendSchematic(), CheckAnnotate(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPSFile(), DIALOG_PLOT_SCHEMATIC::createSVGFile(), DeleteAnnotation(), DisplayCurrentSheet(), doCloseWindow(), SCH_EDITOR_CONTROL::doCopy(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_EDITOR_CONTROL::EnterSheet(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), FixupJunctions(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_COMPONENT::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), GetScreen(), GetScreenDesc(), GetUniqueFilenameForCurrentSheet(), HardRedraw(), SCH_EDITOR_CONTROL::HasMatch(), HIERARCHY_NAVIG_DLG::HIERARCHY_NAVIG_DLG(), highlightNet(), importFile(), SCH_DRAWING_TOOLS::Init(), EE_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_EDITOR_CONTROL::LeaveSheet(), DIALOG_ERC::OnERCItemSelected(), DIALOG_MIGRATE_BUSES::onItemSelected(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_SCH_SHEET_PROPS::onSheetFilenameChanged(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_EDIT_TOOL::Properties(), ReannotateFromPCBNew(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), DIALOG_PLOT_SCHEMATIC::restoreEnvironment(), SaveEEFile(), SelectUnit(), SetCurrentSheet(), SetSheetNumberAndCount(), setupUIConditions(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateFind(), HIERARCHY_NAVIG_DLG::UpdateHierarchyTree(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and UpdateTitle().

◆ GetDefaults()

SCHEMATIC_SETTINGS& SCH_BASE_FRAME::GetDefaults ( )
inlineinherited

Definition at line 121 of file sch_base_frame.h.

122  {
123  return *m_defaults;
124  }
SCHEMATIC_SETTINGS * m_defaults

References SCH_BASE_FRAME::m_defaults.

◆ GetDocumentExtents()

const BOX2I SCH_EDIT_FRAME::GetDocumentExtents ( ) const
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1215 of file sch_edit_frame.cpp.

1216 {
1217  int sizeX = GetScreen()->GetPageSettings().GetWidthIU();
1218  int sizeY = GetScreen()->GetPageSettings().GetHeightIU();
1219 
1220  return BOX2I( VECTOR2I(0, 0), VECTOR2I( sizeX, sizeY ) );
1221 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:180
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.

References SCH_SCREEN::GetPageSettings(), and GetScreen().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

Indicates that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 128 of file tools_holder.h.

128 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:63

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const
inlineinherited

Indicates that a drag should draw a selection rectangle, even when started over an item.

Definition at line 134 of file tools_holder.h.

134 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:67

References TOOLS_HOLDER::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
FILE_HISTORY aFileHistory = nullptr 
)
inherited

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if FILE_HISTORY::UseMenu was called at init time

Parameters
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used
Returns
a wxString containing the selected filename

Definition at line 703 of file eda_base_frame.cpp.

705 {
706  if( !aFileHistory )
707  aFileHistory = m_fileHistory;
708 
709  wxASSERT( aFileHistory );
710 
711  int baseId = aFileHistory->GetBaseId();
712 
713  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
714 
715  unsigned i = cmdId - baseId;
716 
717  if( i < aFileHistory->GetCount() )
718  {
719  wxString fn = aFileHistory->GetHistoryFile( i );
720 
721  if( wxFileName::FileExists( fn ) )
722  return fn;
723  else
724  {
725  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
726  wxMessageBox( msg );
727 
728  aFileHistory->RemoveFileFromHistory( i );
729  }
730  }
731 
732  // Update the menubar to update the file history menu
733  if( GetMenuBar() )
734  {
735  ReCreateMenuBar();
736  GetMenuBar()->Refresh();
737  }
738 
739  return wxEmptyString;
740 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References _, Format(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 487 of file eda_base_frame.h.

488  {
489  return *m_fileHistory;
490  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 171 of file eda_draw_frame.h.

171 { return m_findStringHistoryList; }
wxArrayString m_findStringHistoryList

References EDA_DRAW_FRAME::m_findStringHistoryList.

Referenced by DIALOG_FIND::DIALOG_FIND(), and DIALOG_FIND::search().

◆ GetFindReplaceData()

wxFindReplaceData * SCH_EDIT_FRAME::GetFindReplaceData ( )

Get the find criteria (as set by the dialog).

Definition at line 751 of file sch_edit_frame.cpp.

752 {
753  if( m_findReplaceDialog && m_findReplaceDialog->IsVisible()
754  && !m_findReplaceData->GetFindString().IsEmpty() )
755  {
756  return m_findReplaceData;
757  }
758 
759  return nullptr;
760 }
DIALOG_SCH_FIND * m_findReplaceDialog
wxFindReplaceData * m_findReplaceData

References EDA_DRAW_FRAME::m_findReplaceData, and m_findReplaceDialog.

Referenced by SCH_EDITOR_CONTROL::FindNext(), SCH_EDITOR_CONTROL::HasMatch(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ GetFlattenedLibPart()

LIB_PART* SCH_BASE_FRAME::GetFlattenedLibPart ( const LIB_ID aLibId,
bool  aShowErrorMsg = false 
)
inherited

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const wxPoint& SCH_BASE_FRAME::GetGridOrigin ( ) const
inlineoverridevirtualinherited

Return the absolute coordinates of the origin of the snap grid.

This is treated as a relative offset, and snapping will occur at multiples of the grid size relative to this point.

Implements EDA_DRAW_FRAME.

Definition at line 135 of file sch_base_frame.h.

136  {
137  static wxPoint zero;
138  return zero;
139  }

◆ GetHighlightedConnection()

const SCH_CONNECTION* SCH_EDIT_FRAME::GetHighlightedConnection ( ) const
inline

Definition at line 350 of file sch_edit_frame.h.

351  {
352  return m_highlightedConn;
353  }
const SCH_CONNECTION * m_highlightedConn
The highlighted net or bus, or nullptr.

References m_highlightedConn.

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and UpdateNetHighlightStatus().

◆ GetInfoBar()

◆ GetItem()

EDA_ITEM * SCH_EDIT_FRAME::GetItem ( const KIID aId)
overridevirtual

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 467 of file sch_edit_frame.cpp.

468 {
469  return Schematic().GetSheets().GetItem( aId );
470 }
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:89
SCH_ITEM * GetItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr)
Fetch a SCH_ITEM by ID.
SCHEMATIC & Schematic() const

References SCH_SHEET_LIST::GetItem(), SCHEMATIC::GetSheets(), and Schematic().

◆ GetLayerColor()

COLOR4D SCH_BASE_FRAME::GetLayerColor ( SCH_LAYER_ID  aLayer)
inherited

Helper to retrieve a layer color from the global color settings.

Definition at line 419 of file sch_base_frame.cpp.

420 {
421  return GetColorSettings()->GetColor( aLayer );
422 }
COLOR_SETTINGS * GetColorSettings() override
Returns a pointer to the active color theme settings.
COLOR4D GetColor(int aLayer) const

References COLOR_SETTINGS::GetColor(), and SCH_BASE_FRAME::GetColorSettings().

◆ GetLibPart()

LIB_PART * SCH_BASE_FRAME::GetLibPart ( const LIB_ID aLibId,
bool  aUseCacheLib = false,
bool  aShowErrorMsg = false 
)
inherited

Load symbol from symbol library table.

Parameters
aLibIdis the symbol library identifier to load.
aUseCacheLibset to true to fall back to cache library if symbol is not found in symbol library table.
aShowErrorMessageset to true to show any error messages.
Returns
The symbol found in the library or NULL if the symbol was not found.

Definition at line 212 of file sch_base_frame.cpp.

213 {
214  PART_LIB* cache = ( aUseCacheLib ) ? Prj().SchLibs()->GetCacheLibrary() : NULL;
215 
216  return SchGetLibPart( aLibId, Prj().SchSymbolLibTable(), cache, this, aShowErrorMsg );
217 }
static S3D_CACHE * cache
Definition: export_vrml.cpp:61
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
LIB_PART * SchGetLibPart(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, PART_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Load symbol from symbol library table.
Object used to load, save, search, and otherwise manipulate symbol library files.

References cache, NULL, KIWAY_HOLDER::Prj(), and SchGetLibPart().

Referenced by CreateArchiveLibrary(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_BASE_FRAME::SelectCompFromLibTree(), SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_UPDATE_FIELDS::updateFields().