KiCad PCB EDA Suite
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
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 }
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 SCH_EDIT_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~SCH_EDIT_FRAME () override
 
SCH_SCREEN * GetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
SELECTION & GetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
SCHEMATIC & Schematic () 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 ()
 Load 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
 Save 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...
 
void RecordERCExclusions ()
 Scan existing markers and record data from any that are Excluded. More...
 
void ResolveERCExclusions ()
 Update markers to match recorded exclusions. 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
 Receive 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_DLG * FindHierarchyNavigator ()
 
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=nullptr, SCH_SCREEN *aScreen=nullptr)
 Break a single segment into two at the specified point. More...
 
bool BreakSegments (const wxPoint &aPoint, SCH_SCREEN *aScreen=nullptr)
 Check 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)
 Test all junctions and bus entries in the schematic for intersections with wires and buses and breaks any intersections into multiple segments. More...
 
void 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)
 Send a connection (net or bus) to Pcbnew for highlighting. More...
 
void SendCrossProbeClearHighlight ()
 Tell Pcbnew to clear the existing highlighted net, if one exists. More...
 
const SCH_CONNECTION * GetHighlightedConnection () const
 
void SetHighlightedConnection (const SCH_CONNECTION *aConnection)
 
bool ReadyToNetlist (const wxString &aAnnotateMessage)
 Check 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=nullptr)
 Create a netlist file. More...
 
void DeleteAnnotation (bool aCurrentSheetOnly, bool *appendUndo)
 Clear the current component annotation. More...
 
void AnnotateSymbols (bool aAnnotateSchematic, ANNOTATE_ORDER_T aSortOption, ANNOTATE_OPTION_T aAlgoOption, int aStartNumber, bool aResetAnnotation, bool aRepairTimestamps, bool aLockUnits, REPORTER &aReporter)
 Annotate the symbols in the schematic that are not currently annotated. More...
 
int CheckAnnotate (ANNOTATION_ERROR_HANDLER aErrorHandler, bool aOneSheetOnly=false)
 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_PATH & GetCurrentSheet () 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
 Open 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 ()
 Check if any of the screens has unsaved changes and asks the user whether to save or drop them. More...
 
SCH_JUNCTION * AddJunction (SCH_SCREEN *aScreen, const wxPoint &aPos, bool aAppendToUndo, bool aFinal=true)
 
bool SchematicCleanUp (SCH_SCREEN *aScreen=nullptr)
 Perform 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< wxPoint > GetSchematicConnections ()
 Collect 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...
 
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 *aSymbol)
 
void SelectUnit (SCH_COMPONENT *aSymbol, int aUnit)
 
void StartNewUndo ()
 Create a new, blank stack for future Undo commands to be pushed to. More...
 
void SaveCopyInUndoList (SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
 Create a copy of the current schematic item, and put it in the undo list. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand, bool aAppend)
 Create a new entry in undo list of commands. More...
 
void PutDataInPreviousState (PICKED_ITEMS_LIST *aList)
 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 (const SCH_ITEM *aItem)
 Clone aItem and owns that clone in this container. More...
 
SCH_ITEM * GetRepeatItem () const
 Return the item which is to be repeated with the insert key. More...
 
EDA_ITEM * GetItem (const KIID &aId) const override
 Fetch an item by KIID. More...
 
void RollbackSchematicFromUndo ()
 Perform 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 (const 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)
 Generate the connection data for the entire schematic hierarchy. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allow 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 (bool aIncludeAllVisible=true) const override
 Returns bbox of document with option to not include some items. More...
 
void FixupJunctions ()
 
void FocusOnItem (SCH_ITEM *aItem)
 
void SaveSymbolToSchematic (const LIB_PART &aSymbol)
 Update the LIB_PART of the currently selected symbol. More...
 
void RecomputeIntersheetRefs ()
 Update the schematic's page reference map for all global labels, and refresh the labels so that they are redrawn with up-to-date references. More...
 
void ShowAllIntersheetRefs (bool aShow)
 
void createCanvas ()
 
SCH_DRAW_PANEL * GetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
EESCHEMA_SETTINGS * eeconfig () const
 
SYMBOL_EDITOR_SETTINGS * libeditconfig () const
 
KIGFX::SCH_RENDER_SETTINGS * GetRenderSettings ()
 
SCHEMATIC_SETTINGS & GetDefaults ()
 
COLOR4D GetDrawBgColor () const override
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFO & GetPageSettings () 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 wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const TITLE_BLOCK & GetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
void UpdateStatusBar () override
 Update the status bar information. More...
 
PICKED_SYMBOL PickSymbolFromLibTree (const SCHLIB_FILTER *aFilter, std::vector< PICKED_SYMBOL > &aHistoryList, bool aUseLibBrowser, int aUnit, int aConvert, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
 Call the library viewer to select component to import into schematic. More...
 
LIB_PART * GetLibPart (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
 Load symbol from symbol library table. More...
 
LIB_PART * GetFlattenedLibPart (const LIB_ID &aLibId, bool aShowErrorMsg=false)
 
PICKED_SYMBOL PickSymbolFromLibBrowser (wxTopLevelWindow *aParent, const SCHLIB_FILTER *aFilter, const LIB_ID &aPreselectedLibId, int aUnit, int aConvert)
 Call 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_SETTINGS * GetColorSettings () const 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
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 Get the pair or units in current use. More...
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
wxPoint GetNearestHalfGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize / 2 location to aPosition. More...
 
virtual ORIGIN_TRANSFORMS & GetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
virtual void UpdateToolbarControlSizes ()
 Update the sizes of any controls in the toolbars of the frame. More...
 
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. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...
 
void PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the drawing-sheet (frame and title block). 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 &aTextUpper, const wxString &aTextLower, int aPadding=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)
 
void SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Helper function that erases the msg panel and then appends a single message. More...
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. 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_OPTIONS & GetGalDisplayOptions ()
 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 check tools. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handle command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
 Show 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. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 
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_MANAGER * GetSettingsManager () const
 
virtual SEVERITY 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 (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 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 UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action 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_STACK & sys_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)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBAR * GetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
virtual APP_SETTINGS_BASE * config () 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)
 Load window settings from the given settings object. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Save window settings to the given settings object. More...
 
virtual WINDOW_SETTINGS * GetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Return a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 Get the configuration base name. More...
 
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_HISTORY & GetFileHistory ()
 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 ThemeChanged ()
 Process light/dark theme change. 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 ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LIST * 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)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
TOOL_MANAGER * GetToolManager () 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
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType () const
 
KIWAY & Kiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECT & Prj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handle 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
 Return 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)
 Save 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 setupUnits (APP_SETTINGS_BASE *aCfg)
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
virtual void handleActivateEvent (wxActivateEvent &aEvent)
 Handle a window activation event. More...
 
void onActivate (wxActivateEvent &aEvent)
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

SCHEMATIC_SETTINGS m_base_frame_defaults
 These are only used by symbol_editor. More...
 
SCHEMATIC_SETTINGS * m_defaults
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
 
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_TOOLBAR * m_mainToolBar
 
ACTION_TOOLBAR * m_auxiliaryToolBar
 
ACTION_TOOLBAR * m_drawToolBar
 
ACTION_TOOLBAR * m_optionsToolBar
 
wxFindReplaceData * m_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANEL * m_messagePanel
 
int m_msgFrameHeight
 
COLOR_SETTINGS * m_colorSettings
 The current canvas type. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 
bool m_modal
 
WX_EVENT_LOOP * m_modal_loop
 < Points to nested event_loop. NULL means not modal and dismissed. More...
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBAR * m_infoBar
 
wxString m_configName
 
SETTINGS_MANAGER * m_settingsManager
 
FILE_HISTORY * m_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
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandler > m_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_MANAGER * m_toolManager
 
ACTIONS * m_actions
 
TOOL_DISPATCHER * m_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
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...
 
void initScreenZoom ()
 Initialize the zoom value of the current screen and mark the screen as zoom-initialized. 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)
 Fill a map of uuid -> reference from the currently loaded schematic. More...
 

Private Attributes

SCHEMATIC * m_schematic
 The currently loaded schematic. More...
 
const SCH_CONNECTION * m_highlightedConn
 The highlighted net or bus, or nullptr. More...
 
wxPageSetupDialogData m_pageSetupData
 
SCH_ITEM * m_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_FIND * m_findReplaceDialog
 

Friends

class SCH_EDITOR_CONTROL
 

Detailed Description

Schematic editor (Eeschema) main window.

Definition at line 117 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.

42 { DIALOG, FRAME, PANEL };
KIWAY_HOLDER::DIALOG
Definition: kiway_holder.h:42
KIWAY_HOLDER::PANEL
Definition: kiway_holder.h:42
KIWAY_HOLDER::FRAME
Definition: kiway_holder.h:42

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST
inherited

Remove the aItemCount of 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. Commands are deleted from the older to the last.

Parameters
aList= the UNDO_REDO_CONTAINER of commands.
aItemCountnumber of old commands to delete. -1 to remove all old commands this will empty the list of commands.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 524 of file eda_base_frame.h.

524 { UNDO_LIST, REDO_LIST };
EDA_BASE_FRAME::UNDO_LIST
Definition: eda_base_frame.h:524
EDA_BASE_FRAME::REDO_LIST
Definition: eda_base_frame.h:524

Constructor & Destructor Documentation

◆ SCH_EDIT_FRAME()

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

Definition at line 209 of file sch_edit_frame.cpp.

209  :
210  SCH_BASE_FRAME( aKiway, aParent, FRAME_SCH, wxT( "Eeschema" ), wxDefaultPosition,
211  wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, SCH_EDIT_FRAME_NAME ),
212  m_highlightedConn( nullptr ),
213  m_item_to_repeat( nullptr )
214 {
215  m_maximizeByDefault = true;
216  m_schematic = new SCHEMATIC( nullptr );
217 
218  m_showBorderAndTitleBlock = true; // true to show sheet references
219  m_hasAutoSave = true;
220  m_aboutTitle = _( "KiCad Schematic Editor" );
221 
222  m_findReplaceDialog = nullptr;
223 
224  // Give an icon
225  wxIcon icon;
226  wxIconBundle icon_bundle;
227 
228  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_eeschema ) );
229  icon_bundle.AddIcon( icon );
230  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_eeschema_32 ) );
231  icon_bundle.AddIcon( icon );
232  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_eeschema_16 ) );
233  icon_bundle.AddIcon( icon );
234 
235  SetIcons( icon_bundle );
236 
237  LoadSettings( eeconfig() );
238 
239  // Also links the schematic to the loaded project
240  CreateScreens();
241 
242  // After schematic has been linked to project, SCHEMATIC_SETTINGS works
243  m_defaults = &m_schematic->Settings();
244  LoadProjectSettings();
245 
246  setupTools();
247  setupUIConditions();
248  ReCreateMenuBar();
249  ReCreateHToolbar();
250  ReCreateVToolbar();
251  ReCreateOptToolbar();
252 
253  // Initialize common print setup dialog settings.
254  m_pageSetupData.GetPrintData().SetPrintMode( wxPRINT_MODE_PRINTER );
255  m_pageSetupData.GetPrintData().SetQuality( wxPRINT_QUALITY_MEDIUM );
256  m_pageSetupData.GetPrintData().SetBin( wxPRINTBIN_AUTO );
257  m_pageSetupData.GetPrintData().SetNoCopies( 1 );
258 
259  m_auimgr.SetManagedWindow( this );
260 
261  CreateInfoBar();
262  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
263  .Top().Layer( 6 ) );
264  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
265  .Left().Layer( 3 ) );
266  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
267  .Right().Layer( 2 ) );
268  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
269  .Center() );
270  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
271  .Bottom().Layer( 6 ) );
272 
273  FinishAUIInitialization();
274 
275  resolveCanvasType();
276  SwitchCanvas( m_canvasType );
277 
278  initScreenZoom();
279 
280  // This is used temporarily to fix a client size issue on GTK that causes zoom to fit
281  // to calculate the wrong zoom size. See SCH_EDIT_FRAME::onSize().
282  Bind( wxEVT_SIZE, &SCH_EDIT_FRAME::onSize, this );
283 
284  if( GetCanvas() )
285  {
286  GetCanvas()->GetGAL()->SetAxesEnabled( false );
287 
288  if( auto p = dynamic_cast<KIGFX::SCH_PAINTER*>( GetCanvas()->GetView()->GetPainter() ) )
289  p->SetSchematic( m_schematic );
290  }
291 
292  setupUnits( eeconfig() );
293 
294  // Net list generator
295  DefaultExecFlags();
296 
297  UpdateTitle();
298 
299  // Default shutdown reason until a file is loaded
300  KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New schematic file is unsaved" ) );
301 
302  // Ensure the window is on top
303  Raise();
304 }
SCH_EDIT_FRAME::onSize
void onSize(wxSizeEvent &aEvent)
Definition: sch_edit_frame.cpp:1596
SCH_EDIT_FRAME::m_schematic
SCHEMATIC * m_schematic
The currently loaded schematic.
Definition: sch_edit_frame.h:910
SCH_EDIT_FRAME::DefaultExecFlags
void DefaultExecFlags()
Reset the execution flags to defaults for external netlist and bom generators.
Definition: sch_edit_frame.h:765
SCH_BASE_FRAME::SCH_BASE_FRAME
SCH_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aWindowType, const wxString &aTitle, const wxPoint &aPosition, const wxSize &aSize, long aStyle, const wxString &aFrameName)
Definition: sch_base_frame.cpp:81
SCHEMATIC
Holds all the data relating to one schematic.
Definition: schematic.h:59
BITMAPS::icon_eeschema
EDA_BASE_FRAME::CreateInfoBar
void CreateInfoBar()
Definition: eda_base_frame.cpp:735
EDA_DRAW_FRAME::m_optionsToolBar
ACTION_TOOLBAR * m_optionsToolBar
Definition: eda_draw_frame.h:512
SCH_EDIT_FRAME::ReCreateMenuBar
void ReCreateMenuBar() override
Recreates the menu bar.
Definition: eeschema/menubar.cpp:42
EDA_DRAW_FRAME::m_canvasType
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
Definition: eda_draw_frame.h:524
SCHEMATIC::Settings
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:127
BITMAPS::icon_eeschema_16
SCH_EDIT_FRAME::UpdateTitle
void UpdateTitle()
Set the main window title bar text.
Definition: sch_edit_frame.cpp:1243
EDA_DRAW_FRAME::resolveCanvasType
void resolveCanvasType()
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
Definition: eda_draw_frame.cpp:1028
BITMAPS::icon_eeschema_32
FRAME_SCH
Definition: frame_type.h:34
SCH_EDIT_FRAME::setupUIConditions
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
Definition: sch_edit_frame.cpp:362
EDA_BASE_FRAME::m_auimgr
wxAuiManager m_auimgr
Definition: eda_base_frame.h:671
EDA_DRAW_FRAME::m_mainToolBar
ACTION_TOOLBAR * m_mainToolBar
Definition: eda_draw_frame.h:509
EDA_BASE_FRAME::m_maximizeByDefault
bool m_maximizeByDefault
Definition: eda_base_frame.h:663
SCH_EDIT_FRAME::setupTools
void setupTools()
Definition: sch_edit_frame.cpp:330
SCH_BASE_FRAME::eeconfig
EESCHEMA_SETTINGS * eeconfig() const
Definition: sch_base_frame.cpp:117
KIPLATFORM::APP::SetShutdownBlockReason
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:76
SCH_EDIT_FRAME::ReCreateHToolbar
void ReCreateHToolbar() override
Definition: toolbars_sch_editor.cpp:39
SCH_EDIT_FRAME_NAME
#define SCH_EDIT_FRAME_NAME
Definition: eda_draw_frame.h:54
SCH_EDIT_FRAME::m_pageSetupData
wxPageSetupDialogData m_pageSetupData
Definition: sch_edit_frame.h:913
EDA_BASE_FRAME::FinishAUIInitialization
void FinishAUIInitialization()
Definition: eda_base_frame.cpp:747
EDA_DRAW_FRAME::m_messagePanel
EDA_MSG_PANEL * m_messagePanel
Definition: eda_draw_frame.h:518
EDA_DRAW_FRAME::m_showBorderAndTitleBlock
bool m_showBorderAndTitleBlock
Definition: eda_draw_frame.h:503
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
SCH_EDIT_FRAME::initScreenZoom
void initScreenZoom()
Initialize the zoom value of the current screen and mark the screen as zoom-initialized.
Definition: sch_edit_frame.cpp:1274
SCH_EDIT_FRAME::m_item_to_repeat
SCH_ITEM * m_item_to_repeat
Last item to insert by the repeat command.
Definition: sch_edit_frame.h:914
EDA_DRAW_PANEL_GAL::GetGAL
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
Definition: class_draw_panel_gal.h:108
SCH_EDIT_FRAME::m_findReplaceDialog
DIALOG_SCH_FIND * m_findReplaceDialog
Definition: sch_edit_frame.h:920
KICAD_DEFAULT_DRAWFRAME_STYLE
#define KICAD_DEFAULT_DRAWFRAME_STYLE
Definition: eda_base_frame.h:54
SCH_BASE_FRAME::m_defaults
SCHEMATIC_SETTINGS * m_defaults
Definition: sch_base_frame.h:269
KIGFX::GAL::SetAxesEnabled
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
Definition: graphics_abstraction_layer.h:916
EDA_PANE
Specialization of the wxAuiPaneInfo class for KiCad panels.
Definition: eda_base_frame.h:731
SCH_EDIT_FRAME::ReCreateOptToolbar
void ReCreateOptToolbar() override
Definition: toolbars_sch_editor.cpp:164
SCH_EDIT_FRAME::LoadProjectSettings
bool LoadProjectSettings()
Load the KiCad project file (*.pro) settings specific to Eeschema.
Definition: eeschema_config.cpp:75
SCH_EDIT_FRAME::m_highlightedConn
const SCH_CONNECTION * m_highlightedConn
The highlighted net or bus, or nullptr.
Definition: sch_edit_frame.h:911
SCH_EDIT_FRAME::CreateScreens
void CreateScreens()
Definition: sch_edit_frame.cpp:537
EDA_DRAW_FRAME::SwitchCanvas
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
Definition: eda_draw_frame.cpp:656
_
#define _(s)
Definition: 3d_actions.cpp:33
SCH_EDIT_FRAME::LoadSettings
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
Definition: eeschema_config.cpp:134
EDA_DRAW_FRAME::setupUnits
void setupUnits(APP_SETTINGS_BASE *aCfg)
Definition: eda_draw_frame.cpp:982
EDA_BASE_FRAME::m_hasAutoSave
bool m_hasAutoSave
Definition: eda_base_frame.h:683
EDA_BASE_FRAME::m_aboutTitle
wxString m_aboutTitle
Definition: eda_base_frame.h:669
SCH_EDIT_FRAME::ReCreateVToolbar
void ReCreateVToolbar() override
Definition: toolbars_sch_editor.cpp:121
EDA_DRAW_FRAME::m_drawToolBar
ACTION_TOOLBAR * m_drawToolBar
Definition: eda_draw_frame.h:511
KiBitmap
wxBitmap KiBitmap(BITMAPS aBitmap)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104

References _, PCAD2KICAD::Center, KIGFX::eeconfig(), icon_eeschema, icon_eeschema_16, icon_eeschema_32, KiBitmap(), PCAD2KICAD::Left, onSize(), PCAD2KICAD::Right, and KIPLATFORM::APP::SetShutdownBlockReason().

◆ ~SCH_EDIT_FRAME()

SCH_EDIT_FRAME::~SCH_EDIT_FRAME ( )
override

Definition at line 307 of file sch_edit_frame.cpp.

308 {
309  // Shutdown all running tools
310  if( m_toolManager )
311  {
312  m_toolManager->ShutdownAllTools();
313  delete m_toolManager;
314  m_toolManager = nullptr;
315  }
316 
317  delete m_item_to_repeat; // we own the cloned object, see this->SaveCopyForRepeatItem()
318 
319  SetScreen( NULL );
320 
321  delete m_schematic;
322  m_schematic = nullptr;
323 
324  // Close the project if we are standalone, so it gets cleaned up properly
325  if( Kiface().IsSingle() )
326  GetSettingsManager()->UnloadProject( &Prj(), false );
327 }
TOOL_MANAGER::ShutdownAllTools
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
Definition: tool_manager.cpp:436
SCH_EDIT_FRAME::m_schematic
SCHEMATIC * m_schematic
The currently loaded schematic.
Definition: sch_edit_frame.h:910
EDA_BASE_FRAME::GetSettingsManager
SETTINGS_MANAGER * GetSettingsManager() const
Definition: eda_base_frame.h:128
SCH_EDIT_FRAME::SetScreen
void SetScreen(BASE_SCREEN *aScreen) override
Definition: sch_edit_frame.cpp:1442
NULL
#define NULL
KIWAY_HOLDER::Prj
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Definition: kiway_holder.cpp:35
Kiface
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: bitmap2cmp_main.cpp:76
SCH_EDIT_FRAME::m_item_to_repeat
SCH_ITEM * m_item_to_repeat
Last item to insert by the repeat command.
Definition: sch_edit_frame.h:914
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
SETTINGS_MANAGER::UnloadProject
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
Definition: settings_manager.cpp:813

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 PCB_BASE_FRAME, GERBVIEW_FRAME, PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 649 of file eda_draw_frame.cpp.

650 {
651  GetCanvas()->SetEvtHandlerEnabled( true );
652  GetCanvas()->StartDrawing();
653 }
EDA_DRAW_FRAME::GetCanvas
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: eda_draw_frame.h:423
EDA_DRAW_PANEL_GAL::StartDrawing
void StartDrawing()
Begin drawing if it was stopped previously.
Definition: draw_panel_gal.cpp:338

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_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 1151 of file sch_edit_frame.cpp.

1153 {
1154  wxCHECK_RET( aItem != NULL, wxT( "Cannot add null item to list." ) );
1155 
1156  SCH_SHEET* parentSheet = nullptr;
1157  SCH_COMPONENT* parentSymbol = nullptr;
1158  SCH_ITEM* undoItem = aItem;
1159 
1160  if( aItem->Type() == SCH_SHEET_PIN_T )
1161  {
1162  parentSheet = (SCH_SHEET*) aItem->GetParent();
1163 
1164  wxCHECK_RET( parentSheet && parentSheet->Type() == SCH_SHEET_T,
1165  wxT( "Cannot place sheet pin in invalid schematic sheet." ) );
1166 
1167  undoItem = parentSheet;
1168  }
1169 
1170  else if( aItem->Type() == SCH_FIELD_T )
1171  {
1172  parentSymbol = (SCH_COMPONENT*) aItem->GetParent();
1173 
1174  wxCHECK_RET( parentSymbol && parentSymbol->Type() == SCH_COMPONENT_T,
1175  wxT( "Cannot place field in invalid schematic symbol." ) );
1176 
1177  undoItem = parentSymbol;
1178  }
1179 
1180  if( aItem->IsNew() )
1181  {
1182  if( aItem->Type() == SCH_SHEET_PIN_T )
1183  {
1184  // Sheet pins are owned by their parent sheet.
1185  SaveCopyInUndoList( aScreen, undoItem, UNDO_REDO::CHANGED, aUndoAppend );
1186 
1187  parentSheet->AddPin( (SCH_SHEET_PIN*) aItem );
1188  }
1189  else if( aItem->Type() == SCH_FIELD_T )
1190  {
1191  // Symbol fields are also owned by their parent, but new symbol fields are
1192  // handled elsewhere.
1193  wxLogMessage( wxT( "addCurrentItemToScreen: unexpected new SCH_FIELD" ) );
1194  }
1195  else
1196  {
1197  if( !aScreen->CheckIfOnDrawList( aItem ) ) // don't want a loop!
1198  AddToScreen( aItem, aScreen );
1199 
1200  SaveCopyForRepeatItem( aItem );
1201  SaveCopyInUndoList( aScreen, undoItem, UNDO_REDO::NEWITEM, aUndoAppend );
1202  }
1203 
1204  // Update connectivity info for new item
1205  if( !aItem->IsMoving() )
1206  {
1207  RecalculateConnections( LOCAL_CLEANUP );
1208 
1209  if( SCH_TEXT* textItem = dynamic_cast<SCH_TEXT*>( aItem ) )
1210  inheritNetclass( GetCurrentSheet(), textItem );
1211  }
1212  }
1213 
1214  aItem->ClearFlags( IS_NEW );
1215 
1216  aScreen->SetModify();
1217  UpdateItem( aItem );
1218 
1219  if( !aItem->IsMoving() && aItem->IsConnectable() )
1220  {
1221  std::vector< wxPoint > pts = aItem->GetConnectionPoints();
1222 
1223  for( auto i = pts.begin(); i != pts.end(); i++ )
1224  {
1225  for( auto j = i + 1; j != pts.end(); j++ )
1226  TrimWire( *i, *j );
1227 
1228  if( aScreen->IsJunctionNeeded( *i, true ) )
1229  AddJunction( aScreen, *i, true, false );
1230  }
1231 
1232  TestDanglingEnds();
1233 
1234  for( SCH_ITEM* item : aItem->ConnectedItems( GetCurrentSheet() ) )
1235  UpdateItem( item );
1236  }
1237 
1238  aItem->ClearEditFlags();
1239  GetCanvas()->Refresh();
1240 }
SCH_ITEM::IsConnectable
virtual bool IsConnectable() const
Definition: sch_item.h:362
SCH_BASE_FRAME::UpdateItem
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
Definition: sch_base_frame.cpp:301
SCH_ITEM::GetConnectionPoints
virtual std::vector< wxPoint > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
Definition: sch_item.h:377
SCH_EDIT_FRAME::RecalculateConnections
void RecalculateConnections(SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
Definition: sch_edit_frame.cpp:1281
EDA_ITEM::IsMoving
bool IsMoving() const
Definition: eda_item.h:170
LOCAL_CLEANUP
Definition: sch_edit_frame.h:109
SCH_SHEET::AddPin
void AddPin(SCH_SHEET_PIN *aSheetPin)
Add aSheetPin to the sheet.
Definition: sch_sheet.cpp:299
UNDO_REDO::CHANGED
EDA_ITEM::IsNew
bool IsNew() const
Definition: eda_item.h:169
SCH_EDIT_FRAME::AddJunction
SCH_JUNCTION * AddJunction(SCH_SCREEN *aScreen, const wxPoint &aPos, bool aAppendToUndo, bool aFinal=true)
Definition: bus-wire-junction.cpp:455
NULL
#define NULL
SCH_EDIT_FRAME::TestDanglingEnds
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
Definition: bus-wire-junction.cpp:69
inheritNetclass
static void inheritNetclass(const SCH_SHEET_PATH &aSheetPath, SCH_TEXT *aItem)
Definition: sch_edit_frame.cpp:1104
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
SCH_EDIT_FRAME::SaveCopyForRepeatItem
void SaveCopyForRepeatItem(const SCH_ITEM *aItem)
Clone aItem and owns that clone in this container.
Definition: sch_edit_frame.cpp:465
EDA_ITEM::GetParent
EDA_ITEM * GetParent() const
Definition: eda_item.h:165
SCH_SHEET_PIN
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
SCH_TEXT
Definition: sch_text.h:165
UNDO_REDO::NEWITEM
EDA_DRAW_PANEL_GAL::Refresh
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...
Definition: draw_panel_gal.cpp:303
SCH_SHEET
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
SCH_BASE_FRAME::AddToScreen
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,...
Definition: sch_base_frame.cpp:362
SCH_ITEM::ConnectedItems
SCH_ITEM_SET & ConnectedItems(const SCH_SHEET_PATH &aPath)
Retrieve the set of items connected to this item on the given sheet.
Definition: sch_item.cpp:164
SCH_EDIT_FRAME::SaveCopyInUndoList
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
Definition: schematic_undo_redo.cpp:105
SCH_COMPONENT
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_SCREEN::IsJunctionNeeded
bool IsJunctionNeeded(const wxPoint &aPosition, bool aNew=false) const
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:374
EDA_ITEM::ClearFlags
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:204
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567
SCH_EDIT_FRAME::TrimWire
bool TrimWire(const wxPoint &aStart, const wxPoint &aEnd)
If any single wire passes through both points, remove the portion between the two points,...
Definition: bus-wire-junction.cpp:81
BASE_SCREEN::SetModify
void SetModify()
Definition: base_screen.h:59
EDA_ITEM::ClearEditFlags
void ClearEditFlags()
Definition: eda_item.h:222
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197
IS_NEW
#define IS_NEW
New item, just created.
Definition: eda_item.h:107
EDA_ITEM::Type
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163
SCH_SCREEN::CheckIfOnDrawList
bool CheckIfOnDrawList(const SCH_ITEM *aItem) const
Definition: sch_screen.cpp:307

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(), inheritNetclass(), 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::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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 455 of file bus-wire-junction.cpp.

457 {
458  SCH_JUNCTION* junction = new SCH_JUNCTION( aPos );
459 
460  AddToScreen( junction, aScreen );
461  SaveCopyInUndoList( aScreen, junction, UNDO_REDO::NEWITEM, aUndoAppend );
462  BreakSegments( aPos );
463 
464  if( aFinal )
465  {
466  m_toolManager->PostEvent( EVENTS::SelectedItemsModified );
467 
468  TestDanglingEnds();
469  OnModify();
470 
471  KIGFX::SCH_VIEW* view = GetCanvas()->GetView();
472  view->ClearPreview();
473  view->ShowPreview( false );
474  view->ClearHiddenFlags();
475  }
476 
477  return junction;
478 }
SCH_DRAW_PANEL::GetView
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Definition: sch_draw_panel.cpp:176
KIGFX::SCH_VIEW::ClearHiddenFlags
void ClearHiddenFlags()
Clear the hide flag of all items in the view.
Definition: sch_view.cpp:171
SCH_EDIT_FRAME::BreakSegments
bool BreakSegments(const wxPoint &aPoint, SCH_SCREEN *aScreen=nullptr)
Check every wire and bus for a intersection at aPoint and break into two segments at aPoint if an int...
Definition: bus-wire-junction.cpp:319
EVENTS::SelectedItemsModified
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
Definition: actions.h:206
KIGFX::VIEW::ShowPreview
void ShowPreview(bool aShow=true)
Definition: view.cpp:1561
SCH_EDIT_FRAME::TestDanglingEnds
void TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
Definition: bus-wire-junction.cpp:69
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
KIGFX::VIEW::ClearPreview
void ClearPreview()
Definition: view.cpp:1525
SCH_JUNCTION
Definition: sch_junction.h:35
UNDO_REDO::NEWITEM
KIGFX::SCH_VIEW
Definition: sch_view.h:73
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
SCH_BASE_FRAME::AddToScreen
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,...
Definition: sch_base_frame.cpp:362
SCH_EDIT_FRAME::SaveCopyInUndoList
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
Definition: schematic_undo_redo.cpp:105
SCH_EDIT_FRAME::OnModify
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
Definition: sch_edit_frame.cpp:767
TOOL_MANAGER::PostEvent
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:267

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

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

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 417 of file eda_base_frame.cpp.

418 {
419  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
420  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
421 
422  helpMenu->Add( ACTIONS::help );
423  helpMenu->Add( ACTIONS::gettingStarted );
424  helpMenu->Add( ACTIONS::listHotKeys );
425  helpMenu->Add( ACTIONS::getInvolved );
426  helpMenu->Add( ACTIONS::donate );
427  helpMenu->Add( ACTIONS::reportBug );
428 
429  helpMenu->AppendSeparator();
430  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
431 
432  aMenuBar->Append( helpMenu, _( "&Help" ) );
433 }
ACTIONS::listHotKeys
static TOOL_ACTION listHotKeys
Definition: actions.h:180
ACTION_MENU
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
ACTIONS::reportBug
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:183
ACTIONS::donate
static TOOL_ACTION donate
Definition: actions.h:181
COMMON_CONTROL
Handle actions that are shared between different applications.
Definition: common_control.h:35
BITMAPS::about
TOOL_MANAGER::GetTool
T * GetTool()
Definition: tool_manager.h:219
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
_
#define _(s)
Definition: 3d_actions.cpp:33
ACTIONS::help
static TOOL_ACTION help
Definition: actions.h:179
ACTIONS::getInvolved
static TOOL_ACTION getInvolved
Definition: actions.h:182
ACTIONS::gettingStarted
static TOOL_ACTION gettingStarted
Definition: actions.h:178

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU &  aMenu)
inherited

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

zoom and grid).

Definition at line 443 of file eda_draw_frame.cpp.

444 {
445  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
446  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
447 
448  aMenu.AddSeparator( 1000 );
449 
450  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
451  zoomMenu->SetTool( commonTools );
452  aToolMenu.AddSubMenu( zoomMenu );
453 
454  auto gridMenu = std::make_shared<GRID_MENU>( this );
455  gridMenu->SetTool( commonTools );
456  aToolMenu.AddSubMenu( gridMenu );
457 
458  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
459  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
460 }
SELECTION_CONDITIONS::ShowAlways
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
Definition: selection_conditions.h:77
TOOL_MENU::GetMenu
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
COMMON_TOOLS
Handles action that are shared between different applications.
Definition: common_tools.h:37
CONDITIONAL_MENU::AddSeparator
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
Definition: conditional_menu.cpp:96
TOOL_MANAGER::GetTool
T * GetTool()
Definition: tool_manager.h:219
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
CONDITIONAL_MENU
Definition: conditional_menu.h:42

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, and SELECTION_CONDITIONS::ShowAlways().

Referenced by ROUTER_TOOL::Init(), PL_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PCB_VIEWER_TOOLS::Init(), PL_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and PICKER_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 362 of file sch_base_frame.cpp.

363 {
364  auto screen = aScreen;
365 
366  if( aScreen == nullptr )
367  screen = GetScreen();
368 
369  screen->Append( (SCH_ITEM*) aItem );
370 
371  if( screen == GetScreen() )
372  {
373  GetCanvas()->GetView()->Add( aItem );
374  UpdateItem( aItem, true ); // handle any additional parent semantics
375  }
376 }
SCH_DRAW_PANEL::GetView
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Definition: sch_draw_panel.cpp:176
SCH_BASE_FRAME::UpdateItem
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
Definition: sch_base_frame.cpp:301
SCH_BASE_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_base_frame.cpp:111
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
KIGFX::VIEW::Add
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:322
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197

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 clash risk.

Definition at line 556 of file sheet.cpp.

557 {
558  wxString msg;
559  SCH_SCREENS screens( Schematic().Root() );
560  wxFileName fn = aSchematicFileName;
561 
562  wxCHECK( fn.IsAbsolute(), false );
563 
564  if( eeconfig()->m_Appearance.show_sheet_filename_case_sensitivity_dialog
565  && screens.CanCauseCaseSensitivityIssue( aSchematicFileName ) )
566  {
567  msg.Printf( _( "The file name \"%s\" can cause issues with an existing file name\n"
568  "already defined in the schematic on systems that support case\n"
569  "insensitive file names. This will cause issues if you copy this\n"
570  "project to an operating system that supports case insensitive file\n"
571  "names.\n\nDo you wish to continue?" ),
572  fn.GetName() );
573 
574  wxRichMessageDialog dlg( this, msg, _( "Warning" ),
575  wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
576  dlg.ShowCheckBox( _( "Do not show this message again." ) );
577  dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Create New Sheet" ) ),
578  wxMessageDialog::ButtonLabel( _( "Discard New Sheet" ) ) );
579 
580  if( dlg.ShowModal() == wxID_NO )
581  return false;
582 
583  eeconfig()->m_Appearance.show_sheet_filename_case_sensitivity_dialog =
584  !dlg.IsCheckBoxChecked();
585  }
586 
587  return true;
588 }
EESCHEMA_SETTINGS::m_Appearance
APPEARANCE m_Appearance
Definition: eeschema_settings.h:219
SCH_BASE_FRAME::eeconfig
EESCHEMA_SETTINGS * eeconfig() const
Definition: sch_base_frame.cpp:117
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
_
#define _(s)
Definition: 3d_actions.cpp:33
EESCHEMA_SETTINGS::APPEARANCE::show_sheet_filename_case_sensitivity_dialog
bool show_sheet_filename_case_sensitivity_dialog
Definition: eeschema_settings.h:49
SCH_SCREENS
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:549

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_SHEET_PROPERTIES::onSheetFilenameChanged().

