Schematic editor (Eeschema) main window. More...
#include <sch_edit_frame.h>
Public Types | |
| enum | UNDO_REDO_LIST { UNDO_LIST , REDO_LIST } |
| Specifies whether we are interacting with the undo or redo stacks. 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 | setupUIConditions () override |
| Setup the UI conditions for the various actions and their controls in this frame. More... | |
| bool | IsContentModified () const 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 and update other data structures and GUI elements. More... | |
| void | RecordERCExclusions () |
| Scan existing markers and record data from any that are Excluded. More... | |
| void | ResolveERCExclusions () |
| Update markers to match recorded exclusions. More... | |
| SEVERITY | GetSeverity (int aErrorCode) const override |
| 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 | AutoRotateItem (SCH_SCREEN *aScreen, SCH_ITEM *aItem) |
| Automatically set the rotation of an item (if the item supports it) 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 () |
| Update the hierarchy navigation tree and history. More... | |
| void | UpdateHierarchySelection () |
| Update the hierarchy navigation tree selection (cross-probe from schematic to hierarchy pane). More... | |
| void | ShowFindReplaceStatus (const wxString &aMsg, int aStatusTime) |
| void | ClearFindReplaceStatus () |
| void | OnFindDialogClose () |
| Notification that the Find dialog has closed. More... | |
| void | BreakSegment (SCH_LINE *aSegment, const VECTOR2I &aPoint, SCH_LINE **aNewSegment=nullptr, SCH_SCREEN *aScreen=nullptr) |
| Break a single segment into two at the specified point. More... | |
| bool | BreakSegments (const VECTOR2I &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 | SendSelectItemsToPcb (const std::vector< EDA_ITEM * > &aItems, bool aForce) |
| Sends items to Pcbnew for selection. 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 (ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive, bool *appendUndo) |
| Clear the current symbol annotation. More... | |
| void | AnnotateSymbols (ANNOTATE_SCOPE_T aAnnotateScope, ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption, bool aRecursive, int aStartNumber, bool aResetAnnotation, bool aRepairTimestamps, REPORTER &aReporter, bool appendUndo=false) |
| Annotate the symbols in the schematic that are not currently annotated. More... | |
| int | CheckAnnotate (ANNOTATION_ERROR_HANDLER aErrorHandler, ANNOTATE_SCOPE_T aAnnotateScope=ANNOTATE_ALL, bool aRecursive=true) |
| 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 | UpdateItem (EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override |
| Mark an item for refresh. More... | |
| 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... | |
| void | SetSheetNumberAndCount () |
| Set the m_ScreenNumber and m_NumberOfScreens members for screens. More... | |
| wxPageSetupDialogData & | GetPageSetupData () |
| void | NewProject () |
| void | LoadProject () |
| bool | SaveProject (bool aSaveAs=false) |
| Save the currently-open schematic (including its hierarchy) and associated project. More... | |
| 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 | AddSheetAndUpdateDisplay (const wxString aFullFileName) |
| Add a sheet file into the current sheet and updates display. 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 VECTOR2I &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 VECTOR2I &aStart, const VECTOR2I &aEnd) |
| If any single wire passes through both points, remove the portion between the two points, potentially splitting the wire into two. 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_SYMBOL *aSymbol) |
| void | SelectUnit (SCH_SYMBOL *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, bool aDirtyConnectivity=true) |
| 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, bool aDirtyConnectivity=true) |
| 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... | |
| void | AddCopyForRepeatItem (const SCH_ITEM *aItem) |
| const std::vector< std::unique_ptr< SCH_ITEM > > & | GetRepeatItems () const |
| Return the items which are 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 symbols 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 | CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override |
| Called after the preferences dialog is run. More... | |
| void | UpdateNetHighlightStatus () |
| void | ShowChangedLanguage () override |
| 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... | |
| int | GetSchematicJunctionSize () |
| void | FocusOnItem (SCH_ITEM *aItem) |
| bool | IsSyncingSelection () |
| void | SaveSymbolToSchematic (const LIB_SYMBOL &aSymbol, const KIID &aSchematicSymbolUUID) |
| Update a schematic symbol from a LIB_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) |
| virtual void | CheckForAutoSaveFile (const wxFileName &aFileName) override |
| This overloaded version checks if the auto save master file "#auto_saved_files#" exists and recovers all of the schematic files listed in it. More... | |
| void | ToggleSchematicHierarchy () |
| Toggle the show/hide state of the left side schematic navigation panel. More... | |
| 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 () |
| 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 VECTOR2I & | GetGridOrigin () const override |
| Return the absolute coordinates of the origin of the snap grid. More... | |
| void | SetGridOrigin (const VECTOR2I &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 SYMBOL_LIBRARY_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 symbol to import into schematic. More... | |
| LIB_SYMBOL * | GetLibSymbol (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false) |
| Load symbol from symbol library table. More... | |
| PICKED_SYMBOL | PickSymbolFromLibBrowser (wxTopLevelWindow *aParent, const SYMBOL_LIBRARY_FILTER *aFilter, const LIB_ID &aPreselectedLibId, int aUnit, int aConvert) |
| Call the library viewer to select symbol to import into schematic. More... | |
| wxString | SelectLibraryFromList () |
| Display a list of loaded libraries and allows the user to select a library. More... | |
| SYMBOL_LIB_TABLE * | SelectSymLibTable (bool aOptional=false) |
| Display a dialog asking the user to select a symbol library table. More... | |
| virtual void | RedrawScreen (const VECTOR2I &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 | RefreshZoomDependentItems () |
| 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 (bool aForceRefresh=false) const override |
| Returns a pointer to the active color theme settings. More... | |
| void | ActivateGalCanvas () override |
| Use to start up the GAL drawing canvas. 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... | |
| void | ScriptingConsoleEnableDisable () |
| Toggles the scripting console visibility. More... | |
| bool | IsScriptingConsoleVisible () |
| Gets the current visibility of the scripting console window. More... | |
| EDA_SEARCH_DATA & | GetFindReplaceData () |
| 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... | |
| VECTOR2I | GetNearestGridPosition (const VECTOR2I &aPosition) const |
| Return the nearest aGridSize location to aPosition. More... | |
| VECTOR2I | GetNearestHalfGridPosition (const VECTOR2I &aPosition) const |
| Return the nearest aGridSize / 2 location to aPosition. More... | |
| virtual void | SetDrawBgColor (const COLOR4D &aColor) |
| 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 (const 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 wxchoice. More... | |
| void | OnUpdateSelectZoom (wxUpdateUIEvent &aEvent) |
| Update the checked item in the zoom wxchoice. More... | |
| void | UpdateZoomSelectBox () |
| Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) 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) override |
| 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 VECTOR2I &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, const std::map< wxString, wxString > *aProperties, 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 | DisplayConstraintsMsg (const wxString &msg) |
| void | DisplayUnitsMsg () |
| Display current unit pane in the status bar. More... | |
| virtual void | DisplayGridMsg () |
| Display current grid size in the status bar. More... | |
| 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 | 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 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) |
| void | CreateServer (int service, bool local=true) |
| void | OnSockRequest (wxSocketEvent &evt) |
| void | OnSockRequestServer (wxSocketEvent &evt) |
| void | ChangeUserUnits (EDA_UNITS aUnits) |
| ORIGIN_TRANSFORMS & | GetOriginTransforms () override |
| Return a reference to the default ORIGIN_TRANSFORMS object. More... | |
| SETTINGS_MANAGER * | GetSettingsManager () const |
| bool | ProcessEvent (wxEvent &aEvent) override |
| Override the default process event handler to implement the auto save feature. More... | |
| virtual void | OnCharHook (wxKeyEvent &aKeyEvent) |
| 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) |
| int | GetAutoSaveInterval () const |
| bool | IsType (FRAME_T aType) const |
| FRAME_T | GetFrameType () 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) |
| Displays the preferences and settings of all opened editors paged dialog. More... | |
| void | ShowPreferences (wxString aStartPage, wxString aStartParentPage) |
| Displays the preferences and settings of all opened editors paged dialog, starting with a particular page. More... | |
| void | PrintMsg (const wxString &text) |
| void | CreateInfoBar () |
| void | FinishAUIInitialization () |
| WX_INFOBAR * | GetInfoBar () |
| void | ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC) |
| 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 | ReCreateMenuBar () |
| Recreates the menu bar. More... | |
| void | AddStandardHelpMenu (wxMenuBar *aMenuBar) |
| Adds the standard KiCad help menu to the menubar. More... | |
| bool | IsWritable (const wxFileName &aFileName, bool aVerbose=true) |
| Checks if aFileName can be written. 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 |
| const wxString & | GetUntranslatedAboutTitle () 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 TOOL_EVENT &aEvent) |
| NB: the definition of "tool" is different at the user level. More... | |
| virtual void | PopTool (const TOOL_EVENT &aEvent) |
| Pops a tool from the stack. More... | |
| 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... | |
| bool | HasKiway () const |
| Safety check before asking for the Kiway reference. 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... | |
| EDA_UNITS | GetUserUnits () const |
| void | SetUserUnits (EDA_UNITS aUnits) |
| const EDA_IU_SCALE & | GetIuScale () const |
| wxString | StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) |
| Converts aValue in internal units into a united string. More... | |
| wxString | StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false) |
| wxString | MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) |
| A lower-precision version of StringFromValue(). More... | |
| wxString | MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true) |
| int | ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) |
| Converts aTextValue in aUnits to internal units used by the frame. More... | |
| EDA_ANGLE | AngleValueFromString (const wxString &aTextValue) |
Static Public Member Functions | |
| static const wxString | SchematicHierarchyPaneName () |
| 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... | |
| void | doReCreateMenuBar () override |
| void | sendNetlistToCvpcb () |
| Send the KiCad netlist over to CVPCB. More... | |
| void | onSize (wxSizeEvent &aEvent) |
| void | handleActivateEvent (wxActivateEvent &aEvent) override |
| Handle a window activation event. More... | |
| void | handleIconizeEvent (wxIconizeEvent &aEvent) override |
| Handle a window iconize event. More... | |
| 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) |
| std::vector< wxWindow * > | findDialogs () |
| 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... | |
| 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 | onIconize (wxIconizeEvent &aEvent) |
| virtual bool | isAutoSaveRequired () const |
| Return the auto save status of the application. 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... | |
| void | ensureWindowIsOnScreen () |
| virtual void | OnDropFiles (wxDropFilesEvent &aEvent) |
| Handles event fired when a file is dropped to the window. More... | |
| virtual void | DoWithAcceptedFiles () |
| Execute action on accepted dropped file. More... | |
Static Protected Member Functions | |
| static wxString | GetAutoSaveFilePrefix () |
Static Protected Attributes | |
| static bool | m_openGLFailureOccured = false |
| Has any failure occured when switching to OpenGL in any EDA_DRAW_FRAME? More... | |
| 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 | OnResizeHierarchyNavigator (wxSizeEvent &aEvent) |
| 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 its 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... | |
| bool | saveSchematicFile (SCH_SHEET *aSheet, const wxString &aSavePath) |
| Save aSheet to a schematic file. More... | |
| void | mapExistingAnnotation (std::map< wxString, wxString > &aMap) |
| Fill a map of uuid -> reference from the currently loaded schematic. More... | |
| bool | updateAutoSaveFile () |
| const wxString & | getAutoSaveFileName () const |
| void | windowClosing (wxCloseEvent &event) |
| (with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings(). More... | |
| void | commonInit (FRAME_T aFrameType) |
| Collect common initialization functions used in all CTORs. More... | |
| wxWindow * | findQuasiModalDialog () |
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 |
| std::vector< std::unique_ptr< SCH_ITEM > > | m_items_to_repeat |
| For the repeat-last-item cmd. 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 |
| HIERARCHY_PANE * | m_hierarchy |
| bool | m_syncingPcbToSchSelection |
| BASE_SCREEN * | m_currentScreen |
| current used SCREEN More... | |
| EDA_DRAW_PANEL_GAL * | m_canvas |
| This the frame's interface to setting GAL display options. More... | |
| KIGFX::GAL_DISPLAY_OPTIONS | m_galDisplayOptions |
| KIWAY * | m_kiway |
| HOLDER_TYPE | m_type |
| const EDA_IU_SCALE & | m_iuScale |
| EDA_UNITS | m_userUnits |
Friends | |
| class | SCH_EDITOR_CONTROL |
| class | SCH_FIND_REPLACE_TOOL |
Detailed Description
Schematic editor (Eeschema) main window.
Definition at line 97 of file sch_edit_frame.h.
Member Enumeration Documentation
◆ HOLDER_TYPE
|
inherited |
◆ UNDO_REDO_LIST
|
inherited |
Specifies whether we are interacting with the undo or redo stacks.
| Enumerator | |
|---|---|
| UNDO_LIST | |
| REDO_LIST | |
Definition at line 111 of file eda_base_frame.h.
Constructor & Destructor Documentation
◆ SCH_EDIT_FRAME()
| SCH_EDIT_FRAME::SCH_EDIT_FRAME | ( | KIWAY * | aKiway, |
| wxWindow * | aParent | ||
| ) |
Definition at line 116 of file sch_edit_frame.cpp.
References _, _HKI, PCAD2KICAD::Center, EE_ACTIONS::ddAppendFile, KIGFX::eeconfig(), KIGFX::VIEW::GetPainter(), EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_docked_width, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_float_height, EESCHEMA_SETTINGS::AUI_PANELS::hierarchy_panel_float_width, icon_eeschema, icon_eeschema_16, icon_eeschema_32, KiBitmap(), KiCadSchematicFileExtension, PCAD2KICAD::Left, EESCHEMA_SETTINGS::m_AuiPanels, OnResizeHierarchyNavigator(), onSize(), PCAD2KICAD::Right, EESCHEMA_SETTINGS::AUI_PANELS::schematic_hierarchy_float, SetAuiPaneSize(), KIPLATFORM::APP::SetShutdownBlockReason(), and EESCHEMA_SETTINGS::AUI_PANELS::show_schematic_hierarchy.
◆ ~SCH_EDIT_FRAME()
|
override |
Definition at line 287 of file sch_edit_frame.cpp.
References DIALOG_ERC_WINDOW_NAME, EDA_DRAW_PANEL_GAL::GetBackend(), SCH_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetSettingsManager(), Kiface(), EDA_DRAW_FRAME::m_canvasType, m_hierarchy, m_schematic, TOOLS_HOLDER::m_toolManager, OnResizeHierarchyNavigator(), KIWAY_HOLDER::Prj(), SetScreen(), TOOL_MANAGER::ShutdownAllTools(), and SETTINGS_MANAGER::UnloadProject().
Member Function Documentation
◆ ActivateGalCanvas()
|
overridevirtualinherited |
Use to start up the GAL drawing canvas.
Reimplemented from EDA_DRAW_FRAME.
Definition at line 348 of file sch_base_frame.cpp.
References EDA_DRAW_FRAME::ActivateGalCanvas(), and SCH_BASE_FRAME::GetCanvas().
Referenced by SCH_BASE_FRAME::createCanvas(), and SCH_DRAW_PANEL::OnShow().
◆ AddCopyForRepeatItem()
| void SCH_EDIT_FRAME::AddCopyForRepeatItem | ( | const SCH_ITEM * | aItem | ) |
Definition at line 607 of file sch_edit_frame.cpp.
References EDA_ITEM::Clone(), and m_items_to_repeat.
Referenced by SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDIT_TOOL::RepeatDrawItem(), and SaveCopyForRepeatItem().
◆ 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
-
aUndoAppend True if the action should be appended to the current undo record.
Definition at line 1287 of file sch_edit_frame.cpp.
References AddJunction(), SCH_SHEET::AddPin(), SCH_BASE_FRAME::AddToScreen(), AutoRotateItem(), CHANGED, SCH_SCREEN::CheckIfOnDrawList(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearFlags(), SCH_ITEM::ConnectedItems(), SCH_BASE_FRAME::GetCanvas(), SCH_ITEM::GetConnectionPoints(), GetCurrentSheet(), EDA_ITEM::GetParent(), IS_NEW, SCH_ITEM::IsConnectable(), SCH_SCREEN::IsExplicitJunctionNeeded(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), LOCAL_CLEANUP, NEWITEM, RecalculateConnections(), EDA_DRAW_PANEL_GAL::Refresh(), SaveCopyForRepeatItem(), SaveCopyInUndoList(), SCH_FIELD_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, BASE_SCREEN::SetContentModified(), TestDanglingEnds(), TrimWire(), EDA_ITEM::Type(), and UpdateItem().
Referenced by SCH_DRAWING_TOOLS::DrawShape(), 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 VECTOR2I & | aPos, | ||
| bool | aAppendToUndo, | ||
| bool | aFinal = true |
||
| ) |
Definition at line 421 of file bus-wire-junction.cpp.
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_LINE_WIRE_BUS_TOOL::finishSegments(), and SCH_MOVE_TOOL::Main().
◆ AddSheetAndUpdateDisplay()
| bool SCH_EDIT_FRAME::AddSheetAndUpdateDisplay | ( | const wxString | aFullFileName | ) |
Add a sheet file into the current sheet and updates display.
- Note
- Used in AppendSchematic() and SCH_EDIT_TOOL::ddAppendFile() (so it is public)
- Parameters
-
aFullFileName Path and name of sheet
- Returns
- True if the sheet was properly added
Definition at line 550 of file eeschema/files-io.cpp.
References GetCurrentSheet(), HardRedraw(), initScreenZoom(), LoadSheetFromFile(), OnModify(), SetSheetNumberAndCount(), SCH_BASE_FRAME::SyncView(), and UpdateHierarchyNavigator().
Referenced by AppendSchematic(), and SCH_EDIT_TOOL::DdAppendFile().
◆ AddStandardHelpMenu()
|
inherited |
Adds the standard KiCad help menu to the menubar.
Definition at line 462 of file eda_base_frame.cpp.
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_FRAME::CreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().
◆ AddStandardSubMenus()
|
inherited |
Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g.
zoom and grid).
Definition at line 576 of file eda_draw_frame.cpp.
References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, TOOL_MENU::RegisterSubMenu(), and SELECTION_CONDITIONS::ShowAlways().
Referenced by EE_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), and PCB_VIEWER_TOOLS::Init().
◆ AddToScreen()
|
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 440 of file sch_base_frame.cpp.
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(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::orthoLineDrag(), PutDataInPreviousState(), and SCH_EDIT_TOOL::RepeatDrawItem().
◆ 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
-
aSchematicFileName is 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 623 of file sheet.cpp.
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().
◆ AngleValueFromString()
|
inlineinherited |
Definition at line 116 of file units_provider.h.
References PNS::angle(), DEGREES, DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().
Referenced by FP_TEXT_GRID_TABLE::SetValue().
◆ AnnotateSymbols()
| void SCH_EDIT_FRAME::AnnotateSymbols | ( | ANNOTATE_SCOPE_T | aAnnotateScope, |
| ANNOTATE_ORDER_T | aSortOption, | ||
| ANNOTATE_ALGO_T | aAlgoOption, | ||
| bool | aRecursive, | ||
| int | aStartNumber, | ||
| bool | aResetAnnotation, | ||
| bool | aRepairTimestamps, | ||
| REPORTER & | aReporter, | ||
| bool | appendUndo = false |
||
| ) |
Annotate the symbols in the schematic that are not currently annotated.
Multi-unit symbols are annotated together. E.g. if two symbols were R8A and R8B, they may become R3A and R3B, but not R3A and R3C or R3C and R4D.
- Parameters
-
aAnnotateScope See ANNOTATE_SCOPE_T aSortOption Define the annotation order. See ANNOTATE_ORDER_T. aAlgoOption Define the annotation style. See ANNOTATE_ALGO_T. aRecursive Annotation should descend into and annotate subsheets aStartNumber The start number for non-sheet-based annotation styles. aResetAnnotation Clear any previous annotation if true. Otherwise, keep the existing symbol annotation. aRepairTimestamps Test 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. aReporter A sink for error messages. Use NULL_REPORTER if you don't need errors. appendUndo True if the annotation operation should be added to an existing undo, false if it should be separately undo-able.
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 194 of file annotate.cpp.
References _, SCH_REFERENCE_LIST::AddItem(), SCH_REFERENCE::Annotate(), ANNOTATE_ALL, ANNOTATE_CURRENT_SHEET, ANNOTATE_SELECTION, SCH_REFERENCE_LIST::AnnotateByOptions(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), KIID_PATH::AsString(), CHANGED, CheckAnnotate(), SCH_REFERENCE_LIST::Contains(), DIALOG_ERC_WINDOW_NAME, SCH_BASE_FRAME::GetCanvas(), SCH_REFERENCE_LIST::GetCount(), GetCurrentSheet(), getInferredSymbols(), SCH_SHEET_PATH::GetMultiUnitSymbols(), SCH_SHEET_LIST::GetMultiUnitSymbols(), SCH_SYMBOL::GetRef(), EE_SELECTION_TOOL::GetSelection(), SCH_REFERENCE::GetSheetPath(), SCHEMATIC::GetSheets(), SCH_SCREEN::GetSheets(), SCH_SHEET_LIST::GetSheetsWithinPath(), SCH_REFERENCE::GetSymbol(), SCH_SHEET_PATH::GetSymbols(), SCH_SHEET_LIST::GetSymbols(), SCH_SHEET_LIST::GetSymbolsWithinPath(), TOOL_MANAGER::GetTool(), SCH_SYMBOL::GetUnit(), SCH_SYMBOL::GetUnitCount(), SCH_SYMBOL::GetUnitSelection(), SCH_SYMBOL::GetValueFieldText(), SCH_SHEET_PATH::LastScreen(), TOOLS_HOLDER::m_toolManager, EDA_ITEM::m_Uuid, mapExistingAnnotation(), OnModify(), SCH_SHEET_PATH::Path(), SCH_SHEET_PATH::push_back(), EDA_DRAW_PANEL_GAL::Refresh(), SCH_REFERENCE_LIST::RemoveAnnotation(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), REPORTER::Report(), REPORTER::ReportTail(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, SaveCopyInUndoList(), SCH_SHEET_T, Schematic(), SetSheetNumberAndCount(), SCH_REFERENCE_LIST::SplitReferences(), LIB_SYMBOL::SubReference(), SCH_BASE_FRAME::SyncView(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and UpdateNetHighlightStatus().
Referenced by DIALOG_ANNOTATE::OnApplyClick(), and SCH_EDIT_TOOL::RepeatDrawItem().
◆ AppendMsgPanel()
|
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
-
aTextUpper The message upper text. aTextLower The message lower text. aPadding Number of spaces to pad between messages.
Definition at line 736 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::AppendMessage(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().
◆ 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 527 of file eeschema/files-io.cpp.
References _, AddSheetAndUpdateDisplay(), GetScreen(), KiCadSchematicFileWildcard(), path, and KIWAY_HOLDER::Prj().
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 1304 of file eeschema/files-io.cpp.
References _, FRAME_SIMULATOR, SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), HandleUnsavedChanges(), KIWAY_HOLDER::Kiway(), KIWAY::Player(), SaveProject(), and Schematic().
Referenced by OnImportProject(), and OpenProjectFiles().
◆ AutoRotateItem()
| void SCH_EDIT_FRAME::AutoRotateItem | ( | SCH_SCREEN * | aScreen, |
| SCH_ITEM * | aItem | ||
| ) |
Automatically set the rotation of an item (if the item supports it)
Definition at line 1261 of file sch_edit_frame.cpp.
References SCH_LABEL_BASE::AutoplaceFields(), GetCurrentSheet(), SCH_SCREEN::GetLabelOrientationForPoint(), EDA_TEXT::GetText(), SCH_ITEM::IsType(), SCH_SCREEN::Items(), EE_RTREE::OfType(), and SCH_GLOBAL_LABEL_T.
Referenced by AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::Main(), SCH_EDIT_TOOL::Swap(), and DIALOG_LABEL_PROPERTIES::TransferDataFromWindow().
◆ BreakSegment()
| void SCH_EDIT_FRAME::BreakSegment | ( | SCH_LINE * | aSegment, |
| const VECTOR2I & | 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
-
aSegment Line segment to break aPoint Point at which to break the segment aNewSegment Pointer to the newly created segment (if given and created) aScreen is the screen to examine, or nullptr to examine the current screen.
Definition at line 272 of file bus-wire-junction.cpp.
References SCH_BASE_FRAME::AddToScreen(), SCH_LINE::BreakAt(), CHANGED, GetScreen(), IS_BROKEN, IS_CHANGED, IS_NEW, NEWITEM, SaveCopyInUndoList(), EDA_ITEM::SetFlags(), and UpdateItem().
Referenced by BreakSegments(), SCH_EDIT_TOOL::BreakWire(), and TrimWire().
◆ BreakSegments()
| bool SCH_EDIT_FRAME::BreakSegments | ( | const VECTOR2I & | 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
-
aPoint Test this point for an intersection. aScreen is 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.
References BreakSegment(), SCH_SCREEN::GetBusesAndWires(), and GetScreen().
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
-
aScreen is the screen to examine, or nullptr to examine the current screen
- Returns
- True if any wires or buses were broken.
Definition at line 312 of file bus-wire-junction.cpp.
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()
|
overrideprivatevirtual |
Reimplemented from EDA_BASE_FRAME.
Definition at line 729 of file sch_edit_frame.cpp.
References _, ACTIONS::cancelInteractive, DIALOG_ERC_WINDOW_NAME, Format(), FRAME_SCH_SYMBOL_EDITOR, FRAME_SCH_VIEWER, FRAME_SCH_VIEWER_MODAL, FRAME_SIMULATOR, SCH_SCREEN::GetFileName(), SCHEMATIC::GetSheets(), HandleUnsavedChanges(), SCH_SHEET_LIST::IsModified(), SCHEMATIC::IsValid(), Kiface(), KIWAY_HOLDER::Kiway(), TOOLS_HOLDER::m_toolManager, KIWAY::Player(), SCHEMATIC::RootScreen(), TOOL_MANAGER::RunAction(), Schematic(), and KIPLATFORM::APP::SupportsShutdownBlockReason().
◆ ChangeUserUnits()
|
inherited |
Definition at line 1352 of file eda_base_frame.cpp.
References UNITS_PROVIDER::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, |
| ANNOTATE_SCOPE_T | aAnnotateScope = ANNOTATE_ALL, |
||
| bool | aRecursive = true |
||
| ) |
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
-
aReporter A handler for error reporting. aAnnotateScope See ANNOTATE_SCOPE_T Check the current sheet only if true. Otherwise check the entire schematic.
Definition at line 441 of file annotate.cpp.
References ANNOTATE_ALL, ANNOTATE_CURRENT_SHEET, ANNOTATE_SELECTION, SCH_SHEET_PATH::AppendSymbol(), SCH_REFERENCE_LIST::CheckAnnotation(), SCH_REFERENCE_LIST::GetCount(), GetCurrentSheet(), getInferredSymbols(), SCHEMATIC::GetSheets(), SCH_SCREEN::GetSheets(), SCH_SHEET_LIST::GetSheetsWithinPath(), SCH_SHEET_PATH::GetSymbols(), SCH_SHEET_LIST::GetSymbols(), TOOL_MANAGER::GetTool(), SCH_SHEET_PATH::LastScreen(), TOOLS_HOLDER::m_toolManager, SCH_SHEET_PATH::push_back(), EE_SELECTION_TOOL::RequestSelection(), SCH_SHEET_T, and Schematic().
Referenced by AnnotateSymbols(), DIALOG_ERC::OnRunERCClick(), ReadyToNetlist(), and DIALOG_ERC::UpdateAnnotationWarning().
◆ CheckForAutoSaveFile()
|
overridevirtual |
This overloaded version checks if the auto save master file "#auto_saved_files#" exists and recovers all of the schematic files listed in it.
- Parameters
-
aFileName is the project auto save master file name.
Reimplemented from EDA_BASE_FRAME.
Definition at line 1395 of file eeschema/files-io.cpp.
References _, BackupFileSuffix, EDA_BASE_FRAME::GetAutoSaveFilePrefix(), IsGUI(), Pgm(), and traceAutoSave.
Referenced by OpenProjectFiles().
◆ checkForNoFullyDefinedLibIds()
|
private |
Verify that the symbol library links aSheet and all of its child sheets have been remapped to the symbol library table.
- Parameters
-
aSheet is the SCH_SHEET object to test.
- Returns
- true if aSheet and its child sheets have not been remapped.
Definition at line 75 of file sheet.cpp.
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
-
aSheet is the SCH_SHEET object to test. aHierarchy is the SCH_SHEET_PATH where aSheet is going to reside.
- Returns
- true if aSheet will cause a recursion error in aHierarchy.
Definition at line 47 of file sheet.cpp.
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()
|
inline |
Clear (removes) specified flags that not needed for next execution of external generator of the netlist or bom.
- Parameters
-
aFlags is the wxEXEC_* flags, see wxExecute documentation.
Definition at line 751 of file sch_edit_frame.h.
References m_exec_flags.
◆ ClearFileHistory()
|
inherited |
Removes all files from the file history.
- Parameters
-
aFileHistory The FILE_HISTORY in use. If null, the main application file history is used
Definition at line 969 of file eda_base_frame.cpp.
References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().
Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), OnClearFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().
◆ ClearFindReplaceStatus()
| void SCH_EDIT_FRAME::ClearFindReplaceStatus | ( | ) |
Definition at line 1066 of file sch_edit_frame.cpp.
References WX_INFOBAR::Dismiss(), and EDA_BASE_FRAME::m_infoBar.
Referenced by SCH_FIND_REPLACE_TOOL::FindNext().
◆ ClearMsgPanel()
|
virtualinherited |
Clear all messages from the message panel.
Reimplemented in SYMBOL_EDIT_FRAME.
Definition at line 744 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and GERBVIEW_FRAME::UpdateTitleAndInfo().
◆ ClearUndoORRedoList()
|
overridevirtual |
Free the undo or redo list from aList element.
- Wrappers are deleted.
- data pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED)
- Parameters
-
whichList is the UNDO_REDO_CONTAINER to clear aItemCount is 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 404 of file schematic_undo_redo.cpp.
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()
|
virtualinherited |
Clear the undo and redo list using ClearUndoORRedoList()
Picked items are deleted by ClearUndoORRedoList() according to their status.
Definition at line 1297 of file eda_base_frame.cpp.
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(), PCB_EDIT_FRAME::ImportSpecctraSession(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().
◆ commonInit()
|
privateinherited |
Collect common initialization functions used in all CTORs.
Definition at line 117 of file eda_base_frame.cpp.
References DEFAULT_MAX_UNDO_ITEMS, defaultSize(), PATHS::GetDefaultUserProjectsPath(), ID_AUTO_SAVE_TIMER, minSize(), EDA_BASE_FRAME::onAutoSaveTimer(), Pgm(), and EDA_BASE_FRAME::windowClosing().
Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().
◆ CommonSettingsChanged()
|
overridevirtual |
Called after the preferences dialog is run.
Reimplemented from SCH_BASE_FRAME.
Definition at line 1531 of file sch_edit_frame.cpp.
References TEMPLATES::AddTemplateFieldNames(), SCH_BASE_FRAME::CommonSettingsChanged(), EESCHEMA_SETTINGS::APPEARANCE::default_font, TEMPLATES::DeleteAllFieldNameTemplates(), EESCHEMA_SETTINGS::DRAWING::field_names, EDA_DRAW_PANEL_GAL::ForceRefresh(), SCH_BASE_FRAME::GetCanvas(), GetCurrentSheet(), EDA_DRAW_FRAME::GetGalDisplayOptions(), SCH_SCREEN::GetLibSymbols(), SCH_BASE_FRAME::GetRenderSettings(), GetSchematicJunctionSize(), SCH_DRAW_PANEL::GetView(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), LAYER_ERC_ERR, LAYER_ERC_EXCLUSION, LAYER_ERC_WARN, EESCHEMA_SETTINGS::m_Appearance, EESCHEMA_SETTINGS::m_Drawing, SCHEMATIC_SETTINGS::m_IntersheetRefsShow, SCHEMATIC_SETTINGS::m_JunctionSize, SCHEMATIC_SETTINGS::m_TemplateFieldNames, APP_SETTINGS_BASE::m_Window, Pgm(), KIGFX::GAL_DISPLAY_OPTIONS::ReadWindowSettings(), EDA_DRAW_FRAME::RecreateToolbars(), Schematic(), KIGFX::RENDER_SETTINGS::SetDefaultFont(), KIGFX::VIEW::SetLayerVisible(), SCHEMATIC::Settings(), EESCHEMA_SETTINGS::APPEARANCE::show_erc_errors, EESCHEMA_SETTINGS::APPEARANCE::show_erc_exclusions, EESCHEMA_SETTINGS::APPEARANCE::show_erc_warnings, and ShowAllIntersheetRefs().
◆ config()
|
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 809 of file eda_base_frame.cpp.
References Kiface(), and KIFACE_BASE::KifaceSettings().
Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), SIM_PLOT_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetRotationAngle(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_BASE_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), CVPCB_MAINFRAME::setupTools(), setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BM2CMP_FRAME::~BM2CMP_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 350 of file eda_base_frame.h.
References EDA_BASE_FRAME::m_configName.
◆ ConvertPart()
| void SCH_EDIT_FRAME::ConvertPart | ( | SCH_SYMBOL * | aSymbol | ) |
Definition at line 278 of file picksymbol.cpp.
References _, EE_ACTIONS::addItemToSel, EDA_ITEM::ClearFlags(), DisplayError(), SCH_SYMBOL::GetConvert(), EDA_ITEM::GetFlags(), SCH_SYMBOL::GetLibSymbolRef(), EDA_ITEM::IsSelected(), TOOLS_HOLDER::m_toolManager, OnModify(), TOOL_MANAGER::RunAction(), SCH_SYMBOL::SetConvert(), EDA_ITEM::SetFlags(), TestDanglingEnds(), and UpdateItem().
Referenced by SCH_EDIT_TOOL::ConvertDeMorgan().
◆ CreateArchiveLibrary()
| bool SCH_EDIT_FRAME::CreateArchiveLibrary | ( | const wxString & | aFileName | ) |
Create a library aFileName that contains all symbols used in the current schematic.
- Parameters
-
aFileName The full path and file name of the archive library.
- Returns
- True if aFileName was written successfully.
Definition at line 65 of file libarch.cpp.
References _, DisplayErrorMessage(), LIB_SYMBOL::Flatten(), SCH_SCREENS::GetFirst(), SCH_SYMBOL::GetLibId(), SCH_BASE_FRAME::GetLibSymbol(), SCH_SCREENS::GetNext(), LIB_ID::GetUniStringLibId(), LIB_ID::GetUniStringLibItemName(), LT_EESCHEMA, SCH_SYMBOL_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 symbols used in the current schematic.
- Parameters
-
aUseCurrentSheetFilename set 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.
References CreateArchiveLibrary(), SCH_SCREEN::GetFileName(), GetScreen(), LegacySymbolLibFileExtension, SCHEMATIC::RootScreen(), Schematic(), and SCH_SCREENS::UpdateSymbolLinks().
◆ createCanvas()
|
inherited |
Definition at line 338 of file sch_base_frame.cpp.
References SCH_BASE_FRAME::ActivateGalCanvas(), 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()
|
inherited |
Definition at line 834 of file eda_base_frame.cpp.
References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.
Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().
◆ CreateScreens()
| void SCH_EDIT_FRAME::CreateScreens | ( | ) |
Definition at line 657 of file sch_edit_frame.cpp.
References GetScreen(), SCH_SCREEN::GetUuid(), m_schematic, EDA_ITEM::m_Uuid, KIWAY_HOLDER::Prj(), SCH_SHEET_PATH::push_back(), SCHEMATIC::Reset(), SCHEMATIC::Root(), SCHEMATIC::RootScreen(), Schematic(), SCH_SCREEN::SetFileName(), SCH_SHEET_PATH::SetPageNumber(), BASE_SCREEN::SetPageNumber(), SCHEMATIC::SetProject(), SCHEMATIC::SetRoot(), SetScreen(), and SCH_SHEET::SetScreen().
Referenced by importFile(), and OpenProjectFiles().
◆ CreateServer()
|
inherited |
Definition at line 43 of file eda_dde.cpp.
References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and KIWAY_PLAYER::m_socketServer.
Referenced by SaveFileAs().
◆ CurrentToolName()
|
inherited |
Definition at line 110 of file tools_holder.cpp.
References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.
Referenced by TOOLS_HOLDER::ShowChangedLanguage().
◆ DefaultExecFlags()
|
inline |
Reset the execution flags to defaults for external netlist and bom generators.
Definition at line 736 of file sch_edit_frame.h.
References m_exec_flags.
Referenced by WriteNetListFile().
◆ DeleteAnnotation()
| void SCH_EDIT_FRAME::DeleteAnnotation | ( | ANNOTATE_SCOPE_T | aAnnotateScope, |
| bool | aRecursive, | ||
| bool * | appendUndo | ||
| ) |
Clear the current symbol annotation.
- Parameters
-
aCurrentSheetOnly Where to clear the annotation. See ANNOTATE_SCOPE_T appendUndo true to add the action to the previous undo list
Definition at line 60 of file annotate.cpp.
References ANNOTATE_ALL, ANNOTATE_CURRENT_SHEET, ANNOTATE_SELECTION, CHANGED, SCH_SYMBOL::ClearAnnotation(), DIALOG_ERC_WINDOW_NAME, SCH_BASE_FRAME::GetCanvas(), GetCurrentSheet(), GetScreen(), SCHEMATIC::GetSheets(), SCH_SCREEN::GetSheets(), SCH_SHEET_LIST::GetSheetsWithinPath(), TOOL_MANAGER::GetTool(), SCH_SHEET_PATH::LastScreen(), TOOLS_HOLDER::m_toolManager, OnModify(), SCH_SHEET_PATH::push_back(), EDA_DRAW_PANEL_GAL::Refresh(), EE_SELECTION_TOOL::RequestSelection(), SaveCopyInUndoList(), SCH_SHEET_T, SCH_SYMBOL_T, Schematic(), SCH_BASE_FRAME::SyncView(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and UpdateNetHighlightStatus().
Referenced by 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
-
aItem The junction to delete aAppend True 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 341 of file bus-wire-junction.cpp.
References DELETED, alg::for_all_pairs(), EDA_ITEM::GetEditFlags(), SCH_LINE::GetEndPoint(), EDA_ITEM::GetPosition(), GetScreen(), SCH_LINE::GetStartPoint(), TOOL_MANAGER::GetTool(), SCH_LINE::IsEndPoint(), SCH_LINE::IsType(), SCH_SCREEN::Items(), TOOLS_HOLDER::m_toolManager, SCH_LINE::MergeOverlap(), EE_RTREE::Overlapping(), PICKED_ITEMS_LIST::PushItem(), SCH_BASE_FRAME::RemoveFromScreen(), SCH_LINE_T, and STRUCT_DELETED.
Referenced by SCH_EDIT_TOOL::DoDelete().
◆ Destroy()
|
overrideinherited |
Our version of Destroy() which is virtual from wxWidgets.
Definition at line 170 of file kiway_player.cpp.
Referenced by DISPLAY_FOOTPRINTS_FRAME::doCloseWindow(), doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SYMBOL_EDIT_FRAME::doCloseWindow(), SYMBOL_VIEWER_FRAME::doCloseWindow(), GERBVIEW_FRAME::doCloseWindow(), PL_EDITOR_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), EDA_3D_VIEWER_FRAME::OnCloseWindow(), BM2CMP_FRAME::OnExit(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().
◆ DismissModal()
|
inherited |
Definition at line 182 of file kiway_player.cpp.
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().
◆ DisplayConstraintsMsg()
|
inherited |
Definition at line 602 of file eda_draw_frame.cpp.
Referenced by EDIT_TOOL::doMoveSelection(), and DRAWING_TOOL::UpdateStatusBar().
◆ DisplayCurrentSheet()
| void SCH_EDIT_FRAME::DisplayCurrentSheet | ( | ) |
Draw the current sheet on the display.
Definition at line 1804 of file sch_edit_frame.cpp.
References SELECTION_TOOL::BrightenItem(), ACTIONS::cancelInteractive, EE_ACTIONS::clearSelection, dummy, SCH_BASE_FRAME::GetCanvas(), GetCurrentSheet(), GetScreen(), TOOL_MANAGER::GetTool(), SCH_DRAW_PANEL::GetView(), HardRedraw(), initScreenZoom(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), EDA_DRAW_FRAME::m_findReplaceData, m_findReplaceDialog, m_hierarchy, TOOLS_HOLDER::m_toolManager, SCH_SCREEN::m_zoomInitialized, SCH_BASE_FRAME::RedrawScreen(), TOOL_MANAGER::RunAction(), KIGFX::SCH_VIEW::SetScale(), SetScreen(), SetSheetNumberAndCount(), SELECTION_TOOL::UnbrightenItem(), SCH_SHEET_PATH::UpdateAllScreenReferences(), HIERARCHY_PANE::UpdateHierarchySelection(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and updateTitle().
Referenced by SCH_NAVIGATE_TOOL::Back(), SCH_NAVIGATE_TOOL::changeSheet(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_NAVIGATE_TOOL::Forward(), DIALOG_ERC::OnERCItemSelected(), OnPageSettingsChange(), PutDataInPreviousState(), SCH_EDITOR_CONTROL::Revert(), and EE_SELECTION_TOOL::SyncSelection().
◆ DisplayGridMsg()
|
virtualinherited |
Display current grid size in the status bar.
Reimplemented in GERBVIEW_FRAME, PCB_BASE_FRAME, and PL_EDITOR_FRAME.
Definition at line 608 of file eda_draw_frame.cpp.
References EDA_DRAW_FRAME::GetCanvas(), and UNITS_PROVIDER::MessageTextFromValue().
Referenced by SCH_BASE_FRAME::UpdateStatusBar().
◆ DisplayToolMsg()
|
overridevirtualinherited |
Reimplemented from TOOLS_HOLDER.
Definition at line 596 of file eda_draw_frame.cpp.
Referenced by EDIT_TOOL::Duplicate(), and PCB_CONTROL::Paste().
◆ DisplayUnitsMsg()
|
inherited |
Display current unit pane in the status bar.
Definition at line 618 of file eda_draw_frame.cpp.
References _, UNITS_PROVIDER::GetUserUnits(), INCHES, MILLIMETRES, and MILS.
Referenced by EDA_DRAW_FRAME::UpdateGridSelectBox(), SCH_BASE_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().
◆ 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 1129 of file eeschema/files-io.cpp.
References EDA_BASE_FRAME::GetAutoSaveFilePrefix(), SCH_SCREENS::GetCount(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), NULL_REPORTER::GetInstance(), SCH_SCREENS::GetScreen(), EDA_BASE_FRAME::GetSettingsManager(), SCH_SCREENS::GetSheet(), BASE_SCREEN::IsContentModified(), IsContentModified(), EDA_BASE_FRAME::IsWritable(), Kiface(), EDA_BASE_FRAME::m_autoSavePending, EDA_BASE_FRAME::m_autoSaveRequired, KIWAY_HOLDER::Prj(), SCHEMATIC::Root(), saveSchematicFile(), Schematic(), BASE_SCREEN::SetContentModified(), SETTINGS_MANAGER::TriggerBackupIfNeeded(), and updateAutoSaveFile().
◆ doCloseWindow()
|
overrideprivatevirtual |
Reimplemented from EDA_BASE_FRAME.
Definition at line 809 of file sch_edit_frame.cpp.
References PROJECT::AbsolutePath(), SCH_SHEET_PATH::clear(), SCH_SCREEN::Clear(), SCH_SHEET_LIST::ClearModifyStatus(), KIWAY_PLAYER::Destroy(), FRAME_SIMULATOR, getAutoSaveFileName(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), GetCurrentSheet(), DIALOG_SCH_FIND::GetFindEntries(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), PROJECT::GetProjectFile(), PROJECT::GetProjectFullName(), DIALOG_SCH_FIND::GetReplaceEntries(), SCHEMATIC::GetSheets(), KIWAY_HOLDER::Kiway(), EDA_BASE_FRAME::m_auimgr, m_findReplaceDialog, EDA_DRAW_FRAME::m_findStringHistoryList, SCHEMATIC_SETTINGS::m_NgspiceSimulatorSettings, EDA_DRAW_FRAME::m_replaceStringHistoryList, PROJECT_FILE::m_SchematicSettings, TOOLS_HOLDER::m_toolManager, KIWAY_HOLDER::Prj(), RecordERCExclusions(), SCHEMATIC::Reset(), SCHEMATIC::RootScreen(), SaveProjectSettings(), Schematic(), SchematicHierarchyPaneName(), SetScreen(), TOOL_MANAGER::ShutdownAllTools(), and EDA_BASE_FRAME::UpdateFileHistory().
◆ doReCreateMenuBar()
|
overrideprotectedvirtual |
Reimplemented from EDA_BASE_FRAME.
Definition at line 43 of file eeschema/menubar.cpp.
References _, ACTION_MENU::Add(), add_document, FILE_HISTORY::AddFilesToMenu(), AddMenuLanguageList(), ACTION_MENU::AddQuitOrClose(), EDA_BASE_FRAME::AddStandardHelpMenu(), EE_ACTIONS::annotate, EE_ACTIONS::assignFootprints, EE_ACTIONS::changeSymbols, ACTION_MENU::CHECK, ACTION_MENU::Clone(), ACTIONS::configurePaths, ACTIONS::copy, ACTIONS::cut, ACTIONS::deleteTool, ACTIONS::doDelete, ACTIONS::doNew, EE_ACTIONS::drawArc, EE_ACTIONS::drawBus, EE_ACTIONS::drawCircle, EE_ACTIONS::drawLines, EE_ACTIONS::drawRectangle, EE_ACTIONS::drawSheet, EE_ACTIONS::drawSheetOnClipboard, EE_ACTIONS::drawTextBox, EE_ACTIONS::drawWire, EE_ACTIONS::editPageNumber, EE_ACTIONS::editSymbolFields, EE_ACTIONS::editSymbolLibraryLinks, EE_ACTIONS::editTextAndGraphics, ACTION_CONDITIONS::Enable(), ACTIONS::excludeMarker, export_file, EE_ACTIONS::exportNetlist, EE_ACTIONS::exportSymbolsToLibrary, EE_ACTIONS::exportSymbolsToNewLibrary, FILE_HISTORY::FileHistoryNotEmpty(), ACTIONS::find, ACTIONS::findAndReplace, EE_ACTIONS::generateBOM, ADVANCED_CFG::GetCfg(), EDA_BASE_FRAME::GetFileHistory(), TOOL_MANAGER::GetTool(), ACTIONS::gridProperties, ID_APPEND_PROJECT, ID_IMPORT_NON_KICAD_SCH, import, import_document, EE_ACTIONS::importFPAssignments, EE_ACTIONS::importSheetPin, ACTIONS::inchesUnits, Kiface(), TOOLS_HOLDER::m_toolManager, ACTIONS::millimetersUnits, ACTIONS::milsUnits, EE_ACTIONS::navigateBack, EE_ACTIONS::navigateForward, EE_ACTIONS::navigateNext, EE_ACTIONS::navigatePrevious, EE_ACTIONS::navigateUp, ACTIONS::nextMarker, ACTION_MENU::NORMAL, ACTIONS::open, ACTIONS::pageSettings, ACTIONS::paste, ACTIONS::pasteSpecial, EE_ACTIONS::placeBusWireEntry, EE_ACTIONS::placeClassLabel, EE_ACTIONS::placeGlobalLabel, EE_ACTIONS::placeHierLabel, EE_ACTIONS::placeImage, EE_ACTIONS::placeJunction, EE_ACTIONS::placeLabel, EE_ACTIONS::placeNoConnect, EE_ACTIONS::placePower, EE_ACTIONS::placeSchematicText, EE_ACTIONS::placeSymbol, ACTIONS::plot, preference, ACTIONS::prevMarker, ACTIONS::print, recent, ACTIONS::redo, EDA_BASE_FRAME::RegisterUIUpdateHandler(), EE_ACTIONS::remapSymbols, EE_ACTIONS::repairSchematic, EE_ACTIONS::rescueSymbols, ACTIONS::revert, EE_ACTIONS::runERC, EE_ACTIONS::runSimulation, ACTIONS::save, ACTIONS::saveAs, EE_ACTIONS::saveCurrSheetCopyAs, EE_ACTIONS::schematicSetup, ACTIONS::selectAll, ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), EE_ACTIONS::showHierarchy, EE_ACTIONS::showPcbNew, ACTIONS::showSymbolBrowser, ACTIONS::showSymbolEditor, ACTIONS::showSymbolLibTable, ACTIONS::toggleCursorStyle, EE_ACTIONS::toggleERCErrors, EE_ACTIONS::toggleERCExclusions, EE_ACTIONS::toggleERCWarnings, ACTIONS::toggleGrid, EE_ACTIONS::toggleHiddenFields, EE_ACTIONS::toggleHiddenPins, ACTIONS::undo, unit_mm, FILE_HISTORY::UpdateClearText(), ACTIONS::updatePcbFromSchematic, ACTIONS::updateSchematicFromPcb, EE_ACTIONS::updateSymbols, ACTIONS::zoomFitObjects, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.
◆ DoWithAcceptedFiles()
|
protectedvirtualinherited |
Execute action on accepted dropped file.
Called in OnDropFiles and should be populated with the action to execute in inherited classes.
Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.
Definition at line 1178 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_AcceptedFiles, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::RunAction().
Referenced by EDA_BASE_FRAME::OnDropFiles().
◆ 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 543 of file sheet.cpp.
References SCH_BASE_FRAME::eeconfig(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_BASE_FRAME::GetPageSizeIU(), SCH_BASE_FRAME::GetRenderSettings(), GetScreen(), GRForceBlackPen(), GRResetPenAndBrush(), image, EDA_IU_SCALE::IU_PER_MILS, LAYER_DRAWINGSHEET, LAYER_SCHEMATIC_DRAWINGSHEET, BASE_SCREEN::m_DrawOrg, BASE_SCREEN::m_StartVisu, PrintPage(), scale, schIUScale, KIGFX::RENDER_SETTINGS::SetDefaultFont(), KIGFX::RENDER_SETTINGS::SetLayerColor(), KIGFX::RENDER_SETTINGS::SetPrintDC(), VECTOR2< T >::x, and VECTOR2< T >::y.
Referenced by SCH_EDITOR_CONTROL::DrawSheetOnClipboard().
◆ EditSheetProperties()
| bool SCH_EDIT_FRAME::EditSheetProperties | ( | SCH_SHEET * | aSheet, |
| SCH_SHEET_PATH * | aHierarchy, | ||
| bool * | aClearAnnotationNewItems | ||
| ) |
Edit an existing sheet or add a new sheet to the schematic.
When aSheet is a new sheet:
- and the file name already exists in the schematic hierarchy, the screen associated with the sheet found in the hierarchy is associated with aSheet.
- and the file name already exists on the system, then aSheet is loaded with the existing file.
- and the file name does not exist in the schematic hierarchy or on the file system, then a new screen is created and associated with aSheet.
When aSheet is an existing sheet:
- and the file name already exists in the schematic hierarchy, the current associated screen is replace by the one found in the hierarchy.
- and the file name already exists on the system, the current associated screen file name is changed and the file is loaded.
- and the file name does not exist in the schematic hierarchy or on the file system, the current associated screen file name is changed and saved to disk.
Note: the screen is not refresh. The caller is responsible to do that
- Parameters
-
aSheet is the sheet to edit aHierarchy is the current hierarchy containing aSheet aClearAnnotationNewItems is 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 527 of file sheet.cpp.
Referenced by SCH_DRAWING_TOOLS::DrawSheet(), and SCH_EDIT_TOOL::Properties().
◆ eeconfig()
|
inherited |
Definition at line 131 of file sch_base_frame.cpp.
References EDA_BASE_FRAME::config().
Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), AllowCaseSensitiveFileNameClashes(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDITOR_CONTROL::ChangeLineMode(), EE_SELECTION_TOOL::CollectHits(), DIALOG_BOM::DIALOG_BOM(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), DrawCurrentSheetToClipboard(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::editFieldText(), ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), GetSchematicJunctionSize(), GetShowAllPins(), EE_SELECTION_TOOL::GuessSelectionCandidates(), DIALOG_BOM::installGeneratorsList(), KiwayMailIn(), SCH_EDITOR_CONDITIONS::lineModeFunc(), LoadSettings(), EE_SELECTION_TOOL::Main(), SCH_EDITOR_CONTROL::NextLineMode(), DIALOG_SHAPE_PROPERTIES::onBorderChecked(), DIALOG_TEXT_PROPERTIES::onBorderChecked(), DIALOG_PRINT_USING_PRINTER::OnOutputChoice(), OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_PRINTOUT::PrintPage(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), SaveSettings(), EE_SELECTION_TOOL::Selectable(), SelectUnit(), setupUIConditions(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), EE_SELECTION_TOOL::SyncSelection(), SCH_EDITOR_CONTROL::ToggleAnnotateAuto(), SCH_EDITOR_CONTROL::ToggleAnnotateRecursive(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), ToggleSchematicHierarchy(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), and DIALOG_BOM::~DIALOG_BOM().
◆ ensureWindowIsOnScreen()
|
protectedinherited |
Definition at line 659 of file eda_base_frame.cpp.
References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.
Referenced by EDA_BASE_FRAME::OnSize().
◆ EraseMsgBox()
|
inherited |
Definition at line 345 of file eda_draw_frame.cpp.
References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.
Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().
◆ ExecuteRemoteCommand()
|
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 symbol 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: