KiCad PCB EDA Suite
SCH_BASE_FRAME Class Referenceabstract

A shim class between EDA_DRAW_FRAME and several derived classes: LIB_EDIT_FRAME, LIB_VIEW_FRAME, and SCH_EDIT_FRAME, and it brings in a common way of handling the provided virtual functions for the derived classes. More...

#include <sch_base_frame.h>

Inheritance diagram for SCH_BASE_FRAME:
EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER LIB_EDIT_FRAME LIB_VIEW_FRAME SCH_EDIT_FRAME

Public Types

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

Public Member Functions

 SCH_BASE_FRAME (KIWAY *aKiway, wxWindow *aParent, FRAME_T aWindowType, const wxString &aTitle, const wxPoint &aPosition, const wxSize &aSize, long aStyle, const wxString &aFrameName)
 
virtual ~SCH_BASE_FRAME ()
 
void createCanvas ()
 
SCH_DRAW_PANELGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
SCH_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
EESCHEMA_SETTINGSeeconfig () const
 
LIBEDIT_SETTINGSlibeditconfig () const
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
KIGFX::SCH_RENDER_SETTINGSGetRenderSettings ()
 
SCHEMATIC_SETTINGSGetDefaults ()
 
virtual bool GetShowAllPins () const
 Allow some frames to show/hide hidden pins. More...
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPointGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
void UpdateStatusBar () override
 Update the status bar information. More...
 
COMPONENT_SELECTION SelectCompFromLibTree (const SCHLIB_FILTER *aFilter, std::vector< COMPONENT_SELECTION > &aHistoryList, bool aUseLibBrowser, int aUnit, int aConvert, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
 Function SelectComponentFromLib Calls the library viewer to select component to import into schematic. More...
 
LIB_PARTGetLibPart (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
 Load symbol from symbol library table. More...
 
LIB_PARTGetFlattenedLibPart (const LIB_ID &aLibId, bool aShowErrorMsg=false)
 
COMPONENT_SELECTION SelectComponentFromLibBrowser (wxTopLevelWindow *aParent, const SCHLIB_FILTER *aFilter, const LIB_ID &aPreselectedLibid, int aUnit, int aConvert)
 Function SelectComponentFromLibBrowser Calls the library viewer to select component to import into schematic. More...
 
virtual void RedrawScreen (const wxPoint &aCenterPoint, bool aWarpPointer)
 
virtual void CenterScreen (const wxPoint &aCenterPoint, bool aWarpPointer)
 
void HardRedraw () override
 Rebuild the GAL and redraws the screen. More...
 
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...
 
virtual void OnModify ()
 Must be called after a model change in order to set the "modify" flag and do other frame-specific processing. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
COLOR4D GetLayerColor (SCH_LAYER_ID aLayer)
 Helper to retrieve a layer color from the global color settings. More...
 
COLOR_SETTINGSGetColorSettings () override
 Returns a pointer to the active color theme settings. More...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
virtual ORIGIN_TRANSFORMSGetOriginTransforms ()
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
virtual wxString GetScreenDesc () const
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest(). More...
 
void EraseMsgBox ()
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
virtual void ReCreateHToolbar ()=0
 
virtual void ReCreateVToolbar ()=0
 
virtual void ReCreateOptToolbar ()=0
 
virtual void ReCreateAuxiliaryToolbar ()
 
bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
virtual COLOR4D GetGridColor ()
 
virtual void SetGridColor (COLOR4D aColor)
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid combobox. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom combobox. More...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the page layout with the frame and the basic inscriptions. More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
virtual void DisplayGridMsg ()
 Display current grid size in the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual EDA_ITEMGetItem (const KIID &aId)
 Fetch an item by KIID. More...
 
virtual void PrintPage (RENDER_SETTINGS *aSettings)
 Print the page pointed by current screen, set by the calling print function. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
virtual void ActivateGalCanvas ()
 Use to start up the GAL drawing canvas. More...
 
virtual void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Changes the current rendering backend. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 
virtual const BOX2I GetDocumentExtents () const
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of ckeck tools. More...
 
virtual bool OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handles command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
virtual void KiwayMailIn (KIWAY_EXPRESS &aEvent)
 Function KiwayMailIn receives KIWAY_EXPRESS messages from other players. More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual int GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions) override
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions)
 Register a UI update handler for the control with ID aID. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction) override
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (int aID)
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg)
 
void ShowInfoBarWarning (const wxString &aWarningMsg)
 
void ShowInfoBarMsg (const wxString &aMsg)
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
virtual void InstallPreferences (PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
 Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences dialog. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. 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_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
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 ShowChangedLanguage ()
 Redraw the menus and what not in current language. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
virtual bool IsContentModified ()
 Get if the contents of the frame have been modified since the last save. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual SELECTIONGetCurrentSelection ()
 Get the current selection from the canvas area. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

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

Protected Member Functions

bool saveSymbolLibTables (bool aGlobal, bool aProject)
 Saves Symbol Library Tables to disk. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void unitsChangeRefresh () override
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 Function language_change is an event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. More...
 
virtual bool canCloseWindow (wxCloseEvent &aCloseEvent)
 
virtual void doCloseWindow ()
 
virtual void setupUIConditions ()
 Setup the UI conditions for the various actions and their controls in this frame. More...
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

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

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Detailed Description

A shim class between EDA_DRAW_FRAME and several derived classes: LIB_EDIT_FRAME, LIB_VIEW_FRAME, and SCH_EDIT_FRAME, and it brings in a common way of handling the provided virtual functions for the derived classes.

The motivation here is to switch onto GetScreen() for the underlying data model.

Author
Dick Hollenbeck

Definition at line 90 of file sch_base_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

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

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

Definition at line 607 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ 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 at line 83 of file sch_base_frame.cpp.

85  :
86  EDA_DRAW_FRAME( aKiway, aParent, aWindowType, aTitle, aPosition, aSize, aStyle, aFrameName ),
87  m_base_frame_defaults( nullptr, "base_Frame_defaults" ),
89 {
90  createCanvas();
91 }
SCHEMATIC_SETTINGS m_base_frame_defaults
These are only used by libedit. Eeschema should be using the one inside the SCHEMATIC.
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
SCHEMATIC_SETTINGS * m_defaults

References createCanvas().

◆ ~SCH_BASE_FRAME()

SCH_BASE_FRAME::~SCH_BASE_FRAME ( )
virtual

Definition at line 94 of file sch_base_frame.cpp.

95 {
96 }

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )
virtualinherited

Use to start up the GAL drawing canvas.

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

Definition at line 635 of file eda_draw_frame.cpp.

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

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

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

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 372 of file eda_base_frame.cpp.

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

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

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

Definition at line 430 of file eda_draw_frame.cpp.

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

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

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

◆ AddToScreen()

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

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

Definition at line 379 of file sch_base_frame.cpp.

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

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

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AddJunction(), SCH_EDIT_FRAME::BreakSegment(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::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(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 592 of file eda_draw_frame.cpp.

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

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

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

◆ canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
inlineprotectedvirtualinherited

◆ CenterScreen()

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

Definition at line 270 of file sch_base_frame.cpp.

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

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

Referenced by SCH_EDITOR_CONTROL::FindComponentAndItem().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 948 of file eda_base_frame.cpp.

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

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 846 of file eda_base_frame.cpp.

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

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

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

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 743 of file eda_base_frame.cpp.

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

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

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  aList,
int  aItemCount = -1 
)
inlinevirtualinherited

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

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

Notification event that some of the common (suite-wide) settings have changed.

Update hotkeys, preferences, etc.

Reimplemented from TOOLS_HOLDER.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 425 of file sch_base_frame.cpp.

426 {
427  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
428 
429  EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
430  m_colorSettings = Pgm().GetSettingsManager().GetColorSettings( cfg->m_ColorTheme );
431 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
COLOR_SETTINGS * m_colorSettings
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:174

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

Referenced by LIB_VIEW_FRAME::CommonSettingsChanged(), LIB_EDIT_FRAME::CommonSettingsChanged(), and SCH_EDIT_FRAME::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 642 of file eda_base_frame.cpp.

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

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

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

◆ ConfigBaseName()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 423 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ createCanvas()

void SCH_BASE_FRAME::createCanvas ( )

Definition at line 301 of file sch_base_frame.cpp.

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

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

Referenced by SCH_BASE_FRAME().

◆ CreateServer()

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

Definition at line 49 of file eda_dde.cpp.

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

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

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

◆ CurrentToolName()

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

Definition at line 99 of file tools_holder.cpp.

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

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

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

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

Definition at line 161 of file kiway_player.cpp.

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

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

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

◆ DisplayGridMsg()

void EDA_DRAW_FRAME::DisplayGridMsg ( )
virtualinherited

Display current grid size in the status bar.

Reimplemented in PCB_BASE_FRAME, GERBVIEW_FRAME, and PL_EDITOR_FRAME.

Definition at line 474 of file eda_draw_frame.cpp.

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

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

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 465 of file eda_draw_frame.cpp.

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

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 493 of file eda_draw_frame.cpp.

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

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

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

This should be overridden by the derived class to handle the auto save feature.

Returns
true if the auto save was successful otherwise false.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 263 of file eda_base_frame.cpp.

264 {
265  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
266 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

◆ eeconfig()

EESCHEMA_SETTINGS * SCH_BASE_FRAME::eeconfig ( ) const

Definition at line 105 of file sch_base_frame.cpp.

106 {
107  return dynamic_cast<EESCHEMA_SETTINGS*>( config() );
108 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

References EDA_BASE_FRAME::config().

Referenced by LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AllowCaseSensitiveFileNameClashes(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::editFieldText(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDIT_FRAME::GetShowAllPins(), EE_SELECTION_TOOL::GuessSelectionCandidates(), SCH_EDIT_FRAME::LoadSettings(), SCH_EDIT_TOOL::Mirror(), DIALOG_PRINT_USING_PRINTER::OnMonochromeChecked(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_PRINTOUT::PrintPage(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), SCH_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_FRAME::setupUIConditions(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_EDITOR_CONTROL::ToggleForceHV(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PANEL_EESCHEMA_SETTINGS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), and DIALOG_PRINT_USING_PRINTER::TransferDataToWindow().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 222 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

virtual void EDA_DRAW_FRAME::ExecuteRemoteCommand ( const char *  cmdline)
inlinevirtualinherited

Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest().

this is a virtual function becuse the actual commands depends on the application. the basic function do nothing

Parameters
cmdline= received command from socket

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 244 of file eda_draw_frame.h.

244 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint aPos)
inherited

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

Parameters
aPosis the point to go to.

Definition at line 767 of file eda_draw_frame.cpp.

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

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

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 573 of file eda_base_frame.h.

573 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

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

◆ GetAutoSaveFilePrefix()

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

Definition at line 195 of file eda_base_frame.h.

196  {
197  return wxT( "_autosave-" );
198  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 334 of file eda_base_frame.h.

334 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetBackupSuffix()

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

Definition at line 187 of file eda_base_frame.h.

188  {
189  return wxT( "-bak" );
190  }

◆ GetCanvas()

SCH_DRAW_PANEL * SCH_BASE_FRAME::GetCanvas ( ) const
overridevirtual

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

Returns
Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 288 of file sch_base_frame.cpp.

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

References EDA_DRAW_FRAME::GetCanvas().

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

◆ GetColorSettings()

COLOR_SETTINGS * SCH_BASE_FRAME::GetColorSettings ( )
overridevirtual

Returns a pointer to the active color theme settings.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 434 of file sch_base_frame.cpp.

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

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

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

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

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 in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 504 of file eda_base_frame.h.

504 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )
inlinevirtualinherited

Get the current selection from the canvas area.

Returns
the current selection

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, SCH_EDIT_FRAME, LIB_EDIT_FRAME, LIB_VIEW_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 104 of file tools_holder.h.

105  {
106  return m_dummySelection;
107  }
SELECTION m_dummySelection
Definition: tools_holder.h:54

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ GetDefaults()

SCHEMATIC_SETTINGS& SCH_BASE_FRAME::GetDefaults ( )
inline

Definition at line 121 of file sch_base_frame.h.

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

References m_defaults.

◆ GetDocumentExtents()

const BOX2I EDA_DRAW_FRAME::GetDocumentExtents ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME, LIB_EDIT_FRAME, PL_EDITOR_FRAME, LIB_VIEW_FRAME, GERBVIEW_FRAME, PCB_BASE_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 737 of file eda_draw_frame.cpp.

738 {
739  return BOX2I();
740 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522

Referenced by COMMON_TOOLS::doZoomFit().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 128 of file tools_holder.h.

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

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragSelects()

bool TOOLS_HOLDER::GetDragSelects ( ) const
inlineinherited

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

Definition at line 134 of file tools_holder.h.

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

References TOOLS_HOLDER::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

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

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

Definition at line 703 of file eda_base_frame.cpp.

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

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

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::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 489 of file eda_base_frame.h.

490  {
491  return *m_fileHistory;
492  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

Definition at line 171 of file eda_draw_frame.h.

171 { return m_findStringHistoryList; }
wxArrayString m_findStringHistoryList

References EDA_DRAW_FRAME::m_findStringHistoryList.

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

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

Definition at line 170 of file eda_draw_frame.h.

170 { return *m_findReplaceData; }
wxFindReplaceData * m_findReplaceData

References EDA_DRAW_FRAME::m_findReplaceData.

Referenced by DIALOG_FIND::search().

◆ GetFlattenedLibPart()

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

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const wxPoint& SCH_BASE_FRAME::GetGridOrigin ( ) const
inlineoverridevirtual

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

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

Implements EDA_DRAW_FRAME.

Definition at line 135 of file sch_base_frame.h.

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

◆ GetInfoBar()

◆ GetItem()

virtual EDA_ITEM* EDA_DRAW_FRAME::GetItem ( const KIID aId)
inlinevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 433 of file eda_draw_frame.h.

433 { return nullptr; }

Referenced by MARKER_PCB::GetMsgPanelInfo(), and RC_TREE_MODEL::GetValue().

◆ GetLayerColor()

COLOR4D SCH_BASE_FRAME::GetLayerColor ( SCH_LAYER_ID  aLayer)

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

Definition at line 419 of file sch_base_frame.cpp.

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

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

◆ GetLibPart()

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

Load symbol from symbol library table.

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

Definition at line 212 of file sch_base_frame.cpp.

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

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

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

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 652 of file eda_base_frame.h.

652 { return m_UndoRedoCountMax; }

References EDA_BASE_FRAME::m_UndoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

Indicates that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are alergic to mouse warping.

Definition at line 140 of file tools_holder.h.

140 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:68

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), LIB_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().

◆ GetMruPath()

◆ GetNearestGridPosition()

wxPoint EDA_DRAW_FRAME::GetNearestGridPosition ( const wxPoint aPosition) const
inherited

Return the nearest aGridSize location to aPosition.

Parameters
aPositionThe position to check.
Returns
The nearst grid position.

Definition at line 723 of file eda_draw_frame.cpp.

724 {
725  const wxPoint& gridOrigin = GetGridOrigin();
726  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
727 
728  double xOffset = fmod( gridOrigin.x, gridSize.x );
729  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
730  double yOffset = fmod( gridOrigin.y, gridSize.y );
731  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
732 
733  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
734 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
const VECTOR2D & GetGridSize() const
Returns the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

Referenced by LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and SCH_DRAWING_TOOLS::sizeSheet().

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS& EDA_DRAW_FRAME::GetOriginTransforms ( )
inlinevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 209 of file eda_draw_frame.h.

210  { return m_OriginTransforms; }
ORIGIN_TRANSFORMS m_OriginTransforms
Default display origin transforms object.

References EDA_DRAW_FRAME::m_OriginTransforms.

Referenced by DRAWSEGMENT::GetMsgPanelInfo().

◆ GetPageSettings()

const PAGE_INFO & SCH_BASE_FRAME::GetPageSettings ( ) const
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 123 of file sch_base_frame.cpp.

124 {
125  return GetScreen()->GetPageSettings();
126 }
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:180

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

Referenced by DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF().

◆ GetPageSizeIU()

const wxSize SCH_BASE_FRAME::GetPageSizeIU ( ) const
overridevirtual

Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view.

Implements EDA_DRAW_FRAME.

Definition at line 129 of file sch_base_frame.cpp.

130 {
131  // GetSizeIU is compile time dependent:
132  return GetScreen()->GetPageSettings().GetSizeIU();
133 }
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:180

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

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetRenderSettings()

KIGFX::SCH_RENDER_SETTINGS * SCH_BASE_FRAME::GetRenderSettings ( )

Definition at line 294 of file sch_base_frame.cpp.

295 {
296  KIGFX::PAINTER* painter = GetCanvas()->GetView()->GetPainter();
297  return static_cast<KIGFX::SCH_RENDER_SETTINGS*>( painter->GetSettings() );
298 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
PAINTER contains all the knowledge about how to draw graphical object onto any particular output devi...
Definition: painter.h:58
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.

References GetCanvas(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), and SCH_DRAW_PANEL::GetView().

Referenced by DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_EDIT_FRAME::LoadProjectSettings(), LIB_VIEW_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), LIB_EDIT_FRAME::LoadSettings(), DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), DIALOG_PLOT_SCHEMATIC::PlotSchematic(), SCH_PRINTOUT::PrintPage(), LIB_EDIT_FRAME::RebuildView(), LIB_VIEW_FRAME::SaveSettings(), LIB_EDIT_FRAME::SaveSettings(), LIB_VIEW_FRAME::setupUIConditions(), LIB_EDIT_FRAME::setupUIConditions(), LIB_CONTROL::ShowElectricalTypes(), LIB_EDIT_FRAME::SVG_PlotComponent(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_LIBEDIT_SETTINGS::TransferDataFromWindow(), PANEL_LIBEDIT_SETTINGS::TransferDataToWindow(), and LIB_VIEW_FRAME::updatePreviewSymbol().

◆ GetScreen()

SCH_SCREEN * SCH_BASE_FRAME::GetScreen ( ) const
overridevirtual

Return a pointer to a BASE_SCREEN or one of its derivatives.

It is overloaded by derived classes to return SCH_SCREEN or PCB_SCREEN.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 99 of file sch_base_frame.cpp.

100 {
102 }
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References EDA_DRAW_FRAME::GetScreen().

Referenced by AddToScreen(), LIB_EDIT_TOOL::DeleteItemCursor(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), KIGFX::SCH_VIEW::GetItemsExtents(), EE_SELECTION_TOOL::GetNode(), GetPageSettings(), GetPageSizeIU(), GetTitleBlock(), LIB_EDIT_FRAME::IsContentModified(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_EDIT_FRAME::LoadComponentAndSelectLib(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), EDIT_POINTS_FACTORY::Make(), LIB_EDIT_FRAME::OnModify(), LIB_EDIT_FRAME::PrintPage(), EE_SELECTION_TOOL::RebuildSelection(), RemoveFromScreen(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::SelectConnection(), EE_SELECTION_TOOL::SelectPoint(), SetPageSettings(), SetTitleBlock(), LIB_VIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), LIB_EDIT_FRAME::setupUIConditions(), LIB_EDIT_FRAME::storeCurrentPart(), LIB_EDIT_FRAME::SVG_PlotComponent(), UpdateStatusBar(), LIB_CONTROL::UpdateSymbolInSchematic(), and LIB_EDIT_FRAME::~LIB_EDIT_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 861 of file eda_draw_frame.cpp.

862 {
863  // Virtual function. Base class implementation returns an empty string.
864  return wxEmptyString;
865 }

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), and EDA_DRAW_FRAME::PrintWorkSheet().

◆ GetSettingsManager()

◆ GetSeverity()

virtual int EDA_BASE_FRAME::GetSeverity ( int  aErrorCode) const
inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 263 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetShowAllPins()

virtual bool SCH_BASE_FRAME::GetShowAllPins ( ) const
inlinevirtual

Allow some frames to show/hide hidden pins.

The default impl shows all pins.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 129 of file sch_base_frame.h.

129 { return true; }

Referenced by EE_SELECTION_TOOL::Selectable().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inlineinherited

◆ GetTitleBlock()

const TITLE_BLOCK & SCH_BASE_FRAME::GetTitleBlock ( ) const
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 136 of file sch_base_frame.cpp.

137 {
138  wxASSERT( GetScreen() );
139  return GetScreen()->GetTitleBlock();
140 }
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:190

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

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG().

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 465 of file eda_draw_frame.h.

465 { return GetCanvas(); }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 78 of file tools_holder.h.

78 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50

References TOOLS_HOLDER::m_toolManager.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), LIB_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 247 of file eda_base_frame.h.

248  {
249  return m_userUnits;
250  }
EDA_UNITS m_userUnits

References EDA_BASE_FRAME::m_userUnits.

Referenced by PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), GERBER_FILE_IMAGE::DisplayImageInfo(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), MARKER_PCB::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), TEXTE_PCB::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), GetUserUnits(), RC_TREE_MODEL::GetValue(), GRID_MENU::GRID_MENU(), SELECTION_TOOL::highlightInternal(), PCB_INSPECTION_TOOL::InspectClearance(), GERBVIEW_FRAME::Liste_D_Codes(), PCB_VIEWER_TOOLS::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_SELECT_NET_FROM_LIST::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUpdateThicknessValue(), PANEL_PREV_3D::PANEL_PREV_3D(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_SETTINGS::TransferDataToWindow(), PANEL_EDIT_OPTIONS::TransferDataToWindow(), PANEL_SETUP_FEATURE_CONSTRAINTS::TransferDataToWindow(), SELECTION_TOOL::unhighlightInternal(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GRID_MENU::update(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), EDA_DRAW_FRAME::UpdateGridSelectBox(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateTrackWidthSelectBox(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and PANEL_SETUP_TRACKS_AND_VIAS::validateData().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Returns a pointer to the window settings for this frame.

By default, points to aCfg->m_Window for top-level frames.

Parameters
aCfgis this frame's config object

Reimplemented in SIM_PLOT_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, LIB_VIEW_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 636 of file eda_base_frame.cpp.

637 {
638  return &aCfg->m_Window;
639 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:171

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::SaveSettings(), and EDA_BASE_FRAME::SaveSettings().

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns
the undecorated window size

Definition at line 980 of file eda_base_frame.cpp.

981 {
982 #ifdef __WXGTK__
983  // GTK includes the window decorations in the normal GetSize call,
984  // so we have to use a GTK-specific sizing call that returns the
985  // non-decorated window size.
986  int width = 0;
987  int height = 0;
988  GTKDoGetSize( &width, &height );
989 
990  wxSize winSize( width, height );
991 #else
992  wxSize winSize = GetSize();
993 #endif
994 
995  return winSize;
996 }

Referenced by EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 528 of file eda_draw_frame.cpp.

529 {
530  // returns a human readable value which can be displayed as zoom
531  // level indicator in dialogs.
532  double zoom = m_canvas->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
533  return wxString::Format( wxT( "Z %.2f" ), zoom );
534 }
#define ZOOM_COEFF
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
double GetZoomFactor() const
Get the zoom factor.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201

References Format(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::m_canvas, and ZOOM_COEFF.

Referenced by EDA_DRAW_FRAME::UpdateStatusBar().

◆ HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent ( wxUpdateUIEvent &  aEvent,
EDA_BASE_FRAME aFrame,
ACTION_CONDITIONS  aCond 
)
staticinherited

Handles events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters
aEventis the wxUpdateUIEvent to be processed.
aFrameis the frame to get the selection from
aCondare the UI SELECTION_CONDITIONS used

Definition at line 311 of file eda_base_frame.cpp.

313 {
314  bool checkRes = false;
315  bool enableRes = true;
316  bool showRes = true;
317  SELECTION& selection = aFrame->GetCurrentSelection();
318 
319  try
320  {
321  checkRes = aCond.checkCondition( selection );
322  enableRes = aCond.enableCondition( selection );
323  showRes = aCond.showCondition( selection );
324  }
325  catch( std::exception& )
326  {
327  // Something broke with the conditions, just skip the event.
328  aEvent.Skip();
329  return;
330  }
331 
332  aEvent.Enable( enableRes );
333  aEvent.Show( showRes );
334 
335  bool canCheck = true;
336 
337  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
338  // see if they can be and can't just universally apply a check in this event.
339  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
340  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
341 
342  if( canCheck )
343  aEvent.Check( checkRes );
344 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:104

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void SCH_BASE_FRAME::HardRedraw ( )
overridevirtual

Rebuild the GAL and redraws the screen.

Call when something went wrong.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 281 of file sch_base_frame.cpp.

282 {
284  GetCanvas()->ForceRefresh();
285 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
void UpdateAllItems(int aUpdateFlags)
Updates all items in the view according to the given flags.
Definition: view.cpp:1435
Item needs to be redrawn.
Definition: view_item.h:63
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.

References KIGFX::ALL, EDA_DRAW_PANEL_GAL::ForceRefresh(), GetCanvas(), SCH_DRAW_PANEL::GetView(), and KIGFX::VIEW::UpdateAllItems().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 655 of file eda_base_frame.cpp.

656 {
657  return Kiface().GetHelpFileName();
658 }
const wxString & GetHelpFileName() const
Function GetHelpFileName returns just the basename portion of the current help file.
Definition: kiface_i.h:123
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile ( std::map< std::string, TOOL_ACTION * >  aActionMap,
const wxString &  aDefaultShortname 
)
inherited

Prompt the user for a hotkey file to read, and read it.

Parameters
aActionMap= current hotkey map (over which the imported hotkeys will be applied)
aDefaultShortname= a default short name (extension not needed) like eechema, kicad...

◆ InitExitKey()

void EDA_DRAW_FRAME::InitExitKey ( )
protectedinherited

Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window

Definition at line 456 of file eda_draw_frame.cpp.

457 {
458  wxAcceleratorEntry entries[1];
459  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
460  wxAcceleratorTable accel( 1, entries );
461  SetAcceleratorTable( accel );
462 }

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME().

◆ InstallPreferences()

virtual void EDA_BASE_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
inlinevirtualinherited

Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters
aParenta paged dialog into which the preference panels should be installed

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, GERBVIEW_FRAME, LIB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 369 of file eda_base_frame.h.

369 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 210 of file eda_base_frame.h.

210 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( )
virtualinherited

Get if the contents of the frame have been modified since the last save.

Returns
true if the contents of the frame have not been saved

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, CVPCB_MAINFRAME, LIB_EDIT_FRAME, PL_EDITOR_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 892 of file eda_base_frame.cpp.

893 {
894  // This function should be overridden in child classes
895  return false;
896 }

Referenced by EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION aAction) const
inherited

Definition at line 108 of file tools_holder.cpp.

109 {
110  if( m_toolStack.empty() )
111  return &aAction == &ACTIONS::selectionTool;
112  else
113  return m_toolStack.back() == aAction.GetName();
114 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:56
static TOOL_ACTION selectionTool
Definition: actions.h:149
const std::string & GetName() const
Returns name of the action.
Definition: tool_action.h:75

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by PCB_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), EDIT_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited

Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal().

IOW, it will return true if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 155 of file kiway_player.cpp.

156 {
157  return !m_modal_loop;
158 }
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:202

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridVisible()

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const
inlineoverridevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented from EDA_BASE_FRAME.

Definition at line 176 of file kiway_player.h.

176 { return m_modal; }

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_VIEW_FRAME::OnCloseWindow(), and KIWAY_PLAYER::ShowModal().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 336 of file eda_base_frame.h.

336 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), LIB_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), EDA_3D_VIEWER::CreateMenuBar(), LIB_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), MODULE::GetMsgPanelInfo(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), LIB_CONTROL::OnDeMorgan(), PCB_LAYER_WIDGET::OnLayerVisible(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_LAYER_WIDGET::OnRenderEnable(), PCBNEW_CONTROL::Paste(), LIB_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), and LIB_CONTROL::UnpinLibrary().

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName)
inherited

Checks if aFileName can be written.

The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.

Note
The file name path must be set or an assertion will be raised on debug builds and return false on release builds.
Parameters
aFileNameThe full path and/or file name of the file to test.
Returns
False if aFileName cannot be written.

Definition at line 802 of file eda_base_frame.cpp.

803 {
804  wxString msg;
805  wxFileName fn = aFileName;
806 
807  // Check for absence of a file path with a file name. Unfortunately KiCad
808  // uses paths relative to the current project path without the ./ part which
809  // confuses wxFileName. Making the file name path absolute may be less than
810  // elegant but it solves the problem.
811  if( fn.GetPath().IsEmpty() && fn.HasName() )
812  fn.MakeAbsolute();
813 
814  wxCHECK_MSG( fn.IsOk(), false,
815  wxT( "File name object is invalid. Bad programmer!" ) );
816  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
817  wxT( "File name object path <" ) + fn.GetFullPath() +
818  wxT( "> is not set. Bad programmer!" ) );
819 
820  if( fn.IsDir() && !fn.IsDirWritable() )
821  {
822  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
823  GetChars( fn.GetPath() ) );
824  }
825  else if( !fn.FileExists() && !fn.IsDirWritable() )
826  {
827  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
828  GetChars( fn.GetFullName() ), GetChars( fn.GetPath() ) );
829  }
830  else if( fn.FileExists() && !fn.IsFileWritable() )
831  {
832  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
833  GetChars( fn.GetFullPath() ) );
834  }
835 
836  if( !msg.IsEmpty() )
837  {
838  wxMessageBox( msg );
839  return false;
840  }
841 
842  return true;
843 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
#define _(s)
Definition: 3d_actions.cpp:33

References _, and GetChars().

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), LIB_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

177 {
178  // logging support
179  KiwayMailIn( aEvent ); // call the virtual, override in derived.
180 }
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

Merely override it in derived classes.

Reimplemented in LIB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PCB_EDIT_FRAME, SCH_EDIT_FRAME, and CVPCB_MAINFRAME.

Definition at line 70 of file kiway_player.cpp.

71 {
72  // override this in derived classes.
73 }

Referenced by KIWAY_PLAYER::kiway_express(), and KIWAY::ProcessEvent().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

Function language_change is an event handler called on a language menu selection.

Definition at line 183 of file kiway_player.cpp.

184 {
185  int id = event.GetId();
186 
187  // tell all the KIWAY_PLAYERs about the language change.
188  Kiway().SetLanguage( id );
189 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY void SetLanguage(int aLanguage)
Function SetLanguage changes the language and then calls ShowChangedLanguage() on all KIWAY_PLAYERs.
Definition: kiway.cpp:445

References KIWAY_HOLDER::Kiway(), and KIWAY::SetLanguage().

◆ libeditconfig()

LIBEDIT_SETTINGS * SCH_BASE_FRAME::libeditconfig ( ) const

Definition at line 111 of file sch_base_frame.cpp.

112 {
113  return dynamic_cast<LIBEDIT_SETTINGS*>( config() );
114 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

References EDA_BASE_FRAME::config().

◆ LibraryFileBrowser()

bool EDA_DRAW_FRAME::LibraryFileBrowser ( bool  doOpen,
wxFileName &  aFilename,
const wxString &  wildcard,
const wxString &  ext,
bool  isDirectory = false 
)
protectedinherited
Parameters
doOpenif true runs an Open Library browser, otherwise New Library
aFilenamefor New may contain a default name; in both cases return the chosen filename.
wildcarda wildcard to filter the displayed files
extthe library file extension
isDirectoryindicates the library files are directories
Returns
true for OK; false for Cancel.

Definition at line 867 of file eda_draw_frame.cpp.

870 {
871  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
872  aFilename.SetExt( ext );
873 
874  if( isDirectory && doOpen )
875  {
876  wxDirDialog dlg( this, prompt, Prj().GetProjectPath(),
877  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
878 
879  if( dlg.ShowModal() == wxID_CANCEL )
880  return false;
881 
882  aFilename = dlg.GetPath();
883  aFilename.SetExt( ext );
884  }
885  else
886  {
887  // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
888  if( aFilename.GetName().empty() )
889  aFilename.SetName( "Library" );
890 
891  wxString dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
892 
893  wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
894  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
895  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
896 
897  if( dlg.ShowModal() == wxID_CANCEL )
898  return false;
899 
900  aFilename = dlg.GetPath();
901  aFilename.SetExt( ext );
902  }
903 
904  return true;
905 }
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:124
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY bool IsNullProject() const
Checks if this project is a null project (i.e.
Definition: project.cpp:136
#define _(s)
Definition: 3d_actions.cpp:33

References _, PROJECT::GetProjectPath(), PROJECT::IsNullProject(), and KIWAY_HOLDER::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_EDIT_FRAME::AddLibraryFile(), and PCB_BASE_EDIT_FRAME::CreateNewLibrary().

◆ LoadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::LoadCanvasTypeSetting ( )
inherited

Returns the canvas type stored in the application settings.

Definition at line 651 of file eda_draw_frame.cpp.

652 {
653 #ifdef __WXMAC__
654  // Cairo renderer doesn't handle Retina displays so there's really only one game
655  // in town for Mac
657 #endif
658 
661 
662  if( cfg )
663  canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
664 
665  if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
666  || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
667  {
668  wxASSERT( false );
670  }
671 
672  // Legacy canvas no longer supported. Switch to Cairo, and on the first instantiation
673  // the user will be prompted to switch to OpenGL
674  if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
676 
677  return canvasType;
678 }
static constexpr GAL_TYPE GAL_FALLBACK
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
Sentinel, do not use as a parameter.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
GAL not used (the legacy wxDC engine is used)
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

References APP_SETTINGS_BASE::GRAPHICS::canvas_type, EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, Kiface(), KIFACE_I::KifaceSettings(), and APP_SETTINGS_BASE::m_Graphics.

Referenced by createCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), and GERBVIEW_FRAME::GERBVIEW_FRAME().

◆ LoadSettings()

void SCH_BASE_FRAME::LoadSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 325 of file eeschema_config.cpp.

326 {
327  wxCHECK_RET( aCfg, "Call to SCH_BASE_FRAME::SaveSettings with null settings" );
328 
330 
331  if( aCfg->m_Window.grid.sizes.empty() )
332  {
333  /*
334  * Do NOT add others values (mainly grid values in mm), because they can break the
335  * schematic: Because wires and pins are considered as connected when the are to the
336  * same coordinate we cannot mix coordinates in mils (internal units) and mm (that
337  * cannot exactly converted in mils in many cases). In fact schematic must only use
338  * 50 and 25 mils to place labels, wires and components others values are useful only
339  * for graphic items (mainly in library editor) so use integer values in mils only.
340  * The 100 mil grid is added to help conform to the KiCad Library Convention which
341  * states: "Using a 100mil grid, pin ends and origin must lie on grid nodes IEC-60617"
342  */
343  aCfg->m_Window.grid.sizes = { "100 mil",
344  "50 mil",
345  "25 mil",
346  "10 mil",
347  "5 mil",
348  "2 mil",
349  "1 mil" };
350  }
351 
352  if( aCfg->m_Window.zoom_factors.empty() )
353  {
354  aCfg->m_Window.zoom_factors = { 0.1,
355  0.15,
356  0.2,
357  0.3,
358  0.5,
359  0.7,
360  1.0,
361  1.5,
362  2.0,
363  3.0,
364  4.5,
365  6.5,
366  10.0,
367  15.0,
368  20.0,
369  30.0,
370  45.0,
371  65.0,
372  100.0,
373  150.0 };
374  }
375 
376  for( double& factor : aCfg->m_Window.zoom_factors )
377  factor = std::min( factor, MAX_ZOOM_FACTOR );
378 }
#define MAX_ZOOM_FACTOR
std::vector< double > zoom_factors
Definition: app_settings.h:86
std::vector< wxString > sizes
Definition: app_settings.h:52
GRID_SETTINGS grid
Definition: app_settings.h:89
WINDOW_SETTINGS m_Window
Definition: app_settings.h:171
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.

References WINDOW_SETTINGS::grid, EDA_DRAW_FRAME::LoadSettings(), APP_SETTINGS_BASE::m_Window, MAX_ZOOM_FACTOR, GRID_SETTINGS::sizes, and WINDOW_SETTINGS::zoom_factors.

Referenced by LIB_VIEW_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), and LIB_EDIT_FRAME::LoadSettings().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS aCfg)
inherited

Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 536 of file eda_base_frame.cpp.

537 {
538  LoadWindowState( aCfg->state );
539 
540  if( m_hasAutoSave )
541  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
542 
543  m_perspective = aCfg->perspective;
544  m_mruPath = aCfg->mru_path;
545 
546  TOOLS_HOLDER::CommonSettingsChanged( false, false );
547 }
wxString mru_path
Definition: app_settings.h:84
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
wxString m_mruPath
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
wxString perspective
Definition: app_settings.h:85
WINDOW_STATE state
Definition: app_settings.h:83
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.

References TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString &  aFileName)
inherited

Definition at line 421 of file eda_base_frame.cpp.

422 {
423  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
424  return;
425 
426  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
427 
428  if( state != nullptr )
429  {
430  LoadWindowState( state->window );
431  }
432 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
VTBL_ENTRY PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:147
void LoadWindowState(const wxString &aFileName)
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
struct WINDOW_STATE window
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)

References PROJECT_LOCAL_SETTINGS::GetFileState(), PROJECT::GetLocalSettings(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), EDA_BASE_FRAME::LoadWindowSettings(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE aState)
virtualinherited

Load frame state info from a configuration file.

Definition at line 435 of file eda_base_frame.cpp.

436 {
437  m_FramePos.x = aState.pos_x;
438  m_FramePos.y = aState.pos_y;
439  m_FrameSize.x = aState.size_x;
440  m_FrameSize.y = aState.size_y;
441 
442  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
444 
445  // Ensure minimum size is set if the stored config was zero-initialized
447  {
450 
451  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_FrameSize.x, m_FrameSize.y );
452  }
453 
454  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
455 
456  if( aState.display >= wxDisplay::GetCount() )
457  {
458  wxLogTrace( traceDisplayLocation, "Previous display not found" );
459 
460  // If it isn't attached, use the first display
461  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
462  const unsigned int index = 0;
463  wxDisplay display( index );
464  wxRect clientSize = display.GetGeometry();
465 
466  m_FramePos = wxDefaultPosition;
467 
468  // Ensure the window fits on the display, since the other one could have been larger
469  if( m_FrameSize.x > clientSize.width )
470  m_FrameSize.x = clientSize.width;
471 
472  if( m_FrameSize.y > clientSize.height )
473  m_FrameSize.y = clientSize.height;
474  }
475  else
476  {
477  wxPoint upperRight( m_FramePos.x + m_FrameSize.x, m_FramePos.y );
478  wxPoint upperLeft( m_FramePos.x, m_FramePos.y );
479 
480  wxDisplay display( aState.display );
481  wxRect clientSize = display.GetClientArea();
482 
483  // The percentage size (represented in decimal) of the region around the screen's border where
484  // an upper corner is not allowed
485 #define SCREEN_BORDER_REGION 0.10
486 
487  int yLim = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
488  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
489  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
490 
491  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
492  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
493  upperRight.y > yLim ) // Upper corner too close to the bottom of the screen
494  {
495  m_FramePos = wxDefaultPosition;
496  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
497  }
498  }
499 
500  // Ensure Window title bar is visible
501 #if defined( __WXOSX__ )
502  // for macOSX, the window must be below system (macOSX) toolbar
503  int Ypos_min = 20;
504 #else
505  int Ypos_min = 0;
506 #endif
507  if( m_FramePos.y < Ypos_min )
508  m_FramePos.y = Ypos_min;
509 
510  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
512 
513  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
514 
515  // Center the window if we reset to default
516  if( m_FramePos.x == -1 )
517  {
518  wxLogTrace( traceDisplayLocation, "Centering window" );
519  Center();
520  m_FramePos = GetPosition();
521  }
522 
523  // Record the frame sizes in an un-maximized state
526 
527  // Maximize if we were maximized before
528  if( aState.maximized )
529  {
530  wxLogTrace( traceDisplayLocation, "Maximizing window" );
531  Maximize();
532  }
533 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
#define SCREEN_BORDER_REGION
static const int s_minsize_x
static const int s_minsize_y
unsigned int display
Definition: app_settings.h:75
wxPoint m_NormalFramePos

References PCAD2KICAD::Center, WINDOW_STATE::display, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, WINDOW_STATE::maximized, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, s_minsize_x, s_minsize_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, traceDisplayLocation, wxPoint::x, and wxPoint::y.

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString &  aFileName)
inherited

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

Parameters
aFileName= full path to the file.
Returns
false if the file was already locked, true otherwise.

Definition at line 182 of file eda_draw_frame.cpp.

183 {
184  m_file_checker = ::LockFile( aFileName );
185 
186  return bool( m_file_checker );
187 }
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
prevents opening same file multiple times.
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.

References EDA_DRAW_FRAME::m_file_checker.

Referenced by SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::SaveEEFile().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 654 of file eda_base_frame.h.

655  {
656  m_isNonUserClose = true;
657  return Close( aForce );
658  }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 256 of file eda_base_frame.cpp.

257 {
258  if( !doAutoSave() )
259  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
260 }
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
virtualinherited

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 269 of file eda_base_frame.cpp.

270 {
271  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
272  // Key events can be filtered here.
273  // Currently no filtering is made.
274  event.Skip();
275 }
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.

References dump(), and kicadTraceKeyEvent.

◆ OnGridSettings()

void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent &  event)
inherited

Definition at line 310 of file eda_draw_frame.cpp.

311 {
312  DIALOG_GRID_SETTINGS dlg( this );
313 
314  if( dlg.ShowModal() == wxID_OK )
315  {
316  UpdateStatusBar();
317  GetCanvas()->Refresh();
318  }
319 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void UpdateStatusBar() override
Update the status bar information.

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::Refresh(), and EDA_DRAW_FRAME::UpdateStatusBar().

Referenced by EDA_DRAW_FRAME::OnSelectGrid().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 761 of file eda_base_frame.cpp.

762 {
763  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
764  ShowAboutDialog( this );
765 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

Definition at line 958 of file eda_base_frame.cpp.

959 {
960  // When we maximize the window, we want to save the old information
961  // so that we can add it to the settings on next window load.
962  // Contrary to the documentation, this event seems to be generated
963  // when the window is also being unmaximized on OSX, so we only
964  // capture the size information when we maximize the window when on OSX.
965 #ifdef __WXOSX__
966  if( !IsMaximized() )
967 #endif
968  {
970  m_NormalFramePos = GetPosition();
971  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
973  }
974 
975  // Skip event to actually maximize the window
976  aEvent.Skip();
977 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize m_NormalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxPoint m_NormalFramePos

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, traceDisplayLocation, wxPoint::x, and wxPoint::y.

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent &  event)
inherited

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 278 of file eda_base_frame.cpp.

279 {
280  if( !m_toolDispatcher )
281  aEvent.Skip();
282  else
284 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:52

References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.

◆ OnModify()

virtual void SCH_BASE_FRAME::OnModify ( )
inlinevirtual

Must be called after a model change in order to set the "modify" flag and do other frame-specific processing.

Reimplemented in LIB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 250 of file sch_base_frame.h.

250 {}

Referenced by EE_POINT_EDITOR::Main().

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent &  aEvent)
overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 413 of file eda_draw_frame.cpp.

414 {
415  // If the window is moved to a different display, the scaling factor may change
416  double oldFactor = m_galDisplayOptions.m_scaleFactor;
418 
419  if( oldFactor != m_galDisplayOptions.m_scaleFactor && m_canvas )
420  {
421  wxSize clientSize = GetClientSize();
422  GetCanvas()->GetGAL()->ResizeScreen( clientSize.x, clientSize.y );
423  GetCanvas()->GetView()->MarkDirty();
424  }
425 
426  aEvent.Skip();
427 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
double m_scaleFactor
The pixel scale factor (>1 for hi-DPI scaled displays)
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:599

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_FRAME::m_canvas, EDA_DRAW_FRAME::m_galDisplayOptions, KIGFX::GAL_DISPLAY_OPTIONS::m_scaleFactor, KIGFX::VIEW::MarkDirty(), KIGFX::GAL::ResizeScreen(), and KIGFX::GAL_DISPLAY_OPTIONS::UpdateScaleFactor().

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )
inlinevirtualinherited

Called when modifying the page settings.

In derived classes it can be used to modify parameters like draw area size, and any other local parameter related to the page settings.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 366 of file eda_draw_frame.h.

366 {}

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 768 of file eda_base_frame.cpp.

769 {
770  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
771  wxTreebook* book = dlg.GetTreebook();
772 
773  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
774 
775  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
776 
777  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
778  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
779 
780  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
781  {
782  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
783 
784  if( frame )
785  frame->InstallPreferences( &dlg, hotkeysPanel );
786  }
787 
788  // The Kicad manager frame is not a player so we have to add it by hand
789  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
790 
791  if( manager )
792  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
793 
794  for( size_t i = 0; i < book->GetPageCount(); ++i )
795  book->GetPage( i )->Layout();
796 
797  if( dlg.ShowModal() == wxID_OK )
798  dlg.Kiway().CommonSettingsChanged( false, false );
799 }
KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of ...
Definition: kiway_player.h:59
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
FRAME_T
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:343
#define KICAD_MANAGER_FRAME_NAME
#define _(s)
Definition: 3d_actions.cpp:33
virtual void InstallPreferences(PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences...

References _, KIWAY::CommonSettingsChanged(), PAGED_DIALOG::GetTreebook(), EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, and KIWAY::Player().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent &  event)
inherited

Command event handler for selecting grid sizes.

All commands that set the grid size should eventually end up here. This is where the application setting is saved. If you override this method, make sure you call down to the base class.

Parameters
event- Command event passed by selecting grid size from the grid size combobox on the toolbar.

Definition at line 277 of file eda_draw_frame.cpp.

278 {
279  wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );
280 
281  int idx = m_gridSelectBox->GetCurrentSelection();
282 
283  if( idx == int( m_gridSelectBox->GetCount() ) - 2 )
284  {
285  // wxWidgets will check the separator, which we don't want.
286  // Re-check the current grid.
287  wxUpdateUIEvent dummy;
289  }
290  else if( idx == int( m_gridSelectBox->GetCount() ) - 1 )
291  {
292  // wxWidgets will check the Grid Settings... entry, which we don't want.
293  // Re-check the current grid.
294  wxUpdateUIEvent dummy;
296  // Now run the Grid Settings... dialog
297  wxCommandEvent dummy2;
298  OnGridSettings( dummy2 );
299  }
300  else
301  {
303  }
304 
305  UpdateStatusBar();
306  m_canvas->Refresh();
307 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
wxChoice * m_gridSelectBox
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
static TOOL_ACTION gridPreset
Definition: actions.h:137
void OnUpdateSelectGrid(wxUpdateUIEvent &aEvent)
Update the checked item in the grid combobox.
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...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
void OnGridSettings(wxCommandEvent &event)
void UpdateStatusBar() override
Update the status bar information.

References dummy(), ACTIONS::gridPreset, EDA_DRAW_FRAME::m_canvas, EDA_DRAW_FRAME::m_gridSelectBox, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::OnGridSettings(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent &  event)
virtualinherited

Set the zoom factor when selected by the zoom list box in the main tool bar.

Note
List position 0 is fit to page List position >= 1 = zoom (1 to zoom max) Last list position is custom zoom not in zoom list.

Definition at line 398 of file eda_draw_frame.cpp.

399 {
400  wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );
401 
402  int id = m_zoomSelectBox->GetCurrentSelection();
403 
404  if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
405  return;
406 
407  m_toolManager->RunAction( "common.Control.zoomPreset", true, id );
408  UpdateStatusBar();
409  m_canvas->Refresh();
410 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
wxChoice * m_zoomSelectBox
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...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
void UpdateStatusBar() override
Update the status bar information.

References EDA_DRAW_FRAME::m_canvas, TOOLS_HOLDER::m_toolManager, EDA_DRAW_FRAME::m_zoomSelectBox, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent &  event)
virtualinherited

Recalculate the size of toolbars and display panel when the frame size changes.

Reimplemented in FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and LIB_VIEW_FRAME.

Definition at line 508 of file eda_draw_frame.cpp.

509 {
510  m_FrameSize = GetClientSize( );
511 
512  SizeEv.Skip();
513 }

References EDA_BASE_FRAME::m_FrameSize.

Referenced by SCH_EDIT_FRAME::onSize(), and PCB_EDIT_FRAME::onSize().

◆ OnSockRequest()

void EDA_DRAW_FRAME::OnSockRequest ( wxSocketEvent &  evt)
inherited

Definition at line 71 of file eda_dde.cpp.

72 {
73  size_t len;
74  wxSocketBase* sock = evt.GetSocket();
75 
76  switch( evt.GetSocketEvent() )
77  {
78  case wxSOCKET_INPUT:
79  sock->Read( client_ipc_buffer, 1 );
80 
81  if( sock->LastCount() == 0 )
82  break; // No data, occurs on opening connection
83 
84  sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
85  len = 1 + sock->LastCount();
86  client_ipc_buffer[len] = 0;
88  break;
89 
90  case wxSOCKET_LOST:
91  return;
92  break;
93 
94  default:
95  wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
96  break;
97  }
98 }
#define IPC_BUF_SIZE
Definition: eda_dde.cpp:39
static char client_ipc_buffer[IPC_BUF_SIZE]
Definition: eda_dde.cpp:40
virtual void ExecuteRemoteCommand(const char *cmdline)
Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (cu...

References client_ipc_buffer, EDA_DRAW_FRAME::ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void EDA_DRAW_FRAME::OnSockRequestServer ( wxSocketEvent &  evt)
inherited

Definition at line 103 of file eda_dde.cpp.

104 {
105  wxSocketBase* socket;
106  wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
107 
108  socket = server->Accept();
109 
110  if( socket == NULL )
111  return;
112 
113  m_sockets.push_back( socket );
114 
115  socket->Notify( true );
116  socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
117  socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
118 }
std::vector< wxSocketBase * > m_sockets
interprocess communication
#define NULL

References ID_EDA_SOCKET_EVENT, EDA_DRAW_FRAME::m_sockets, and NULL.

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent)
inherited

Update the checked item in the grid combobox.

Definition at line 253 of file eda_draw_frame.cpp.

254 {
255  // No need to update the grid select box if it doesn't exist or the grid setting change
256  // was made using the select box.
257  if( m_gridSelectBox == NULL )
258  return;
259 
260  int idx = config()->m_Window.grid.last_size_idx;
261  idx = std::max( 0, std::min( idx, (int) m_gridSelectBox->GetCount() - 1 ) );
262 
263  if( idx != m_gridSelectBox->GetSelection() )
264  m_gridSelectBox->SetSelection( idx );
265 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
wxChoice * m_gridSelectBox
#define NULL
GRID_SETTINGS grid
Definition: app_settings.h:89
WINDOW_SETTINGS m_Window
Definition: app_settings.h:171

References EDA_BASE_FRAME::config(), WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, EDA_DRAW_FRAME::m_gridSelectBox, APP_SETTINGS_BASE::m_Window, and NULL.

Referenced by COMMON_TOOLS::OnGridChanged(), and EDA_DRAW_FRAME::OnSelectGrid().

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent &  aEvent)
inherited

Update the checked item in the zoom combobox.

Definition at line 371 of file eda_draw_frame.cpp.

372 {
373  if( m_zoomSelectBox == NULL || m_zoomSelectBox->GetParent() == NULL )
374  return;
375 
376  int current = 0; // display Auto if no match found
377 
378  // check for a match within 1%
379  double zoom = GetCanvas()->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
380 
381  for( unsigned i = 0; i < config()->m_Window.zoom_factors.size(); i++ )
382  {
383  if( std::fabs( zoom - config()->m_Window.zoom_factors[i] ) < ( zoom / 100.0 ) )
384  {
385  current = i + 1;
386  break;
387  }
388  }
389 
390  if( current != m_zoomSelectBox->GetSelection() )
391  m_zoomSelectBox->SetSelection( current );
392 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
#define ZOOM_COEFF
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
std::vector< double > zoom_factors
Definition: app_settings.h:86
#define NULL
wxChoice * m_zoomSelectBox
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
double GetZoomFactor() const
Get the zoom factor.
WINDOW_SETTINGS m_Window
Definition: app_settings.h:171

References EDA_BASE_FRAME::config(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), APP_SETTINGS_BASE::m_Window, EDA_DRAW_FRAME::m_zoomSelectBox, NULL, ZOOM_COEFF, and WINDOW_SETTINGS::zoom_factors.

◆ OpenProjectFiles()

virtual bool KIWAY_PLAYER::OpenProjectFiles ( const std::vector< wxString > &  aFileList,
int  aCtl = 0 
)
inlinevirtualinherited

Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList.

This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb", because any KIWAY_PLAYER is only in one KIWAY and the KIWAY owns the PROJECT. Therefore opening files from multiple projects into the same KIWAY_PLAYER is precluded.

Each derived class should handle this in a way specific to its needs. No filename prompting is done inside here for any file or project. There should be no need to call this with aFileList which is empty. However, calling it with a single filename which does not exist should indicate to the implementor that a new session is being started and that the given name is the desired name for the data file at time of save.

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff.

Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

After loading the window should update its Title as part of this operation. If the KIWAY_PLAYER needs to, it can load the *.pro file as part of this operation.

If the KIWAY_PLAYER cannot load any of the file(s) in the list, then it should say why through some GUI interface, and return false.

Parameters
aFileListincludes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtlis a set of bit flags ORed together from the set of KICTL_* #defined above.
Returns
bool - true if all requested files were opened OK, else false.

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, GERBVIEW_FRAME, CVPCB_MAINFRAME, BM2CMP_FRAME, and PL_EDITOR_FRAME.

Definition at line 118 of file kiway_player.h.

119  {
120  // overload me for your wxFrame type.
121 
122  // Any overload should probably do this also:
123  // Prj().MaybeLoadProjectSettings();
124 
125  // Then update the window title.
126 
127  return false;
128  }

Referenced by BACK_ANNOTATE::FetchNetlistFromPCB(), PGM_TEST_FRAME::MacOpenFile(), PGM_SINGLE_TOP::MacOpenFile(), PGM_MOCK_EESCHEMA_FRAME::MacOpenFile(), SCH_EDIT_FRAME::OnOpenPcbnew(), PGM_SINGLE_TOP::OnPgmInit(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::RunEeschema(), and PCB_EDIT_FRAME::TestStandalone().

◆ ParseArgs()

virtual void KIWAY_PLAYER::ParseArgs ( wxCmdLineParser &  aParser)
inlinevirtualinherited

Handles command-line arguments in a frame-specific way.

The given argument parser has already been initialized with the command line and any options/switches that are handled by the top-level launcher before passing control to the child frame.

Parameters
aParseris the argument parser created by the top-level launcher.

Definition at line 138 of file kiway_player.h.

139  {
140  WXUNUSED( aParser );
141  }

Referenced by PGM_SINGLE_TOP::OnPgmInit().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 942 of file eda_base_frame.cpp.

943 {
944  return m_redoList.PopCommand();
945 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

References EDA_BASE_FRAME::m_redoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), and SCH_EDITOR_CONTROL::Redo().

◆ PopCommandFromUndoList()

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const std::string &  actionName)
virtualinherited

Definition at line 61 of file tools_holder.cpp.

62 {
63  // Push/pop events can get out of order (such as when they're generated by the Simulator
64  // frame but not processed until the mouse is back in the Schematic frame), so make sure
65  // we're popping the right stack frame.
66 
67  for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
68  {
69  if( m_toolStack[ i ] == actionName )
70  {
71  m_toolStack.erase( m_toolStack.begin() + i );
72 
73  // If there's something underneath us, and it's now the top of the stack, then
74  // re-activate it
75  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
76  {
77  std::string back = m_toolStack[ i ];
79 
80  if( action )
81  {
82  // Pop the action as running it will push it back onto the stack
83  m_toolStack.pop_back();
84 
85  TOOL_EVENT evt = action->MakeEvent();
86  evt.SetHasPosition( false );
87  GetToolManager()->PostEvent( evt );
88  }
89  }
90  else
92 
93  return;
94  }
95  }
96 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:122
TOOL_ACTION * FindAction(const std::string &aActionName) const
Finds an action with a given name (if there is one available).
TOOL_EVENT.
Definition: tool_event.h:171
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
std::vector< std::string > m_toolStack
Definition: tools_holder.h:56
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:199
Represents a single user action.
Definition: tool_action.h:44
TOOL_EVENT MakeEvent() const
Returns the event associated with the action (i.e.
Definition: tool_action.h:113
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:78
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:273
static TOOL_ACTION selectionTool
Definition: actions.h:149
void SetHasPosition(bool aHasPosition)
Definition: tool_event.h:261

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOLS_HOLDER::GetToolManager(), TOOLS_HOLDER::m_toolManager, TOOLS_HOLDER::m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, and TOOL_EVENT::SetHasPosition().

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString &  text)
inherited

Definition at line 661 of file eda_base_frame.cpp.

662 {
663  SetStatusText( text );
664 }

◆ PrintPage()

void EDA_DRAW_FRAME::PrintPage ( RENDER_SETTINGS aSettings)
virtualinherited

Print the page pointed by current screen, set by the calling print function.

Parameters
aDC= wxDC given by the calling print function

Reimplemented in SCH_EDIT_FRAME, LIB_EDIT_FRAME, and PL_EDITOR_FRAME.

Definition at line 268 of file eda_draw_frame.cpp.

269 {
270  wxMessageBox( wxT("EDA_DRAW_FRAME::PrintPage() error") );
271 }

◆ PrintWorkSheet()

void EDA_DRAW_FRAME::PrintWorkSheet ( RENDER_SETTINGS aSettings,
BASE_SCREEN aScreen,
double  aScale,
const wxString &  aFilename,
const wxString &  aSheetLayer = wxEmptyString 
)
inherited

Prints the page layout with the frame and the basic inscriptions.

Parameters
aScreenscreen to draw
aScaleThe mils to Iu conversion factor.
aFilenameThe filename to display in basic inscriptions.
aSheetLayerThe layer displayed from pcbnew.

Definition at line 833 of file eda_draw_frame.cpp.

836 {
838  return;
839 
840  wxDC* DC = aSettings->GetPrintDC();
841  wxPoint origin = DC->GetDeviceOrigin();
842 
843  if( origin.y > 0 )
844  {
845  DC->SetDeviceOrigin( 0, 0 );
846  DC->SetAxisOrientation( true, false );
847  }
848 
849  PrintPageLayout( aSettings, GetPageSettings(), GetScreenDesc(), aFilename, GetTitleBlock(),
850  aScreen->m_NumberOfScreens, aScreen->m_ScreenNumber, aScalar, &Prj(),
851  aSheetLayer );
852 
853  if( origin.y > 0 )
854  {
855  DC->SetDeviceOrigin( origin.x, origin.y );
856  DC->SetAxisOrientation( true, true );
857  }
858 }
int m_ScreenNumber
Definition: base_screen.h:79
virtual const TITLE_BLOCK & GetTitleBlock() const =0
virtual const PAGE_INFO & GetPageSettings() const =0
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool m_showBorderAndTitleBlock
void PrintPageLayout(RENDER_SETTINGS *aSettings, const PAGE_INFO &aPageInfo, const wxString &aFullSheetName, const wxString &aFileName, const TITLE_BLOCK &aTitleBlock, int aSheetCount, int aSheetNumber, double aScalar, const PROJECT *aProject, const wxString &aSheetLayer)
Function PrintPageLayout is a core function to print the page layout with the frame and the basic ins...
int m_NumberOfScreens
Definition: base_screen.h:80
virtual wxString GetScreenDesc() const

References EDA_DRAW_FRAME::GetPageSettings(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_DRAW_FRAME::GetScreenDesc(), EDA_DRAW_FRAME::GetTitleBlock(), BASE_SCREEN::m_NumberOfScreens, BASE_SCREEN::m_ScreenNumber, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, PrintPageLayout(), KIWAY_HOLDER::Prj(), wxPoint::x, and wxPoint::y.

Referenced by PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), PL_EDITOR_FRAME::PrintPage(), and SCH_EDIT_FRAME::PrintPage().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), PCB_INSPECTION_TOOL::reportCopperClearance(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent &  aEvent)
overrideinherited

Override the default process event handler to implement the auto save feature.

Warning
If you override this function in a derived class, make sure you call down to this or the auto save feature will be disabled.

Definition at line 198 of file eda_base_frame.cpp.

199 {
200 #ifdef __WXMAC__
201  // Apple in its infinite wisdom will raise a disabled window before even passing
202  // us the event, so we have no way to stop it. Instead, we have to catch an
203  // improperly ordered disabled window and quasi-modal dialog here and reorder
204  // them.
205  if( !IsEnabled() && IsActive() )
206  {
207  wxWindow* dlg = findQuasiModalDialog();
208  if( dlg )
209  dlg->Raise();
210  }
211 #endif
212 
213  if( !wxFrame::ProcessEvent( aEvent ) )
214  return false;
215 
216  if( IsShown() && m_hasAutoSave && IsActive() &&
218  {
219  if( !m_autoSaveState )
220  {
221  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
222  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
223  m_autoSaveState = true;
224  }
225  else if( m_autoSaveTimer->IsRunning() )
226  {
227  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
228  m_autoSaveTimer->Stop();
229  m_autoSaveState = false;
230  }
231  }
232 
233  return true;
234 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
virtual bool isAutoSaveRequired() const
Return the auto save status of the application.
wxTimer * m_autoSaveTimer
wxWindow * findQuasiModalDialog()

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_hasAutoSave, and traceAutoSave.

Referenced by COMMON_TOOLS::GridProperties(), LIB_VIEW_FRAME::onSelectNextSymbol(), LIB_VIEW_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and LIB_VIEW_FRAME::ReCreateListCmp().

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )
inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in PCB_EDIT_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 571 of file eda_base_frame.h.

571 {}

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList)

Definition at line 921 of file eda_base_frame.cpp.

922 {
923  m_redoList.PushCommand( aNewitem );
924 
925  // Delete the extra items, if count max reached
926  if( m_UndoRedoCountMax > 0 )
927  {
928  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
929 
930  if( extraitems > 0 )
931  ClearUndoORRedoList( REDO_LIST, extraitems );
932  }
933 }
virtual int GetRedoCommandCount() const
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_redoList

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_UndoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::REDO_LIST.

Referenced by LIB_EDIT_FRAME::GetComponentFromUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList)

Definition at line 906 of file eda_base_frame.cpp.

907 {
908  m_undoList.PushCommand( aNewitem );
909 
910  // Delete the extra items, if count max reached
911  if( m_UndoRedoCountMax > 0 )
912  {
913  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
914 
915  if( extraitems > 0 )
916  ClearUndoORRedoList( UNDO_LIST, extraitems );
917  }
918 }
UNDO_REDO_CONTAINER m_undoList
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
virtual int GetUndoCommandCount() const

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_BASE_FRAME::m_undoList, EDA_BASE_FRAME::m_UndoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::UNDO_LIST.

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PL_EDITOR_FRAME::SaveCopyInUndoList(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const std::string &  actionName)
virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Definition at line 44 of file tools_holder.cpp.

45 {
46  m_toolStack.push_back( actionName );
47 
48  // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
49  if( m_toolStack.size() > 3 )
50  m_toolStack.erase( m_toolStack.begin() );
51 
52  TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
53 
54  if( action )
55  DisplayToolMsg( action->GetLabel() );
56  else
57  DisplayToolMsg( actionName );
58 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:122
TOOL_ACTION * FindAction(const std::string &aActionName) const
Finds an action with a given name (if there is one available).
wxString GetLabel() const
Definition: tool_action.cpp:69
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
std::vector< std::string > m_toolStack
Definition: tools_holder.h:56
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:199
Represents a single user action.
Definition: tool_action.h:44

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_ACTION::GetLabel(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

Referenced by EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), LIB_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )
inlinevirtualinherited

Reimplemented in PCB_EDIT_FRAME, and GERBVIEW_FRAME.

Definition at line 252 of file eda_draw_frame.h.

252 { }

Referenced by EDA_DRAW_FRAME::RecreateToolbars(), and PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ ReCreateHToolbar()

◆ ReCreateMenuBar()

void EDA_DRAW_FRAME::ReCreateMenuBar ( )
inlineoverridevirtualinherited

Recreates the menu bar.

Needed when the language is changed

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME, PCB_BASE_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 248 of file eda_draw_frame.h.

248 { }

◆ ReCreateOptToolbar()

◆ RecreateToolbars()

void EDA_DRAW_FRAME::RecreateToolbars ( )
inherited

Rebuild all toolbars, and update the checked state of ckeck tools.

Definition at line 908 of file eda_draw_frame.cpp.

909 {
910  // Rebuild all toolbars, and update the checked state of check tools
911  if( m_mainToolBar )
913 
914  if( m_drawToolBar ) // Drawing tools (typically on right edge of window)
916 
917  if( m_optionsToolBar ) // Options (typically on left edge of window)
919 
920  if( m_auxiliaryToolBar ) // Additional tools under main toolbar
922 }
virtual void ReCreateVToolbar()=0
ACTION_TOOLBAR * m_auxiliaryToolBar
ACTION_TOOLBAR * m_optionsToolBar
ACTION_TOOLBAR * m_mainToolBar
virtual void ReCreateOptToolbar()=0
virtual void ReCreateHToolbar()=0
virtual void ReCreateAuxiliaryToolbar()
ACTION_TOOLBAR * m_drawToolBar

References EDA_DRAW_FRAME::m_auxiliaryToolBar, EDA_DRAW_FRAME::m_drawToolBar, EDA_DRAW_FRAME::m_mainToolBar, EDA_DRAW_FRAME::m_optionsToolBar, EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar(), EDA_DRAW_FRAME::ReCreateHToolbar(), EDA_DRAW_FRAME::ReCreateOptToolbar(), and EDA_DRAW_FRAME::ReCreateVToolbar().

Referenced by PCB_BASE_FRAME::CommonSettingsChanged(), LIB_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::ShowChangedLanguage(), LIB_EDIT_FRAME::ShowChangedLanguage(), and SCH_EDIT_FRAME::ShowChangedLanguage().

◆ ReCreateVToolbar()

◆ RedrawScreen()

void SCH_BASE_FRAME::RedrawScreen ( const wxPoint aCenterPoint,
bool  aWarpPointer 
)
virtual

Definition at line 259 of file sch_base_frame.cpp.

260 {
261  GetCanvas()->GetView()->SetCenter( aCenterPoint );
262 
263  if( aWarpPointer )
265 
266  GetCanvas()->Refresh();
267 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
virtual void CenterOnCursor() const =0
Function CenterOnCursor() Sets the viewport center to the current cursor position and warps the curso...
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:603
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...

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

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), DIALOG_ERC::OnERCItemSelected(), and DIALOG_MIGRATE_BUSES::onItemSelected().

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )
inlineoverridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 472 of file eda_draw_frame.h.

473  {
474  GetCanvas()->Refresh();
475  }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...

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

◆ RefreshSelection()

void SCH_BASE_FRAME::RefreshSelection ( )

Mark selected items for refresh.

Definition at line 348 of file sch_base_frame.cpp.

349 {
350  if( m_toolManager )
351  {
353  SELECTION& selection = selectionTool->GetSelection();
354  KIGFX::SCH_VIEW* view = GetCanvas()->GetView();
355 
356  for( EDA_ITEM* item : selection )
357  {
358  EDA_ITEM* parent = item->GetParent();
359 
360  if( item->Type() == SCH_SHEET_PIN_T )
361  {
362  // Sheet pins aren't in the view. Refresh their parent.
363  if( parent )
364  GetCanvas()->GetView()->Update( parent );
365  }
366  else
367  {
368  view->Update( item, KIGFX::REPAINT );
369 
370  // Component children are drawn from their parents. Mark them for re-paint.
371  if( parent && parent->Type() == SCH_COMPONENT_T )
372  GetCanvas()->GetView()->Update( parent, KIGFX::REPAINT );
373  }
374  }
375  }
376 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
EE_SELECTION & GetSelection()
Function GetSelection()
Item is being added to the view.
Definition: view_item.h:62
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1531
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References GetCanvas(), EDA_ITEM::GetParent(), EE_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), SCH_DRAW_PANEL::GetView(), TOOLS_HOLDER::m_toolManager, KIGFX::REPAINT, SCH_COMPONENT_T, SCH_SHEET_PIN_T, EDA_ITEM::Type(), and KIGFX::VIEW::Update().

Referenced by KIGFX::SCH_VIEW::SetScale().

◆ RegisterUIUpdateHandler() [1/2]

virtual void EDA_BASE_FRAME::RegisterUIUpdateHandler ( const TOOL_ACTION aAction,
const ACTION_CONDITIONS aConditions 
)
inlineoverridevirtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters
aActionis the action to register
aConditionsare the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 288 of file eda_base_frame.h.

290  {
291  RegisterUIUpdateHandler( aAction.GetUIId(), aConditions );
292  }
int GetUIId() const
Definition: tool_action.h:102
virtual void RegisterUIUpdateHandler(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions) override
Register an action's update conditions with the UI layer to allow the UI to appropriately display the...

References TOOL_ACTION::GetUIId().

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::setupUIConditions(), EDA_3D_VIEWER::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), EDA_BASE_FRAME::setupUIConditions(), and LIB_EDIT_FRAME::setupUIConditions().

◆ RegisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler ( int  aID,
const ACTION_CONDITIONS aConditions 
)
virtualinherited

Register a UI update handler for the control with ID aID.

Parameters
aIDis the control ID to register the handler for
aConditionsare the UI conditions to use for the control states

Definition at line 287 of file eda_base_frame.cpp.

288 {
290  std::placeholders::_1,
291  this,
292  aConditions );
293 
294  m_uiUpdateMap[aID] = evtFunc;
295 
296  Bind( wxEVT_UPDATE_UI, evtFunc, aID );
297 }
static void HandleUpdateUIEvent(wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
Handles events generated when the UI is trying to figure out the current state of the UI controls rel...
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
std::map< int, UIUpdateHandler > m_uiUpdateMap

References EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )
inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 176 of file eda_draw_frame.cpp.

177 {
178  m_file_checker = nullptr;
179 }
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
prevents opening same file multiple times.

References EDA_DRAW_FRAME::m_file_checker.

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::OpenProjectFiles(), and EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ RemoveFromScreen()

void SCH_BASE_FRAME::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.

Definition at line 396 of file sch_base_frame.cpp.

397 {
398  auto screen = aScreen;
399 
400  if( aScreen == nullptr )
401  screen = GetScreen();
402 
403  if( screen == GetScreen() )
404  GetCanvas()->GetView()->Remove( aItem );
405 
406  screen->Remove( (SCH_ITEM*) aItem );
407 
408  if( screen == GetScreen() )
409  UpdateItem( aItem, true ); // handle any additional parent semantics
410 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:375
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::SchematicCleanUp(), and SCH_EDIT_FRAME::TrimWire().

◆ saveCanvasTypeSetting()

bool EDA_DRAW_FRAME::saveCanvasTypeSetting ( EDA_DRAW_PANEL_GAL::GAL_TYPE  aCanvasType)
protectedinherited

Stores the canvas type in the application settings.

Definition at line 681 of file eda_draw_frame.cpp.

682 {
683  // Not all classes derived from EDA_DRAW_FRAME can save the canvas type, because some
684  // have a fixed type, or do not have a option to set the canvas type (they inherit from
685  // a parent frame)
686  FRAME_T allowed_frames[] =
687  {
688  FRAME_SCH,
691  };
692 
693  bool allow_save = false;
694 
695  for( unsigned ii = 0; ii < arrayDim( allowed_frames ); ii++ )
696  {
697  if( m_Ident == allowed_frames[ii] )
698  {
699  allow_save = true;
700  break;
701  }
702  }
703 
704  if( !allow_save )
705  return false;
706 
707  if( aCanvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
708  || aCanvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
709  {
710  wxASSERT( false );
711  return false;
712  }
713 
715 
716  if( cfg )
717  cfg->m_Graphics.canvas_type = static_cast<int>( aCanvasType );
718 
719  return false;
720 }
FRAME_T
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
Sentinel, do not use as a parameter.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:99
GAL not used (the legacy wxDC engine is used)
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:160

References arrayDim(), APP_SETTINGS_BASE::GRAPHICS::canvas_type, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_EDITOR, FRAME_SCH, EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, Kiface(), KIFACE_I::KifaceSettings(), APP_SETTINGS_BASE::m_Graphics, and EDA_BASE_FRAME::m_Ident.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), and EDA_DRAW_FRAME::~EDA_DRAW_FRAME().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )
inlinevirtualinherited