◆ AnnotateSymbols()

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

Annotate the symbols 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 97 of file annotate.cpp.

105 {
106  SCH_REFERENCE_LIST references;
107  SCH_SCREENS screens( Schematic().Root() );
108  SCH_SHEET_LIST sheets = Schematic().GetSheets();
109  bool appendUndo = false;
110 
111  // Map of locked symbols
112  SCH_MULTI_UNIT_REFERENCE_MAP lockedSymbols;
113 
114  // Map of previous annotation for building info messages
115  std::map<wxString, wxString> previousAnnotation;
116 
117  // Test for and replace duplicate time stamps in symbols and sheets. Duplicate
118  // time stamps can happen with old schematics, schematic conversions, or manual
119  // editing of files.
120  if( aRepairTimestamps )
121  {
122  int count = screens.ReplaceDuplicateTimeStamps();
123 
124  if( count )
125  {
126  wxString msg;
127  msg.Printf( _( "%d duplicate time stamps were found and replaced." ), count );
128  aReporter.ReportTail( msg, RPT_SEVERITY_WARNING );
129  }
130  }
131 
132  // If units must be locked, collect all the sets that must be annotated together.
133  if( aLockUnits )
134  {
135  if( aAnnotateSchematic )
136  sheets.GetMultiUnitSymbols( lockedSymbols );
137  else
138  GetCurrentSheet().GetMultiUnitSymbols( lockedSymbols );
139  }
140 
141  // Store previous annotations for building info messages
142  mapExistingAnnotation( previousAnnotation );
143 
144  // If it is an annotation for all the symbols, reset previous annotation.
145  if( aResetAnnotation )
146  DeleteAnnotation( !aAnnotateSchematic, &appendUndo );
147 
148  // Set sheet number and number of sheets.
149  SetSheetNumberAndCount();
150 
151  // Build symbol list
152  if( aAnnotateSchematic )
153  sheets.GetSymbols( references );
154  else
155  GetCurrentSheet().GetSymbols( references );
156 
157  // Break full symbol reference into name (prefix) and number:
158  // example: IC1 become IC, and 1
159  references.SplitReferences();
160 
161  switch( aSortOption )
162  {
163  default:
164  case SORT_BY_X_POSITION: references.SortByXCoordinate(); break;
165  case SORT_BY_Y_POSITION: references.SortByYCoordinate(); break;
166  }
167 
168  bool useSheetNum = false;
169  int idStep = 100;
170 
171  switch( aAlgoOption )
172  {
173  default:
174  case INCREMENTAL_BY_REF:
175  break;
176 
177  case SHEET_NUMBER_X_100:
178  useSheetNum = true;
179  break;
180 
181  case SHEET_NUMBER_X_1000:
182  useSheetNum = true;
183  idStep = 1000;
184  break;
185  }
186 
187  // Recalculate and update reference numbers in schematic
188  references.Annotate( useSheetNum, idStep, aStartNumber, lockedSymbols );
189 
190  for( size_t i = 0; i < references.GetCount(); i++ )
191  {
192  SCH_REFERENCE& ref = references[i];
193  SCH_COMPONENT* symbol = ref.GetSymbol();
194  SCH_SHEET_PATH* sheet = &ref.GetSheetPath();
195 
196  SaveCopyInUndoList( sheet->LastScreen(), symbol, UNDO_REDO::CHANGED, appendUndo );
197  appendUndo = true;
198  ref.Annotate();
199 
200  KIID_PATH full_uuid = sheet->Path();
201  full_uuid.push_back( symbol->m_Uuid );
202 
203  wxString prevRef = previousAnnotation[ full_uuid.AsString() ];
204  wxString newRef = symbol->GetRef( sheet );
205 
206  if( symbol->GetUnitCount() > 1 )
207  newRef << LIB_PART::SubReference( symbol->GetUnitSelection( sheet ) );
208 
209  wxString msg;
210 
211  if( prevRef.Length() )
212  {
213  if( newRef == prevRef )
214  continue;
215 
216  if( symbol->GetUnitCount() > 1 )
217  msg.Printf( _( "Updated %s (unit %s) from %s to %s" ),
218  symbol->GetValue( sheet, true ),
219  LIB_PART::SubReference( symbol->GetUnit(), false ),
220  prevRef,
221  newRef );
222  else
223  msg.Printf( _( "Updated %s from %s to %s" ),
224  symbol->GetValue( sheet, true ),
225  prevRef,
226  newRef );
227  }
228  else
229  {
230  if( symbol->GetUnitCount() > 1 )
231  msg.Printf( _( "Annotated %s (unit %s) as %s" ),
232  symbol->GetValue( sheet, true ),
233  LIB_PART::SubReference( symbol->GetUnit(), false ),
234  newRef );
235  else
236  msg.Printf( _( "Annotated %s as %s" ),
237  symbol->GetValue( sheet, true ),
238  newRef );
239  }
240 
241  aReporter.Report( msg, RPT_SEVERITY_ACTION );
242  }
243 
244  // Final control (just in case ... ).
245  if( !CheckAnnotate(
246  [ &aReporter ]( ERCE_T , const wxString& aMsg, SCH_REFERENCE* , SCH_REFERENCE* )
247  {
248  aReporter.Report( aMsg, RPT_SEVERITY_ERROR );
249  },
250  !aAnnotateSchematic ) )
251  {
252  aReporter.ReportTail( _( "Annotation complete." ), RPT_SEVERITY_ACTION );
253  }
254 
255  // Update on screen references, that can be modified by previous calculations:
256  GetCurrentSheet().UpdateAllScreenReferences();
257  SetSheetNumberAndCount();
258 
259  SyncView();
260  GetCanvas()->Refresh();
261  OnModify();
262 
263  // Must go after OnModify() so the connectivity graph has been updated
264  UpdateNetHighlightStatus();
265 }
SCH_SHEET_LIST
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Definition: sch_sheet_path.h:344
SCH_EDIT_FRAME::CheckAnnotate
int CheckAnnotate(ANNOTATION_ERROR_HANDLER aErrorHandler, bool aOneSheetOnly=false)
Check for annotation errors.
Definition: annotate.cpp:268
SCH_SHEET_PATH::GetMultiUnitSymbols
void GetMultiUnitSymbols(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Add a SCH_REFERENCE_LIST object to aRefList for each same-reference set of multi-unit parts in the sh...
Definition: sch_sheet_path.cpp:289
SCH_REFERENCE_LIST::SortByYCoordinate
void SortByYCoordinate()
Sort the list of references by Y position.
Definition: sch_reference_list.h:334
SCH_EDIT_FRAME::UpdateNetHighlightStatus
void UpdateNetHighlightStatus()
Definition: sch_edit_frame.cpp:1428
SCH_EDIT_FRAME::mapExistingAnnotation
void mapExistingAnnotation(std::map< wxString, wxString > &aMap)
Fill a map of uuid -> reference from the currently loaded schematic.
Definition: annotate.cpp:35
RPT_SEVERITY_ACTION
Definition: ui_common.h:87
SCH_SHEET_LIST::GetMultiUnitSymbols
void GetMultiUnitSymbols(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Add a SCH_REFERENCE_LIST object to aRefList for each same-reference set of multi-unit parts in the li...
Definition: sch_sheet_path.cpp:690
SCH_SHEET_LIST::GetSymbols
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
Definition: sch_sheet_path.cpp:682
SCH_REFERENCE::GetSheetPath
const SCH_SHEET_PATH & GetSheetPath() const
Definition: sch_reference_list.h:66
SCH_SHEET_PATH::Path
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
Definition: sch_sheet_path.cpp:205
REPORTER::ReportTail
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Places the report at the end of the list, for objects that support report ordering.
Definition: reporter.h:93
RPT_SEVERITY_ERROR
Definition: ui_common.h:89
SCH_COMPONENT::GetUnitCount
int GetUnitCount() const
Return the number of units per package of the symbol.
Definition: sch_symbol.cpp:361
INCREMENTAL_BY_REF
Annotate incrementally using the first free reference number.
Definition: sch_edit_frame.h:92
SCH_SHEET_PATH::UpdateAllScreenReferences
void UpdateAllScreenReferences()
Update all the symbol references for this sheet path.
Definition: sch_sheet_path.cpp:250
RPT_SEVERITY_WARNING
Definition: ui_common.h:88
SCH_EDIT_FRAME::DeleteAnnotation
void DeleteAnnotation(bool aCurrentSheetOnly, bool *appendUndo)
Clear the current component annotation.
Definition: annotate.cpp:60
REPORTER::Report
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
UNDO_REDO::CHANGED
SCH_REFERENCE_LIST
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
Definition: sch_reference_list.h:198
SCH_COMPONENT::GetUnit
int GetUnit() const
Definition: sch_symbol.h:195
SCH_COMPONENT::GetValue
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific value for the given sheet path.
Definition: sch_symbol.cpp:593
SCH_REFERENCE_LIST::SortByXCoordinate
void SortByXCoordinate()
Sort the list of references by X position.
Definition: sch_reference_list.h:319
SCH_BASE_FRAME::SyncView
void SyncView()
Mark all items for refresh.
Definition: sch_base_frame.cpp:396
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
SCH_REFERENCE::Annotate
void Annotate()
Update the annotation of the symbol according the the current object state.
Definition: component_references_lister.cpp:689
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_REFERENCE_LIST::Annotate
void Annotate(bool aUseSheetNum, int aSheetIntervalId, int aStartNumber, SCH_MULTI_UNIT_REFERENCE_MAP aLockedUnitMap)
Set the reference designators in the list that have not been annotated.
Definition: component_references_lister.cpp:280
SCH_SHEET_PATH
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Definition: sch_sheet_path.h:128
ERCE_T
ERCE_T
ERC error codes.
Definition: erc_settings.h:36
SCH_MULTI_UNIT_REFERENCE_MAP
std::map< wxString, SCH_REFERENCE_LIST > SCH_MULTI_UNIT_REFERENCE_MAP
Container to map reference designators for multi-unit parts.
Definition: sch_sheet_path.h:111
EDA_DRAW_PANEL_GAL::Refresh
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...
Definition: draw_panel_gal.cpp:303
SCH_REFERENCE::GetSymbol
SCH_COMPONENT * GetSymbol() const
Definition: sch_reference_list.h:62
EDA_ITEM::m_Uuid
const KIID m_Uuid
Definition: eda_item.h:525
SORT_BY_Y_POSITION
Annotate by Y position from top to bottom.
Definition: sch_edit_frame.h:84
SCH_REFERENCE_LIST::GetCount
unsigned GetCount() const
Definition: sch_reference_list.h:224
SHEET_NUMBER_X_100
Annotate using the first free reference number starting at the sheet number * 100.
Definition: sch_edit_frame.h:93
SCHEMATIC::GetSheets
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
SCH_SHEET_PATH::LastScreen
SCH_SCREEN * LastScreen()
Definition: sch_sheet_path.cpp:168
SCH_EDIT_FRAME::SetSheetNumberAndCount
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
Definition: sch_edit_frame.cpp:488
SCH_REFERENCE_LIST::SplitReferences
void SplitReferences()
Attempt to split all reference designators into a name (U) and number (1).
Definition: sch_reference_list.h:255
SCH_EDIT_FRAME::SaveCopyInUndoList
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
Definition: schematic_undo_redo.cpp:105
_
#define _(s)
Definition: 3d_actions.cpp:33
KIID_PATH::AsString
wxString AsString() const
Definition: kiid.cpp:256
SCH_SHEET_PATH::GetSymbols
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Adds SCH_REFERENCE object to aReferences for each symbol in the sheet.
Definition: sch_sheet_path.cpp:264
SORT_BY_X_POSITION
Annotate by X position from left to right.
Definition: sch_edit_frame.h:83
LIB_PART::SubReference
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Definition: lib_symbol.cpp:447
SHEET_NUMBER_X_1000
Annotate using the first free reference number starting at the sheet number * 1000.
Definition: sch_edit_frame.h:95
SCH_COMPONENT
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567
SCH_EDIT_FRAME::OnModify
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
Definition: sch_edit_frame.cpp:767
SCH_COMPONENT::GetUnitSelection
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
Definition: sch_symbol.cpp:551
SCH_REFERENCE
A helper to define a symbol's reference designator in a schematic.
Definition: sch_reference_list.h:45
SCH_SCREENS
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:549
SCH_COMPONENT::GetRef
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:432
KIID_PATH
Definition: kiid.h:107

References _, SCH_REFERENCE::Annotate(), SCH_REFERENCE_LIST::Annotate(), KIID_PATH::AsString(), CHANGED, CheckAnnotate(), DeleteAnnotation(), SCH_BASE_FRAME::GetCanvas(), SCH_REFERENCE_LIST::GetCount(), GetCurrentSheet(), SCH_SHEET_PATH::GetMultiUnitSymbols(), SCH_SHEET_LIST::GetMultiUnitSymbols(), SCH_COMPONENT::GetRef(), SCH_REFERENCE::GetSheetPath(), SCHEMATIC::GetSheets(), SCH_REFERENCE::GetSymbol(), SCH_SHEET_PATH::GetSymbols(), SCH_SHEET_LIST::GetSymbols(), 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_ERROR, 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 DIALOG_ANNOTATE::OnApplyClick().

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  aTextUpper,
const wxString &  aTextLower,
int  aPadding = 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
aTextUpperThe message upper text.
aTextLowerThe message lower text.
aPaddingNumber of spaces to pad between messages.

Definition at line 594 of file eda_draw_frame.cpp.

596 {
597  if( m_messagePanel )
598  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
599 }
EDA_DRAW_FRAME::m_messagePanel
EDA_MSG_PANEL * m_messagePanel
Definition: eda_draw_frame.h:518
EDA_MSG_PANEL::AppendMessage
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:119

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

Referenced by GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), and SYMBOL_VIEWER_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 620 of file eeschema/files-io.cpp.

621 {
622  wxString fullFileName;
623  SCH_SCREEN* screen = GetScreen();
624 
625  if( !screen )
626  {
627  wxLogError( wxT( "Document not ready, cannot import" ) );
628  return false;
629  }
630 
631  // open file chooser dialog
632  wxString path = wxPathOnly( Prj().GetProjectFullName() );
633 
634  wxFileDialog dlg( this, _( "Append Schematic" ), path, wxEmptyString,
635  KiCadSchematicFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
636 
637  if( dlg.ShowModal() == wxID_CANCEL )
638  return false;
639 
640  fullFileName = dlg.GetPath();
641 
642  if( !LoadSheetFromFile( GetCurrentSheet().Last(), &GetCurrentSheet(), fullFileName ) )
643  return false;
644 
645  initScreenZoom();
646  SetSheetNumberAndCount();
647 
648  SyncView();
649  OnModify();
650  HardRedraw(); // Full reinit of the current screen and the display.
651 
652  return true;
653 }
KiCadSchematicFileWildcard
wxString KiCadSchematicFileWildcard()
Definition: wildcards_and_files_ext.cpp:229
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
BITMAPS::path
SCH_EDIT_FRAME::LoadSheetFromFile
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, const wxString &aFileName)
Load a the KiCad schematic file aFileName into the sheet aSheet.
Definition: sheet.cpp:101
SCH_EDIT_FRAME::HardRedraw
void HardRedraw() override
Rebuild the GAL and redraw the screen.
Definition: sch_edit_frame.cpp:585
SCH_BASE_FRAME::SyncView
void SyncView()
Mark all items for refresh.
Definition: sch_base_frame.cpp:396
KIWAY_HOLDER::Prj
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Definition: kiway_holder.cpp:35
SCH_EDIT_FRAME::initScreenZoom
void initScreenZoom()
Initialize the zoom value of the current screen and mark the screen as zoom-initialized.
Definition: sch_edit_frame.cpp:1274
SCH_EDIT_FRAME::SetSheetNumberAndCount
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
Definition: sch_edit_frame.cpp:488
_
#define _(s)
Definition: 3d_actions.cpp:33
SCH_SCREEN
Definition: sch_screen.h:94
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567
SCH_EDIT_FRAME::OnModify
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
Definition: sch_edit_frame.cpp:767

References _, GetCurrentSheet(), GetScreen(), HardRedraw(), initScreenZoom(), KiCadSchematicFileWildcard(), LoadSheetFromFile(), OnModify(), path, KIWAY_HOLDER::Prj(), SetSheetNumberAndCount(), and SCH_BASE_FRAME::SyncView().

Referenced by OnAppendProject().

◆ AskToSaveChanges()

bool SCH_EDIT_FRAME::AskToSaveChanges ( )

Check 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 1056 of file eeschema/files-io.cpp.

1057 {
1058  SCH_SCREENS screenList( Schematic().Root() );
1059 
1060  // Save any currently open and modified project files.
1061  for( SCH_SCREEN* screen = screenList.GetFirst(); screen; screen = screenList.GetNext() )
1062  {
1063  if( screen->IsModify() )
1064  {
1065  if( !HandleUnsavedChanges( this, _( "The current schematic has been modified. "
1066  "Save changes?" ),
1067  [&]()->bool { return SaveProject(); } ) )
1068  {
1069  return false;
1070  }
1071  }
1072  }
1073 
1074  return true;
1075 }
HandleUnsavedChanges
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:207
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
_
#define _(s)
Definition: 3d_actions.cpp:33
SCH_SCREEN
Definition: sch_screen.h:94
SCH_EDIT_FRAME::SaveProject
bool SaveProject()
Definition: eeschema/files-io.cpp:751
SCH_SCREENS
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:549

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 = nullptr,
SCH_SCREEN *  aScreen = nullptr 
)

