KiCad PCB EDA Suite
EDA_DRAW_FRAME Class Referenceabstract

The base class for create windows for drawing purpose. More...

#include <eda_draw_frame.h>

Inheritance diagram for EDA_DRAW_FRAME:
KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER GERBVIEW_FRAME PCB_BASE_FRAME PL_EDITOR_FRAME SCH_BASE_FRAME DISPLAY_FOOTPRINTS_FRAME FOOTPRINT_VIEWER_FRAME PCB_BASE_EDIT_FRAME LIB_VIEW_FRAME SCH_EDIT_FRAME SYMBOL_EDIT_FRAME FOOTPRINT_EDIT_FRAME FOOTPRINT_WIZARD_FRAME PCB_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

 EDA_DRAW_FRAME (KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
 
 ~EDA_DRAW_FRAME ()
 
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 ()
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings)=0
 
virtual const PAGE_INFOGetPageSettings () const =0
 
virtual const wxSize GetPageSizeIU () const =0
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 Get the pair or units in current use. More...
 
virtual const wxPoint & GetGridOrigin () const =0
 Return the absolute coordinates of the origin of the snap grid. More...
 
virtual void SetGridOrigin (const wxPoint &aPosition)=0
 
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 const TITLE_BLOCKGetTitleBlock () const =0
 
virtual void SetTitleBlock (const TITLE_BLOCK &aTitleBlock)=0
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
virtual COLOR_SETTINGSGetColorSettings ()
 Returns a pointer to the active color theme settings. More...
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
virtual wxString GetScreenDesc () const
 
virtual BASE_SCREENGetScreen () const
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). 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 HardRedraw ()
 Rebuild the GAL and redraws the screen. More...
 
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 UpdateStatusBar () override
 Update the status bar information. 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 LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
void AppendMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
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...
 
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...
 
virtual EDA_DRAW_PANEL_GALGetCanvas () const
 Return a pointer to GAL-based canvas of given EDA draw frame. 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 (bool aIncludeAllVisible=true) const
 Returns bbox of document with option to not include some items. More...
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of check 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 (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_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 () const
 
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

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 setupUnits (APP_SETTINGS_BASE *aCfg)
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. 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

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
 
bool m_maximizeByDefault
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 
bool m_isClosing
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Private Attributes

BASE_SCREENm_currentScreen
 current used SCREEN More...
 
EDA_DRAW_PANEL_GALm_canvas
 GAL display options - this is the frame's interface to setting GAL display options. More...
 
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
 
ORIGIN_TRANSFORMS m_originTransforms
 Default display origin transforms object. More...
 

Detailed Description

The base class for create windows for drawing purpose.

The Eeschema, Pcbnew and GerbView main windows are just a few examples of classes derived from EDA_DRAW_FRAME.

Definition at line 67 of file eda_draw_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 588 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ EDA_DRAW_FRAME()

EDA_DRAW_FRAME::EDA_DRAW_FRAME ( KIWAY aKiway,
wxWindow *  aParent,
FRAME_T  aFrameType,
const wxString &  aTitle,
const wxPoint &  aPos,
const wxSize &  aSize,
long  aStyle,
const wxString &  aFrameName 
)

Definition at line 70 of file eda_draw_frame.cpp.

72  :
73  KIWAY_PLAYER( aKiway, aParent, aFrameType, aTitle, aPos, aSize, aStyle, aFrameName )
74 {
75  m_socketServer = nullptr;
84 
86  m_canvas = NULL;
90  m_showBorderAndTitleBlock = false; // true to display reference sheet.
91  m_gridColor = COLOR4D( DARKGRAY ); // Default grid color
92  m_showPageLimits = false;
93  m_drawBgColor = COLOR4D( BLACK ); // the background color of the draw canvas:
94  // BLACK for Pcbnew, BLACK or WHITE for Eeschema
95  m_colorSettings = nullptr;
98  m_polarCoords = false;
99  m_findReplaceData = new wxFindReplaceData( wxFR_DOWN );
100 
101  m_auimgr.SetFlags(wxAUI_MGR_DEFAULT);
102 
103  CreateStatusBar( 7 );
104 
105  // set the size of the status bar subwindows:
106 
107  wxWindow* stsbar = GetStatusBar();
108 
109  int dims[] = {
110 
111  // remainder of status bar on far left is set to a default or whatever is left over.
112  -1,
113 
114  // When using GetTextSize() remember the width of character '1' is not the same
115  // as the width of '0' unless the font is fixed width, and it usually won't be.
116 
117  // zoom:
118  KIUI::GetTextSize( wxT( "Z 762000" ), stsbar ).x + 10,
119 
120  // cursor coords
121  KIUI::GetTextSize( wxT( "X 0234.567890 Y 0234.567890" ), stsbar ).x + 10,
122 
123  // delta distances
124  KIUI::GetTextSize( wxT( "dx 0234.567890 dx 0234.567890 d 0234.567890" ), stsbar ).x + 10,
125 
126  // grid size
127  KIUI::GetTextSize( wxT( "grid X 0234.567890 Y 0234.567890" ), stsbar ).x + 10,
128 
129  // units display, Inches is bigger than mm
130  KIUI::GetTextSize( _( "Inches" ), stsbar ).x + 10,
131 
132  // Size for the "Current Tool" panel; longest string from SetTool()
133  KIUI::GetTextSize( wxT( "Add layer alignment target" ), stsbar ).x + 10,
134  };
135 
136  SetStatusWidths( arrayDim( dims ), dims );
137 
138  // Create child subwindows.
139  GetClientSize( &m_frameSize.x, &m_frameSize.y );
140  m_framePos.x = m_framePos.y = 0;
142 
143  m_messagePanel = new EDA_MSG_PANEL( this, -1, wxPoint( 0, m_frameSize.y ),
144  wxSize( m_frameSize.x, m_msgFrameHeight ) );
145 
146  m_messagePanel->SetBackgroundColour( COLOR4D( LIGHTGRAY ).ToColour() );
147 }
ACTION_TOOLBAR * m_auxiliaryToolBar
ACTION_TOOLBAR * m_optionsToolBar
KIWAY_PLAYER(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aWdoName=wxFrameNameStr)
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
Definition: color4d.h:45
EDA_MSG_PANEL is a panel to display various information messages.
Definition: msgpanel.h:104
#define DEFAULT_MAX_UNDO_ITEMS
COLOR4D m_drawBgColor
wxChoice * m_gridSelectBox
COLOR4D m_gridColor
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
BASE_SCREEN * m_currentScreen
current used SCREEN
#define NULL
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: ui_common.cpp:57
EDA_MSG_PANEL * m_messagePanel
GAL not used (the legacy wxDC engine is used)
bool m_showBorderAndTitleBlock
wxChoice * m_zoomSelectBox
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50
COLOR_SETTINGS * m_colorSettings
wxSocketServer * m_socketServer
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits
wxFindReplaceData * m_findReplaceData
static int GetRequiredHeight()
Function GetRequiredHeight returns the required height (in pixels) of a EDA_MSG_PANEL.
Definition: msgpanel.cpp:75
long m_firstRunDialogSetting
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100
ACTION_TOOLBAR * m_drawToolBar

References _, arrayDim(), BLACK, DARKGRAY, DEFAULT_MAX_UNDO_ITEMS, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_MSG_PANEL::GetRequiredHeight(), KIUI::GetTextSize(), LIGHTGRAY, MILLIMETRES, and NULL.

◆ ~EDA_DRAW_FRAME()

EDA_DRAW_FRAME::~EDA_DRAW_FRAME ( )

Definition at line 150 of file eda_draw_frame.cpp.

151 {
152  delete m_socketServer;
153 
154  for( auto socket : m_sockets )
155  {
156  socket->Shutdown();
157  socket->Destroy();
158  }
159 
161 
162  delete m_actions;
163  delete m_toolManager;
164  delete m_toolDispatcher;
165  delete m_canvas;
166 
167  delete m_currentScreen;
169 
170  delete m_findReplaceData;
171 
172  m_auimgr.UnInit();
173 
174  ReleaseFile();
175 }
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
std::vector< wxSocketBase * > m_sockets
interprocess communication
void ReleaseFile()
Release the current file marked in use.
wxAuiManager m_auimgr
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
BASE_SCREEN * m_currentScreen
current used SCREEN
#define NULL
ACTIONS * m_actions
Definition: tools_holder.h:49
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:50
wxSocketServer * m_socketServer
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
wxFindReplaceData * m_findReplaceData
bool saveCanvasTypeSetting(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Stores the canvas type in the application settings.

References TOOLS_HOLDER::m_actions, EDA_BASE_FRAME::m_auimgr, m_canvas, m_canvasType, m_currentScreen, m_findReplaceData, m_sockets, m_socketServer, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, NULL, ReleaseFile(), and saveCanvasTypeSetting().

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )
virtual

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 647 of file eda_draw_frame.cpp.

648 {
649  GetCanvas()->SetEvtHandlerEnabled( true );
650  GetCanvas()->StartDrawing();
651 }
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 GetCanvas(), and EDA_DRAW_PANEL_GAL::StartDrawing().

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

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 386 of file eda_base_frame.cpp.

387 {
388  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
389  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
390 
391  helpMenu->Add( ACTIONS::help );
392  helpMenu->Add( ACTIONS::gettingStarted );
393  helpMenu->Add( ACTIONS::listHotKeys );
394  helpMenu->Add( ACTIONS::getInvolved );
395  helpMenu->Add( ACTIONS::reportBug );
396 
397  helpMenu->AppendSeparator();
398  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
399 
400  aMenuBar->Append( helpMenu, _( "&Help" ) );
401 }
static TOOL_ACTION listHotKeys
Definition: actions.h:177
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:179
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:176
static TOOL_ACTION getInvolved
Definition: actions.h:178
static TOOL_ACTION gettingStarted
Definition: actions.h:175

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(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), LIB_VIEW_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_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)

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 436 of file eda_draw_frame.cpp.