Save changes to the project settings to the project (.pro) file.

The method is virtual so you can override it to call the suitable save method. The base method do nothing

Parameters
aAskForSave= true to open a dialog before saving the settings

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 436 of file eda_base_frame.h.

436 {};

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ SaveSettings()

void SCH_BASE_FRAME::SaveSettings ( APP_SETTINGS_BASE aCfg)
overridevirtual

Saves common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 381 of file eeschema_config.cpp.

382 {
383  wxCHECK_RET( aCfg, "Call to SCH_BASE_FRAME::SaveSettings with null settings" );
384 
386 }
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Saves common frame parameters to a configuration data file.

References EDA_DRAW_FRAME::SaveSettings().

Referenced by LIB_VIEW_FRAME::SaveSettings(), SCH_EDIT_FRAME::SaveSettings(), and LIB_EDIT_FRAME::SaveSettings().

◆ saveSymbolLibTables()

bool SCH_BASE_FRAME::saveSymbolLibTables ( bool  aGlobal,
bool  aProject 
)
protected

Saves Symbol Library Tables to disk.

Parameters
aGlobalwhen true, the Global Table is saved.
aProjectwhen true, the Project Table is saved.
Returns
True when all requested actions succeeded.

Definition at line 220 of file sch_base_frame.cpp.

221 {
222  wxString msg;
223  bool success = true;
224 
225  if( aGlobal )
226  {
227  try
228  {
230  }
231  catch( const IO_ERROR& ioe )
232  {
233  success = false;
234  msg.Printf( _( "Error saving global symbol library table:\n%s" ), ioe.What() );
235  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
236  }
237  }
238 
239  if( aProject && !Prj().GetProjectName().IsEmpty() )
240  {
241  wxFileName fn( Prj().GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
242 
243  try
244  {
245  Prj().SchSymbolLibTable()->Save( fn.GetFullPath() );
246  }
247  catch( const IO_ERROR& ioe )
248  {
249  success = false;
250  msg.Printf( _( "Error saving project-specific symbol library table:\n%s" ), ioe.What() );
251  wxMessageBox( msg, _( "File Save Error" ), wxOK | wxICON_ERROR );
252  }
253  }
254 
255  return success;
256 }
static const wxString & GetSymbolLibTableFileName()
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.

References _, SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), KIWAY_HOLDER::Prj(), LIB_TABLE::Save(), and IO_ERROR::What().

Referenced by LIB_EDIT_FRAME::AddLibraryFile(), and LIB_EDIT_FRAME::ExportPart().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS aCfg)
inherited

Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 550 of file eda_base_frame.cpp.