Break a single segment into two at the specified point.

Note
This 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 295 of file bus-wire-junction.cpp.

297 {
298  if( aScreen == nullptr )
299  aScreen = GetScreen();
300 
301  SCH_LINE* newSegment = new SCH_LINE( *aSegment );
302 
303  newSegment->SetStartPoint( aPoint );
304  AddToScreen( newSegment, aScreen );
305 
306  SaveCopyInUndoList( aScreen, newSegment, UNDO_REDO::NEWITEM, true );
307  SaveCopyInUndoList( aScreen, aSegment, UNDO_REDO::CHANGED, true );
308 
309  UpdateItem( aSegment );
310  aSegment->SetEndPoint( aPoint );
311 
312  if( aNewSegment )
313  *aNewSegment = newSegment;
314 
315  return true;
316 }
SCH_BASE_FRAME::UpdateItem
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
Definition: sch_base_frame.cpp:301
UNDO_REDO::CHANGED
SCH_LINE::SetEndPoint
void SetEndPoint(const wxPoint &aPosition)
Definition: sch_line.h:94
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
SCH_LINE::SetStartPoint
void SetStartPoint(const wxPoint &aPosition)
Definition: sch_line.h:91
UNDO_REDO::NEWITEM
SCH_BASE_FRAME::AddToScreen
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,...
Definition: sch_base_frame.cpp:362
SCH_LINE
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
SCH_EDIT_FRAME::SaveCopyInUndoList
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
Definition: schematic_undo_redo.cpp:105

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

Referenced by BreakSegments(), SCH_EDIT_TOOL::BreakWire(), and TrimWire().

◆ BreakSegments()

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

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

Note
This 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 319 of file bus-wire-junction.cpp.

320 {
321  static const KICAD_T wiresAndBuses[] = { SCH_LINE_LOCATE_WIRE_T, SCH_LINE_LOCATE_BUS_T, EOT };
322 
323  if( aScreen == nullptr )
324  aScreen = GetScreen();
325 
326  bool brokenSegments = false;
327  std::vector<SCH_LINE*> wires;
328 
329  for( SCH_ITEM* item : aScreen->Items().Overlapping( SCH_LINE_T, aPoint ) )
330  {
331  if( item->IsType( wiresAndBuses ) )
332  {
333  SCH_LINE* wire = static_cast<SCH_LINE*>( item );
334 
335  if( IsPointOnSegment( wire->GetStartPoint(), wire->GetEndPoint(), aPoint )
336  && !wire->IsEndPoint( aPoint ) )
337  {
338  wires.push_back( wire );
339  }
340  }
341  }
342 
343  for( SCH_LINE* wire : wires )
344  brokenSegments |= BreakSegment( wire, aPoint, NULL, aScreen );
345 
346  return brokenSegments;
347 }
SCH_LINE::GetStartPoint
wxPoint GetStartPoint() const
Definition: sch_line.h:90
IsPointOnSegment
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
EOT
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
NULL
#define NULL
SCH_LINE::IsEndPoint
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:80
EE_RTREE::Overlapping
EE_TYPE Overlapping(const EDA_RECT &aRect) const
Definition: sch_rtree.h:221
SCH_EDIT_FRAME::BreakSegment
bool BreakSegment(SCH_LINE *aSegment, const wxPoint &aPoint, SCH_LINE **aNewSegment=nullptr, SCH_SCREEN *aScreen=nullptr)
Break a single segment into two at the specified point.
Definition: bus-wire-junction.cpp:295
SCH_LINE
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
SCH_SCREEN::Items
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197
SCH_LINE::GetEndPoint
wxPoint GetEndPoint() const
Definition: sch_line.h:93

References BreakSegment(), EOT, SCH_LINE::GetEndPoint(), GetScreen(), SCH_LINE::GetStartPoint(), SCH_LINE::IsEndPoint(), IsPointOnSegment(), SCH_SCREEN::Items(), NULL, EE_RTREE::Overlapping(), SCH_LINE_LOCATE_BUS_T, SCH_LINE_LOCATE_WIRE_T, and SCH_LINE_T.

Referenced by AddJunction(), and BreakSegmentsOnJunctions().

◆ BreakSegmentsOnJunctions()

bool SCH_EDIT_FRAME::BreakSegmentsOnJunctions ( SCH_SCREEN *  aScreen = nullptr)

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

Note
This 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 350 of file bus-wire-junction.cpp.

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

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 596 of file sch_edit_frame.cpp.

597 {
598  // Exit interactive editing
599  // Note this this will commit *some* pending changes. For instance, the EE_POINT_EDITOR
600  // will cancel any drag currently in progress, but commit all changes from previous drags.
601  if( m_toolManager )
602  m_toolManager->RunAction( ACTIONS::cancelInteractive, true );
603 
604  // Shutdown blocks must be determined and vetoed as early as possible
605  if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
606  && Schematic().GetSheets().IsModified() )
607  {
608  return false;
609  }
610 
611  if( Kiface().IsSingle() )
612  {
613  auto* symbolEditor = (SYMBOL_EDIT_FRAME*) Kiway().Player( FRAME_SCH_SYMBOL_EDITOR, false );
614 
615  if( symbolEditor && !symbolEditor->Close() ) // Can close symbol editor?
616  return false;
617 
618  auto* symbolViewer = (SYMBOL_VIEWER_FRAME*) Kiway().Player( FRAME_SCH_VIEWER, false );
619 
620  if( symbolViewer && !symbolViewer->Close() ) // Can close symbol viewer?
621  return false;
622 
623  symbolViewer = (SYMBOL_VIEWER_FRAME*) Kiway().Player( FRAME_SCH_VIEWER_MODAL, false );
624 
625  if( symbolViewer && !symbolViewer->Close() ) // Can close modal symbol viewer?
626  return false;
627  }
628 
629  SIM_PLOT_FRAME* simFrame = (SIM_PLOT_FRAME*) Kiway().Player( FRAME_SIMULATOR, false );
630 
631  if( simFrame && !simFrame->Close() ) // Can close the simulator?
632  return false;
633 
634  // We may have gotten multiple events; don't clean up twice
635  if( !Schematic().IsValid() )
636  return false;
637 
638  SCH_SHEET_LIST sheetlist = Schematic().GetSheets();
639 
640  if( sheetlist.IsModified() )
641  {
642  wxFileName fileName = Schematic().RootScreen()->GetFileName();
643  wxString msg = _( "Save changes to \"%s\" before closing?" );
644 
645  if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ),
646  [&]()->bool { return SaveProject(); } ) )
647  {
648  return false;
649  }
650  }
651 
652  return true;
653 }
SCH_SHEET_LIST
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Definition: sch_sheet_path.h:344
HandleUnsavedChanges
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:207
SCH_SCREEN::GetFileName
const wxString & GetFileName() const
Definition: sch_screen.h:133
KIWAY_HOLDER::Kiway
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
SCH_SHEET_LIST::IsModified
bool IsModified() const
Check the entire hierarchy for any modifications.
Definition: sch_sheet_path.cpp:530
SCHEMATIC::IsValid
bool IsValid() const
A simple test if the schematic is loaded, not a complete one.
Definition: schematic.h:108
ACTIONS::cancelInteractive
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
TOOL_MANAGER::RunAction
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
SYMBOL_VIEWER_FRAME
Symbol library viewer main window.
Definition: symbol_viewer_frame.h:43
KIWAY::Player
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:357
KIFACE_I::IsSingle
bool IsSingle() const
Is this KIFACE_I running under single_top?
Definition: kiface_i.h:104
Kiface
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: bitmap2cmp_main.cpp:76
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
KIPLATFORM::APP::SupportsShutdownBlockReason
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:65
SIM_PLOT_FRAME
Implementing SIM_PLOT_FRAME_BASE.
Definition: sim_plot_frame.h:117
Format
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
FRAME_SCH_VIEWER
Definition: frame_type.h:36
SCHEMATIC::GetSheets
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
FRAME_SIMULATOR
Definition: frame_type.h:38
_
#define _(s)
Definition: 3d_actions.cpp:33
SCH_EDIT_FRAME::SaveProject
bool SaveProject()
Definition: eeschema/files-io.cpp:751
SCHEMATIC::RootScreen
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:115
FRAME_SCH_VIEWER_MODAL
Definition: frame_type.h:37
FRAME_SCH_SYMBOL_EDITOR
Definition: frame_type.h:35
SYMBOL_EDIT_FRAME
The symbol library editor main window.
Definition: symbol_edit_frame.h:52

References _, ACTIONS::cancelInteractive, Format(), FRAME_SCH_SYMBOL_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(), TOOLS_HOLDER::m_toolManager, KIWAY::Player(), SCHEMATIC::RootScreen(), TOOL_MANAGER::RunAction(), SaveProject(), Schematic(), and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ CenterScreen()

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

Definition at line 253 of file sch_base_frame.cpp.

254 {
255  GetCanvas()->GetView()->SetCenter( aCenterPoint );
256 
257  if( aWarpPointer )
258  GetCanvas()->GetViewControls()->WarpCursor( aCenterPoint, true );
259 
260  GetCanvas()->Refresh();
261 }
SCH_DRAW_PANEL::GetView
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Definition: sch_draw_panel.cpp:176
EDA_DRAW_PANEL_GAL::GetViewControls
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
Definition: class_draw_panel_gal.h:122
KIGFX::VIEW_CONTROLS::WarpCursor
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
If enabled (.
KIGFX::VIEW::SetCenter
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:580
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
EDA_DRAW_PANEL_GAL::Refresh
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...
Definition: draw_panel_gal.cpp:303

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 1084 of file eda_base_frame.cpp.

1085 {
1086  SetUserUnits( aUnits );
1087  unitsChangeRefresh();
1088 
1089  wxCommandEvent e( UNITS_CHANGED );
1090  ProcessEventLocally( e );
1091 }
EDA_BASE_FRAME::unitsChangeRefresh
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
Definition: eda_base_frame.h:618
EDA_BASE_FRAME::SetUserUnits
void SetUserUnits(EDA_UNITS aUnits)
Definition: eda_base_frame.h:119

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

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckAnnotate()

int SCH_EDIT_FRAME::CheckAnnotate ( ANNOTATION_ERROR_HANDLER  aErrorHandler,
bool  aOneSheetOnly = false 
)

Check for annotation errors.

The following list of items are checked:

  • Symbols that are not annotated.
  • Duplicate symbol references.
  • Multiple part per package symbols where the part number is greater number of parts in the package.
  • Multiple part per package symbols where the reference designator is different between parts.
Returns
Number of annotation errors found.
Parameters
aReporterA handler for error reporting.
aOneSheetOnlyCheck the current sheet only if true. Otherwise check the entire schematic.

Definition at line 268 of file annotate.cpp.

269 {
270  SCH_REFERENCE_LIST referenceList;
271  constexpr bool includePowerSymbols = false;
272 
273  // Build the list of symbols
274  if( !aOneSheetOnly )
275  Schematic().GetSheets().GetSymbols( referenceList, includePowerSymbols );
276  else
277  GetCurrentSheet().GetSymbols( referenceList );
278 
279  // Empty schematic does not need annotation
280  if( referenceList.GetCount() == 0 )
281  return 0;
282 
283  return referenceList.CheckAnnotation( aErrorHandler );
284 }
SCH_SHEET_LIST::GetSymbols
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
Definition: sch_sheet_path.cpp:682
SCH_REFERENCE_LIST
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
Definition: sch_reference_list.h:198
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_REFERENCE_LIST::GetCount
unsigned GetCount() const
Definition: sch_reference_list.h:224
SCHEMATIC::GetSheets
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
SCH_REFERENCE_LIST::CheckAnnotation
int CheckAnnotation(ANNOTATION_ERROR_HANDLER aErrorHandler)
Check for annotations errors.
Definition: component_references_lister.cpp:496
SCH_SHEET_PATH::GetSymbols
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Adds SCH_REFERENCE object to aReferences for each symbol in the sheet.
Definition: sch_sheet_path.cpp:264
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567

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

Referenced by AnnotateSymbols(), DIALOG_ERC::DIALOG_ERC(), DIALOG_ERC::OnRunERCClick(), and ReadyToNetlist().

◆ 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 972 of file eda_base_frame.cpp.

973 {
974  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
975 
976  wxFileName autoSaveFileName = aFileName;
977 
978  // Check for auto save file.
979  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
980 
981  wxLogTrace( traceAutoSave,
982  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
983 
984  if( !autoSaveFileName.FileExists() )
985  return;
986 
987  wxString msg = wxString::Format( _(
988  "Well this is potentially embarrassing!\n"
989  "It appears that the last time you were editing the file\n"
990  "\"%s\"\n"
991  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
992  aFileName.GetFullName()
993  );
994 
995  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
996  this );
997 
998  // Make a backup of the current file, delete the file, and rename the auto save file to
999  // the file name.
1000  if( response == wxYES )
1001  {
1002  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1003  {
1004  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1005  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1006  }
1007  }
1008  else
1009  {
1010  wxLogTrace( traceAutoSave,
1011  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1012 
1013  // Remove the auto save file when using the previous file as is.
1014  wxRemoveFile( autoSaveFileName.GetFullPath() );
1015  }
1016 }
traceAutoSave
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
Definition: trace_helpers.cpp:44
Pgm
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
Format
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
EDA_BASE_FRAME::GetAutoSaveFilePrefix
static wxString GetAutoSaveFilePrefix()
Definition: eda_base_frame.h:582
_
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and 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 72 of file sheet.cpp.

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

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 recursion error in aHierarchy.

Definition at line 44 of file sheet.cpp.

45 {
46  wxASSERT( aSheet && aHierarchy );
47 
48  wxString msg;
49  SCH_SHEET_LIST hierarchy = Schematic().GetSheets(); // The full schematic sheet hierarchy.
50  SCH_SHEET_LIST sheetHierarchy( aSheet ); // This is the hierarchy of the loaded file.
51 
52  wxFileName destFile = aHierarchy->LastScreen()->GetFileName();
53 
54  // SCH_SCREEN object file paths are expected to be absolute. If this assert fires,
55  // something is seriously broken.
56  wxASSERT( destFile.IsAbsolute() );
57 
58  if( hierarchy.TestForRecursion( sheetHierarchy, destFile.GetFullPath() ) )
59  {
60  msg.Printf( _( "The sheet changes cannot be made because the destination sheet already "
61  "has the sheet \"%s\" or one of it's subsheets as a parent somewhere in "
62  "the schematic hierarchy." ),
63  destFile.GetFullPath() );
64  DisplayError( this, msg );
65  return true;
66  }
67 
68  return false;
69 }
DisplayError
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
SCH_SHEET_LIST
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Definition: sch_sheet_path.h:344
SCH_SCREEN::GetFileName
const wxString & GetFileName() const
Definition: sch_screen.h:133
SCH_SHEET_LIST::TestForRecursion
bool TestForRecursion(const SCH_SHEET_LIST &aSrcSheetHierarchy, const wxString &aDestFileName)
Test every SCH_SHEET_PATH in this SCH_SHEET_LIST to verify if adding the sheets stored in aSrcSheetHi...
Definition: sch_sheet_path.cpp:710
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCHEMATIC::GetSheets
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
SCH_SHEET_PATH::LastScreen
SCH_SCREEN * LastScreen()
Definition: sch_sheet_path.cpp:168
_
#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_SHEET_PROPERTIES::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
aFlagsis the wxEXEC_* flags, see wxExecute documentation.

Definition at line 780 of file sch_edit_frame.h.

780 { m_exec_flags &= ~( aFlags ); }
SCH_EDIT_FRAME::m_exec_flags
int m_exec_flags
Flags of the wxExecute() function to call a custom net list generator.
Definition: sch_edit_frame.h:917

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 869 of file eda_base_frame.cpp.

870 {
871  if( !aFileHistory )
872  aFileHistory = m_fileHistory;
873 
874  wxASSERT( aFileHistory );
875 
876  aFileHistory->ClearFileHistory();
877 
878  // Update the menubar to update the file history menu
879  if( GetMenuBar() )
880  {
881  ReCreateMenuBar();
882  GetMenuBar()->Refresh();
883  }
884 }
FILE_HISTORY::ClearFileHistory
void ClearFileHistory()
Clear all entries from the file history.
Definition: filehistory.cpp:168
EDA_BASE_FRAME::m_fileHistory
FILE_HISTORY * m_fileHistory
Definition: eda_base_frame.h:681
EDA_BASE_FRAME::ReCreateMenuBar
virtual void ReCreateMenuBar()
Recreates the menu bar.
Definition: eda_base_frame.cpp:412

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 901 of file sch_edit_frame.cpp.

902 {
903  m_infoBar->Dismiss();
904 }
WX_INFOBAR::Dismiss
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
Definition: infobar.cpp:171
EDA_BASE_FRAME::m_infoBar
WX_INFOBAR * m_infoBar
Definition: eda_base_frame.h:674

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

Referenced by SCH_EDITOR_CONTROL::FindNext().

◆ ClearMsgPanel()

void EDA_DRAW_FRAME::ClearMsgPanel ( )
virtualinherited

Clear all messages from the message panel.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 602 of file eda_draw_frame.cpp.

603 {
604  if( m_messagePanel )
605  m_messagePanel->EraseMsgBox();
606 }
EDA_DRAW_FRAME::m_messagePanel
EDA_MSG_PANEL * m_messagePanel
Definition: eda_draw_frame.h:518
EDA_MSG_PANEL::EraseMsgBox
void EraseMsgBox()
Definition: msgpanel.cpp:223

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

Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), NETLIST_DIALOG::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

◆ 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
whichListis the UNDO_REDO_CONTAINER to clear
aItemCountis the count of items to remove. Use < 0 to remove all items from the beginning of the list.

Reimplemented from EDA_BASE_FRAME.

Definition at line 392 of file schematic_undo_redo.cpp.

393 {
394  if( aItemCount == 0 )
395  return;
396 
397  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
398 
399  for( PICKED_ITEMS_LIST* command : list.m_CommandsList )
400  {
401  command->ClearListAndDeleteItems();
402  delete command;
403  }
404 
405  list.m_CommandsList.clear();
406 }
EDA_BASE_FRAME::UNDO_LIST
Definition: eda_base_frame.h:524
EDA_BASE_FRAME::m_undoList
UNDO_REDO_CONTAINER m_undoList
Definition: eda_base_frame.h:690
UNDO_REDO_CONTAINER
A holder to handle a list of undo (or redo) commands.
Definition: undo_redo_container.h:298
UNDO_REDO_CONTAINER::m_CommandsList
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
Definition: undo_redo_container.h:310
PICKED_ITEMS_LIST
A holder to handle information on schematic or board items.
Definition: undo_redo_container.h:134
EDA_BASE_FRAME::m_redoList
UNDO_REDO_CONTAINER m_redoList
Definition: eda_base_frame.h:691
PICKED_ITEMS_LIST::ClearListAndDeleteItems
void ClearListAndDeleteItems()
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...
Definition: undo_redo_container.cpp:120

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()

void EDA_BASE_FRAME::ClearUndoRedoList ( )
virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1035 of file eda_base_frame.cpp.

1036 {
1037  ClearUndoORRedoList( UNDO_LIST );
1038  ClearUndoORRedoList( REDO_LIST );
1039 }
EDA_BASE_FRAME::UNDO_LIST
Definition: eda_base_frame.h:524
EDA_BASE_FRAME::ClearUndoORRedoList
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
Definition: eda_base_frame.h:525
EDA_BASE_FRAME::REDO_LIST
Definition: eda_base_frame.h:524

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PL_EDITOR_FRAME::OnNewPageLayout(), OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().

◆ 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 1384 of file sch_edit_frame.cpp.

1385 {
1386  SCHEMATIC_SETTINGS& settings = Schematic().Settings();
1387  SCH_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1388 
1389  ShowAllIntersheetRefs( settings.m_IntersheetRefsShow );
1390 
1391  RecreateToolbars();
1392  Layout();
1393  SendSizeEvent();
1394 }
SCHEMATIC::Settings
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:127
EDA_DRAW_FRAME::RecreateToolbars
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of check tools.
Definition: eda_draw_frame.cpp:952
SCHEMATIC_SETTINGS::m_IntersheetRefsShow
bool m_IntersheetRefsShow
Definition: schematic_settings.h:57
SCH_EDIT_FRAME::ShowAllIntersheetRefs
void ShowAllIntersheetRefs(bool aShow)
Definition: sch_edit_frame.cpp:1363
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_BASE_FRAME::CommonSettingsChanged
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
Definition: sch_base_frame.cpp:408
SCHEMATIC_SETTINGS
These settings were stored in SCH_BASE_FRAME previously.
Definition: schematic_settings.h:38

References SCH_BASE_FRAME::CommonSettingsChanged(), SCHEMATIC_SETTINGS::m_IntersheetRefsShow, EDA_DRAW_FRAME::RecreateToolbars(), Schematic(), SCHEMATIC::Settings(), and ShowAllIntersheetRefs().

◆ 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 SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 710 of file eda_base_frame.cpp.

711 {
712  // KICAD_MANAGER_FRAME overrides this
713  return Kiface().KifaceSettings();
714 }
KIFACE_I::KifaceSettings
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
Kiface
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: bitmap2cmp_main.cpp:76

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_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(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_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

Get the configuration base name.

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 configuration can be used.

Returns
a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 338 of file eda_base_frame.h.

339  {
340  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
341  return baseCfgName;
342  }
EDA_BASE_FRAME::m_configName
wxString m_configName
Definition: eda_base_frame.h:676

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ ConvertPart()

void SCH_EDIT_FRAME::ConvertPart ( SCH_COMPONENT *  aSymbol)

Definition at line 237 of file getpart.cpp.

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

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().

◆ 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 65 of file libarch.cpp.

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

References _, DisplayErrorMessage(), LIB_PART::Flatten(), SCH_SCREENS::GetFirst(), SCH_BASE_FRAME::GetLibPart(), SCH_SCREENS::GetNext(), LT_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
aUseCurrentSheetFilenameset to 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 42 of file libarch.cpp.

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

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 284 of file sch_base_frame.cpp.

285 {
286  m_canvasType = loadCanvasTypeSetting();
287 
288  // Allows only a CAIRO or OPENGL canvas:
289  if( m_canvasType != EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL
290  && m_canvasType != EDA_DRAW_PANEL_GAL::GAL_FALLBACK )
291  {
292  m_canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
293  }
294 
295  SetCanvas( new SCH_DRAW_PANEL( this, wxID_ANY, wxPoint( 0, 0 ), m_frameSize,
296  GetGalDisplayOptions(), m_canvasType ) );
297  ActivateGalCanvas();
298 }
EDA_DRAW_FRAME::GetGalDisplayOptions
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
Definition: eda_draw_frame.h:431
EDA_DRAW_FRAME::m_canvasType
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
Definition: eda_draw_frame.h:524
EDA_DRAW_PANEL_GAL::GAL_FALLBACK
static constexpr GAL_TYPE GAL_FALLBACK
Definition: class_draw_panel_gal.h:72
EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL
OpenGL implementation.
Definition: class_draw_panel_gal.h:63
EDA_DRAW_FRAME::ActivateGalCanvas
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
Definition: eda_draw_frame.cpp:649
EDA_DRAW_FRAME::SetCanvas
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
Definition: eda_draw_frame.h:424
EDA_DRAW_FRAME::loadCanvasTypeSetting
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
Definition: eda_draw_frame.cpp:665
EDA_BASE_FRAME::m_frameSize
wxSize m_frameSize
Definition: eda_base_frame.h:662
SCH_DRAW_PANEL
Definition: sch_draw_panel.h:38

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().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 735 of file eda_base_frame.cpp.

736 {
737 #if defined( __WXOSX_MAC__ )
738  m_infoBar = new WX_INFOBAR( GetToolCanvas() );
739 #else
740  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
741 
742  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
743 #endif
744 }
EDA_BASE_FRAME::m_auimgr
wxAuiManager m_auimgr
Definition: eda_base_frame.h:671
TOOLS_HOLDER::GetToolCanvas
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
EDA_PANE
Specialization of the wxAuiPaneInfo class for KiCad panels.
Definition: eda_base_frame.h:731
WX_INFOBAR
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:71
EDA_BASE_FRAME::m_infoBar
WX_INFOBAR * m_infoBar
Definition: eda_base_frame.h:674

References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.

◆ CreateScreens()

void SCH_EDIT_FRAME::CreateScreens ( )

Definition at line 537 of file sch_edit_frame.cpp.

538 {
539  m_schematic->Reset();
540  m_schematic->SetProject( &Prj() );
541 
542  m_schematic->SetRoot( new SCH_SHEET( m_schematic ) );
543 
544  m_defaults = &m_schematic->Settings();
545 
546  SCH_SCREEN* rootScreen = new SCH_SCREEN( m_schematic );
547  m_schematic->Root().SetScreen( rootScreen );
548  SetScreen( Schematic().RootScreen() );
549 
550  m_schematic->RootScreen()->SetFileName( wxEmptyString );
551 
552  // Don't leave root page number empty
553  SCH_SHEET_PATH rootSheetPath;
554  rootSheetPath.push_back( &m_schematic->Root() );
555  m_schematic->RootScreen()->SetPageNumber( wxT( "1" ) );
556  m_schematic->Root().AddInstance( rootSheetPath.Path() );
557  m_schematic->Root().SetPageNumber( rootSheetPath, wxT( "1" ) );
558 
559  if( GetScreen() == NULL )
560  {
561  SCH_SCREEN* screen = new SCH_SCREEN( m_schematic );
562  SetScreen( screen );
563  }
564 }
SCH_EDIT_FRAME::m_schematic
SCHEMATIC * m_schematic
The currently loaded schematic.
Definition: sch_edit_frame.h:910
BASE_SCREEN::SetPageNumber
void SetPageNumber(const wxString &aPageNumber)
Definition: base_screen.h:83
SCH_EDIT_FRAME::SetScreen
void SetScreen(BASE_SCREEN *aScreen) override
Definition: sch_edit_frame.cpp:1442
SCH_SHEET_PATH::push_back
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
Definition: sch_sheet_path.h:160
SCH_SHEET_PATH::Path
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
Definition: sch_sheet_path.cpp:205
SCHEMATIC::Settings
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:127
SCH_SHEET::SetScreen
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
Definition: sch_sheet.cpp:156
SCH_SHEET::SetPageNumber
void SetPageNumber(const SCH_SHEET_PATH &aInstance, const wxString &aPageNumber)
Set the page number for the sheet instance aInstance.
Definition: sch_sheet.cpp:1135
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
SCHEMATIC::SetRoot
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
Definition: schematic.cpp:102
NULL
#define NULL
KIWAY_HOLDER::Prj
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Definition: kiway_holder.cpp:35
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_SHEET_PATH
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Definition: sch_sheet_path.h:128
SCH_BASE_FRAME::m_defaults
SCHEMATIC_SETTINGS * m_defaults
Definition: sch_base_frame.h:269
SCHEMATIC::SetProject
void SetProject(PROJECT *aPrj)
Definition: schematic.cpp:74
SCH_SHEET
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
SCHEMATIC::Reset
void Reset()
Initialize this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:51
SCHEMATIC::Root
SCH_SHEET & Root() const
Definition: schematic.h:92
SCH_SCREEN
Definition: sch_screen.h:94
SCH_SCREEN::SetFileName
void SetFileName(const wxString &aFileName)
Definition: sch_screen.h:131
SCHEMATIC::RootScreen
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:115
SCH_SHEET::AddInstance
bool AddInstance(const KIID_PATH &aInstance)
Add a new instance aSheetPath to the instance list.
Definition: sch_sheet.cpp:1093

References SCH_SHEET::AddInstance(), GetScreen(), SCH_BASE_FRAME::m_defaults, m_schematic, NULL, SCH_SHEET_PATH::Path(), KIWAY_HOLDER::Prj(), SCH_SHEET_PATH::push_back(), SCHEMATIC::Reset(), SCHEMATIC::Root(), SCHEMATIC::RootScreen(), Schematic(), SCH_SCREEN::SetFileName(), BASE_SCREEN::SetPageNumber(), SCH_SHEET::SetPageNumber(), 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 48 of file eda_dde.cpp.

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

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

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

◆ 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 }
TOOLS_HOLDER::m_toolStack
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
ACTIONS::selectionTool
static TOOL_ACTION selectionTool
Definition: actions.h:156

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 765 of file sch_edit_frame.h.

765 { m_exec_flags = wxEXEC_SYNC; }
SCH_EDIT_FRAME::m_exec_flags
int m_exec_flags
Flags of the wxExecute() function to call a custom net list generator.
Definition: sch_edit_frame.h:917

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 60 of file annotate.cpp.

61 {
62  auto clearAnnotation =
63  [&]( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aSheet )
64  {
65  for( SCH_ITEM* item : aScreen->Items().OfType( SCH_COMPONENT_T ) )
66  {
67  SCH_COMPONENT* symbol = static_cast<SCH_COMPONENT*>( item );
68 
69  SaveCopyInUndoList( aScreen, symbol, UNDO_REDO::CHANGED, *aAppendUndo );
70  *aAppendUndo = true;
71  symbol->ClearAnnotation( aSheet );
72  }
73  };
74 
75  if( aCurrentSheetOnly )
76  {
77  clearAnnotation( GetScreen(), &GetCurrentSheet() );
78  }
79  else
80  {
81  for( const SCH_SHEET_PATH& sheet : Schematic().GetSheets() )
82  clearAnnotation( sheet.LastScreen(), nullptr );
83  }
84 
85  // Update the references for the sheet that is currently being displayed.
86  GetCurrentSheet().UpdateAllScreenReferences();
87 
88  SyncView();
89  GetCanvas()->Refresh();
90  OnModify();
91 
92  // Must go after OnModify() so the connectivity graph has been updated
93  UpdateNetHighlightStatus();
94 }
EE_RTREE::OfType
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
SCH_EDIT_FRAME::UpdateNetHighlightStatus
void UpdateNetHighlightStatus()
Definition: sch_edit_frame.cpp:1428
SCH_SHEET_PATH::UpdateAllScreenReferences
void UpdateAllScreenReferences()
Update all the symbol references for this sheet path.
Definition: sch_sheet_path.cpp:250
UNDO_REDO::CHANGED
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
SCH_BASE_FRAME::SyncView
void SyncView()
Mark all items for refresh.
Definition: sch_base_frame.cpp:396
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_SHEET_PATH
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Definition: sch_sheet_path.h:128
EDA_DRAW_PANEL_GAL::Refresh
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...
Definition: draw_panel_gal.cpp:303
SCH_EDIT_FRAME::SaveCopyInUndoList
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
Definition: schematic_undo_redo.cpp:105
SCH_SCREEN
Definition: sch_screen.h:94
SCH_SCREEN::Items
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_COMPONENT
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567
SCH_EDIT_FRAME::OnModify
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
Definition: sch_edit_frame.cpp:767
SCH_COMPONENT::ClearAnnotation
void ClearAnnotation(const SCH_SHEET_PATH *aSheetPath)
Clear exiting symbol annotation.
Definition: sch_symbol.cpp:1036
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197

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 AnnotateSymbols(), 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 377 of file bus-wire-junction.cpp.

378 {
379  SCH_SCREEN* screen = GetScreen();
380  PICKED_ITEMS_LIST undoList;
381  EE_SELECTION_TOOL* selectionTool = m_toolManager->GetTool<EE_SELECTION_TOOL>();
382  KICAD_T wiresAndBuses[] = { SCH_LINE_LOCATE_WIRE_T, SCH_LINE_LOCATE_BUS_T, EOT };
383 
384  auto remove_item = [ & ]( SCH_ITEM* aItem ) -> void
385  {
386  aItem->SetFlags( STRUCT_DELETED );
387  undoList.PushItem( ITEM_PICKER( screen, aItem, UNDO_REDO::DELETED ) );
388  };
389 
390  remove_item( aJunction );
391  RemoveFromScreen( aJunction, screen );
392 
395  std::list<SCH_LINE*> lines;
396 
397  for( SCH_ITEM* item : screen->Items().Overlapping( SCH_LINE_T, aJunction->GetPosition() ) )
398  {
399  SCH_LINE* line = static_cast<SCH_LINE*>( item );
400 
401  if( line->IsType( wiresAndBuses ) && line->IsEndPoint( aJunction->GetPosition() )
402  && !( line->GetEditFlags() & STRUCT_DELETED ) )
403  lines.push_back( line );
404  }
405 
406  alg::for_all_pairs( lines.begin(), lines.end(),
407  [&]( SCH_LINE* firstLine, SCH_LINE* secondLine )
408  {
409  if( ( firstLine->GetEditFlags() & STRUCT_DELETED )
410  || ( secondLine->GetEditFlags() & STRUCT_DELETED )
411  || !secondLine->IsParallel( firstLine ) )
412  {
413  return;
414  }
415 
416  // Remove identical lines
417  if( firstLine->IsEndPoint( secondLine->GetStartPoint() )
418  && firstLine->IsEndPoint( secondLine->GetEndPoint() ) )
419  {
420  remove_item( firstLine );
421  return;
422  }
423 
424  // Try to merge the remaining lines
425  if( SCH_LINE* line = secondLine->MergeOverlap( screen, firstLine, false ) )
426  {
427  remove_item( firstLine );
428  remove_item( secondLine );
429  undoList.PushItem( ITEM_PICKER( screen, line, UNDO_REDO::NEWITEM ) );
430  AddToScreen( line, screen );
431 
432  if( line->IsSelected() )
433  selectionTool->AddItemToSel( line, true /*quiet mode*/ );
434 
435  lines.push_back( line );
436  }
437  } );
438 
439  SaveCopyInUndoList( undoList, UNDO_REDO::DELETED, aAppend );
440 
441 
442  for( SCH_LINE* line : lines )
443  {
444  if( line->GetEditFlags() & STRUCT_DELETED )
445  {
446  if( line->IsSelected() )
447  selectionTool->RemoveItemFromSel( line, true /*quiet mode*/ );
448 
449  RemoveFromScreen( line, screen );
450  }
451  }
452 }
SCH_LINE::MergeOverlap
SCH_LINE * MergeOverlap(SCH_SCREEN *aScreen, SCH_LINE *aLine, bool aCheckJunctions)
Check line against aLine to see if it overlaps and merge if it does.
Definition: sch_line.cpp:453
EDA_ITEM::IsSelected
bool IsSelected() const
Definition: eda_item.h:173
SCH_BASE_FRAME::RemoveFromScreen
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,...
Definition: sch_base_frame.cpp:379
PICKED_ITEMS_LIST::PushItem
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
Definition: undo_redo_container.cpp:70
EOT
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
alg::for_all_pairs
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:65
EDA_ITEM::SetFlags
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:203
EDA_ITEM::GetEditFlags
STATUS_FLAGS GetEditFlags() const
Definition: eda_item.h:208
UNDO_REDO::DELETED
SCH_LINE::IsEndPoint
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:80
STRUCT_DELETED
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:116
PICKED_ITEMS_LIST
A holder to handle information on schematic or board items.
Definition: undo_redo_container.h:134
UNDO_REDO::NEWITEM
EE_RTREE::Overlapping
EE_TYPE Overlapping(const EDA_RECT &aRect) const
Definition: sch_rtree.h:221
EE_SELECTION_TOOL
Definition: ee_selection_tool.h:55
ITEM_PICKER
Definition: undo_redo_container.h:75
EE_SELECTION_TOOL::RemoveItemFromSel
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
Definition: ee_selection_tool.cpp:1428
TOOL_MANAGER::GetTool
T * GetTool()
Definition: tool_manager.h:219
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
EE_SELECTION_TOOL::AddItemToSel
int AddItemToSel(const TOOL_EVENT &aEvent)
Definition: ee_selection_tool.cpp:1385
SCH_BASE_FRAME::AddToScreen
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,...
Definition: sch_base_frame.cpp:362
SCH_LINE
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
SCH_EDIT_FRAME::SaveCopyInUndoList
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
Definition: schematic_undo_redo.cpp:105
SCH_SCREEN
Definition: sch_screen.h:94
SCH_SCREEN::Items
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_LINE::IsType
bool IsType(const KICAD_T aScanTypes[]) const override
Check whether the item is one of the listed types.
Definition: sch_line.h:62
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197

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()

bool KIWAY_PLAYER::Destroy ( )
overrideinherited

Our version of Destroy() which is virtual from wxWidgets.

Definition at line 150 of file kiway_player.cpp.

151 {
152  return EDA_BASE_FRAME::Destroy();
153 }

Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), EDA_3D_VIEWER::OnCloseWindow(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ 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 }
KIWAY_PLAYER::m_modal_ret_val
bool m_modal_ret_val
Definition: kiway_player.h:199
KIWAY_PLAYER::m_modal_string
wxString m_modal_string
Definition: kiway_player.h:198
KIWAY_PLAYER::m_modal_loop
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

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

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

◆ DisplayCurrentSheet()

void SCH_EDIT_FRAME::DisplayCurrentSheet ( )

Draw the current sheet on the display.

Definition at line 289 of file hierarch.cpp.

290 {
291  m_toolManager->RunAction( ACTIONS::cancelInteractive, true );
292  m_toolManager->RunAction( EE_ACTIONS::clearSelection, true );
293  SCH_SCREEN* screen = GetCurrentSheet().LastScreen();
294 
295  wxASSERT( screen );
296 
297  SetScreen( screen );
298 
299  // update the References
300  GetCurrentSheet().UpdateAllScreenReferences();
301  SetSheetNumberAndCount();
302 
303  if( !screen->m_zoomInitialized )
304  {
305  initScreenZoom();
306  }
307  else
308  {
309  // Set zoom to last used in this screen
310  GetCanvas()->GetView()->SetScale( GetScreen()->m_LastZoomLevel );
311  RedrawScreen( (wxPoint) GetScreen()->m_ScrollCenter, false );
312  }
313 
314  UpdateTitle();
315 
316  SCH_EDITOR_CONTROL* editTool = m_toolManager->GetTool<SCH_EDITOR_CONTROL>();
317  TOOL_EVENT dummy;
318  editTool->UpdateNetHighlighting( dummy );
319 
320  HardRedraw(); // Ensure all items are redrawn (especially the drawing-sheet items)
321 }
SCH_DRAW_PANEL::GetView
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Definition: sch_draw_panel.cpp:176
SCH_BASE_FRAME::RedrawScreen
virtual void RedrawScreen(const wxPoint &aCenterPoint, bool aWarpPointer)
Definition: sch_base_frame.cpp:242
SCH_EDIT_FRAME::SetScreen
void SetScreen(BASE_SCREEN *aScreen) override
Definition: sch_edit_frame.cpp:1442
ACTIONS::cancelInteractive
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
SCH_EDIT_FRAME::UpdateTitle
void UpdateTitle()
Set the main window title bar text.
Definition: sch_edit_frame.cpp:1243
TOOL_MANAGER::RunAction
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
dummy
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
SCH_SHEET_PATH::UpdateAllScreenReferences
void UpdateAllScreenReferences()
Update all the symbol references for this sheet path.
Definition: sch_sheet_path.cpp:250
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
SCH_EDITOR_CONTROL
Handle actions specific to the schematic editor.
Definition: sch_editor_control.h:38
SCH_EDIT_FRAME::HardRedraw
void HardRedraw() override
Rebuild the GAL and redraw the screen.
Definition: sch_edit_frame.cpp:585
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
TOOL_EVENT
Generic, UI-independent tool event.
Definition: tool_event.h:173
SCH_EDIT_FRAME::initScreenZoom
void initScreenZoom()
Initialize the zoom value of the current screen and mark the screen as zoom-initialized.
Definition: sch_edit_frame.cpp:1274
EE_ACTIONS::clearSelection
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:54
SCH_EDITOR_CONTROL::UpdateNetHighlighting
int UpdateNetHighlighting(const TOOL_EVENT &aEvent)
Launch a tool to highlight nets.
Definition: sch_editor_control.cpp:978
KIGFX::SCH_VIEW::SetScale
void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 }) override
Set the scaling factor, zooming around a given anchor point.
Definition: sch_view.cpp:72
TOOL_MANAGER::GetTool
T * GetTool()
Definition: tool_manager.h:219
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
SCH_SHEET_PATH::LastScreen
SCH_SCREEN * LastScreen()
Definition: sch_sheet_path.cpp:168
SCH_SCREEN::m_zoomInitialized
bool m_zoomInitialized
Definition: sch_screen.h:504
SCH_EDIT_FRAME::SetSheetNumberAndCount
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
Definition: sch_edit_frame.cpp:488
SCH_SCREEN
Definition: sch_screen.h:94
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567