437 {
438  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
439  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
440 
441  aMenu.AddSeparator( 1000 );
443  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
444  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
446  if( IsType( FRAME_SCH ) || IsType( FRAME_PCB_EDITOR ) )
448 
449  aMenu.AddSeparator( 1000 );
450 
451  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
452  zoomMenu->SetTool( commonTools );
453  aToolMenu.AddSubMenu( zoomMenu );
454 
455  auto gridMenu = std::make_shared<GRID_MENU>( this );
456  gridMenu->SetTool( commonTools );
457  aToolMenu.AddSubMenu( gridMenu );
458 
459  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
460  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
461 }
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
static TOOL_ACTION zoomFitObjects
Definition: actions.h:95
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:48
bool IsType(FRAME_T aType) const
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(), FRAME_PCB_EDITOR, FRAME_SCH, TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::IsType(), TOOLS_HOLDER::m_toolManager, SELECTION_CONDITIONS::ShowAlways(), ACTIONS::zoomCenter, ACTIONS::zoomFitObjects, ACTIONS::zoomFitScreen, ACTIONS::zoomIn, and ACTIONS::zoomOut.

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

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  aTextUpper,
const wxString &  aTextLower,
int  aPadding = 6 
)

Append a message to the message panel.

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

Parameters
aTextUpper- The message upper text.
aTextLower- The message lower text.
aPadding- Number of spaces to pad between messages.

Definition at line 604 of file eda_draw_frame.cpp.

606 {
607  if( m_messagePanel )
608  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
609 }
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:114

References EDA_MSG_PANEL::AppendMessage(), and m_messagePanel.

Referenced by PCB_BASE_FRAME::Compile_Ratsnest(), GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 968 of file eda_base_frame.cpp.

969 {
970  SetUserUnits( aUnits );
972 
973  wxCommandEvent e( UNITS_CHANGED );
974  ProcessEventLocally( e );
975 }
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::SwitchUnits(), 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 866 of file eda_base_frame.cpp.