551 {
552  wxString text;
553 
554  if( IsIconized() )
555  return;
556 
557  wxString baseCfgName = ConfigBaseName();
558 
559  // If the window is maximized, we use the saved window size from before it was maximized
560  if( IsMaximized() )
561  {
564  }
565  else
566  {
568  m_FramePos = GetPosition();
569  }
570 
571  aCfg->state.pos_x = m_FramePos.x;
572  aCfg->state.pos_y = m_FramePos.y;
573  aCfg->state.size_x = m_FrameSize.x;
574  aCfg->state.size_y = m_FrameSize.y;
575  aCfg->state.maximized = IsMaximized();
576  aCfg->state.display = wxDisplay::GetFromWindow( this );
577 
578  wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
579  wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
581 
582  // TODO(JE) should auto-save in common settings be overwritten by every app?
583  if( m_hasAutoSave )
584  Pgm().GetCommonSettings()->m_System.autosave_interval = m_autoSaveInterval;
585 
586  // Once this is fully implemented, wxAuiManager will be used to maintain
587  // the persistance of the main frame and all it's managed windows and
588  // all of the legacy frame persistence position code can be removed.
589  aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
590 
591  aCfg->mru_path = m_mruPath;
592 }
wxString mru_path
Definition: app_settings.h:84
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxAuiManager m_auimgr
wxSize m_NormalFrameSize
wxString perspective
Definition: app_settings.h:85
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxString ConfigBaseName() override
WINDOW_STATE state
Definition: app_settings.h:83
unsigned int display
Definition: app_settings.h:75
wxPoint m_NormalFramePos