References ACTIONS::cancelInteractive, EE_ACTIONS::clearSelection, dummy(), SCH_BASE_FRAME::GetCanvas(), GetCurrentSheet(), GetScreen(), TOOL_MANAGER::GetTool(), SCH_DRAW_PANEL::GetView(), HardRedraw(), initScreenZoom(), SCH_SHEET_PATH::LastScreen(), TOOLS_HOLDER::m_toolManager, SCH_SCREEN::m_zoomInitialized, SCH_BASE_FRAME::RedrawScreen(), TOOL_MANAGER::RunAction(), KIGFX::SCH_VIEW::SetScale(), SetScreen(), SetSheetNumberAndCount(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and UpdateTitle().

Referenced by SCH_NAVIGATE_TOOL::EnterSheet(), SCH_EDITOR_CONTROL::EnterSheet(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_NAVIGATE_TOOL::HypertextCommand(), SCH_NAVIGATE_TOOL::LeaveSheet(), 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 469 of file eda_draw_frame.cpp.

470 {
471  wxString line;
472 
473  line.Printf( "grid %s",
474  MessageTextFromValue( GetUserUnits(), GetCanvas()->GetGAL()->GetGridSize().x, false ) );
475 
476  SetStatusText( line, 4 );
477 }
MessageTextFromValue
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:90
EDA_DRAW_FRAME::GetCanvas
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: eda_draw_frame.h:423
EDA_BASE_FRAME::GetUserUnits
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
Definition: eda_base_frame.h:114

References EDA_DRAW_FRAME::GetCanvas(), EDA_BASE_FRAME::GetUserUnits(), and MessageTextFromValue().

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 463 of file eda_draw_frame.cpp.

464 {
465  SetStatusText( msg, 6 );
466 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 480 of file eda_draw_frame.cpp.

481 {
482  wxString msg;
483 
484  switch( m_userUnits )
485  {
486  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
487  case EDA_UNITS::MILS: msg = _( "mils" ); break;
488  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
489  default: msg = _( "Units" ); break;
490  }
491 
492  SetStatusText( msg, 5 );
493 }
EDA_UNITS::MILS
_
#define _(s)
Definition: 3d_actions.cpp:33
EDA_BASE_FRAME::m_userUnits
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.
Definition: eda_base_frame.h:695
EDA_UNITS::INCHES
EDA_UNITS::MILLIMETRES

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

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 898 of file eeschema/files-io.cpp.

899 {
900  wxFileName tmpFileName = Schematic().Root().GetFileName();
901  wxFileName fn = tmpFileName;
902  wxFileName tmp;
903  SCH_SCREENS screens( Schematic().Root() );
904 
905  bool autoSaveOk = true;
906 
907  if( fn.GetPath().IsEmpty() )
908  tmp.AssignDir( Prj().GetProjectPath() );
909  else
910  tmp.AssignDir( fn.GetPath() );
911 
912  if( !tmp.IsOk() )
913  return false;
914 
915  if( !IsWritable( tmp ) )
916  return false;
917 
918  for( size_t i = 0; i < screens.GetCount(); i++ )
919  {
920  // Only create auto save files for the schematics that have been modified.
921  if( !screens.GetScreen( i )->IsSave() )
922  continue;
923 
924  tmpFileName = fn = screens.GetScreen( i )->GetFileName();
925 
926  // Auto save file name is the normal file name prefixed with GetAutoSavePrefix().
927  fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
928 
929  screens.GetScreen( i )->SetFileName( fn.GetFullPath() );
930 
931  if( SaveEEFile( screens.GetSheet( i ), false ) )
932  screens.GetScreen( i )->SetModify();
933  else
934  autoSaveOk = false;
935 
936  screens.GetScreen( i )->SetFileName( tmpFileName.GetFullPath() );
937  }
938 
939  if( autoSaveOk )
940  {
941  m_autoSaveState = false;
942 
943  if( !Kiface().IsSingle() &&
944  GetSettingsManager()->GetCommonSettings()->m_Backup.backup_on_autosave )
945  {
946  GetSettingsManager()->TriggerBackupIfNeeded( NULL_REPORTER::GetInstance() );
947  }
948  }
949 
950  return autoSaveOk;
951 }
EDA_BASE_FRAME::m_autoSaveState
bool m_autoSaveState
Definition: eda_base_frame.h:684
EDA_BASE_FRAME::GetSettingsManager
SETTINGS_MANAGER * GetSettingsManager() const
Definition: eda_base_frame.h:128
COMMON_SETTINGS::m_Backup
AUTO_BACKUP m_Backup
Definition: common_settings.h:138
EDA_BASE_FRAME::IsWritable
bool IsWritable(const wxFileName &aFileName)
Checks if aFileName can be written.
Definition: eda_base_frame.cpp:928
SCH_EDIT_FRAME::SaveEEFile
bool SaveEEFile(SCH_SHEET *aSheet, bool aSaveUnderNewName=false)
Save aSheet to a schematic file.
Definition: eeschema/files-io.cpp:64
KIFACE_I::IsSingle
bool IsSingle() const
Is this KIFACE_I running under single_top?
Definition: kiface_i.h:104
SETTINGS_MANAGER::TriggerBackupIfNeeded
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
Definition: settings_manager.cpp:1079
KIWAY_HOLDER::Prj
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Definition: kiway_holder.cpp:35
Kiface
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: bitmap2cmp_main.cpp:76
SETTINGS_MANAGER::GetCommonSettings
COMMON_SETTINGS * GetCommonSettings() const
Retrieves the common settings shared by all applications.
Definition: settings_manager.h:180
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_SHEET::GetFileName
wxString GetFileName() const
Return the filename corresponding to this sheet.
Definition: sch_sheet.h:315
EDA_BASE_FRAME::GetAutoSaveFilePrefix
static wxString GetAutoSaveFilePrefix()
Definition: eda_base_frame.h:582
SCHEMATIC::Root
SCH_SHEET & Root() const
Definition: schematic.h:92
COMMON_SETTINGS::AUTO_BACKUP::backup_on_autosave
bool backup_on_autosave
Trigger a backup on autosave.
Definition: common_settings.h:60
NULL_REPORTER::GetInstance
static REPORTER & GetInstance()
Definition: reporter.cpp:105
SCH_SCREENS
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:549

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, KIWAY_HOLDER::Prj(), 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 656 of file sch_edit_frame.cpp.

657 {
658  SCH_SHEET_LIST sheetlist = Schematic().GetSheets();
659 
660  // Shutdown all running tools
661  if( m_toolManager )
662  m_toolManager->ShutdownAllTools();
663 
664  RecordERCExclusions();
665 
666  // Close the find dialog and preserve it's setting if it is displayed.
667  if( m_findReplaceDialog )
668  {
669  m_findStringHistoryList = m_findReplaceDialog->GetFindEntries();
670  m_replaceStringHistoryList = m_findReplaceDialog->GetReplaceEntries();
671 
672  m_findReplaceDialog->Destroy();
673  m_findReplaceDialog = nullptr;
674  }
675 
676  if( FindHierarchyNavigator() )
677  FindHierarchyNavigator()->Close( true );
678 
679  SCH_SCREENS screens( Schematic().Root() );
680  wxFileName fn;
681 
682  for( SCH_SCREEN* screen = screens.GetFirst(); screen != NULL; screen = screens.GetNext() )
683  {
684  fn = Prj().AbsolutePath( screen->GetFileName() );
685 
686  // Auto save file name is the normal file name prepended with GetAutoSaveFilePrefix().
687  fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
688 
689  if( fn.FileExists() && fn.IsFileWritable() )
690  wxRemoveFile( fn.GetFullPath() );
691  }
692 
693  sheetlist.ClearModifyStatus();
694 
695  wxString fileName = Prj().AbsolutePath( Schematic().RootScreen()->GetFileName() );
696 
697  if( !Schematic().GetFileName().IsEmpty() && !Schematic().RootScreen()->IsEmpty() )
698  UpdateFileHistory( fileName );
699 
700  Schematic().RootScreen()->Clear();
701 
702  // all sub sheets are deleted, only the main sheet is usable
703  GetCurrentSheet().clear();
704 
705  // Clear view before destroying schematic as repaints depend on schematic being valid
706  SetScreen( nullptr );
707 
708  Schematic().Reset();
709 
710  Destroy();
711 }
TOOL_MANAGER::ShutdownAllTools
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
Definition: tool_manager.cpp:436
SCH_SHEET_LIST
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Definition: sch_sheet_path.h:344
SCH_EDIT_FRAME::FindHierarchyNavigator
HIERARCHY_NAVIG_DLG * FindHierarchyNavigator()
Definition: sch_edit_frame.cpp:850
DIALOG_SCH_FIND::GetFindEntries
wxArrayString GetFindEntries() const
Definition: dialog_schematic_find.cpp:277
SCH_EDIT_FRAME::SetScreen
void SetScreen(BASE_SCREEN *aScreen) override
Definition: sch_edit_frame.cpp:1442
SCH_SHEET_LIST::ClearModifyStatus
void ClearModifyStatus()
Definition: sch_sheet_path.cpp:542
EDA_DRAW_FRAME::m_findStringHistoryList
wxArrayString m_findStringHistoryList
Definition: eda_draw_frame.h:515
EDA_BASE_FRAME::UpdateFileHistory
void UpdateFileHistory(const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
Update the list of recently opened files.
Definition: eda_base_frame.cpp:811
PROJECT::AbsolutePath
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Definition: project.cpp:271
SCH_SCREEN::Clear
void Clear(bool aFree=true)
Delete all draw items and clears the project settings.
Definition: sch_screen.cpp:199
DIALOG_SCH_FIND::GetReplaceEntries
wxArrayString GetReplaceEntries() const
Definition: dialog_schematic_find.h:58
NULL
#define NULL
EDA_DRAW_FRAME::m_replaceStringHistoryList
wxArrayString m_replaceStringHistoryList
Definition: eda_draw_frame.h:516
KIWAY_HOLDER::Prj
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Definition: kiway_holder.cpp:35
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_EDIT_FRAME::m_findReplaceDialog
DIALOG_SCH_FIND * m_findReplaceDialog
Definition: sch_edit_frame.h:920
SCH_SHEET_PATH::clear
void clear()
Forwarded method from std::vector.
Definition: sch_sheet_path.h:143
EDA_BASE_FRAME::GetAutoSaveFilePrefix
static wxString GetAutoSaveFilePrefix()
Definition: eda_base_frame.h:582
SCHEMATIC::Reset
void Reset()
Initialize this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:51
SCHEMATIC::GetSheets
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
SCH_SCREEN
Definition: sch_screen.h:94
KIWAY_PLAYER::Destroy
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
Definition: kiway_player.cpp:150
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567
SCHEMATIC::RootScreen
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:115
SCH_EDIT_FRAME::RecordERCExclusions
void RecordERCExclusions()
Scan existing markers and record data from any that are Excluded.
Definition: sch_edit_frame.cpp:714
SCH_SCREENS
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:549

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(), SCHEMATIC::GetSheets(), m_findReplaceDialog, EDA_DRAW_FRAME::m_findStringHistoryList, EDA_DRAW_FRAME::m_replaceStringHistoryList, TOOLS_HOLDER::m_toolManager, NULL, KIWAY_HOLDER::Prj(), RecordERCExclusions(), SCHEMATIC::Reset(), SCHEMATIC::RootScreen(), 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 481 of file sheet.cpp.

482 {
483  wxRect DrawArea;
484  BASE_SCREEN* screen = GetScreen();
485 
486  DrawArea.SetSize( GetPageSizeIU() );
487 
488  // Calculate a reasonable dc size, in pixels, and the dc scale to fit
489  // the drawings into the dc size
490  // scale is the ratio resolution (in PPI) / internal units
491  double ppi = 300; // Use 300 pixels per inch to create bitmap images on start
492  double inch2Iu = 1000.0 * IU_PER_MILS;
493  double scale = ppi / inch2Iu;
494 
495  wxSize dcsize = DrawArea.GetSize();
496 
497  int maxdim = std::max( dcsize.x, dcsize.y );
498 
499  // the max size in pixels of the bitmap used to build the sheet copy
500  const int maxbitmapsize = 5600;
501 
502  while( int( maxdim * scale ) > maxbitmapsize )
503  {
504  ppi = ppi / 1.5;
505  scale = ppi / inch2Iu;
506  }
507 
508  dcsize.x *= scale;
509  dcsize.y *= scale;
510 
511  // Set draw offset, zoom... to values needed to draw in the memory DC
512  // after saving initial values:
513  wxPoint tmp_startvisu = screen->m_StartVisu;
514  wxPoint old_org = screen->m_DrawOrg;
515  screen->m_DrawOrg.x = screen->m_DrawOrg.y = 0;
516  screen->m_StartVisu.x = screen->m_StartVisu.y = 0;
517 
518  wxMemoryDC dc;
519  wxBitmap image( dcsize );
520  dc.SelectObject( image );
521  dc.Clear();
522 
523  GRResetPenAndBrush( &dc );
524  GRForceBlackPen( false );
525  dc.SetUserScale( scale, scale );
526 
527  GetRenderSettings()->SetPrintDC( &dc );
528  // Init the color of the layer actually used to print the worksheet:
529  GetRenderSettings()->SetLayerColor( LAYER_DRAWINGSHEET,
530  GetRenderSettings()->GetLayerColor( LAYER_SCHEMATIC_DRAWINGSHEET ) );
531 
532  PrintPage( GetRenderSettings() );
533 
534  {
535  wxLogNull doNotLog; // disable logging of failed clipboard actions
536 
537  if( wxTheClipboard->Open() )
538  {
539  // This data objects are held by the clipboard, so do not delete them in the app.
540  wxBitmapDataObject* clipbrd_data = new wxBitmapDataObject( image );
541  wxTheClipboard->SetData( clipbrd_data );
542  wxTheClipboard->Close();
543  }
544  }
545 
546  // Deselect Bitmap from DC in order to delete the MemoryDC
547  dc.SelectObject( wxNullBitmap );
548 
549  GRForceBlackPen( false );
550 
551  screen->m_StartVisu = tmp_startvisu;
552  screen->m_DrawOrg = old_org;
553 }
GRResetPenAndBrush
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:118
SCH_EDIT_FRAME::PrintPage
virtual void PrintPage(const RENDER_SETTINGS *aSettings) override
Plot or print the current sheet to the clipboard.
Definition: sch_edit_frame.cpp:1069
SCH_BASE_FRAME::GetLayerColor
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Helper to retrieve a layer color from the global color settings.
Definition: sch_base_frame.cpp:402
SCH_BASE_FRAME::GetRenderSettings
KIGFX::SCH_RENDER_SETTINGS * GetRenderSettings()
Definition: sch_base_frame.cpp:277
SCH_BASE_FRAME::GetPageSizeIU
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
Definition: sch_base_frame.cpp:141
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
BASE_SCREEN::m_StartVisu
wxPoint m_StartVisu
Coordinates in drawing units of the current view position (upper left corner of device)
Definition: base_screen.h:97
GRForceBlackPen
void GRForceBlackPen(bool flagforce)
Function GRForceBlackPen.
Definition: gr_basic.cpp:199
BASE_SCREEN
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:40
KIGFX::RENDER_SETTINGS::SetLayerColor
void SetLayerColor(int aLayer, const COLOR4D &aColor)
Change the color used to draw a layer.
Definition: render_settings.h:233
scale
const int scale
Definition: spread_footprints.cpp:61
BASE_SCREEN::m_DrawOrg
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
Definition: base_screen.h:92
IU_PER_MILS
#define IU_PER_MILS
Definition: plotter.cpp:137
LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layers_id_colors_and_visibility.h:217
KIGFX::RENDER_SETTINGS::SetPrintDC
void SetPrintDC(wxDC *aDC)
Definition: render_settings.h:261
LAYER_SCHEMATIC_DRAWINGSHEET
Definition: layers_id_colors_and_visibility.h:363
BITMAPS::image

References SCH_BASE_FRAME::GetLayerColor(), SCH_BASE_FRAME::GetPageSizeIU(), SCH_BASE_FRAME::GetRenderSettings(), GetScreen(), GRForceBlackPen(), GRResetPenAndBrush(), image, IU_PER_MILS, LAYER_DRAWINGSHEET, LAYER_SCHEMATIC_DRAWINGSHEET, BASE_SCREEN::m_DrawOrg, BASE_SCREEN::m_StartVisu, PrintPage(), scale, KIGFX::RENDER_SETTINGS::SetLayerColor(), and KIGFX::RENDER_SETTINGS::SetPrintDC().

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 existing file, or becomes a new instance of a already existing sheet.

Definition at line 465 of file sheet.cpp.

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

References NULL.

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

◆ eeconfig()

EESCHEMA_SETTINGS * SCH_BASE_FRAME::eeconfig ( ) const
inherited

Definition at line 117 of file sch_base_frame.cpp.

118 {
119  return dynamic_cast<EESCHEMA_SETTINGS*>( config() );
120 }
EDA_BASE_FRAME::config
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
Definition: eda_base_frame.cpp:710

References EDA_BASE_FRAME::config().

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), AllowCaseSensitiveFileNameClashes(), DIALOG_BOM::DIALOG_BOM(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::editFieldText(), ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindComponentAndItem(), GetShowAllPins(), EE_SELECTION_TOOL::GuessSelectionCandidates(), DIALOG_BOM::installGeneratorsList(), LoadSettings(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), DIALOG_PRINT_USING_PRINTER::OnMonochromeChecked(), OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_PRINTOUT::PrintPage(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), SaveSettings(), SelectUnit(), setupUIConditions(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_EDITOR_CONTROL::ToggleForceHV(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), and DIALOG_BOM::~DIALOG_BOM().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 232 of file eda_draw_frame.cpp.

233 {
234  if( m_messagePanel )
235  m_messagePanel->EraseMsgBox();
236 }
EDA_DRAW_FRAME::m_messagePanel
EDA_MSG_PANEL * m_messagePanel
Definition: eda_draw_frame.h:518
EDA_MSG_PANEL::EraseMsgBox
void EraseMsgBox()
Definition: msgpanel.cpp:223

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 footprint 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
cmdlineis the command received from Pcbnew.

Reimplemented from EDA_DRAW_FRAME.

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

300 {
301  SCH_EDITOR_CONTROL* editor = m_toolManager->GetTool<SCH_EDITOR_CONTROL>();
302  char line[1024];
303 
304  strncpy( line, cmdline, sizeof( line ) - 1 );
305  line[ sizeof( line ) - 1 ] = '\0';
306 
307  char* idcmd = strtok( line, " \n\r" );
308  char* text = strtok( nullptr, "\"\n\r" );
309 
310  if( idcmd == nullptr )
311  return;
312 
313  CROSS_PROBING_SETTINGS& crossProbingSettings = eeconfig()->m_CrossProbing;
314 
315  if( strcmp( idcmd, "$NET:" ) == 0 )
316  {
317  if( !crossProbingSettings.auto_highlight )
318  return;
319 
320  wxString netName = FROM_UTF8( text );
321 
322  if( auto sg = Schematic().ConnectionGraph()->FindFirstSubgraphByName( netName ) )
323  m_highlightedConn = sg->m_driver_connection;
324  else
325  m_highlightedConn = nullptr;
326 
327  GetToolManager()->RunAction( EE_ACTIONS::updateNetHighlighting, true );
328 
329  SetStatusText( _( "Selected net:" ) + wxS( " " ) + UnescapeString( netName ) );
330  return;
331  }
332 
333  if( strcmp( idcmd, "$CLEAR:" ) == 0 )
334  {
335  // Cross-probing is now done through selection so we no longer need a clear command
336  return;
337  }
338 
339  if( text == nullptr )
340  return;
341 
342  if( strcmp( idcmd, "$PART:" ) != 0 )
343  return;
344 
345  wxString part_ref = FROM_UTF8( text );
346 
347  /* look for a complement */
348  idcmd = strtok( nullptr, " \n\r" );
349 
350  if( idcmd == nullptr ) // Highlight component only (from CvPcb or Pcbnew)
351  {
352  // Highlight component part_ref, or clear Highlight, if part_ref is not existing
353  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, wxEmptyString );
354  return;
355  }
356 
357  text = strtok( nullptr, "\"\n\r" );
358 
359  if( text == nullptr )
360  return;
361 
362  wxString msg = FROM_UTF8( text );
363 
364  if( strcmp( idcmd, "$REF:" ) == 0 )
365  {
366  // Highlighting the reference itself isn't actually that useful, and it's harder to
367  // see. Highlight the parent and display the message.
368  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, msg );
369  }
370  else if( strcmp( idcmd, "$VAL:" ) == 0 )
371  {
372  // Highlighting the value itself isn't actually that useful, and it's harder to see.
373  // Highlight the parent and display the message.
374  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, msg );
375  }
376  else if( strcmp( idcmd, "$PAD:" ) == 0 )
377  {
378  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_PIN, msg );
379  }
380  else
381  {
382  editor->FindComponentAndItem( part_ref, true, HIGHLIGHT_COMPONENT, wxEmptyString );
383  }
384 }
FROM_UTF8
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
HIGHLIGHT_COMPONENT
Definition: sch_edit_frame.h:103
TOOL_MANAGER::RunAction
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:141
EE_ACTIONS::updateNetHighlighting
static TOOL_ACTION updateNetHighlighting
Definition: ee_actions.h:216
SCH_BASE_FRAME::eeconfig
EESCHEMA_SETTINGS * eeconfig() const
Definition: sch_base_frame.cpp:117
SCH_EDITOR_CONTROL
Handle actions specific to the schematic editor.
Definition: sch_editor_control.h:38
CROSS_PROBING_SETTINGS
Cross-probing behavior.
Definition: app_settings.h:30
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
BITMAPS::text
SCH_EDIT_FRAME::m_highlightedConn
const SCH_CONNECTION * m_highlightedConn
The highlighted net or bus, or nullptr.
Definition: sch_edit_frame.h:911
CROSS_PROBING_SETTINGS::auto_highlight
bool auto_highlight
Automatically turn on highlight mode in the target frame.
Definition: app_settings.h:34
TOOL_MANAGER::GetTool
T * GetTool()
Definition: tool_manager.h:219
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
BITMAPS::editor
_
#define _(s)
Definition: 3d_actions.cpp:33
UnescapeString
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:151
HIGHLIGHT_PIN
Definition: sch_edit_frame.h:102
TOOLS_HOLDER::GetToolManager
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
APP_SETTINGS_BASE::m_CrossProbing
CROSS_PROBING_SETTINGS m_CrossProbing
Definition: app_settings.h:167

References _, CROSS_PROBING_SETTINGS::auto_highlight, editor, SCH_BASE_FRAME::eeconfig(), FROM_UTF8(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), HIGHLIGHT_COMPONENT, HIGHLIGHT_PIN, APP_SETTINGS_BASE::m_CrossProbing, m_highlightedConn, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::RunAction(), Schematic(), text, 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 850 of file sch_edit_frame.cpp.

851 {
852  wxWindow* navigator = wxWindow::FindWindowByName( HIERARCHY_NAVIG_DLG_WNAME );
853 
854  return static_cast< HIERARCHY_NAVIG_DLG* >( navigator );
855 }
HIERARCHY_NAVIG_DLG_WNAME
#define HIERARCHY_NAVIG_DLG_WNAME
Definition: hierarch.h:36

References HIERARCHY_NAVIG_DLG_WNAME.

Referenced by doCloseWindow(), and UpdateHierarchyNavigator().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 747 of file eda_base_frame.cpp.

748 {
749 #if defined( __WXOSX_MAC__ )
750  m_auimgr.Update();
751 #else
752  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
753  // hiding it.
754  m_auimgr.Update();
755 
756  // We don't want the infobar displayed right away
757  m_auimgr.GetPane( "InfoBar" ).Hide();
758  m_auimgr.Update();
759 #endif
760 }
EDA_BASE_FRAME::m_auimgr
wxAuiManager m_auimgr
Definition: eda_base_frame.h:671

References EDA_BASE_FRAME::m_auimgr.

◆ FixupJunctions()

void SCH_EDIT_FRAME::FixupJunctions ( )

Definition at line 1493 of file sch_edit_frame.cpp.

1494 {
1495  // Save the current sheet, to retrieve it later
1496  SCH_SHEET_PATH oldsheetpath = GetCurrentSheet();
1497 
1498  bool modified = false;
1499 
1500  SCH_SHEET_LIST sheetList = Schematic().GetSheets();
1501 
1502  for( const SCH_SHEET_PATH& sheet : sheetList )
1503  {
1504  // We require a set here to avoid adding multiple junctions to the same spot
1505  std::set<wxPoint> junctions;
1506 
1507  SetCurrentSheet( sheet );
1508  GetCurrentSheet().UpdateAllScreenReferences();
1509 
1510  SCH_SCREEN* screen = GetCurrentSheet().LastScreen();
1511 
1512  for( auto aItem : screen->Items().OfType( SCH_COMPONENT_T ) )
1513  {
1514  auto cmp = static_cast<SCH_COMPONENT*>( aItem );
1515 
1516  for( const SCH_PIN* pin : cmp->GetPins( &sheet ) )
1517  {
1518  auto pos = pin->GetPosition();
1519 
1520  // Test if a _new_ junction is needed, and add it if missing
1521  if( screen->IsJunctionNeeded( pos, true ) )
1522  junctions.insert( pos );
1523  }
1524  }
1525 
1526  for( const wxPoint& pos : junctions )
1527  AddJunction( screen, pos, false, false );
1528 
1529  if( junctions.size() )
1530  modified = true;
1531  }
1532 
1533  if( modified )
1534  OnModify();
1535 
1536  // Reselect the initial sheet:
1537  SetCurrentSheet( oldsheetpath );
1538  GetCurrentSheet().UpdateAllScreenReferences();
1539  SetScreen( GetCurrentSheet().LastScreen() );
1540 }
SCH_EDIT_FRAME::SetCurrentSheet
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
Definition: sch_edit_frame.cpp:573
SCH_SHEET_LIST
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Definition: sch_sheet_path.h:344
EE_RTREE::OfType
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
SCH_EDIT_FRAME::SetScreen
void SetScreen(BASE_SCREEN *aScreen) override
Definition: sch_edit_frame.cpp:1442
SCH_SHEET_PATH::UpdateAllScreenReferences
void UpdateAllScreenReferences()
Update all the symbol references for this sheet path.
Definition: sch_sheet_path.cpp:250
SCH_EDIT_FRAME::AddJunction
SCH_JUNCTION * AddJunction(SCH_SCREEN *aScreen, const wxPoint &aPos, bool aAppendToUndo, bool aFinal=true)
Definition: bus-wire-junction.cpp:455
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_SHEET_PATH
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Definition: sch_sheet_path.h:128
BITMAPS::pin
SCHEMATIC::GetSheets
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
SCH_SHEET_PATH::LastScreen
SCH_SCREEN * LastScreen()
Definition: sch_sheet_path.cpp:168
SCH_SCREEN
Definition: sch_screen.h:94
SCH_SCREEN::Items
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_SCREEN::IsJunctionNeeded
bool IsJunctionNeeded(const wxPoint &aPosition, bool aNew=false) const
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:374
SCH_PIN
Definition: sch_pin.h:35
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:567
SCH_EDIT_FRAME::OnModify
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
Definition: sch_edit_frame.cpp:767

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

Referenced by importFile(), and OpenProjectFiles().

◆ FocusOnItem()

void SCH_EDIT_FRAME::FocusOnItem ( SCH_ITEM *  aItem)

Definition at line 1556 of file sch_edit_frame.cpp.

1557 {
1558  static KIID lastBrightenedItemID( niluuid );
1559 
1560  SCH_SHEET_LIST sheetList = Schematic().GetSheets();
1561  SCH_SHEET_PATH dummy;
1562  SCH_ITEM* lastItem = sheetList.GetItem( lastBrightenedItemID, &dummy );
1563 
1564  if( lastItem && lastItem != aItem )
1565  {
1566  lastItem->ClearBrightened();
1567 
1568  UpdateItem( lastItem );
1569  lastBrightenedItemID = niluuid;
1570  }
1571 
1572  if( aItem )
1573  {
1574  aItem->SetBrightened();
1575 
1576  UpdateItem( aItem );
1577  lastBrightenedItemID = aItem->m_Uuid;
1578 
1579  FocusOnLocation( aItem->GetFocusPosition() );
1580  }
1581 }
SCH_SHEET_LIST
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Definition: sch_sheet_path.h:344
SCH_BASE_FRAME::UpdateItem
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
Definition: sch_base_frame.cpp:301
niluuid
KIID niluuid(0)
EDA_ITEM::GetFocusPosition
virtual const wxPoint GetFocusPosition() const
Similar to GetPosition, but allows items to return their visual center rather than their anchor.
Definition: eda_item.h:309
EDA_ITEM::SetBrightened
void SetBrightened()
Definition: eda_item.h:180
dummy
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
EDA_ITEM::ClearBrightened
void ClearBrightened()
Definition: eda_item.h:183
KIID
Definition: kiid.h:44
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCH_SHEET_PATH
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Definition: sch_sheet_path.h:128
EDA_ITEM::m_Uuid
const KIID m_Uuid
Definition: eda_item.h:525
SCH_SHEET_LIST::GetItem
SCH_ITEM * GetItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr) const
Fetch a SCH_ITEM by ID.
Definition: sch_sheet_path.cpp:552
SCHEMATIC::GetSheets
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
EDA_DRAW_FRAME::FocusOnLocation
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions.
Definition: eda_draw_frame.cpp:796
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197

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::OnCancelClick(), 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 796 of file eda_draw_frame.cpp.