867 {
868  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
869 
870  wxFileName autoSaveFileName = aFileName;
871 
872  // Check for auto save file.
873  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
874 
875  wxLogTrace( traceAutoSave,
876  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
877 
878  if( !autoSaveFileName.FileExists() )
879  return;
880 
881  wxString msg = wxString::Format( _(
882  "Well this is potentially embarrassing!\n"
883  "It appears that the last time you were editing the file\n"
884  "\"%s\"\n"
885  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
886  aFileName.GetFullName()
887  );
888 
889  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
890 
891  // Make a backup of the current file, delete the file, and rename the auto save file to
892  // the file name.
893  if( response == wxYES )
894  {
895  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
896  {
897  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
898  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
899  }
900  }
901  else
902  {
903  wxLogTrace( traceAutoSave,
904  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
905 
906  // Remove the auto save file when using the previous file as is.
907  wxRemoveFile( autoSaveFileName.GetFullPath() );
908  }
909 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), 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 763 of file eda_base_frame.cpp.

764 {
765  if( !aFileHistory )
766  aFileHistory = m_fileHistory;
767 
768  wxASSERT( aFileHistory );
769 
770  aFileHistory->ClearFileHistory();
771 
772  // Update the menubar to update the file history menu
773  if( GetMenuBar() )
774  {
775  ReCreateMenuBar();
776  GetMenuBar()->Refresh();
777  }
778 }
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 EDA_DRAW_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtual

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

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_BASE_FRAME.

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

Definition at line 213 of file eda_draw_frame.cpp.

214 {
215  EDA_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
216 
217  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
218  KIGFX::VIEW_CONTROLS* viewControls = GetCanvas()->GetViewControls();
219 
221 
222  viewControls->LoadSettings();
223 
224  m_galDisplayOptions.ReadCommonConfig( *settings, this );
225 }
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.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
virtual void LoadSettings()
Load new settings from program common settings
void ReadCommonConfig(COMMON_SETTINGS &aCommonSettings, wxWindow *aWindow)
Read GAL config options from the common config store.
VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (such a...
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
void SetAutoSaveInterval(int aInterval)
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions

References COMMON_SETTINGS::SYSTEM::autosave_interval, EDA_BASE_FRAME::CommonSettingsChanged(), GetCanvas(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW_CONTROLS::LoadSettings(), m_galDisplayOptions, COMMON_SETTINGS::m_System, Pgm(), KIGFX::GAL_DISPLAY_OPTIONS::ReadCommonConfig(), and EDA_BASE_FRAME::SetAutoSaveInterval().

Referenced by PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), and GERBVIEW_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 659 of file eda_base_frame.cpp.

660 {
661  // KICAD_MANAGER_FRAME overrides this
662  return Kiface().KifaceSettings();
663 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), IsGridVisible(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_BASE_FRAME::libeditconfig(), OnUpdateSelectGrid(), OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SYMBOL_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(), UpdateGridSelectBox(), 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 404 of file eda_base_frame.h.

405  {
406  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
407  return baseCfgName;
408  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateServer()

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

Definition at line 48 of file eda_dde.cpp.

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

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and 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:54
static TOOL_ACTION selectionTool
Definition: actions.h:151

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:207
wxString m_modal_string
Definition: kiway_player.h:206
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:204

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

Display current grid size in the status bar.

Reimplemented in PCB_BASE_FRAME, GERBVIEW_FRAME, and PL_EDITOR_FRAME.

Definition at line 479 of file eda_draw_frame.cpp.

480 {
481  wxString line;
482 
483  line.Printf( "grid %s",
484  MessageTextFromValue( GetUserUnits(), GetCanvas()->GetGAL()->GetGridSize().x, false ) );
485 
486  SetStatusText( line, 4 );
487 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Definition: base_units.cpp:123
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

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

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 473 of file eda_draw_frame.cpp.

474 {
475  SetStatusText( msg, 6 );
476 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )

Display current unit pane in the status bar.

Definition at line 490 of file eda_draw_frame.cpp.

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

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

Referenced by UpdateGridSelectBox(), SCH_BASE_FRAME::UpdateStatusBar(), and 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 270 of file eda_base_frame.cpp.

271 {
272  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
273 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

Definition at line 228 of file eda_draw_frame.cpp.

229 {
230  if( m_messagePanel )
232 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:210

References EDA_MSG_PANEL::EraseMsgBox(), and m_messagePanel.

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).

Subclasses should override to implement actual command handlers.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 258 of file eda_draw_frame.h.

258 {}

Referenced by OnSockRequest().

◆ FocusOnLocation()

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

Parameters
aPosis the point to go to.

Definition at line 780 of file eda_draw_frame.cpp.

781 {
782  bool centerView = false;
783  BOX2D r = GetCanvas()->GetView()->GetViewport();
784 
785  // Center if we're off the current view, or within 10% of its edge
786  r.Inflate( - (int) r.GetWidth() / 10 );
787 
788  if( !r.Contains( aPos ) )
789  centerView = true;
790 
791  // Center if we're behind an obscuring dialog, or within 10% of its edge
792  wxWindow* dialog = findDialog( GetChildren() );
793 
794  if( dialog )
795  {
796  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
797  dialog->GetSize() );
798  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
799 
800  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
801  centerView = true;
802  }
803 
804  if( centerView )
805  {
806  // If a dialog partly obscures the window, then center on the uncovered area.
807  if( dialog )
808  {
809  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
810  dialog->GetSize() );
811  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
812  }
813  else
814  GetCanvas()->GetView()->SetCenter( aPos );
815  }
816 
818 }
BOX2D GetViewport() const
Function GetViewport() Returns the current viewport visible area rectangle.
Definition: view.cpp:519
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:585
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(), 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 554 of file eda_base_frame.h.

554 { 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 187 of file eda_base_frame.h.

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

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

315 { 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 179 of file eda_base_frame.h.

180  {
181  return wxT( "-bak" );
182  }

◆ GetCanvas()

virtual EDA_DRAW_PANEL_GAL* EDA_DRAW_FRAME::GetCanvas ( ) const
inlinevirtual

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

Returns
Pointer to GAL-based canvas.

Reimplemented in PCB_BASE_FRAME, PL_EDITOR_FRAME, and SCH_BASE_FRAME.

Definition at line 466 of file eda_draw_frame.h.

466 { return m_canvas; }
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.

References m_canvas.

Referenced by ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GERBVIEW_CONTROL::canvas(), EDITOR_CONDITIONS::canvasTypeFunc(), COMMON_TOOLS::CenterContents(), GERBVIEW_FRAME::Clear_DrawLayers(), CommonSettingsChanged(), DIALOG_PRINT_GERBVIEW::createPrintout(), GERBVIEW_FRAME::DisplayGridMsg(), DisplayGridMsg(), GERBVIEW_FRAME::doCloseWindow(), COMMON_TOOLS::doZoomFit(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), FocusOnLocation(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SCH_BASE_FRAME::GetCanvas(), PL_EDITOR_FRAME::GetCanvas(), PCB_BASE_FRAME::GetCanvas(), GetNearestGridPosition(), GetToolCanvas(), GERBVIEW_FRAME::GetVisibleLayers(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), ZOOM_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), STATUS_POPUP::onCharHook(), OnGridSettings(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerSelect(), GERBER_LAYER_WIDGET::OnLayerVisible(), OnMove(), GERBER_LAYER_WIDGET::onPopupSelection(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectDisplayMode(), OnUpdateSelectZoom(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), GERBER_LAYER_WIDGET::ReFill(), RefreshCanvas(), resolveCanvasType(), SaveCanvasImageToFile(), ZOOM_TOOL::selectRegion(), GERBVIEW_FRAME::SetActiveLayer(), GERBVIEW_FRAME::SetElementVisibility(), GERBVIEW_FRAME::SetGridColor(), SetGridVisibility(), GERBVIEW_FRAME::SetPageSettings(), GERBVIEW_FRAME::setupTools(), GERBVIEW_FRAME::SetVisibleLayers(), GERBVIEW_FRAME::SortLayersByX2Attributes(), SwitchCanvas(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), ZOOM_MENU::update(), GERBVIEW_FRAME::UpdateDisplayOptions(), GERBVIEW_FRAME::UpdateStatusBar(), and GERBVIEW_FRAME::~GERBVIEW_FRAME().

◆ GetColorSettings()

COLOR_SETTINGS * EDA_DRAW_FRAME::GetColorSettings ( )
virtual

Returns a pointer to the active color theme settings.

Reimplemented in SCH_BASE_FRAME, SYMBOL_EDIT_FRAME, PCB_BASE_EDIT_FRAME, PCB_BASE_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_EDIT_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 941 of file eda_draw_frame.cpp.

942 {
943  if( !m_colorSettings )
944  m_colorSettings = Pgm().GetSettingsManager().GetColorSettings();
945 
946  return m_colorSettings;
947 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
COLOR_SETTINGS * m_colorSettings

References m_colorSettings, and Pgm().

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), and GERBVIEW_CONTROL::Print().

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

485 { 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, SYMBOL_EDIT_FRAME, LIB_VIEW_FRAME, DISPLAY_FOOTPRINTS_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 123 of file tools_holder.h.

124  {
125  return m_dummySelection;
126  }
SELECTION m_dummySelection
Definition: tools_holder.h:52

References TOOLS_HOLDER::m_dummySelection.

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

◆ GetDocumentExtents()

const BOX2I EDA_DRAW_FRAME::GetDocumentExtents ( bool  aIncludeAllVisible = true) const
virtual

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

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

Parameters
aIncludeAllVisible- True = Include everything visible in bbox calculations False = Ignore some visible items (program dependent)
Returns
BOX2I - Bounding box of document (ignoring some items as requested)

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

Definition at line 750 of file eda_draw_frame.cpp.

751 {
752  return BOX2I();
753 }
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 147 of file tools_holder.h.

147 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:61

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 153 of file tools_holder.h.

153 { return m_dragSelects; }
bool m_dragSelects
Definition: tools_holder.h:65

References TOOLS_HOLDER::m_dragSelects.

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

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtual

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

725 {
726  if( !aFileHistory )
727  aFileHistory = m_fileHistory;
728 
729  wxASSERT( aFileHistory );
730 
731  int baseId = aFileHistory->GetBaseId();
732 
733  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
734 
735  unsigned i = cmdId - baseId;
736 
737  if( i < aFileHistory->GetCount() )
738  {
739  wxString fn = aFileHistory->GetHistoryFile( i );
740 
741  if( wxFileName::FileExists( fn ) )
742  return fn;
743  else
744  {
745  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
746  wxMessageBox( msg );
747 
748  aFileHistory->RemoveFileFromHistory( i );
749  }
750  }
751 
752  // Update the menubar to update the file history menu
753  if( GetMenuBar() )
754  {
755  ReCreateMenuBar();
756  GetMenuBar()->Refresh();
757  }
758 
759  return wxEmptyString;
760 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#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 470 of file eda_base_frame.h.

471  {
472  return *m_fileHistory;
473  }
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 ( )
inline

Definition at line 167 of file eda_draw_frame.h.

167 { return m_findStringHistoryList; }
wxArrayString m_findStringHistoryList

References m_findStringHistoryList.

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

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inline

Definition at line 166 of file eda_draw_frame.h.

166 { return *m_findReplaceData; }
wxFindReplaceData * m_findReplaceData

References m_findReplaceData.

Referenced by DIALOG_FIND::search().

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtual

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

Definition at line 275 of file eda_draw_frame.h.

275 { return m_gridColor; }
COLOR4D m_gridColor

References m_gridColor.

Referenced by PCBNEW_CONTROL::Reset().

◆ GetGridOrigin()

virtual const wxPoint& EDA_DRAW_FRAME::GetGridOrigin ( ) const
pure virtual

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.

Implemented in PCB_BASE_FRAME, SCH_BASE_FRAME, PL_EDITOR_FRAME, and GERBVIEW_FRAME.

Referenced by GetNearestGridPosition(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), and DIALOG_GRID_SETTINGS::TransferDataToWindow().

◆ GetInfoBar()

◆ GetItem()

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

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 442 of file eda_draw_frame.h.

442 { return nullptr; }

Referenced by PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), and EE_SELECTION_TOOL::Main().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 633 of file eda_base_frame.h.

633 { return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by 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 159 of file tools_holder.h.

159 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:66

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 736 of file eda_draw_frame.cpp.

737 {
738  const wxPoint& gridOrigin = GetGridOrigin();
739  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
740 
741  double xOffset = fmod( gridOrigin.x, gridSize.x );
742  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
743  double yOffset = fmod( gridOrigin.y, gridSize.y );
744  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
745 
746  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
747 }
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 GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), VECTOR2< T >::x, 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 ( )
inlinevirtual

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented in PCB_BASE_FRAME.

Definition at line 212 of file eda_draw_frame.h.

213  { return m_originTransforms; }
ORIGIN_TRANSFORMS m_originTransforms
Default display origin transforms object.

References m_originTransforms.

Referenced by DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), and LEADER::GetMsgPanelInfo().

◆ GetPageSettings()

◆ GetPageSizeIU()

virtual const wxSize EDA_DRAW_FRAME::GetPageSizeIU ( ) const
pure virtual

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

Implemented in PCB_BASE_FRAME, SCH_BASE_FRAME, PL_EDITOR_FRAME, and GERBVIEW_FRAME.

Referenced by PL_DRAW_PANEL_GAL::DisplayWorksheet().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetScreen()

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtual

Reimplemented in SCH_EDIT_FRAME.

Definition at line 876 of file eda_draw_frame.cpp.

877 {
878  // Virtual function. Base class implementation returns an empty string.
879  return wxEmptyString;
880 }

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

◆ GetSettingsManager()

◆ GetSeverity()

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

Reimplemented in PCB_BASE_FRAME.

Definition at line 255 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inline

For those frames that support polar coordinates.

Definition at line 181 of file eda_draw_frame.h.

181 { return m_polarCoords; }

References m_polarCoords.

Referenced by EDITOR_CONDITIONS::polarCoordFunc(), COMMON_TOOLS::TogglePolarCoords(), GERBVIEW_FRAME::UpdateStatusBar(), and PCB_BASE_FRAME::UpdateStatusBar().

◆ GetTitleBlock()

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 469 of file eda_draw_frame.h.

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

References GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 76 of file tools_holder.h.

76 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48

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_FOOTPRINT_CHECKER::deleteAllMarkers(), 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_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), SCH_FIELD::DoHypertextMenu(), 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(), SCH_NAVIGATE_TOOL::HypertextCommand(), ROUTER_TOOL::InlineBreakTrack(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SYMBOL_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), DIALOG_INSPECTION_REPORTER::OnErrorLinkClicked(), 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(), resolveCanvasType(), 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(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::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(), UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
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

◆ GetUnitPair()

void EDA_DRAW_FRAME::GetUnitPair ( EDA_UNITS aPrimaryUnit,
EDA_UNITS aSecondaryUnits 
)

Get the pair or units in current use.

The primary unit is the main unit of the frame, and the secondary unit is the unit of the other system that was used most recently.

Definition at line 972 of file eda_draw_frame.cpp.

973 {
975 
976  aPrimaryUnit = GetUserUnits();
977  aSecondaryUnits = EDA_UNITS::MILS;
978 
979  if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
980  {
981  if( cmnTool )
982  aSecondaryUnits = cmnTool->GetLastMetricUnits();
983  else
984  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
985  }
986  else
987  {
988  if( cmnTool )
989  aSecondaryUnits = cmnTool->GetLastImperialUnits();
990  else
991  aSecondaryUnits = EDA_UNITS::MILS;
992  }
993 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:75
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:26
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:76
COMMON_TOOLS.
Definition: common_tools.h:38
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), TOOLS_HOLDER::m_toolManager, MILLIMETRES, and MILS.

Referenced by GRID_MENU::BuildChoiceList(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 239 of file eda_base_frame.h.

240  {
241  return m_userUnits;
242  }
EDA_UNITS m_userUnits

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), 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_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), 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_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), WS_DRAW_ITEM_BASE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), PCB_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_NET_INSPECTOR::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(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_FEATURE_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), 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 653 of file eda_base_frame.cpp.

654 {
655  return &aCfg->m_Window;
656 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:173

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_BASE_FRAME::LoadSettings(), LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and 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 1000 of file eda_base_frame.cpp.

1001 {
1002 #ifdef __WXGTK__
1003  // GTK includes the window decorations in the normal GetSize call,
1004  // so we have to use a GTK-specific sizing call that returns the
1005  // non-decorated window size.
1006  int width = 0;
1007  int height = 0;
1008  GTKDoGetSize( &width, &height );
1009 
1010  wxSize winSize( width, height );
1011 #else
1012  wxSize winSize = GetSize();
1013 #endif
1014 
1015  return winSize;
1016 }

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

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const

Return a human readable value for display in dialogs.

Definition at line 526 of file eda_draw_frame.cpp.

527 {
528  // returns a human readable value which can be displayed as zoom
529  // level indicator in dialogs.
530  double zoom = m_canvas->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
531  return wxString::Format( wxT( "Z %.2f" ), zoom );
532 }
#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, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

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

Referenced by 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 318 of file eda_base_frame.cpp.

320 {
321  bool checkRes = false;
322  bool enableRes = true;
323  bool showRes = true;
324  SELECTION& selection = aFrame->GetCurrentSelection();
325 
326  try
327  {
328  checkRes = aCond.checkCondition( selection );
329  enableRes = aCond.enableCondition( selection );
330  showRes = aCond.showCondition( selection );
331  }
332  catch( std::exception& )
333  {
334  // Something broke with the conditions, just skip the event.
335  aEvent.Skip();
336  return;
337  }
338 
339  aEvent.Enable( enableRes );
340  aEvent.Show( showRes );
341 
342  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
343  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
344 #if wxCHECK_VERSION( 3, 1, 5 )
345  if( aEvent.IsCheckable() )
346  aEvent.Check( checkRes );
347 #else
348  bool canCheck = true;
349 
350  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
351  // see if they can be and can't just universally apply a check in this event.
352  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
353  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
354 
355  if( canCheck )
356  aEvent.Check( checkRes );
357 #endif
358 }
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:123

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

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )
virtual

Rebuild the GAL and redraws the screen.

Call when something went wrong.

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, SCH_BASE_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 756 of file eda_draw_frame.cpp.

757 {
758  // To be implemented by subclasses.
759 }

Referenced by COMMON_TOOLS::ZoomRedraw().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 672 of file eda_base_frame.cpp.

673 {
674  return Kiface().GetHelpFileName();
675 }
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 ( )
protected

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 464 of file eda_draw_frame.cpp.

465 {
466  wxAcceleratorEntry entries[1];
467  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
468  wxAcceleratorTable accel( 1, entries );
469  SetAcceleratorTable( accel );
470 }

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 SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 350 of file eda_base_frame.h.

350 { }

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

202 { 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, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 912 of file eda_base_frame.cpp.

913 {
914  // This function should be overridden in child classes
915  return false;
916 }

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:54
static TOOL_ACTION selectionTool
Definition: actions.h:151
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:204

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridVisible()

bool EDA_DRAW_FRAME::IsGridVisible ( ) const

◆ 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 178 of file kiway_player.h.

178 { 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 317 of file eda_base_frame.h.

317 { return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), AddStandardSubMenus(), 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(), FOOTPRINT::GetMsgPanelInfo(), CONVERT_TOOL::Init(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), LIB_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), 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 822 of file eda_base_frame.cpp.

823 {
824  wxString msg;
825  wxFileName fn = aFileName;
826 
827  // Check for absence of a file path with a file name. Unfortunately KiCad
828  // uses paths relative to the current project path without the ./ part which
829  // confuses wxFileName. Making the file name path absolute may be less than
830  // elegant but it solves the problem.
831  if( fn.GetPath().IsEmpty() && fn.HasName() )
832  fn.MakeAbsolute();
833 
834  wxCHECK_MSG( fn.IsOk(), false,
835  wxT( "File name object is invalid. Bad programmer!" ) );
836  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
837  wxT( "File name object path <" ) + fn.GetFullPath() +
838  wxT( "> is not set. Bad programmer!" ) );
839 
840  if( fn.IsDir() && !fn.IsDirWritable() )
841  {
842  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
843  fn.GetPath() );
844  }
845  else if( !fn.FileExists() && !fn.IsDirWritable() )
846  {
847  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
848  fn.GetFullName(), fn.GetPath() );
849  }
850  else if( fn.FileExists() && !fn.IsFileWritable() )
851  {
852  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
853  fn.GetFullPath() );
854  }
855 
856  if( !msg.IsEmpty() )
857  {
858  wxMessageBox( msg );
859  return false;
860  }
861 
862  return true;
863 }
#define _(s)
Definition: 3d_actions.cpp:33

References _.

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(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), 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::GetFootprint(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::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(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), 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::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), 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 SYMBOL_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:447

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

◆ LibraryFileBrowser()

bool EDA_DRAW_FRAME::LibraryFileBrowser ( bool  doOpen,
wxFileName &  aFilename,
const wxString &  wildcard,
const wxString &  ext,
bool  isDirectory = false 
)
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 883 of file eda_draw_frame.cpp.

886 {
887  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
888  aFilename.SetExt( ext );
889 
890  if( isDirectory && doOpen )
891  {
892  wxDirDialog dlg( this, prompt, Prj().GetProjectPath(),
893  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
894 
895  if( dlg.ShowModal() == wxID_CANCEL )
896  return false;
897 
898  aFilename = dlg.GetPath();
899  aFilename.SetExt( ext );
900  }
901  else
902  {
903  // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
904  if( aFilename.GetName().empty() )
905  aFilename.SetName( "Library" );
906 
907  wxString dir = Prj().IsNullProject() ? aFilename.GetFullPath() : Prj().GetProjectPath();
908 
909  wxFileDialog dlg( this, prompt, dir, aFilename.GetFullName(),
910  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
911  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
912 
913  if( dlg.ShowModal() == wxID_CANCEL )
914  return false;
915 
916  aFilename = dlg.GetPath();
917  aFilename.SetExt( ext );
918  }
919 
920  return true;
921 }
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:122
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:134
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ loadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting ( )
protected

Returns the canvas type stored in the application settings.

Definition at line 663 of file eda_draw_frame.cpp.

664 {
665 #ifdef __WXMAC__
666  // Cairo renderer doesn't handle Retina displays so there's really only one game
667  // in town for Mac
669 #endif
670 
673 
674  if( cfg )
675  canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
676 
677  if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
678  || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
679  {
680  wxASSERT( false );
682  }
683 
684  // Legacy canvas no longer supported. Switch to Cairo, and on the first instantiation
685  // the user will be prompted to switch to OpenGL
686  if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
688 
689  return canvasType;
690 }
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 SCH_BASE_FRAME::createCanvas(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), and resolveCanvasType().

◆ LoadSettings()

void EDA_DRAW_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 PCB_BASE_FRAME, PCB_EDIT_FRAME, FOOTPRINT_WIZARD_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 535 of file eda_draw_frame.cpp.

536 {
538 
539  COMMON_SETTINGS* cmnCfg = Pgm().GetCommonSettings();
540  WINDOW_SETTINGS* window = GetWindowSettings( aCfg );
541 
542  // Read units used in dialogs and toolbars
543  SetUserUnits( static_cast<EDA_UNITS>( aCfg->m_System.units ) );
544 
547 
548  m_galDisplayOptions.ReadConfig( *cmnCfg, *window, this );
549 
550  m_findReplaceData->SetFlags( aCfg->m_FindReplace.flags );
551  m_findReplaceData->SetFindString( aCfg->m_FindReplace.find_string );
552  m_findReplaceData->SetReplaceString( aCfg->m_FindReplace.replace_string );
553 
554  for( auto& s : aCfg->m_FindReplace.find_history )
555  m_findStringHistoryList.Add( s );
556 
557  for( auto& s : aCfg->m_FindReplace.replace_history )
559 }
std::vector< wxString > find_history
Definition: app_settings.h:108
wxArrayString m_findStringHistoryList
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
Stores the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:81
FIND_REPLACE m_FindReplace
Definition: app_settings.h:161
wxArrayString m_replaceStringHistoryList
std::vector< wxString > replace_history
Definition: app_settings.h:110
virtual WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg)
Returns a pointer to the window settings for this frame.
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
void ReadConfig(COMMON_SETTINGS &aCommonConfig, WINDOW_SETTINGS &aWindowConfig, wxWindow *aWindow)
Read application and common configs.
wxFindReplaceData * m_findReplaceData
void SetUserUnits(EDA_UNITS aUnits)
long m_firstRunDialogSetting
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.

References APP_SETTINGS_BASE::FIND_REPLACE::find_history, APP_SETTINGS_BASE::FIND_REPLACE::find_string, APP_SETTINGS_BASE::SYSTEM::first_run_shown, APP_SETTINGS_BASE::FIND_REPLACE::flags, EDA_BASE_FRAME::GetWindowSettings(), EDA_BASE_FRAME::LoadSettings(), APP_SETTINGS_BASE::m_FindReplace, m_findReplaceData, m_findStringHistoryList, m_firstRunDialogSetting, m_galDisplayOptions, m_replaceStringHistoryList, APP_SETTINGS_BASE::m_System, m_undoRedoCountMax, APP_SETTINGS_BASE::SYSTEM::max_undo_items, Pgm(), KIGFX::GAL_DISPLAY_OPTIONS::ReadConfig(), APP_SETTINGS_BASE::FIND_REPLACE::replace_history, APP_SETTINGS_BASE::FIND_REPLACE::replace_string, EDA_BASE_FRAME::SetUserUnits(), and APP_SETTINGS_BASE::SYSTEM::units.

Referenced by SCH_BASE_FRAME::LoadSettings(), PL_EDITOR_FRAME::LoadSettings(), GERBVIEW_FRAME::LoadSettings(), and PCB_BASE_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 553 of file eda_base_frame.cpp.

554 {
555  LoadWindowState( aCfg->state );
556 
557  if( m_hasAutoSave )
558  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
559 
560  m_perspective = aCfg->perspective;
561  m_mruPath = aCfg->mru_path;
562 
563  TOOLS_HOLDER::CommonSettingsChanged( false, false );
564 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
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 435 of file eda_base_frame.cpp.

436 {
437  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
438  return;
439 
440  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
441 
442  if( state != nullptr )
443  {
444  LoadWindowState( state->window );
445  }
446 }
VTBL_ENTRY PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:149
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
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 449 of file eda_base_frame.cpp.

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

References PCAD2KICAD::Center, WINDOW_STATE::display, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, s_defaultSize_x, s_defaultSize_y, s_minsize_x, s_minsize_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ LockFile()

bool EDA_DRAW_FRAME::LockFile ( const wxString &  aFileName)

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 184 of file eda_draw_frame.cpp.

185 {
186  m_file_checker = ::LockFile( aFileName );
187 
188  return bool( m_file_checker );
189 }
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 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 635 of file eda_base_frame.h.

636  {
637  m_isNonUserClose = true;
638  return Close( aForce );
639  }

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

264 {
265  if( !doAutoSave() )
266  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
267 }
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 276 of file eda_base_frame.cpp.

277 {
278  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
279  // Key events can be filtered here.
280  // Currently no filtering is made.
281  event.Skip();
282 }
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)

Definition at line 316 of file eda_draw_frame.cpp.

317 {
318  DIALOG_GRID_SETTINGS dlg( this );
319 
320  if( dlg.ShowModal() == wxID_OK )
321  {
322  UpdateStatusBar();
323  GetCanvas()->Refresh();
324  }
325 }
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 GetCanvas(), EDA_DRAW_PANEL_GAL::Refresh(), and UpdateStatusBar().

Referenced by OnSelectGrid().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 781 of file eda_base_frame.cpp.

782 {
783  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
784  ShowAboutDialog( this );
785 }
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 978 of file eda_base_frame.cpp.

979 {
980  // When we maximize the window, we want to save the old information
981  // so that we can add it to the settings on next window load.
982  // Contrary to the documentation, this event seems to be generated
983  // when the window is also being unmaximized on OSX, so we only
984  // capture the size information when we maximize the window when on OSX.
985 #ifdef __WXOSX__
986  if( !IsMaximized() )
987 #endif
988  {
990  m_normalFramePos = GetPosition();
991  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
993  }
994 
995  // Skip event to actually maximize the window
996  aEvent.Skip();
997 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxSize m_normalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, and traceDisplayLocation.

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

286 {
287  if( !m_toolDispatcher )
288  aEvent.Skip();
289  else
291 }
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:50

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

◆ OnMove()

void EDA_DRAW_FRAME::OnMove ( wxMoveEvent &  aEvent)
overridevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 419 of file eda_draw_frame.cpp.

420 {
421  // If the window is moved to a different display, the scaling factor may change
422  double oldFactor = m_galDisplayOptions.m_scaleFactor;
424 
425  if( oldFactor != m_galDisplayOptions.m_scaleFactor && m_canvas )
426  {
427  wxSize clientSize = GetClientSize();
428  GetCanvas()->GetGAL()->ResizeScreen( clientSize.x, clientSize.y );
429  GetCanvas()->GetView()->MarkDirty();
430  }
431 
432  aEvent.Skip();
433 }
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:596

References GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_PANEL_GAL::GetView(), m_canvas, 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 ( )
inlinevirtual

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 379 of file eda_draw_frame.h.

379 {}

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 788 of file eda_base_frame.cpp.

789 {
790  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
791  wxTreebook* book = dlg.GetTreebook();
792 
793  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
794 
795  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
796 
797  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
798  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
799 
800  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
801  {
802  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
803 
804  if( frame )
805  frame->InstallPreferences( &dlg, hotkeysPanel );
806  }
807 
808  // The Kicad manager frame is not a player so we have to add it by hand
809  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
810 
811  if( manager )
812  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
813 
814  for( size_t i = 0; i < book->GetPageCount(); ++i )
815  book->GetPage( i )->Layout();
816 
817  if( dlg.ShowModal() == wxID_OK )
818  dlg.Kiway().CommonSettingsChanged( false, false );
819 }
KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of ...
Definition: kiway_player.h:61
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:345
#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().

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent &  event)

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 from the grid size combobox on the toolbar.

Definition at line 283 of file eda_draw_frame.cpp.

284 {
285  wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );
286 
287  int idx = m_gridSelectBox->GetCurrentSelection();
288 
289  if( idx == int( m_gridSelectBox->GetCount() ) - 2 )
290  {
291  // wxWidgets will check the separator, which we don't want.
292  // Re-check the current grid.
293  wxUpdateUIEvent dummy;
295  }
296  else if( idx == int( m_gridSelectBox->GetCount() ) - 1 )
297  {
298  // wxWidgets will check the Grid Settings... entry, which we don't want.
299  // Re-check the current grid.
300  wxUpdateUIEvent dummy;
302  // Now run the Grid Settings... dialog
303  wxCommandEvent dummy2;
304  OnGridSettings( dummy2 );
305  }
306  else
307  {
309  }
310 
311  UpdateStatusBar();
312  m_canvas->Refresh();
313 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
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:48
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, m_canvas, m_gridSelectBox, TOOLS_HOLDER::m_toolManager, OnGridSettings(), OnUpdateSelectGrid(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), and UpdateStatusBar().

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent &  event)
virtual

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 404 of file eda_draw_frame.cpp.

405 {
406  wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );
407 
408  int id = m_zoomSelectBox->GetCurrentSelection();
409 
410  if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
411  return;
412 
413  m_toolManager->RunAction( "common.Control.zoomPreset", true, id );
414  UpdateStatusBar();
415  m_canvas->Refresh();
416 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
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:48
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnSize()

void EDA_DRAW_FRAME::OnSize ( wxSizeEvent &  event)
virtual

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 506 of file eda_draw_frame.cpp.

507 {
508  m_frameSize = GetClientSize( );
509 
510  SizeEv.Skip();
511 }

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)

Definition at line 70 of file eda_dde.cpp.

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

References client_ipc_buffer, ExecuteRemoteCommand(), and IPC_BUF_SIZE.

◆ OnSockRequestServer()

void EDA_DRAW_FRAME::OnSockRequestServer ( wxSocketEvent &  evt)

Definition at line 102 of file eda_dde.cpp.

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

References ID_EDA_SOCKET_EVENT, m_sockets, and NULL.

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent)

Update the checked item in the grid combobox.

Definition at line 259 of file eda_draw_frame.cpp.

260 {
261  // No need to update the grid select box if it doesn't exist or the grid setting change
262  // was made using the select box.
263  if( m_gridSelectBox == NULL )
264  return;
265 
266  int idx = config()->m_Window.grid.last_size_idx;
267  idx = std::max( 0, std::min( idx, (int) m_gridSelectBox->GetCount() - 1 ) );
268 
269  if( idx != m_gridSelectBox->GetSelection() )
270  m_gridSelectBox->SetSelection( idx );
271 }
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:173

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

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

◆ OnUpdateSelectZoom()

void EDA_DRAW_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent &  aEvent)

Update the checked item in the zoom combobox.

Definition at line 377 of file eda_draw_frame.cpp.

378 {
379  if( m_zoomSelectBox == NULL || m_zoomSelectBox->GetParent() == NULL )
380  return;
381 
382  int current = 0; // display Auto if no match found
383 
384  // check for a match within 1%
385  double zoom = GetCanvas()->GetGAL()->GetZoomFactor() / ZOOM_COEFF;
386 
387  for( unsigned i = 0; i < config()->m_Window.zoom_factors.size(); i++ )
388  {
389  if( std::fabs( zoom - config()->m_Window.zoom_factors[i] ) < ( zoom / 100.0 ) )
390  {
391  current = i + 1;
392  break;
393  }
394  }
395 
396  if( current != m_zoomSelectBox->GetSelection() )
397  m_zoomSelectBox->SetSelection( current );
398 }
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:173

References EDA_BASE_FRAME::config(), GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), APP_SETTINGS_BASE::m_Window, 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 120 of file kiway_player.h.

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