References EDA_BASE_FRAME::ConfigBaseName(), WINDOW_STATE::display, EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_NormalFramePos, EDA_BASE_FRAME::m_NormalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, traceDisplayLocation, wxPoint::x, and wxPoint::y.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SelectCompFromLibTree()

COMPONENT_SELECTION SCH_BASE_FRAME::SelectCompFromLibTree ( const SCHLIB_FILTER aFilter,
std::vector< COMPONENT_SELECTION > &  aHistoryList,
bool  aUseLibBrowser,
int  aUnit,
int  aConvert,
bool  aShowFootprints,
const LIB_ID aHighlight = nullptr,
bool  aAllowFields = true 
)

Function SelectComponentFromLib Calls the library viewer to select component to import into schematic.

if the library viewer is currently running, it is closed and reopened in modal mode.

aAllowFields chooses whether or not features that permit the user to edit fields (e.g. footprint selection) should be enabled. This should be false when they would have no effect, for example loading a part into libedit.

Parameters
aFilteris a SCHLIB_FILTER filter to pass the allowed library names and/or the library name to load the component from and/or some other filter if NULL, no filtering.
aHistoryListlist of previously loaded components - will be edited
aUseLibBrowserbool to call the library viewer to select the component
aUnitpreselected unit
aConvertpreselected De Morgan shape
aHighlightname of component to highlight in the list. highlights none if there isn't one by that name
aShowFootprintswhether to show footprints in the dialog
aAllowFieldswhether to allow field editing in the dialog
Returns
the selected component