797 {
798  bool centerView = false;
799  BOX2D r = GetCanvas()->GetView()->GetViewport();
800 
801  // Center if we're off the current view, or within 10% of its edge
802  r.Inflate( - (int) r.GetWidth() / 10 );
803 
804  if( !r.Contains( aPos ) )
805  centerView = true;
806 
807  // Center if we're behind an obscuring dialog, or within 10% of its edge
808  wxWindow* dialog = findDialog( GetChildren() );
809 
810  if( dialog )
811  {
812  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
813  dialog->GetSize() );
814  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
815 
816  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
817  centerView = true;
818  }
819 
820  if( centerView )
821  {
822  // If a dialog partly obscures the window, then center on the uncovered area.
823  if( dialog )
824  {
825  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
826  dialog->GetSize() );
827  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
828  }
829  else
830  GetCanvas()->GetView()->SetCenter( aPos );
831  }
832 
833  GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( aPos );
834 }
KIGFX::VIEW::GetViewport
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:514
EDA_DRAW_PANEL_GAL::GetViewControls
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
Definition: class_draw_panel_gal.h:122
EDA_DRAW_FRAME::GetCanvas
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: eda_draw_frame.h:423
KIGFX::VIEW::SetCenter
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:580
BOX2::GetWidth
coord_type GetWidth() const
Definition: box2.h:197
BOX2::Contains
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
findDialog
wxWindow * findDialog(wxWindowList &aList)
Definition: eda_draw_frame.cpp:785
EDA_DRAW_PANEL_GAL::GetView
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
Definition: class_draw_panel_gal.h:115
KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2::Inflate
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 PCB_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 493 of file eda_base_frame.h.