Referenced by BACK_ANNOTATE::FetchNetlistFromPCB(), PGM_SINGLE_TOP::MacOpenFile(), PGM_TEST_FRAME::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 140 of file kiway_player.h.

141  {
142  WXUNUSED( aParser );
143  }

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

963 {
964  return m_redoList.PopCommand();
965 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

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

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), 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:141
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:48
std::vector< std::string > m_toolStack
Definition: tools_holder.h:54
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:200
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:76
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:274
static TOOL_ACTION selectionTool
Definition: actions.h:151
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(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::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 678 of file eda_base_frame.cpp.

679 {
680  SetStatusText( text );
681 }

◆ PrintPage()

void EDA_DRAW_FRAME::PrintPage ( RENDER_SETTINGS aSettings)
virtual

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, SYMBOL_EDIT_FRAME, and PL_EDITOR_FRAME.

Definition at line 274 of file eda_draw_frame.cpp.

275 {
276  wxMessageBox( wxT("EDA_DRAW_FRAME::PrintPage() error") );
277 }

◆ PrintWorkSheet()

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

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 848 of file eda_draw_frame.cpp.

851 {
853  return;
854 
855  wxDC* DC = aSettings->GetPrintDC();
856  wxPoint origin = DC->GetDeviceOrigin();
857 
858  if( origin.y > 0 )
859  {
860  DC->SetDeviceOrigin( 0, 0 );
861  DC->SetAxisOrientation( true, false );
862  }
863 
864  PrintPageLayout( aSettings, GetPageSettings(), GetScreenDesc(), aFilename, GetTitleBlock(),
865  aScreen->GetPageCount(), aScreen->GetPageNumber(), aScalar, &Prj(),
866  aSheetLayer, aScreen->GetVirtualPageNumber() == 1 );
867 
868  if( origin.y > 0 )
869  {
870  DC->SetDeviceOrigin( origin.x, origin.y );
871  DC->SetAxisOrientation( true, true );
872  }
873 }
virtual const TITLE_BLOCK & GetTitleBlock() const =0
int GetVirtualPageNumber() const
Definition: base_screen.h:140
int GetPageCount() const
Definition: base_screen.h:137
const wxString & GetPageNumber() const
Definition: base_screen.cpp:79
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, const wxString &aPageNumber, double aScalar, const PROJECT *aProject, const wxString &aSheetLayer, bool aIsFirstPage)
Print the border and title block.
virtual wxString GetScreenDesc() const

References BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), GetPageSettings(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetScreenDesc(), GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), m_showBorderAndTitleBlock, PrintPageLayout(), and KIWAY_HOLDER::Prj().

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:174

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::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::DeleteFootprintFromLibrary(), 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_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), 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(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), 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(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), 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(), SYMBOL_EDIT_FRAME::KiwayMailIn(), LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::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_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::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(), SCH_BASE_FRAME::PickSymbolFromLibTree(), 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(), PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SaveOneSymbol(), SYMBOL_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(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_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(), SYMBOL_LIBRARY_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_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), 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 205 of file eda_base_frame.cpp.

206 {
207 #ifdef __WXMAC__
208  // Apple in its infinite wisdom will raise a disabled window before even passing
209  // us the event, so we have no way to stop it. Instead, we have to catch an
210  // improperly ordered disabled window and quasi-modal dialog here and reorder
211  // them.
212  if( !IsEnabled() && IsActive() )
213  {
214  wxWindow* dlg = findQuasiModalDialog();
215  if( dlg )
216  dlg->Raise();
217  }
218 #endif
219 
220  if( !wxFrame::ProcessEvent( aEvent ) )
221  return false;
222 
223  if( IsShown() && m_hasAutoSave && IsActive() &&
225  {
226  if( !m_autoSaveState )
227  {
228  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
229  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
230  m_autoSaveState = true;
231  }
232  else if( m_autoSaveTimer->IsRunning() )
233  {
234  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
235  m_autoSaveTimer->Stop();
236  m_autoSaveState = false;
237  }
238  }
239 
240  return true;
241 }
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 552 of file eda_base_frame.h.

552 {}

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

942 {
943  m_redoList.PushCommand( aNewitem );
944 
945  // Delete the extra items, if count max reached
946  if( m_undoRedoCountMax > 0 )
947  {
948  int extraitems = GetRedoCommandCount() - m_undoRedoCountMax;
949 
950  if( extraitems > 0 )
951  ClearUndoORRedoList( REDO_LIST, extraitems );
952  }
953 }
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 PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), 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 926 of file eda_base_frame.cpp.