Definition at line 89 of file getpart.cpp.

92 {
93  std::unique_lock<std::mutex> dialogLock( DIALOG_CHOOSE_COMPONENT::g_Mutex, std::defer_lock );
94  wxString dialogTitle;
95  SYMBOL_LIB_TABLE* libs = Prj().SchSymbolLibTable();
96 
97  // One CHOOSE_COMPONENT dialog at a time. User probaby can't handle more anyway.
98  if( !dialogLock.try_lock() )
99  return COMPONENT_SELECTION();
100 
101  auto adapterPtr( SYMBOL_TREE_MODEL_ADAPTER::Create( this, libs ) );
102  auto adapter = static_cast<SYMBOL_TREE_MODEL_ADAPTER*>( adapterPtr.get() );
103  bool loaded = false;
104 
105  if( aFilter )
106  {
107  const wxArrayString& liblist = aFilter->GetAllowedLibList();
108 
109  for( unsigned ii = 0; ii < liblist.GetCount(); ii++ )
110  {
111  if( libs->HasLibrary( liblist[ii], true ) )
112  {
113  loaded = true;
114  adapter->AddLibrary( liblist[ii] );
115  }
116  }
117 
118  adapter->AssignIntrinsicRanks();
119 
120  if( aFilter->GetFilterPowerParts() )
121  adapter->SetFilter( SYMBOL_TREE_MODEL_ADAPTER::CMP_FILTER_POWER );
122  }
123 
124  std::vector< LIB_TREE_ITEM* > history_list;
125 
126  for( auto const& i : aHistoryList )
127  {
128  LIB_PART* symbol = GetLibPart( i.LibId );
129 
130  // This can be null, for example when a symbol has been deleted from a library
131  if( symbol )
132  history_list.push_back( symbol );
133  }
134 
135  adapter->DoAddLibrary( "-- " + _( "Recently Used" ) + " --", wxEmptyString, history_list,
136  true );
137 
138  if( !aHistoryList.empty() )
139  adapter->SetPreselectNode( aHistoryList[0].LibId, aHistoryList[0].Unit );
140 
141  const std::vector< wxString > libNicknames = libs->GetLogicalLibs();
142 
143  if( !loaded )
144  adapter->AddLibraries( libNicknames, this );
145 
146  if( aHighlight && aHighlight->IsValid() )
147  adapter->SetPreselectNode( *aHighlight, /* aUnit */ 0 );
148 
149  if( adapter->GetFilter() == SYMBOL_TREE_MODEL_ADAPTER::CMP_FILTER_POWER )
150  dialogTitle.Printf( _( "Choose Power Symbol (%d items loaded)" ), adapter->GetItemCount() );
151  else
152  dialogTitle.Printf( _( "Choose Symbol (%d items loaded)" ), adapter->GetItemCount() );
153 
154  DIALOG_CHOOSE_COMPONENT dlg( this, dialogTitle, adapterPtr, aConvert,
155  aAllowFields, aShowFootprints, aUseLibBrowser );
156 
157  if( dlg.ShowModal() == wxID_CANCEL )
158  return COMPONENT_SELECTION();
159 
161  LIB_ID id = dlg.GetSelectedLibId( &sel.Unit );
162 
163  if( dlg.IsExternalBrowserSelected() ) // User requested component browser.
164  {
165  sel = SelectComponentFromLibBrowser( this, aFilter, id, sel.Unit, sel.Convert );
166  id = sel.LibId;
167  }
168 
169  if( !id.IsValid() ) // Dialog closed by OK button,
170  // or the selection by lib browser was requested,
171  // but no symbol selected
172  return COMPONENT_SELECTION();
173 
174  if( sel.Unit == 0 )
175  sel.Unit = 1;
176 
177  sel.Fields = dlg.GetFields();
178  sel.LibId = id;
179 
180  if( sel.LibId.IsValid() )
181  {
182  aHistoryList.erase( std::remove_if( aHistoryList.begin(), aHistoryList.end(),
183  [ &sel ]( COMPONENT_SELECTION const& i )
184  {
185  return i.LibId == sel.LibId;
186  } ),
187  aHistoryList.end() );
188 
189  aHistoryList.insert( aHistoryList.begin(), sel );
190  }
191 
192  return sel;
193 }
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
LIB_PART * GetLibPart(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Definition: lib_id.h:171
static PTR Create(EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
Factory function: create a model adapter in a reference-counting container.
Dialog class to select a component from the libraries.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Define a library symbol object.
bool GetFilterPowerParts() const
COMPONENT_SELECTION SelectComponentFromLibBrowser(wxTopLevelWindow *aParent, const SCHLIB_FILTER *aFilter, const LIB_ID &aPreselectedLibid, int aUnit, int aConvert)
Function SelectComponentFromLibBrowser Calls the library viewer to select component to import into sc...
Definition: getpart.cpp:45
#define _(s)
Definition: 3d_actions.cpp:33
const wxArrayString & GetAllowedLibList() const
std::vector< std::pair< int, wxString > > Fields
Definition: sch_screen.h:86
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References _, LIB_TREE_MODEL_ADAPTER::CMP_FILTER_POWER, COMPONENT_SELECTION::Convert, SYMBOL_TREE_MODEL_ADAPTER::Create(), COMPONENT_SELECTION::Fields, DIALOG_CHOOSE_COMPONENT::g_Mutex, SCHLIB_FILTER::GetAllowedLibList(), DIALOG_CHOOSE_COMPONENT::GetFields(), SCHLIB_FILTER::GetFilterPowerParts(), GetLibPart(), LIB_TABLE::GetLogicalLibs(), DIALOG_CHOOSE_COMPONENT::GetSelectedLibId(), LIB_TABLE::HasLibrary(), DIALOG_CHOOSE_COMPONENT::IsExternalBrowserSelected(), LIB_ID::IsValid(), COMPONENT_SELECTION::LibId, KIWAY_HOLDER::Prj(), SelectComponentFromLibBrowser(), and COMPONENT_SELECTION::Unit.

Referenced by SCH_DRAWING_TOOLS::PlaceComponent().

◆ SelectComponentFromLibBrowser()

COMPONENT_SELECTION SCH_BASE_FRAME::SelectComponentFromLibBrowser ( wxTopLevelWindow *  aParent,
const SCHLIB_FILTER aFilter,
const LIB_ID aPreselectedLibid,
int  aUnit,
int  aConvert 
)

Function SelectComponentFromLibBrowser Calls the library viewer to select component to import into schematic.

if the library viewer is currently running, it is closed and reopened in modal mode.

Parameters
aParentis the caller
aFilteris a filter to pass the allowed library names and/or some other filter
aPreselectedLibIdPreselected component LIB_ID. Not valid if none selected.
aUnitpreselected unit
aConvertpreselected deMorgan conversion
Returns
the selected component

Definition at line 45 of file getpart.cpp.

47 {
48  // Close any open non-modal Lib browser, and open a new one, in "modal" mode:
49  LIB_VIEW_FRAME* viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER, false );
50 
51  if( viewlibFrame )
52  viewlibFrame->Destroy();
53 
54  viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER_MODAL, true, aParent );
55 
56  if( aFilter )
57  viewlibFrame->SetFilter( aFilter );
58 
59  if( aPreselectedLibId.IsValid() )
60  {
61  viewlibFrame->SetSelectedLibrary( aPreselectedLibId.GetLibNickname() );
62  viewlibFrame->SetSelectedComponent( aPreselectedLibId.GetLibItemName() );
63  }
64 
65  viewlibFrame->SetUnitAndConvert( aUnit, aConvert );
66 
67  viewlibFrame->Refresh();
68 
70  wxString symbol;
71 
72  if( viewlibFrame->ShowModal( &symbol, aParent ) )
73  {
74  LIB_ID id;
75 
76  if( id.Parse( symbol, LIB_ID::ID_SCH ) == -1 )
77  sel.LibId = id;
78 
79  sel.Unit = viewlibFrame->GetUnit();
80  sel.Convert = viewlibFrame->GetConvert();
81  }
82