493 { return m_aboutTitle; }
EDA_BASE_FRAME::m_aboutTitle
wxString m_aboutTitle
Definition: eda_base_frame.h:669

References EDA_BASE_FRAME::m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), 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 582 of file eda_base_frame.h.

583  {
584  return wxT( "_autosave-" );
585  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::doAutoSave(), 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 190 of file eda_base_frame.h.

190 { return m_autoSaveInterval; }
EDA_BASE_FRAME::m_autoSaveInterval
int m_autoSaveInterval
Definition: eda_base_frame.h:685

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ 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 271 of file sch_base_frame.cpp.

272 {
273  return static_cast<SCH_DRAW_PANEL*>( EDA_DRAW_FRAME::GetCanvas() );
274 }
EDA_DRAW_FRAME::GetCanvas
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: eda_draw_frame.h:423

References EDA_DRAW_FRAME::GetCanvas().

Referenced by AddItemToScreenAndUndoList(), AddJunction(), SCH_BASE_FRAME::AddToScreen(), AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::BreakWire(), SCH_BASE_FRAME::CenterScreen(), SYMBOL_VIEWER_FRAME::ClickOnCmpList(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DeleteAnnotation(), DisplayCurrentSheet(), SYMBOL_VIEWER_FRAME::doCloseWindow(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EE_SELECTION_TOOL::doSelectionMenu(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_EDIT_TOOL::editGraphicProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), SCH_EDITOR_CONTROL::EnterSheet(), DIALOG_ERC::ExcludeMarker(), EE_INSPECTION_TOOL::ExcludeMarker(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), SCH_DRAWING_TOOLS::GetCanvasFreeAreaPixels(), GetDocumentExtents(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::HardRedraw(), HardRedraw(), SCH_EDITOR_CONTROL::ImportFPAssignments(), SCH_EDIT_TOOL::Init(), KiwayMailIn(), SCH_EDITOR_CONTROL::LeaveSheet(), EE_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_ERC::OnEraseDrcMarkersClick(), DIALOG_ERC::OnERCItemRClick(), EE_SELECTION_TOOL::OnIdle(), DIALOG_MIGRATE_BUSES::onItemSelected(), OnModify(), OnPageSettingsChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), SYMBOL_TREE_PANE::onUpdateUI(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::Properties(), PutDataInPreviousState(), ReannotateFromPCBNew(), SYMBOL_EDIT_FRAME::RebuildView(), RecalculateConnections(), RecomputeIntersheetRefs(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), SCH_EDITOR_CONTROL::Redo(), DIALOG_ERC::redrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RefreshSelection(), SCH_EDITOR_CONTROL::RemapSymbols(), SCH_BASE_FRAME::RemoveFromScreen(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::rescueProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), RollbackSchematicFromUndo(), SaveSymbolToSchematic(), EE_SELECTION_TOOL::selectMultiple(), SYMBOL_EDIT_FRAME::SetCurPart(), SetCurrentSheet(), EE_POINT_EDITOR::setEditedPoint(), SetScreen(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), SYMBOL_VIEWER_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), setupTools(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), ShowSchematicSetupDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDIT_FRAME::SwitchCanvas(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), SCH_BASE_FRAME::SyncView(), TestDanglingEnds(), DIALOG_ERC::testErc(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_EDIT_LINE_STYLE::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SCH_EDITOR_CONTROL::UpdateFind(), SCH_BASE_FRAME::UpdateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), SCH_BASE_FRAME::UpdateStatusBar(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME().

◆ GetColorSettings()

COLOR_SETTINGS * SCH_BASE_FRAME::GetColorSettings ( ) const
overridevirtualinherited

Returns a pointer to the active color theme settings.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 420 of file sch_base_frame.cpp.

421 {
422  if( !m_colorSettings )
423  {
424  SETTINGS_MANAGER& settingsManager = Pgm().GetSettingsManager();
425  EESCHEMA_SETTINGS* cfg = settingsManager.GetAppSettings<EESCHEMA_SETTINGS>();
426  COLOR_SETTINGS* colorSettings = settingsManager.GetColorSettings( cfg->m_ColorTheme );
427 
428  const_cast<SCH_BASE_FRAME*>( this )->m_colorSettings = colorSettings;
429  }
430 
431  return m_colorSettings;
432 }
Pgm
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
SETTINGS_MANAGER::GetAppSettings
AppSettings * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
Definition: settings_manager.h:88
SETTINGS_MANAGER
Definition: settings_manager.h:37
EDA_DRAW_FRAME::m_colorSettings
COLOR_SETTINGS * m_colorSettings
The current canvas type.
Definition: eda_draw_frame.h:521
EESCHEMA_SETTINGS
Definition: eeschema_settings.h:33
SETTINGS_MANAGER::GetColorSettings
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
Definition: settings_manager.cpp:180
COLOR_SETTINGS
Color settings are a bit different than most of the settings objects in that there can be more than o...
Definition: color_settings.h:49
APP_SETTINGS_BASE::m_ColorTheme
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184

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

Referenced by SCH_BASE_FRAME::GetDrawBgColor(), SCH_BASE_FRAME::GetLayerColor(), SCH_PRINTOUT::PrintPage(), PrintPage(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), and DIALOG_SHEET_PROPERTIES::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 1584 of file sch_edit_frame.cpp.

1585 {
1586  return Schematic().GetFileName();
1587 }
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:523
SCHEMATIC::GetFileName
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:121

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 1590 of file sch_edit_frame.cpp.

1591 {
1592  return m_toolManager->GetTool<EE_SELECTION_TOOL>()->GetSelection();
1593 }
EE_SELECTION_TOOL
Definition: ee_selection_tool.h:55
TOOL_MANAGER::GetTool
T * GetTool()
Definition: tool_manager.h:219
TOOLS_HOLDER::m_toolManager
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

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

◆ GetCurrentSheet()

SCH_SHEET_PATH & SCH_EDIT_FRAME::GetCurrentSheet ( ) const

Definition at line 567 of file sch_edit_frame.cpp.

568 {
569  return m_schematic->CurrentSheet();
570 }
SCH_EDIT_FRAME::m_schematic
SCHEMATIC * m_schematic
The currently loaded schematic.
Definition: sch_edit_frame.h:910
SCHEMATIC::CurrentSheet
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:119

References SCHEMATIC::CurrentSheet(), and m_schematic.

Referenced by AddItemToScreenAndUndoList(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), AnnotateSymbols(), 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_EDIT_TOOL::EditPageNumber(), SCH_NAVIGATE_TOOL::EnterSheet(), SCH_EDITOR_CONTROL::EnterSheet(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), FixupJunctions(), SCH_PIN::GetMsgPanelInfo(), SCH_COMPONENT::GetMsgPanelInfo(), GetScreen(), GetScreenDesc(), GetUniqueFilenameForCurrentSheet(), HardRedraw(), SCH_EDITOR_CONTROL::HasMatch(), HIERARCHY_NAVIG_DLG::HIERARCHY_NAVIG_DLG(), SCH_NAVIGATE_TOOL::HypertextCommand(), importFile(), SCH_DRAWING_TOOLS::Init(), EE_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_NAVIGATE_TOOL::LeaveSheet(), SCH_EDITOR_CONTROL::LeaveSheet(), DIALOG_ERC::OnERCItemSelected(), DIALOG_MIGRATE_BUSES::onItemSelected(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), SCH_EDIT_TOOL::Properties(), ReannotateFromPCBNew(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), DIALOG_PLOT_SCHEMATIC::restoreEnvironment(), SaveEEFile(), SaveSymbolToSchematic(), SelectUnit(), SetCurrentSheet(), SetSheetNumberAndCount(), setupUIConditions(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), 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 115 of file sch_base_frame.h.

116  {
117  return *m_defaults;
118  }
SCH_BASE_FRAME::m_defaults
SCHEMATIC_SETTINGS * m_defaults
Definition: sch_base_frame.h:269

References SCH_BASE_FRAME::m_defaults.

◆ GetDocumentExtents()

const BOX2I SCH_EDIT_FRAME::GetDocumentExtents ( bool  aIncludeAllVisible = true) const
overridevirtual

Returns bbox of document with option to not include some items.

Used most commonly by "Zoom to Fit" and "Zoom to Objects". In Eeschema for "Zoom to Fit", it's passed "true" to include worksheet border. It's passed false by "Zoom To Objects" to ignore worksheet border. In Pcbnew, false makes it ignore any items outside the PCB edge such as fabrication notes.

Parameters
aIncludeAllVisibleTrue to include everything visible in bbox calculations, false to ignore some visible items (program dependent).
Returns
Bounding box of the document (ignoring some items as requested).

Reimplemented from EDA_DRAW_FRAME.

Definition at line 1452 of file sch_edit_frame.cpp.

1453 {
1454  BOX2I bBoxDoc;
1455 
1456  if( aIncludeAllVisible )
1457  {
1458  // Get the whole page size and return that
1459  int sizeX = GetScreen()->GetPageSettings().GetWidthIU();
1460  int sizeY = GetScreen()->GetPageSettings().GetHeightIU();
1461  bBoxDoc = BOX2I( VECTOR2I( 0, 0 ), VECTOR2I( sizeX, sizeY ) );
1462  }
1463  else
1464  {
1465  // Get current drawing-sheet in a form we can compare to an EDA_ITEM
1466  DS_PROXY_VIEW_ITEM* ds = SCH_BASE_FRAME::GetCanvas()->GetView()->GetDrawingSheet();
1467  EDA_ITEM* dsAsItem = static_cast<EDA_ITEM*>( ds );
1468 
1469  // Need an EDA_RECT so the first ".Merge" sees it's uninitialized
1470  EDA_RECT bBoxItems;
1471 
1472  // Calc the bounding box of all items on screen except the page border
1473  for( EDA_ITEM* item : GetScreen()->Items() )
1474  {
1475  if( item != dsAsItem ) // Ignore the drawing-sheet itself
1476  {
1477  if( item->Type() == SCH_COMPONENT_T )
1478  {
1479  // For symbols we need to get the bounding box without invisible text
1480  SCH_COMPONENT* symbol = static_cast<SCH_COMPONENT*>( item );
1481  bBoxItems.Merge( symbol->GetBoundingBox( false ) );
1482  }
1483  else
1484  bBoxItems.Merge( item->GetBoundingBox() );
1485  }
1486  bBoxDoc = bBoxItems;
1487  }
1488  }
1489  return bBoxDoc;
1490 }
SCH_DRAW_PANEL::GetView
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Definition: sch_draw_panel.cpp:176
BOX2I
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
EDA_RECT::Merge
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:431
VECTOR2I
VECTOR2< int > VECTOR2I
Definition: vector2d.h:623
SCH_SCREEN::GetPageSettings
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:128
BOX2
BOX2 handles a 2-D bounding box, built on top of an origin point and size vector, both of templated c...
Definition: box2.h:43
SCH_COMPONENT::GetBoundingBox
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: sch_symbol.cpp:1358
SCH_EDIT_FRAME::GetScreen
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: sch_edit_frame.cpp:517
SCH_BASE_FRAME::GetCanvas
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: sch_base_frame.cpp:271
DS_PROXY_VIEW_ITEM
Definition: ds_proxy_view_item.h:47
EDA_RECT
Handle the component boundary box.
Definition: eda_rect.h:42
SCH_COMPONENT
Schematic symbol object.
Definition: sch_symbol.h:78
EDA_ITEM
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150
KIGFX::SCH_VIEW::GetDrawingSheet
DS_PROXY_VIEW_ITEM * GetDrawingSheet() const
Definition: sch_view.h:98

References SCH_COMPONENT::GetBoundingBox(), SCH_BASE_FRAME::GetCanvas(), KIGFX::SCH_VIEW::GetDrawingSheet(), SCH_SCREEN::GetPageSettings(), GetScreen(), SCH_DRAW_PANEL::GetView(), EDA_RECT::Merge(), and SCH_COMPONENT_T.

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

Indicate 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; }
TOOLS_HOLDER::m_immediateActions
bool m_immediateActions
Definition: tools_holder.h:170

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 134 of file tools_holder.h.

134 { return m_dragAction; }
TOOLS_HOLDER::m_dragAction
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:174

References TOOLS_HOLDER::m_dragAction.

Referenced by PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

COLOR4D SCH_BASE_FRAME::GetDrawBgColor ( ) const
overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 435 of file sch_base_frame.cpp.

436 {
437  return GetColorSettings()->GetColor( LAYER_SCHEMATIC_BACKGROUND );
438 }
LAYER_SCHEMATIC_BACKGROUND
Definition: layers_id_colors_and_visibility.h:358
SCH_BASE_FRAME::GetColorSettings
COLOR_SETTINGS * GetColorSettings() const override
Returns a pointer to the active color theme settings.
Definition: sch_base_frame.cpp:420
COLOR_SETTINGS::GetColor
COLOR4D GetColor(int aLayer) const
Definition: color_settings.cpp:320

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

Referenced by SCH_PRINTOUT::PrintPage().

◆ 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 initialization 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 829 of file eda_base_frame.cpp.

831 {
832  if( !aFileHistory )
833  aFileHistory = m_fileHistory;
834 
835  wxASSERT( aFileHistory );
836 
837  int baseId = aFileHistory->GetBaseId();
838 
839  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
840 
841  unsigned i = cmdId - baseId;
842 
843  if( i < aFileHistory->GetCount() )
844  {
845  wxString fn = aFileHistory->GetHistoryFile( i );
846 
847  if( wxFileName::FileExists( fn ) )
848  return fn;
849  else
850  {
851  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
852  wxMessageBox( msg );
853 
854  aFileHistory->RemoveFileFromHistory( i );
855  }
856  }
857 
858  // Update the menubar to update the file history menu
859  if( GetMenuBar() )
860  {
861  ReCreateMenuBar();
862  GetMenuBar()->Refresh();
863  }
864 
865  return wxEmptyString;
866 }
Format
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
_
#define _(s)
Definition: 3d_actions.cpp:33
EDA_BASE_FRAME::m_fileHistory
FILE_HISTORY * m_fileHistory
Definition: eda_base_frame.h:681
EDA_BASE_FRAME::ReCreateMenuBar
virtual void ReCreateMenuBar()
Recreates the menu bar.
Definition: eda_base_frame.cpp:412

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 403 of file eda_base_frame.h.

404  {
405  return *m_fileHistory;
406  }
EDA_BASE_FRAME::m_fileHistory
FILE_HISTORY * m_fileHistory
Definition: eda_base_frame.h:681

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 94 of file eda_draw_frame.h.

94 { return m_findStringHistoryList; }
EDA_DRAW_FRAME::m_findStringHistoryList
wxArrayString m_findStringHistoryList
Definition: eda_draw_frame.h:515

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 838 of file sch_edit_frame.cpp.

839 {
840  if( m_findReplaceDialog && m_findReplaceDialog->IsVisible()
841  && !m_findReplaceData->GetFindString().IsEmpty() )
842  {
843  return m_findReplaceData;
844  }
845 
846  return nullptr;
847 }
SCH_EDIT_FRAME::m_findReplaceDialog
DIALOG_SCH_FIND * m_findReplaceDialog
Definition: sch_edit_frame.h:920
EDA_DRAW_FRAME::m_findReplaceData
wxFindReplaceData * m_findReplaceData
Definition: eda_draw_frame.h:514

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()

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_FRAME::GetGalDisplayOptions ( )
inlineinherited

Return a reference to the gal rendering options used by GAL for rendering.

Definition at line 431 of file eda_draw_frame.h.

431 { return m_galDisplayOptions; }
EDA_DRAW_FRAME::m_galDisplayOptions
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
Default display origin transforms object.
Definition: eda_draw_frame.h:531

References EDA_DRAW_FRAME::m_galDisplayOptions.

Referenced by SCH_BASE_FRAME::createCanvas(), EDITOR_CONDITIONS::cursorFunc(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_VIEWER_FRAME::LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::prepareCanvas(), FOOTPRINT_EDIT_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), COMMON_TOOLS::ToggleCursor(), and COMMON_TOOLS::ToggleCursorStyle().

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

Reimplemented in GERBVIEW_FRAME, FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, DISPLAY_FOOTPRINTS_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 223 of file eda_draw_frame.h.

223 { return m_gridColor; }
EDA_DRAW_FRAME::m_gridColor
COLOR4D m_gridColor
Definition: eda_draw_frame.h:496

References EDA_DRAW_FRAME::m_gridColor.

Referenced by PCB_CONTROL::Reset().

◆ GetGridOrigin()

const wxPoint& SCH_BASE_FRAME::GetGridOrigin </