927 {
928  m_undoList.PushCommand( aNewitem );
929 
930  // Delete the extra items, if count max reached
931  if( m_undoRedoCountMax > 0 )
932  {
933  int extraitems = GetUndoCommandCount() - m_undoRedoCountMax;
934 
935  if( extraitems > 0 )
936  ClearUndoORRedoList( UNDO_LIST, extraitems );
937  }
938 }
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 PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_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:141
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:48
std::vector< std::string > m_toolStack
Definition: tools_holder.h:54
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:200
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(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::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 ( )
inlinevirtual

Reimplemented in PCB_EDIT_FRAME, and GERBVIEW_FRAME.

Definition at line 266 of file eda_draw_frame.h.

266 { }

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

◆ ReCreateHToolbar()

◆ ReCreateMenuBar()

void EDA_DRAW_FRAME::ReCreateMenuBar ( )
inlineoverridevirtual

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 262 of file eda_draw_frame.h.

262 { }

◆ ReCreateOptToolbar()

◆ RecreateToolbars()

void EDA_DRAW_FRAME::RecreateToolbars ( )

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

Definition at line 924 of file eda_draw_frame.cpp.

925 {
926  // Rebuild all toolbars, and update the checked state of check tools
927  if( m_mainToolBar )
929 
930  if( m_drawToolBar ) // Drawing tools (typically on right edge of window)
932 
933  if( m_optionsToolBar ) // Options (typically on left edge of window)
935 
936  if( m_auxiliaryToolBar ) // Additional tools under main toolbar
938 }
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 m_auxiliaryToolBar, m_drawToolBar, m_mainToolBar, m_optionsToolBar, ReCreateAuxiliaryToolbar(), ReCreateHToolbar(), ReCreateOptToolbar(), and ReCreateVToolbar().

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

◆ ReCreateVToolbar()

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )
inlineoverridevirtual

Reimplemented from TOOLS_HOLDER.

Definition at line 476 of file eda_draw_frame.h.

477  {
478  GetCanvas()->Refresh();
479  }
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 GetCanvas(), and EDA_DRAW_PANEL_GAL::Refresh().

◆ RegisterUIUpdateHandler() [1/2]

virtual void TOOLS_HOLDER::RegisterUIUpdateHandler ( const TOOL_ACTION aAction,
const ACTION_CONDITIONS aConditions 
)
inlinevirtualinherited

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

Definition at line 85 of file tools_holder.h.

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

References TOOL_ACTION::GetUIId().

Referenced by ACTION_TOOLBAR::doSelectAction(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

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

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

Reimplemented from TOOLS_HOLDER.

Definition at line 294 of file eda_base_frame.cpp.

295 {
297  std::placeholders::_1,
298  this,
299  aConditions );
300 
301  m_uiUpdateMap[aID] = evtFunc;
302 
303  Bind( wxEVT_UPDATE_UI, evtFunc, aID );
304 }
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.

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

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )

Release the current file marked in use.

See m_file_checker.

Definition at line 178 of file eda_draw_frame.cpp.

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

References m_file_checker.

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

◆ resolveCanvasType()

void EDA_DRAW_FRAME::resolveCanvasType ( )
protected

Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.

Definition at line 996 of file eda_draw_frame.cpp.

997 {
999 
1000  // Nudge user to switch to OpenGL if they are on legacy or Cairo
1001  if( m_firstRunDialogSetting < 1 )
1002  {
1004  {
1005  wxString msg =
1006  _( "KiCad can use your graphics card to give you a smoother "
1007  "and faster experience. This option is turned off by "
1008  "default since it is not compatible with all computers.\n\n"
1009  "Would you like to try enabling graphics acceleration?\n\n"
1010  "If you'd like to choose later, select Accelerated Graphics "
1011  "in the Preferences menu." );
1012 
1013  wxMessageDialog dlg( this, msg, _( "Enable Graphics Acceleration" ), wxYES_NO );
1014 
1015  dlg.SetYesNoLabels( _( "&Enable Acceleration" ), _( "&No Thanks" ) );
1016 
1017  if( dlg.ShowModal() == wxID_YES )
1018  {
1019  // Save Cairo as default in case OpenGL crashes
1021 
1022  // Switch to OpenGL, which will save the new setting if successful
1024 
1025  // Switch back to Cairo if OpenGL is not supported
1026  if( GetCanvas()->GetBackend() == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
1028  }
1029  else
1030  {
1031  // If they were on legacy, switch to Cairo
1033  }
1034  }
1035 
1037  SaveSettings( config() );
1038  }
1039 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:141
static TOOL_ACTION standardGraphics
Definition: actions.h:164
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Saves common frame parameters to a configuration data file.
GAL not used (the legacy wxDC engine is used)
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION acceleratedGraphics
Definition: actions.h:163
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:76
bool saveCanvasTypeSetting(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Stores the canvas type in the application settings.
long m_firstRunDialogSetting

References _, ACTIONS::acceleratedGraphics, EDA_BASE_FRAME::config(), EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetCanvas(), TOOLS_HOLDER::GetToolManager(), loadCanvasTypeSetting(), m_canvasType, m_firstRunDialogSetting, TOOL_MANAGER::RunAction(), saveCanvasTypeSetting(), SaveSettings(), and ACTIONS::standardGraphics.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME().

◆ saveCanvasTypeSetting()

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

Stores the canvas type in the application settings.

Definition at line 693 of file eda_draw_frame.cpp.

694 {
695  // Not all classes derived from EDA_DRAW_FRAME can save the canvas type, because some
696  // have a fixed type, or do not have a option to set the canvas type (they inherit from
697  // a parent frame)
698  FRAME_T allowed_frames[] =
699  {
700  FRAME_SCH,
702  FRAME_GERBER,
704  };
705 
706  bool allow_save = false;
707 
708  for( unsigned ii = 0; ii < arrayDim( allowed_frames ); ii++ )
709  {
710  if( m_ident == allowed_frames[ii] )
711  {
712  allow_save = true;
713  break;
714  }
715  }
716 
717  if( !allow_save )
718  return false;
719 
720  if( aCanvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
721  || aCanvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
722  {
723  wxASSERT( false );
724  return false;
725  }
726 
728 
729  if( cfg )
730  cfg->m_Graphics.canvas_type = static_cast<int>( aCanvasType );
731 
732  return false;
733 }
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
Returns # of elements in an array.
Definition: arraydim.h:31

References arrayDim(), APP_SETTINGS_BASE::GRAPHICS::canvas_type, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_EDITOR, FRAME_PL_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 resolveCanvasType(), and ~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 417 of file eda_base_frame.h.

417 {};

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ SaveSettings()

void EDA_DRAW_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 PCB_BASE_FRAME, PCB_EDIT_FRAME, FOOTPRINT_WIZARD_FRAME, PL_EDITOR_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 562 of file eda_draw_frame.cpp.

563 {
565 
566  WINDOW_SETTINGS* window = GetWindowSettings( aCfg );
567 
568  aCfg->m_System.units = static_cast<int>( m_userUnits );
571 
572  m_galDisplayOptions.WriteConfig( *window );
573 
574  aCfg->m_FindReplace.flags = m_findReplaceData->GetFlags();
575  aCfg->m_FindReplace.find_string = m_findReplaceData->GetFindString();
576  aCfg->m_FindReplace.replace_string = m_findReplaceData->GetReplaceString();
577 
578  aCfg->m_FindReplace.find_history.clear();
579  aCfg->m_FindReplace.replace_history.clear();
580 
581  for( size_t i = 0; i < m_findStringHistoryList.GetCount() && i < FR_HISTORY_LIST_CNT; i++ )
582  {
583  aCfg->m_FindReplace.find_history.push_back( m_findStringHistoryList[ i ].ToStdString() );
584  }
585 
586  for( size_t i = 0; i < m_replaceStringHistoryList.GetCount() && i < FR_HISTORY_LIST_CNT; i++ )
587  {
588  aCfg->m_FindReplace.replace_history.push_back(
589  m_replaceStringHistoryList[ i ].ToStdString() );
590  }
591 
592  // Save the units used in this frame
593  if( m_toolManager )
594  {
595  if( COMMON_TOOLS* cmnTool = m_toolManager->GetTool<COMMON_TOOLS>() )
596  {
597  aCfg->m_System.last_imperial_units = static_cast<int>( cmnTool->GetLastImperialUnits() );
598  aCfg->m_System.last_metric_units = static_cast<int>( cmnTool->GetLastMetricUnits() );
599  }
600  }
601 }
std::vector< wxString > find_history
Definition: app_settings.h:108
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Saves common frame parameters to a configuration data file.
wxArrayString m_findStringHistoryList
Stores the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:81
FIND_REPLACE m_FindReplace
Definition: app_settings.h:161
wxArrayString m_replaceStringHistoryList
void WriteConfig(WINDOW_SETTINGS &aCfg)
std::vector< wxString > replace_history
Definition: app_settings.h:110
virtual WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg)
Returns a pointer to the window settings for this frame.
int GetMaxUndoItems() const
#define FR_HISTORY_LIST_CNT
Maximum size of the find/replace history stacks.
COMMON_TOOLS.
Definition: common_tools.h:38
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:48
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
EDA_UNITS m_userUnits
wxFindReplaceData * m_findReplaceData
long m_firstRunDialogSetting

References APP_SETTINGS_BASE::FIND_REPLACE::find_history, APP_SETTINGS_BASE::FIND_REPLACE::find_string, APP_SETTINGS_BASE::SYSTEM::first_run_shown, APP_SETTINGS_BASE::FIND_REPLACE::flags, FR_HISTORY_LIST_CNT, EDA_BASE_FRAME::GetMaxUndoItems(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetWindowSettings(), APP_SETTINGS_BASE::SYSTEM::last_imperial_units, APP_SETTINGS_BASE::SYSTEM::last_metric_units, APP_SETTINGS_BASE::m_FindReplace, m_findReplaceData, m_findStringHistoryList, m_firstRunDialogSetting, m_galDisplayOptions, m_replaceStringHistoryList, APP_SETTINGS_BASE::m_System, TOOLS_HOLDER::m_toolManager, EDA_BASE_FRAME::m_userUnits, APP_SETTINGS_BASE::SYSTEM::max_undo_items, APP_SETTINGS_BASE::FIND_REPLACE::replace_history, APP_SETTINGS_BASE::FIND_REPLACE::replace_string, EDA_BASE_FRAME::SaveSettings(), APP_SETTINGS_BASE::SYSTEM::units, and KIGFX::GAL_DISPLAY_OPTIONS::WriteConfig().

Referenced by resolveCanvasType(), SCH_BASE_FRAME::SaveSettings(), PL_EDITOR_FRAME::SaveSettings(), GERBVIEW_FRAME::SaveSettings(), and PCB_BASE_FRAME::SaveSettings().

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

568 {
569  wxString text;
570 
571  if( IsIconized() )
572  return;
573 
574  wxString baseCfgName = ConfigBaseName();
575 
576  // If the window is maximized, we use the saved window size from before it was maximized
577  if( IsMaximized() )
578  {
581  }
582  else
583  {
585  m_framePos = GetPosition();
586  }
587 
588  aCfg->state.pos_x = m_framePos.x;
589  aCfg->state.pos_y = m_framePos.y;
590  aCfg->state.size_x = m_frameSize.x;
591  aCfg->state.size_y = m_frameSize.y;
592  aCfg->state.maximized = IsMaximized();
593  aCfg->state.display = wxDisplay::GetFromWindow( this );
594 
595  wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
596  wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
598 
599  // TODO(JE) should auto-save in common settings be overwritten by every app?
600  if( m_hasAutoSave )
601  Pgm().GetCommonSettings()->m_System.autosave_interval = m_autoSaveInterval;
602 
603  // Once this is fully implemented, wxAuiManager will be used to maintain
604  // the persistance of the main frame and all it's managed windows and
605  // all of the legacy frame persistence position code can be removed.
606  aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
607 
608  aCfg->mru_path = m_mruPath;
609 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxAuiManager m_auimgr
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
wxString perspective
Definition: app_settings.h:85
wxSize m_normalFrameSize
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

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, and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval ( int  aInterval)
inherited

Definition at line 244 of file eda_base_frame.cpp.

245 {
246  m_autoSaveInterval = aInterval;
247 
248  if( m_autoSaveTimer->IsRunning() )
249  {
250  if( m_autoSaveInterval > 0 )
251  {
252  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
253  }
254  else
255  {
256  m_autoSaveTimer->Stop();
257  m_autoSaveState = false;
258  }
259  }
260 }
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by CommonSettingsChanged().

◆ SetCanvas()

void EDA_DRAW_FRAME::SetCanvas ( EDA_DRAW_PANEL_GAL aPanel)
inline

Definition at line 467 of file eda_draw_frame.h.

467 { m_canvas = aPanel; }
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.

References m_canvas.

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

◆ SetDrawBgColor()

virtual void EDA_DRAW_FRAME::SetDrawBgColor ( COLOR4D  aColor)
inlinevirtual

◆ SetGridColor()

virtual void EDA_DRAW_FRAME::SetGridColor ( COLOR4D  aColor)
inlinevirtual

Reimplemented in PCB_EDIT_FRAME, and GERBVIEW_FRAME.

Definition at line 276 of file eda_draw_frame.h.

276 { m_gridColor = aColor; }
COLOR4D m_gridColor

References m_gridColor.

◆ SetGridOrigin()

virtual void EDA_DRAW_FRAME::SetGridOrigin ( const wxPoint &  aPosition)
pure virtual

◆ SetGridVisibility()

void EDA_DRAW_FRAME::SetGridVisibility ( bool  aVisible)
virtual

Reimplemented in GERBVIEW_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 334 of file eda_draw_frame.cpp.

335 {
336  config()->m_Window.grid.show = aVisible;
337 
338  // Update the display with the new grid
339  if( GetCanvas() )
340  {
341  // Check to ensure these exist, since this function could be called before
342  // the GAL and View have been created
343  if( GetCanvas()->GetGAL() )
344  GetCanvas()->GetGAL()->SetGridVisibility( aVisible );
345 
346  if( GetCanvas()->GetView() )
348 
349  GetCanvas()->Refresh();
350  }
351 }
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:571
GRID_SETTINGS grid
Definition: app_settings.h:89
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 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...
WINDOW_SETTINGS m_Window
Definition: app_settings.h:173
void SetGridVisibility(bool aVisibility)
Sets the visibility setting of the grid.

References EDA_BASE_FRAME::config(), GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_PANEL_GAL::GetView(), WINDOW_SETTINGS::grid, APP_SETTINGS_BASE::m_Window, KIGFX::VIEW::MarkTargetDirty(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::GAL::SetGridVisibility(), GRID_SETTINGS::show, and KIGFX::TARGET_NONCACHED.

Referenced by APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_BASE_EDIT_FRAME::SetGridVisibility(), GERBVIEW_FRAME::SetGridVisibility(), and COMMON_TOOLS::ToggleGrid().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

43 {
44 #if defined(DEBUG)
45  // offer a trap point for debugging most any window
46  wxASSERT( aDest );
47  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
48  {
49  int breakhere=1;
50  (void) breakhere;
51  }
52 #endif
53 
54  (void) aDest;
55 
56  m_kiway = aKiway;
57 }
KIWAY * m_kiway
Definition: kiway_holder.h:81
const char * name
Definition: DXF_plotter.cpp:59

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool  aIsModal)
inlineinherited

Definition at line 179 of file kiway_player.h.

179 { m_modal = aIsModal; }

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), and LIB_VIEW_FRAME::LIB_VIEW_FRAME().

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString &  aPath)
inlineinherited

◆ SetMsgPanel() [1/2]

void EDA_DRAW_FRAME::SetMsgPanel ( const std::vector< MSG_PANEL_ITEM > &  aList)

Clear the message panel and populates it with the contents of aList.

Parameters
aListis the list of MSG_PANEL_ITEM objects to fill the message panel.

Definition at line 619 of file eda_draw_frame.cpp.

620 {
621  if( m_messagePanel )
622  {
624 
625  for( const MSG_PANEL_ITEM& item : aList )
626  m_messagePanel->AppendMessage( item );
627  }
628 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:210
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:54
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:114

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

Referenced by PCB_INSPECTION_TOOL::ClearHighlight(), PCB_BASE_FRAME::Compile_Ratsnest(), PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawZone(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_PIN_TOOL::EditPinProperties(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_INSPECTION_TOOL::highlightNet(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), DRAWING_TOOL::PlaceText(), PAD_TOOL::pushPadSettings(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SetMsgPanel(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PL_POINT_EDITOR::updateItem(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCBNEW_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), and EE_POINT_EDITOR::updateParentItem().

◆ SetMsgPanel() [2/2]

void EDA_DRAW_FRAME::SetMsgPanel ( EDA_ITEM aItem)

Definition at line 631 of file eda_draw_frame.cpp.

632 {
633  wxCHECK_RET( aItem, wxT( "Invalid EDA_ITEM pointer. Bad programmer." ) );
634 
635  MSG_PANEL_ITEMS items;
636  aItem->GetMsgPanelInfo( this, items );
637  SetMsgPanel( items );
638 }
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
virtual void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
Definition: eda_item.h:283
std::vector< MSG_PANEL_ITEM > MSG_PANEL_ITEMS
Definition: msgpanel.h:97

References EDA_ITEM::GetMsgPanelInfo(), and SetMsgPanel().

◆ SetPageSettings()

virtual void EDA_DRAW_FRAME::SetPageSettings ( const PAGE_INFO aPageSettings)
pure virtual

◆ SetScreen()

virtual void EDA_DRAW_FRAME::SetScreen ( BASE_SCREEN aScreen)
inlineprotectedvirtual

◆ SetShowPageLimits()

void EDA_DRAW_FRAME::SetShowPageLimits ( bool  aShow)
inline

◆ SetShowPolarCoords()

void EDA_DRAW_FRAME::SetShowPolarCoords ( bool  aShow)
inline

Definition at line 182 of file eda_draw_frame.h.

182 { m_polarCoords = aShow; }

References m_polarCoords.

Referenced by COMMON_TOOLS::TogglePolarCoords().

◆ SetTitleBlock()

virtual void EDA_DRAW_FRAME::SetTitleBlock ( const TITLE_BLOCK aTitleBlock)
pure virtual

◆ setupUIConditions()

void EDA_BASE_FRAME::setupUIConditions ( )
protectedvirtualinherited

Setup the UI conditions for the various actions and their controls in this frame.

Reimplemented in FOOTPRINT_EDIT_FRAME, SYMBOL_EDIT_FRAME, SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, EDA_3D_VIEWER, GERBVIEW_FRAME, LIB_VIEW_FRAME, DISPLAY_FOOTPRINTS_FRAME, PCB_EDIT_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 361 of file eda_base_frame.cpp.

362 {
363  // Setup the conditions to check a language menu item
364  auto isCurrentLang =
365  [] ( const SELECTION& aSel, int aLangIdentifier )
366  {
367  return Pgm().GetSelectedLanguageIdentifier() == aLangIdentifier;
368  };
369 
370  for( unsigned ii = 0; LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
371  {
372  ACTION_CONDITIONS cond;
373  cond.Check( std::bind( isCurrentLang, std::placeholders::_1,
374  LanguagesList[ii].m_WX_Lang_Identifier ) );
375 
376  RegisterUIUpdateHandler( LanguagesList[ii].m_KI_Lang_Identifier, cond );
377  }
378 }
LANGUAGE_DESCR LanguagesList[]
An array containing all the languages that KiCad supports.
Definition: pgm_base.cpp:72
int m_KI_Lang_Identifier
KiCad identifier used in menu selection (See id.h)
Definition: pgm_base.h:63
virtual void RegisterUIUpdateHandler(int aID, const ACTION_CONDITIONS &aConditions) override
Register a UI update handler for the control with ID aID.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
ACTION_CONDITIONS & Check(const SELECTION_CONDITION &aCondition)

References ACTION_CONDITIONS::Check(), LanguagesList, LANGUAGE_DESCR::m_KI_Lang_Identifier, Pgm(), and EDA_BASE_FRAME::RegisterUIUpdateHandler().

Referenced by FOOTPRINT_VIEWER_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), CVPCB_MAINFRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), LIB_VIEW_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), EDA_3D_VIEWER::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

◆ setupUnits()

void EDA_DRAW_FRAME::setupUnits ( APP_SETTINGS_BASE aCfg)
protected