KiCad PCB EDA Suite
FOOTPRINT_VIEWER_FRAME Class Reference

Component library viewer main window. More...

#include <footprint_viewer_frame.h>

Inheritance diagram for FOOTPRINT_VIEWER_FRAME:
PCB_BASE_FRAME EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 ~FOOTPRINT_VIEWER_FRAME ()
 
PCB_GENERAL_SETTINGSGetConfigSettings ()
 
void ApplyDisplaySettingsToGAL ()
 Updates the GAL with display settings changes. More...
 
virtual COLOR4D GetGridColor () override
 
bool GetAutoZoom () const
 
void SetAutoZoom (bool aEnable)
 
void ReCreateLibraryList ()
 Function ReCreateLibraryList. More...
 
void OnUpdateFootprintButton (wxUpdateUIEvent &aEvent)
 Update the ID_ADD_FOOTPRINT_TO_BOARD tool state in main toolbar. More...
 
bool ShowModal (wxString *aFootprint, wxWindow *aParent) override
 Function ShowModal. More...
 
EDA_3D_VIEWERGet3DViewerFrame ()
 
MODULELoadFootprint (const LIB_ID &aFootprintId)
 Function LoadFootprint attempts to load aFootprintId from the footprint library table. More...
 
EDA_RECT GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
 Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge segments). More...
 
const BOX2I GetDocumentExtents () const override
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPoint & GetAuxOrigin () const override
 Return the origin of the axis used for plotting and various exports. More...
 
void SetAuxOrigin (const wxPoint &aPoint) override
 
const wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
virtual BOARD_DESIGN_SETTINGSGetDesignSettings () const
 Function GetDesignSettings returns the BOARD_DESIGN_SETTINGS for the BOARD owned by this frame. More...
 
virtual void SetDesignSettings (const BOARD_DESIGN_SETTINGS &aSettings)
 
void SetDrawBgColor (COLOR4D aColor) override
 
void * GetDisplayOptions () override
 Function GetDisplayOptions returns the display options current in use Display options are relative to the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode) Must be overloaded in frames which have display options (board editor and footprint editor) More...
 
const ZONE_SETTINGSGetZoneSettings () const
 
void SetZoneSettings (const ZONE_SETTINGS &aSettings)
 
virtual const PCB_PLOT_PARAMSGetPlotSettings () const
 Function GetPlotSettings returns the PCB_PLOT_PARAMS for the BOARD owned by this frame. More...
 
virtual void SetPlotSettings (const PCB_PLOT_PARAMS &aSettings)
 
virtual void SetBoard (BOARD *aBoard)
 Function SetBoard sets the m_Pcb member in such as way as to ensure deleting any previous BOARD. More...
 
BOARDGetBoard () const
 
virtual void ReCreateOptToolbar () override
 
virtual void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
virtual void UpdateStatusBar () override
 Update the status bar information. More...
 
PCB_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
void UpdateGridSelectBox ()
 
const wxString GetZoomLevelIndicator () const override
 Function GetZoomLevelIndicator returns a human readable value which can be displayed as zoom level indicator in dialogs. More...
 
EDA_3D_VIEWERCreateAndShow3D_Frame ()
 Shows the 3D view frame. More...
 
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide ()
 Function GetCollectorsGuide. More...
 
wxString SelectLibrary (const wxString &aNicknameExisting)
 Function SelectLibrary puts up a dialog and allows the user to pick a library, for unspecified use. More...
 
MODULEGetFootprintFromBoardByReference ()
 Function GetFootprintFromBoardByReference. More...
 
virtual void OnModify ()
 Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the current screen and update the date in frame reference do not forget to call this basic OnModify function to update info in derived OnModify functions. More...
 
MODULECreateNewModule (const wxString &aModuleName)
 Function CreateNewModule Creates a new module or footprint, at position 0,0 The new module contains only 2 texts: a reference and a value: Reference = REF** Value = "VAL**" or Footprint name in lib Note: they are dummy texts, which will be replaced by the actual texts when the fooprint is placed on a board and a netlist is read. More...
 
void Edit_Module (MODULE *module, wxDC *DC)
 
void PlaceModule (MODULE *aModule, bool aRecreateRatsnest=true)
 Function PlaceModule places aModule at the current cursor position and updates module coordinates with the new position. More...
 
void InstallPadOptionsFrame (D_PAD *pad)
 
MODULESelectFootprintFromLibTree (LIB_ID aPreselect=LIB_ID())
 Function SelectFootprintFromLibTree opens a dialog to select a footprint. More...
 
virtual void AddModuleToBoard (MODULE *module)
 Adds the given module to the board. More...
 
wxString SelectFootprintFromLibBrowser ()
 Function SelectFootprintFromLibBrowser launches the footprint viewer to select the name of a footprint to load. More...
 
void Compile_Ratsnest (bool aDisplayStatus)
 Function Compile_Ratsnest Create the entire board ratsnest. More...
 
PCB_LAYER_ID SelectLayer (PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
 Install the dialog box for layer selection. More...
 
virtual void SwitchLayer (wxDC *DC, PCB_LAYER_ID layer)
 
virtual void SetActiveLayer (PCB_LAYER_ID aLayer)
 Function SetActiveLayer will change the currently active layer to aLayer. More...
 
virtual PCB_LAYER_ID GetActiveLayer () const
 Function GetActiveLayer returns the active layer. More...
 
void OnTogglePadDrawMode (wxCommandEvent &aEvent)
 
void OnToggleGraphicDrawMode (wxCommandEvent &aEvent)
 
void OnToggleEdgeDrawMode (wxCommandEvent &aEvent)
 
void OnToggleTextDrawMode (wxCommandEvent &aEvent)
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 
virtual void OnUpdateLayerAlpha (wxUpdateUIEvent &aEvent)
 
void SetFastGrid1 ()
 Function SetFastGrid1() More...
 
void SetFastGrid2 ()
 Function SetFastGrid2() More...
 
void DisplayGridMsg ()
 Function DisplayGridMsg() More...
 
PCB_DRAW_PANEL_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
virtual void ActivateGalCanvas () override
 

More...
 
PCB_GENERAL_SETTINGSSettings ()
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
int GetLastGridSizeId () const
 
void SetLastGridSizeId (int aId)
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
virtual COLOR4D GetDrawBgColor () const
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
virtual wxString GetScreenDesc () const
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest(). More...
 
double GetZoomLevelCoeff () const
 Return the coefficient to convert internal display scale factor to zoom level. More...
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
virtual bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
virtual void SetGridColor (COLOR4D aColor)
 
virtual void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
virtual void OnGridSettings (wxCommandEvent &event)
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 
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, bool aCenterView=false)
 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...
 
double GetZoom ()
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (wxDC *aDC, BASE_SCREEN *aScreen, int aLineWidth, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString, COLOR4D aColor=COLOR4D::UNSPECIFIED)
 Prints the page layout with the frame and the basic inscriptions. More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane on the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual void PrintPage (wxDC *aDC)
 Print the page pointed by current screen, set by the calling print function. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
virtual void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Changes the current rendering backend. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 Notification to refresh the drawing canvas (if any). More...
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of ckeck tools. More...
 
virtual bool OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
virtual void 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 ()
 
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_T GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS_T aUnits)
 
void ChangeUserUnits (EDA_UNITS_T aUnits)
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
void OnMenuOpen (wxMenuEvent &event)
 Workaround some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
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)
 
virtual wxConfigBase * config ()
 Returns the wxConfigBase 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...
 
wxString ConfigBaseName ()
 
virtual void SaveProjectSettings (bool aAskForSave)
 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, wxFileHistory *aFileHistory=NULL)
 Fetches the file name from the file history list. More...
 
void UpdateFileHistory (const wxString &FullFileName, wxFileHistory *aFileHistory=NULL)
 Update the list of recently opened files. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void SyncToolbars ()
 Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state. More...
 
const wxString & GetAboutTitle () const
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Public Attributes

PCB_DISPLAY_OPTIONS m_DisplayOptions
 
wxPoint m_UserGridSize
 
int m_FastGrid1
 
int m_FastGrid2
 

Static Public Attributes

static const wxChar AUTO_ZOOM_KEY [] = wxT( "AutoZoom" )
 

Key in KifaceSettings to store the canvas type.

More...
 
static const wxChar ZOOM_KEY [] = wxT( "Zoom" )
 

Protected Member Functions

 FOOTPRINT_VIEWER_FRAME (KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType)
 
void updateZoomSelectBox ()
 
virtual 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...
 
MODULEloadFootprint (const LIB_ID &aFootprintId)
 Function loadFootprint attempts to load aFootprintId from the footprint library table. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
virtual wxString GetCanvasTypeKey ()
 
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...
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

BOARDm_Pcb
 
PCB_GENERAL_SETTINGS m_configSettings
 
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...
 
int m_LastGridSizeId
 
bool m_drawGrid
 
bool m_showPageLimits
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
double m_zoomLevelCoeff
 
int m_UndoRedoCountMax
 
bool m_PolarCoords
 
TOOL_DISPATCHERm_toolDispatcher
 
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
 
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
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_configName
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
wxString m_perspective
 
wxString m_mruPath
 
EDA_UNITS_T m_userUnits
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Private Member Functions

const wxString getCurNickname ()
 
void setCurNickname (const wxString &aNickname)
 
const wxString getCurFootprintName ()
 
void setCurFootprintName (const wxString &aName)
 
void OnSize (wxSizeEvent &event) override
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void ReCreateFootprintList ()
 
void OnIterateFootprintList (wxCommandEvent &event)
 
void UpdateTitle ()
 Function UpdateTitle updates the window title with current library information. More...
 
void OnCloseWindow (wxCloseEvent &Event) override
 
void CloseFootprintViewer (wxCommandEvent &event)
 
void OnExitKiCad (wxCommandEvent &event)
 
void ReCreateHToolbar () override
 
void ReCreateVToolbar () override
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
void OnLibFilter (wxCommandEvent &aEvent)
 
void OnFPFilter (wxCommandEvent &aEvent)
 
void OnCharHook (wxKeyEvent &aEvent) override
 Capture the key event before it is sent to the GUI. More...
 
void selectPrev (wxListBox *aListBox)
 
void selectNext (wxListBox *aListBox)
 
void ClickOnLibList (wxCommandEvent &aEvent)
 
void ClickOnFootprintList (wxCommandEvent &aEvent)
 
void DClickOnFootprintList (wxCommandEvent &aEvent)
 
void InstallDisplayOptions (wxCommandEvent &aEvent)
 
void LoadSettings (wxConfigBase *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (wxConfigBase *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
void OnActivate (wxActivateEvent &event)
 Function OnActivate is called when the frame frame is activate to reload the libraries and component lists that can be changed by the schematic editor or the library editor. More...
 
void AddFootprintToPCB (wxCommandEvent &aEvent)
 Function AddFootprintToPCB exports the current footprint name and close the library browser. More...
 
void SelectAndViewFootprint (int aMode)
 Function SelectAndViewFootprint Select and load the next or the previous footprint if no current footprint, Rebuild the list of footprints available in a given footprint library. More...
 
void Update3DView (bool aForceReload, const wxString *aTitle=nullptr) override
 Function Update3DView must be called after a footprint selection Updates the 3D view and 3D frame title. More...
 
void SaveCopyInUndoList (BOARD_ITEM *, UNDO_REDO_T, const wxPoint &) override
 Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &, UNDO_REDO_T, const wxPoint &) override
 Function SaveCopyInUndoList (virtual pure, overloaded). More...
 
void updateView ()
 

Private Attributes

wxTextCtrl * m_libFilter
 
wxListBox * m_libList
 
wxTextCtrl * m_fpFilter
 
wxListBox * m_fpList
 
bool m_autoZoom
 
double m_lastZoom
 

Friends

struct PCB::IFACE
 

Detailed Description

Component library viewer main window.

Definition at line 42 of file footprint_viewer_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_VIEWER_FRAME()

FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME ( KIWAY aKiway,
wxWindow *  aParent,
FRAME_T  aFrameType 
)
protected

Definition at line 110 of file footprint_viewer_frame.cpp.

111  :
112  PCB_BASE_FRAME( aKiway, aParent, aFrameType, _( "Footprint Library Browser" ),
113  wxDefaultPosition, wxDefaultSize,
114  aFrameType == FRAME_FOOTPRINT_VIEWER_MODAL ? ( aParent ? PARENT_STYLE : MODAL_STYLE )
115  : NONMODAL_STYLE,
118 {
119  wxASSERT( aFrameType == FRAME_FOOTPRINT_VIEWER_MODAL || aFrameType == FRAME_FOOTPRINT_VIEWER );
120 
121  if( aFrameType == FRAME_FOOTPRINT_VIEWER_MODAL )
122  SetModal( true );
123 
124  // Force the frame name used in config. the footprint viewer frame has a name
125  // depending on aFrameType (needed to identify the frame by wxWidgets),
126  // but only one configuration is preferable.
128 
129  // Give an icon
130  wxIcon icon;
131  icon.CopyFromBitmap( KiBitmap( modview_icon_xpm ) );
132  SetIcon( icon );
133 
134  wxPanel* libPanel = new wxPanel( this );
135  wxSizer* libSizer = new wxBoxSizer( wxVERTICAL );
136 
137  m_libFilter = new wxTextCtrl( libPanel, ID_MODVIEW_LIB_FILTER, wxEmptyString,
138  wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER );
139  m_libFilter->SetHint( _( "Filter" ) );
140  libSizer->Add( m_libFilter, 0, wxEXPAND, 5 );
141 
142  m_libList = new wxListBox( libPanel, ID_MODVIEW_LIB_LIST, wxDefaultPosition, wxDefaultSize,
143  0, NULL, wxLB_HSCROLL | wxNO_BORDER );
144  libSizer->Add( m_libList, 1, wxEXPAND, 5 );
145 
146  libPanel->SetSizer( libSizer );
147  libPanel->Fit();
148 
149  wxPanel* fpPanel = new wxPanel( this );
150  wxSizer* fpSizer = new wxBoxSizer( wxVERTICAL );
151 
152  m_fpFilter = new wxTextCtrl( fpPanel, ID_MODVIEW_FOOTPRINT_FILTER, wxEmptyString,
153  wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER );
154  m_fpFilter->SetHint( _( "Filter" ) );
155  m_fpFilter->SetToolTip( _( "Filter on footprint name, keywords, description and pad count.\n"
156  "Search terms are separated by spaces. All search terms must match.\n"
157  "A term which is a number will also match against the pad count." ) );
158  fpSizer->Add( m_fpFilter, 0, wxEXPAND, 5 );
159 
160  m_fpList = new wxListBox( fpPanel, ID_MODVIEW_FOOTPRINT_LIST, wxDefaultPosition, wxDefaultSize,
161  0, NULL, wxLB_HSCROLL | wxNO_BORDER );
162  fpSizer->Add( m_fpList, 1, wxEXPAND, 5 );
163 
164  fpPanel->SetSizer( fpSizer );
165  fpPanel->Fit();
166 
167  SetBoard( new BOARD() );
168  // In viewer, the default net clearance is not known (it depends on the actual board).
169  // So we do not show the default clearance, by setting it to 0
170  // The footprint or pad specific clearance will be shown
171  GetBoard()->GetDesignSettings().GetDefault()->SetClearance(0);
172 
173  // Don't show the default board solder mask clearance in the footprint viewer. Only the
174  // footprint or pad clearance setting should be shown if it is not 0.
176 
177  // Ensure all layers and items are visible:
179  SetScreen( new PCB_SCREEN( GetPageSizeIU() ) );
180 
181  GetScreen()->m_Center = true; // Center coordinate origins on screen.
182  LoadSettings( config() );
184 
185  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
186 
188 
189  // Create GAL canvas
191  auto drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_FrameSize,
193  SetCanvas( drawPanel );
194 
195  // Create the manager and dispatcher & route draw panel events to the dispatcher
197  m_toolManager->SetEnvironment( GetBoard(), drawPanel->GetView(),
198  drawPanel->GetViewControls(), this );
199  m_actions = new PCB_ACTIONS();
201  drawPanel->SetEventDispatcher( m_toolDispatcher );
202 
205  m_toolManager->RegisterTool( new COMMON_TOOLS ); // for std context menus (zoom & grid)
208  m_toolManager->InvokeTool( "pcbnew.InteractiveSelection" );
209 
210  ReCreateMenuBar();
213 
215  UpdateTitle();
216 
217  // If a footprint was previously loaded, reload it
218  if( getCurNickname().size() && getCurFootprintName().size() )
219  {
220  LIB_ID id;
221 
223  id.SetLibItemName( getCurFootprintName() );
224  GetBoard()->Add( loadFootprint( id ) );
225  }
226 
227  drawPanel->DisplayBoard( m_Pcb );
228 
229  m_auimgr.SetManagedWindow( this );
230 
231  // Horizontal items; layers 4 - 6
232  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().VToolbar().Name( "MainToolbar" ).Top().Layer(6) );
233  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
234 
235  // Vertical items; layers 1 - 3
236  m_auimgr.AddPane( libPanel, EDA_PANE().Palette().Name( "Libraries" ).Left().Layer(2)
237  .CaptionVisible( false ).MinSize( 100, -1 ).BestSize( 200, -1 ) );
238  m_auimgr.AddPane( fpPanel, EDA_PANE().Palette().Name( "Footprints" ).Left().Layer( 1)
239  .CaptionVisible( false ).MinSize( 100, -1 ).BestSize( 300, -1 ) );
240 
241  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
242 
243  // after changing something to the aui manager call Update() to reflect the changes
244  m_auimgr.Update();
245 
246  // The canvas should not steal the focus from the list boxes
247  GetCanvas()->SetCanFocus( false );
248  GetCanvas()->GetGAL()->SetAxesEnabled( true );
251 
252  // Restore last zoom. (If auto-zooming we'll adjust when we load the footprint.)
254 
255  updateView();
256  InitExitKey();
257 
258  if( !IsModal() ) // For modal mode, calling ShowModal() will show this frame
259  {
260  Raise(); // On some window managers, this is needed
261  Show( true );
262  }
263 }
int m_SolderMaskMargin
Solder mask margin.
virtual void SetBoard(BOARD *aBoard)
Function SetBoard sets the m_Pcb member in such as way as to ensure deleting any previous BOARD.
void UpdateTitle()
Function UpdateTitle updates the window title with current library information.
#define FOOTPRINT_VIEWER_FRAME_NAME_MODAL
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
TOOL_DISPATCHER * m_toolDispatcher
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
virtual void SetScreen(BASE_SCREEN *aScreen)
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
Class SELECTION_TOOL.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
ACTIONS * m_actions
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
virtual wxConfigBase * config()
Returns the wxConfigBase used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:540
void SetVisibleAlls()
Function SetVisibleAlls changes the bit-mask of visible element categories and layers.
wxAuiManager m_auimgr
#define PARENT_STYLE
ACTION_TOOLBAR * m_mainToolBar
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
PCB_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.
Class PCBNEW_CONTROL.
bool m_axesEnabled
Whether or not to draw the coordinate system axes
Class TOOL_MANAGER.
Definition: tool_manager.h:50
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
double GetZoomLevelCoeff() const
Return the coefficient to convert internal display scale factor to zoom level.
virtual void ActivateGalCanvas() override
bool m_Center
Center on screen.
Definition: base_screen.h:121
EDA_MSG_PANEL * m_messagePanel
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
#define MODAL_STYLE
#define FOOTPRINT_VIEWER_FRAME_NAME
bool IsModal()
Definition: kiway_player.h:163
void InitExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
Class COMMON_CONTROL.
void SetAxesEnabled(bool aAxesEnabled)
Enables drawing the axes.
#define _(s)
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
Specialization of the wxAuiPaneInfo class for KiCad panels.
Class COMMON_TOOLS.
Definition: common_tools.h:38
Class TOOL_DISPATCHER.
void SetModal(bool aIsModal)
Definition: kiway_player.h:164
#define NONMODAL_STYLE
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Function SetScale() Sets the scaling factor, zooming around a given anchor point.
Definition: view.cpp:578
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
Class PCB_ACTIONS.
Definition: pcb_actions.h:62
NETCLASSPTR GetDefault() const
Function GetDefault.
void ReCreateMenuBar() override
Recreates the menu bar.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
void ReCreateLibraryList()
Function ReCreateLibraryList.
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, EDA_BASE_FRAME *aFrame)
Sets the work environment (model, view, view controls and the parent window).
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
TOOL_MANAGER * m_toolManager
void InitTools()
Function InitTools() Initializes all registered tools.
BOARD * GetBoard() const
int SetGrid(const wxRealPoint &size)
set the current grid size m_Grid.
MODULE * loadFootprint(const LIB_ID &aFootprintId)
Function loadFootprint attempts to load aFootprintId from the footprint library table.
wxString m_configName
void RegisterTool(TOOL_BASE *aTool)
Function RegisterTool() Adds a tool to the manager set and sets it up.

References _, PCB_BASE_FRAME::ActivateGalCanvas(), BOARD::Add(), PCAD2KICAD::Center, EDA_BASE_FRAME::config(), FOOTPRINT_VIEWER_FRAME_NAME, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), getCurFootprintName(), getCurNickname(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGalDisplayOptions(), PCB_BASE_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetScreen(), PCB_DRAW_PANEL_GAL::GetView(), EDA_DRAW_FRAME::GetZoom(), EDA_DRAW_FRAME::GetZoomLevelCoeff(), ID_MODVIEW_FOOTPRINT_FILTER, ID_MODVIEW_FOOTPRINT_LIST, ID_MODVIEW_LIB_FILTER, ID_MODVIEW_LIB_LIST, ID_POPUP_GRID_LEVEL_1000, EDA_DRAW_FRAME::InitExitKey(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::InvokeTool(), KIWAY_PLAYER::IsModal(), KiBitmap(), PCAD2KICAD::Left, EDA_DRAW_FRAME::LoadCanvasTypeSetting(), PCB_BASE_FRAME::loadFootprint(), LoadSettings(), EDA_BASE_FRAME::m_actions, EDA_BASE_FRAME::m_auimgr, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, EDA_DRAW_FRAME::m_canvasType, BASE_SCREEN::m_Center, EDA_BASE_FRAME::m_configName, m_fpFilter, m_fpList, EDA_BASE_FRAME::m_FramePos, EDA_BASE_FRAME::m_FrameSize, EDA_DRAW_FRAME::m_LastGridSizeId, m_lastZoom, m_libFilter, m_libList, EDA_DRAW_FRAME::m_mainToolBar, EDA_DRAW_FRAME::m_messagePanel, PCB_BASE_FRAME::m_Pcb, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, EDA_DRAW_FRAME::m_toolDispatcher, EDA_BASE_FRAME::m_toolManager, ReCreateHToolbar(), ReCreateLibraryList(), ReCreateMenuBar(), ReCreateVToolbar(), TOOL_MANAGER::RegisterTool(), KIGFX::GAL::SetAxesEnabled(), PCB_BASE_FRAME::SetBoard(), EDA_DRAW_FRAME::SetCanvas(), TOOL_MANAGER::SetEnvironment(), BASE_SCREEN::SetGrid(), LIB_ID::SetLibNickname(), KIWAY_PLAYER::SetModal(), KIGFX::VIEW::SetScale(), EDA_DRAW_FRAME::SetScreen(), BOARD::SetVisibleAlls(), UpdateTitle(), and updateView().

◆ ~FOOTPRINT_VIEWER_FRAME()

FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME ( )

Definition at line 266 of file footprint_viewer_frame.cpp.

267 {
268  GetCanvas()->StopDrawing();
269  GetCanvas()->GetView()->Clear();
270  // Be sure any event cannot be fired after frame deletion:
271  GetCanvas()->SetEvtHandlerEnabled( false );
272 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1111
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...

References KIGFX::VIEW::Clear(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), and EDA_DRAW_PANEL_GAL::StopDrawing().

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_BASE_FRAME::ActivateGalCanvas ( )
overridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 841 of file pcb_base_frame.cpp.

842 {
844 
845  EDA_DRAW_PANEL_GAL* canvas = GetCanvas();
846 
847  if( m_toolManager )
848  {
850  GetCanvas()->GetViewControls(), this );
851  }
852 
853  SetBoard( m_Pcb );
854 
855  if( m_toolManager )
857 
858  // Transfer latest current display options from legacy to GAL canvas:
859  auto painter = static_cast<KIGFX::PCB_PAINTER*>( canvas->GetView()->GetPainter() );
860  auto settings = painter->GetSettings();
861  auto displ_opts = (PCB_DISPLAY_OPTIONS*) GetDisplayOptions();
862  settings->LoadDisplayOptions( displ_opts, ShowPageLimits() );
863 
864  canvas->GetView()->RecacheAllItems();
866  canvas->StartDrawing();
867 }
virtual void SetBoard(BOARD *aBoard)
Function SetBoard sets the m_Pcb member in such as way as to ensure deleting any previous BOARD.
TOOL_DISPATCHER * m_toolDispatcher
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void RecacheAllItems()
Function RecacheAllItems() Rebuilds GAL display lists.
Definition: view.cpp:1402
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
bool ShowPageLimits() const
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Function ResetTools() Resets all tools (i.e.
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void StartDrawing()
Function StartDrawing() Begins drawing if it was stopped previously.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, EDA_BASE_FRAME *aFrame)
Sets the work environment (model, view, view controls and the parent window).
TOOL_MANAGER * m_toolManager
Rendering engine changes.
Definition: tool_base.h:83

References EDA_DRAW_FRAME::ActivateGalCanvas(), TOOL_BASE::GAL_SWITCH, PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), KIGFX::VIEW::GetPainter(), EDA_DRAW_PANEL_GAL::GetView(), PCB_BASE_FRAME::m_Pcb, EDA_DRAW_FRAME::m_toolDispatcher, EDA_BASE_FRAME::m_toolManager, KIGFX::VIEW::RecacheAllItems(), TOOL_MANAGER::ResetTools(), PCB_BASE_FRAME::SetBoard(), TOOL_MANAGER::SetEnvironment(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), EDA_DRAW_FRAME::ShowPageLimits(), and EDA_DRAW_PANEL_GAL::StartDrawing().

Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME(), and PCB_DRAW_PANEL_GAL::OnShow().

◆ AddFootprintToPCB()

void FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB ( wxCommandEvent &  aEvent)
private

Function AddFootprintToPCB exports the current footprint name and close the library browser.

Definition at line 633 of file footprint_viewer_frame.cpp.

634 {
635  if( IsModal() )
636  {
637  if( m_fpList->GetSelection() >= 0 )
638  {
639  LIB_ID fpid( getCurNickname(), m_fpList->GetStringSelection() );
640  DismissModal( true, fpid.Format() );
641  }
642  else
643  {
644  DismissModal( false );
645  }
646 
647  Close( true );
648  }
649  else if( GetBoard()->GetFirstModule() )
650  {
651  PCB_EDIT_FRAME* pcbframe = (PCB_EDIT_FRAME*) Kiway().Player( FRAME_PCB_EDITOR, false );
652 
653  if( pcbframe == NULL ) // happens when the board editor is not active (or closed)
654  {
655  DisplayErrorMessage( this, _( "No board currently open." ) );
656  return;
657  }
658 
660  BOARD_COMMIT commit( pcbframe );
661 
662  // Create the "new" module
663  MODULE* newmodule = new MODULE( *GetBoard()->GetFirstModule() );
664  newmodule->SetParent( pcbframe->GetBoard() );
665  newmodule->SetLink( 0 );
666 
667  KIGFX::VIEW_CONTROLS* viewControls = pcbframe->GetCanvas()->GetViewControls();
668  VECTOR2D cursorPos = viewControls->GetCursorPosition();
669 
670  commit.Add( newmodule );
671  viewControls->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
672  pcbframe->PlaceModule( newmodule );
673  newmodule->SetPosition( wxPoint( 0, 0 ) );
674  viewControls->SetCrossHairCursorPosition( cursorPos, false );
675  newmodule->SetTimeStamp( GetNewTimeStamp() );
676  commit.Push( wxT( "Insert module" ) );
677 
678  pcbframe->Raise();
679  pcbframe->GetToolManager()->RunAction( PCB_ACTIONS::placeModule, true, newmodule );
680 
681  newmodule->ClearFlags();
682  }
683 }
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:73
static TOOL_ACTION placeModule
Definition: pcb_actions.h:162
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
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
PCB_DRAW_PANEL_GAL * GetCanvas() const override
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:109
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
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:321
void SetLink(timestamp_t aLink)
Definition: class_module.h:530
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:225
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
void SetPosition(const wxPoint &aPos) override
bool IsModal()
Definition: kiway_player.h:163
#define _(s)
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)
Class PCB_EDIT_FRAME is the main frame for Pcbnew.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266
BOARD * GetBoard() const
void PlaceModule(MODULE *aModule, bool aRecreateRatsnest=true)
Function PlaceModule places aModule at the current cursor position and updates module coordinates wit...
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:215

References _, COMMIT::Add(), EDA_ITEM::ClearFlags(), KIWAY_PLAYER::DismissModal(), DisplayErrorMessage(), FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), getCurNickname(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), GetNewTimeStamp(), EDA_BASE_FRAME::GetToolManager(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIWAY_PLAYER::IsModal(), KIWAY_HOLDER::Kiway(), m_fpList, PCB_ACTIONS::placeModule, PCB_BASE_FRAME::PlaceModule(), KIWAY::Player(), BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), MODULE::SetLink(), EDA_ITEM::SetParent(), MODULE::SetPosition(), and EDA_ITEM::SetTimeStamp().

Referenced by DClickOnFootprintList(), and OnCharHook().

◆ AddModuleToBoard()

void PCB_BASE_FRAME::AddModuleToBoard ( MODULE module)
virtualinherited

Adds the given module to the board.

Parameters
module
aDC(can be NULL ) = the current Device Context, to draw the new footprint

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 179 of file pcb_base_frame.cpp.

180 {
181  if( module )
182  {
183  GetBoard()->Add( module, ADD_APPEND );
184 
185  module->SetFlags( IS_NEW );
186 
187  module->SetPosition( wxPoint( 0, 0 ) ); // cursor in GAL may not be initialized yet
188 
189  module->SetTimeStamp( GetNewTimeStamp() );
190 
191  // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
192  // built from a board)
193  if( module->IsFlipped() )
194  module->Flip( module->GetPosition(), m_configSettings.m_FlipLeftRight );
195 
196  // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
197  // it might be stored in another orientation if the lib is an archive built from a board)
198  module->SetOrientation( 0 );
199  }
200 }
bool IsFlipped() const
function IsFlipped
Definition: class_module.h:272
#define IS_NEW
New item, just created.
Definition: base_struct.h:120
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:265
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Function Flip Flip this object, i.e.
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
PCB_GENERAL_SETTINGS m_configSettings
void SetPosition(const wxPoint &aPos) override
void SetOrientation(double newangle)
BOARD * GetBoard() const
const wxPoint GetPosition() const override
Definition: class_module.h:197
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:215

References BOARD::Add(), ADD_APPEND, MODULE::Flip(), PCB_BASE_FRAME::GetBoard(), GetNewTimeStamp(), MODULE::GetPosition(), IS_NEW, MODULE::IsFlipped(), PCB_BASE_FRAME::m_configSettings, PCB_GENERAL_SETTINGS::m_FlipLeftRight, EDA_ITEM::SetFlags(), MODULE::SetOrientation(), MODULE::SetPosition(), and EDA_ITEM::SetTimeStamp().

Referenced by FOOTPRINT_EDIT_FRAME::AddModuleToBoard(), and MWAVE::CreateMicrowaveInductor().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 365 of file eda_base_frame.cpp.

366 {
367  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
368  ACTION_MENU* helpMenu = new ACTION_MENU( false );
369 
370  helpMenu->SetTool( commonControl );
371 
372  helpMenu->Add( ACTIONS::help );
373  helpMenu->Add( ACTIONS::gettingStarted );
374  helpMenu->Add( ACTIONS::listHotKeys );
375  helpMenu->Add( ACTIONS::getInvolved );
376 
377  helpMenu->AppendSeparator();
378  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
379 
380  aMenuBar->Append( helpMenu, _( "&Help" ) );
381 }
static TOOL_ACTION listHotKeys
Definition: actions.h:167
Class ACTION_MENU.
Definition: action_menu.h:43
Class COMMON_CONTROL.
#define _(s)
static TOOL_ACTION help
Definition: actions.h:166
TOOL_MANAGER * m_toolManager
static TOOL_ACTION getInvolved
Definition: actions.h:168
static TOOL_ACTION gettingStarted
Definition: actions.h:165

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

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

Definition at line 349 of file eda_draw_frame.cpp.

350 {
351  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
352  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
353 
354  aMenu.AddSeparator( 1000 );
356  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
357  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
359 
360  aMenu.AddSeparator( 1000 );
361 
362  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
363  zoomMenu->SetTool( commonTools );
364  aToolMenu.AddSubMenu( zoomMenu );
365 
366  auto gridMenu = std::make_shared<GRID_MENU>( this );
367  gridMenu->SetTool( commonTools );
368  aToolMenu.AddSubMenu( gridMenu );
369 
370  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
371  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
372 }
static bool ShowAlways(const SELECTION &aSelection)
Function ShowAlways The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
Class COMMON_TOOLS.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Function AddSeparator()
static TOOL_ACTION zoomCenter
Definition: actions.h:92
static TOOL_ACTION zoomIn
Definition: actions.h:88
static TOOL_ACTION zoomOut
Definition: actions.h:89
TOOL_MANAGER * m_toolManager

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

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

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 554 of file eda_draw_frame.cpp.

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

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

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

◆ ApplyDisplaySettingsToGAL()

void FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL ( )

Updates the GAL with display settings changes.

Definition at line 942 of file footprint_viewer_frame.cpp.

943 {
944  auto painter = static_cast<KIGFX::PCB_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
945  KIGFX::PCB_RENDER_SETTINGS* settings = painter->GetSettings();
946  settings->LoadDisplayOptions( &m_DisplayOptions, false );
947 
949  GetCanvas()->Refresh();
950 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateAllItems(int aUpdateFlags)
Updates all items in the view according to the given flags.
Definition: view.cpp:1444
Item needs to be redrawn.
Definition: view_item.h:61
Class PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:61
virtual KIGFX::PCB_VIEW * GetView() const override
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...
PCB_DISPLAY_OPTIONS m_DisplayOptions
void LoadDisplayOptions(const PCB_DISPLAY_OPTIONS *aOptions, bool aShowPageLimits)
Function LoadDisplayOptions Loads settings related to display options (high-contrast mode,...

References KIGFX::ALL, PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_BASE_FRAME::m_DisplayOptions, EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::UpdateAllItems().

Referenced by DIALOG_FP_BROWSER_DISPLAY_OPTIONS::UpdateObjectSettings().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS_T  aUnits)
inlineinherited

Definition at line 213 of file eda_base_frame.h.

214  {
215  SetUserUnits( aUnits );
217  }
void SetUserUnits(EDA_UNITS_T aUnits)
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 688 of file eda_base_frame.cpp.

689 {
690  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
691 
692  wxFileName autoSaveFileName = aFileName;
693 
694  // Check for auto save file.
695  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
696 
697  wxLogTrace( traceAutoSave,
698  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
699 
700  if( !autoSaveFileName.FileExists() )
701  return;
702 
703  wxString msg = wxString::Format( _(
704  "Well this is potentially embarrassing!\n"
705  "It appears that the last time you were editing the file\n"
706  "\"%s\"\n"
707  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
708  GetChars( aFileName.GetFullName() )
709  );
710 
711  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
712 
713  // Make a backup of the current file, delete the file, and rename the auto save file to
714  // the file name.
715  if( response == wxYES )
716  {
717  // Get the backup file name.
718  wxFileName backupFileName = aFileName;
719  backupFileName.SetExt( aFileName.GetExt() + GetBackupSuffix() );
720 
721  // If an old backup file exists, delete it. If an old copy of the file exists, rename
722  // it to the backup file name
723  if( aFileName.FileExists() )
724  {
725  // Rename the old file to the backup file name.
726  if( !wxRenameFile( aFileName.GetFullPath(), backupFileName.GetFullPath(), true ) )
727  {
728  msg.Printf( _( "Could not create backup file \"%s\"" ),
729  GetChars( backupFileName.GetFullPath() ) );
730  wxMessageBox( msg );
731  }
732  }
733 
734  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
735  {
736  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
737  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
738  }
739  }
740  else
741  {
742  wxLogTrace( traceAutoSave,
743  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
744 
745  // Remove the auto save file when using the previous file as is.
746  wxRemoveFile( autoSaveFileName.GetFullPath() );
747  }
748 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
static wxString GetBackupSuffix()
#define _(s)
static wxString GetAutoSaveFilePrefix()
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

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

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

◆ ClearMsgPanel()

◆ ClickOnFootprintList()

void FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList ( wxCommandEvent &  aEvent)
private

Definition at line 578 of file footprint_viewer_frame.cpp.

579 {
580  if( m_fpList->GetCount() == 0 )
581  return;
582 
583  int ii = m_fpList->GetSelection();
584 
585  if( ii < 0 )
586  return;
587 
588  wxString name = m_fpList->GetString( ii );
589 
590  if( getCurFootprintName().CmpNoCase( name ) != 0 )
591  {
593 
594  // Delete the current footprint (MUST reset tools first)
596 
598 
599  LIB_ID id;
601  id.SetLibItemName( getCurFootprintName() );
602 
603  try
604  {
605  GetBoard()->Add( loadFootprint( id ) );
606  }
607  catch( const IO_ERROR& ioe )
608  {
609  wxString msg = wxString::Format( _( "Could not load footprint '%s' from library '%s'."
610  "\n\n%s" ),
612  getCurNickname(),
613  ioe.Problem() );
614  DisplayError( this, msg );
615  }
616 
617  UpdateTitle();
618 
619  updateView();
620 
621  GetCanvas()->Refresh();
622  Update3DView( true );
623  }
624 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
void UpdateTitle()
Function UpdateTitle updates the window title with current library information.
Model changes (required full reload)
Definition: tool_base.h:82
void setCurFootprintName(const wxString &aName)
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
virtual const wxString Problem() const
what was the problem?
Definition: exceptions.cpp:49
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Function ResetTools() Resets all tools (i.e.
#define _(s)
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
const char * name
Definition: DXF_plotter.cpp:61
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void DeleteAllModules()
Removes all modules from the deque and frees the memory associated with them.
Definition: class_board.h:293
BOARD * GetBoard() const
void Update3DView(bool aForceReload, const wxString *aTitle=nullptr) override
Function Update3DView must be called after a footprint selection Updates the 3D view and 3D frame tit...
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
MODULE * loadFootprint(const LIB_ID &aFootprintId)
Function loadFootprint attempts to load aFootprintId from the footprint library table.

References _, BOARD::Add(), BOARD::DeleteAllModules(), DisplayError(), Format(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), getCurFootprintName(), getCurNickname(), EDA_BASE_FRAME::GetToolManager(), PCB_BASE_FRAME::loadFootprint(), m_fpList, TOOL_BASE::MODEL_RELOAD, name, IO_ERROR::Problem(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::ResetTools(), setCurFootprintName(), LIB_ID::SetLibNickname(), Update3DView(), UpdateTitle(), and updateView().

Referenced by ReCreateFootprintList(), selectNext(), and selectPrev().

◆ ClickOnLibList()

void FOOTPRINT_VIEWER_FRAME::ClickOnLibList ( wxCommandEvent &  aEvent)
private

Definition at line 559 of file footprint_viewer_frame.cpp.

560 {
561  int ii = m_libList->GetSelection();
562 
563  if( ii < 0 )
564  return;
565 
566  wxString name = m_libList->GetString( ii );
567 
568  if( getCurNickname() == name )
569  return;
570 
571  setCurNickname( name );
572 
574  UpdateTitle();
575 }
void UpdateTitle()
Function UpdateTitle updates the window title with current library information.
void setCurNickname(const wxString &aNickname)
const char * name
Definition: DXF_plotter.cpp:61

References getCurNickname(), m_libList, name, ReCreateFootprintList(), setCurNickname(), and UpdateTitle().

Referenced by ReCreateLibraryList(), selectNext(), and selectPrev().

◆ CloseFootprintViewer()

void FOOTPRINT_VIEWER_FRAME::CloseFootprintViewer ( wxCommandEvent &  event)
private

Definition at line 975 of file footprint_viewer_frame.cpp.

976 {
977  Close( false );
978 }

◆ CommonSettingsChanged()

void FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged)
overrideprivatevirtual

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

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_BASE_FRAME.

Definition at line 721 of file footprint_viewer_frame.cpp.

722 {
723  PCB_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged );
724 
725  if( aEnvVarsChanged )
727 }
void CommonSettingsChanged(bool aEnvVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
void ReCreateLibraryList()
Function ReCreateLibraryList.

References PCB_BASE_FRAME::CommonSettingsChanged(), and ReCreateLibraryList().

◆ Compile_Ratsnest()

void PCB_BASE_FRAME::Compile_Ratsnest ( bool  aDisplayStatus)
inherited

Function Compile_Ratsnest Create the entire board ratsnest.

Must be called after a board change (changes for pads, footprints or a read netlist ).

Parameters
aDC= the current device context (can be NULL)
aDisplayStatus: if true, display the computation results

Definition at line 44 of file ratsnest.cpp.

45 {
46  GetBoard()->GetConnectivity()->RecalculateRatsnest();
47  ClearMsgPanel();
48 
49  if( aDisplayStatus )
50  {
51  std::shared_ptr<CONNECTIVITY_DATA> conn = m_Pcb->GetConnectivity();
52  wxString msg;
53 
54  msg.Printf( wxT( " %d" ), conn->GetPadCount() );
55  AppendMsgPanel( _( "Pads" ), msg, RED );
56 
57  msg.Printf( wxT( " %d" ), conn->GetNetCount() - 1 /* Don't include "No Net" in count */ );
58  AppendMsgPanel( _( "Nets" ), msg, CYAN );
59 
60  SetMsgPanel( m_Pcb );
61  }
62 }
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
Definition: colors.h:59
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:310
Definition: colors.h:60
virtual void ClearMsgPanel()
Clear all messages from the message panel.
#define _(s)
void AppendMsgPanel(const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
Append a message to the message panel.
BOARD * GetBoard() const

References _, EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), CYAN, PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), PCB_BASE_FRAME::m_Pcb, RED, and EDA_DRAW_FRAME::SetMsgPanel().

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PCB_EDIT_FRAME::ExportToGenCAD(), DIALOG_EXCHANGE_FOOTPRINTS::OnApplyClicked(), PCB_EDIT_FRAME::OpenProjectFiles(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ config()

wxConfigBase * EDA_BASE_FRAME::config ( )
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 536 of file eda_base_frame.cpp.

537 {
538  // KICAD_MANAGER_FRAME overrides this
539  wxConfigBase* ret = Kiface().KifaceSettings();
540  //wxASSERT( ret );
541  return ret;
542 }
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51

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

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetSettings(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SIM_PLOT_FRAME::onClose(), FOOTPRINT_WIZARD_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OpenProjectFiles(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and EDA_BASE_FRAME::windowClosing().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineinherited
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.

Definition at line 337 of file eda_base_frame.h.

338  {
339  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
340  return baseCfgName;
341  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

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

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )
inherited

Shows the 3D view frame.

If it does not exist, it is created. If it exists, it is bring to the foreground

Definition at line 367 of file pcb_base_frame.cpp.

368 {
369  EDA_3D_VIEWER* draw3DFrame = Get3DViewerFrame();
370 
371  if( !draw3DFrame )
372  draw3DFrame = new EDA_3D_VIEWER( &Kiway(), this, _( "3D Viewer" ) );
373 
374  // Raising the window does not show the window on Windows if iconized. This should work
375  // on any platform.
376  if( draw3DFrame->IsIconized() )
377  draw3DFrame->Iconize( false );
378 
379  draw3DFrame->Raise();
380  draw3DFrame->Show( true );
381 
382  // Raising the window does not set the focus on Linux. This should work on any platform.
383  if( wxWindow::FindFocus() != draw3DFrame )
384  draw3DFrame->SetFocus();
385 
386  return draw3DFrame;
387 }
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
#define _(s)
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
Definition: eda_3d_viewer.h:56
EDA_3D_VIEWER * Get3DViewerFrame()

References _, PCB_BASE_FRAME::Get3DViewerFrame(), and KIWAY_HOLDER::Kiway().

Referenced by CVPCB_FOOTPRINT_VIEWER_CONTROL::Show3DViewer(), and PCBNEW_CONTROL::Show3DViewer().

◆ CreateNewModule()

MODULE * PCB_BASE_FRAME::CreateNewModule ( const wxString &  aModuleName)
inherited

Function CreateNewModule Creates a new module or footprint, at position 0,0 The new module contains only 2 texts: a reference and a value: Reference = REF** Value = "VAL**" or Footprint name in lib Note: they are dummy texts, which will be replaced by the actual texts when the fooprint is placed on a board and a netlist is read.

Parameters
aModuleName= name of the new footprint in library
Returns
a reference to the new module

Definition at line 1034 of file footprint_libraries_utils.cpp.

1035 {
1036  // Creates a new footprint at position 0,0 which contains the minimal items:
1037  // the reference and the value.
1038  // Value : initialized to the footprint name.
1039  // put on fab layer (front side)
1040  // Reference : initialized to a default value (REF**).
1041  // put on silkscreen layer (front side)
1042 
1043  wxString moduleName = aModuleName;
1044 
1045  // Ask for the new module name
1046  if( moduleName.IsEmpty() )
1047  {
1048  WX_TEXT_ENTRY_DIALOG dlg( this, FMT_MOD_REF, FMT_MOD_CREATE, moduleName );
1049  dlg.SetTextValidator( FILE_NAME_CHAR_VALIDATOR( &moduleName ) );
1050 
1051  if( dlg.ShowModal() != wxID_OK )
1052  return NULL; //Aborted by user
1053  }
1054 
1055  moduleName.Trim( true );
1056  moduleName.Trim( false );
1057 
1058  if( moduleName.IsEmpty() )
1059  {
1061  return NULL;
1062  }
1063 
1064  // Creates the new module and add it to the head of the linked list of modules
1065  MODULE* module = new MODULE( GetBoard() );
1066 
1067  // Update parameters: timestamp ...
1068  module->SetLastEditTime();
1069 
1070  // Update its name in lib
1071  module->SetFPID( LIB_ID( wxEmptyString, moduleName ) );
1072 
1073  wxPoint default_pos;
1075 
1076  // Update reference:
1077  if( settings.m_RefDefaultText.IsEmpty() )
1078  module->SetReference( moduleName );
1079  else
1080  module->SetReference( settings.m_RefDefaultText );
1081 
1082  PCB_LAYER_ID layer = ToLAYER_ID( settings.m_RefDefaultlayer );
1083  module->Reference().SetThickness( settings.GetTextThickness( layer ) );
1084  module->Reference().SetTextSize( settings.GetTextSize( layer ) );
1085  module->Reference().SetItalic( settings.GetTextItalic( layer ) );
1086  module->Reference().SetKeepUpright( settings.GetTextUpright( layer ) );
1087  default_pos.y = GetDesignSettings().GetTextSize( layer ).y / 2;
1088  module->Reference().SetPosition( default_pos );
1089  module->Reference().SetLayer( layer );
1090  module->Reference().SetVisible( settings.m_RefDefaultVisibility );
1091 
1092  // Set the value field to a default value
1093  if( settings.m_ValueDefaultText.IsEmpty() )
1094  module->SetValue( moduleName );
1095  else
1096  module->SetValue( settings.m_ValueDefaultText );
1097 
1098  layer = ToLAYER_ID( settings.m_ValueDefaultlayer );
1099  module->Value().SetThickness( settings.GetTextThickness( layer ) );
1100  module->Value().SetTextSize( settings.GetTextSize( layer ) );
1101  module->Value().SetItalic( settings.GetTextItalic( layer ) );
1102  module->Value().SetKeepUpright( settings.GetTextUpright( layer ) );
1103  default_pos.y = -default_pos.y;
1104  module->Value().SetPosition( default_pos );
1105  module->Value().SetLayer( layer );
1106  module->Value().SetVisible( settings.m_ValueDefaultVisibility );
1107 
1108  SetMsgPanel( module );
1109  return module;
1110 }
wxString m_RefDefaultText
Default ref text on fp creation.
bool m_ValueDefaultVisibility
Default value text visibility on fp creation.
void SetKeepUpright(bool aKeepUpright)
TEXTE_MODULE & Reference()
Definition: class_module.h:457
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings returns the BOARD_DESIGN_SETTINGS for the BOARD owned by this frame.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
void SetItalic(bool isItalic)
Definition: eda_text.h:163
void SetVisible(bool aVisible)
Definition: eda_text.h:169
int m_ValueDefaultlayer
Default value text layer on fp creation.
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:222
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int GetTextThickness(PCB_LAYER_ID aLayer) const
Function GetTextThickness Returns the default text thickness from the layer class for the given layer...
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
bool GetTextUpright(PCB_LAYER_ID aLayer) const
bool GetTextItalic(PCB_LAYER_ID aLayer) const
#define FMT_NO_REF_ABORTED
PCB_LAYER_ID
A quick note on layer IDs:
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:456
void SetLastEditTime(timestamp_t aTime)
Definition: class_module.h:327
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:426
virtual void SetPosition(const wxPoint &aPos) override
wxString m_ValueDefaultText
Default value text on fp creation.
void SetValue(const wxString &aValue)
Function SetValue.
Definition: class_module.h:450
int m_RefDefaultlayer
Default ref text layer on fp creation.
BOARD * GetBoard() const
#define FMT_MOD_CREATE
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:265
bool m_RefDefaultVisibility
Default ref text visibility on fp creation.
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:207
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:813
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Function GetTextSize Returns the default text size from the layer class for the given layer.
void SetThickness(int aNewThickness)
Function SetThickness sets pen width.
Definition: eda_text.h:142
#define FMT_MOD_REF
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References DisplayInfoMessage(), FMT_MOD_CREATE, FMT_MOD_REF, FMT_NO_REF_ABORTED, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOARD_DESIGN_SETTINGS::GetTextUpright(), BOARD_DESIGN_SETTINGS::m_RefDefaultlayer, BOARD_DESIGN_SETTINGS::m_RefDefaultText, BOARD_DESIGN_SETTINGS::m_RefDefaultVisibility, BOARD_DESIGN_SETTINGS::m_ValueDefaultlayer, BOARD_DESIGN_SETTINGS::m_ValueDefaultText, BOARD_DESIGN_SETTINGS::m_ValueDefaultVisibility, MODULE::Reference(), MODULE::SetFPID(), EDA_TEXT::SetItalic(), TEXTE_MODULE::SetKeepUpright(), MODULE::SetLastEditTime(), BOARD_ITEM::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), TEXTE_MODULE::SetPosition(), MODULE::SetReference(), EDA_TEXT::SetTextSize(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), EDA_TEXT::SetThickness(), MODULE::SetValue(), EDA_TEXT::SetVisible(), ToLAYER_ID(), and MODULE::Value().

Referenced by MWAVE::CreateMicrowaveInductor(), and PCB_EDIT_FRAME::CreateMuWaveBaseFootprint().

◆ CreateServer()

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

Definition at line 49 of file eda_dde.cpp.

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

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

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

◆ CurrentToolName()

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

Definition at line 220 of file eda_base_frame.cpp.

221 {
222  if( m_toolStack.empty() )
223  return ACTIONS::selectionTool.GetName();
224  else
225  return m_toolStack.back();
226 }
std::vector< std::string > m_toolStack
static TOOL_ACTION selectionTool
Definition: actions.h:143

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

◆ DClickOnFootprintList()

void FOOTPRINT_VIEWER_FRAME::DClickOnFootprintList ( wxCommandEvent &  aEvent)
private

Definition at line 627 of file footprint_viewer_frame.cpp.

628 {
629  AddFootprintToPCB( aEvent );
630 }
void AddFootprintToPCB(wxCommandEvent &aEvent)
Function AddFootprintToPCB exports the current footprint name and close the library browser.

References AddFootprintToPCB().

◆ Destroy()

◆ DismissModal()

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

Definition at line 160 of file kiway_player.cpp.

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

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

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

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )
inherited

Function DisplayGridMsg()

Display the current grid pane on the status bar.

Definition at line 552 of file pcb_base_frame.cpp.

553 {
554  wxString line;
555  wxString gridformatter;
556 
557  switch( m_userUnits )
558  {
559  case INCHES:
560  gridformatter = "grid X %.6f Y %.6f";
561  break;
562 
563  case MILLIMETRES:
564  gridformatter = "grid X %.6f Y %.6f";
565  break;
566 
567  default:
568  gridformatter = "grid X %f Y %f";
569  break;
570  }
571 
572  BASE_SCREEN* screen = GetScreen();
573  wxArrayString gridsList;
574 
575  int icurr = screen->BuildGridsChoiceList( gridsList, m_userUnits != INCHES );
576  GRID_TYPE& grid = screen->GetGrid( icurr );
577  double grid_x = To_User_Unit( m_userUnits, grid.m_Size.x );
578  double grid_y = To_User_Unit( m_userUnits, grid.m_Size.y );
579  line.Printf( gridformatter, grid_x, grid_y );
580 
581  SetStatusText( line, 4 );
582 }
int BuildGridsChoiceList(wxArrayString &aGridsList, bool aMmFirst) const
Function BuildGridsChoiceList().
const GRID_TYPE & GetGrid() const
Return the grid object of the currently selected grid.
Definition: base_screen.h:286
double To_User_Unit(EDA_UNITS_T aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:93
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:74
Definition: common.h:134
wxRealPoint m_Size
Definition: base_screen.h:47
EDA_UNITS_T m_userUnits
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.

References BASE_SCREEN::BuildGridsChoiceList(), BASE_SCREEN::GetGrid(), PCB_BASE_FRAME::GetScreen(), INCHES, GRID_TYPE::m_Size, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and To_User_Unit().

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 375 of file eda_draw_frame.cpp.

376 {
377  SetStatusText( msg, 6 );
378 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane on the status bar.

Definition at line 412 of file eda_draw_frame.cpp.

413 {
414  wxString msg;
415 
416  switch( m_userUnits )
417  {
418  case INCHES: msg = _( "Inches" ); break;
419  case MILLIMETRES: msg = _( "mm" ); break;
420  default: msg = _( "Units" ); break;
421  }
422 
423  SetStatusText( msg, 5 );
424 }
Definition: common.h:134
#define _(s)
EDA_UNITS_T m_userUnits

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

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 303 of file eda_base_frame.cpp.

304 {
305  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
306 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ Edit_Module()

void PCB_BASE_FRAME::Edit_Module ( MODULE module,
wxDC *  DC 
)
inherited

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 244 of file eda_draw_frame.cpp.

245 {
246  if( m_messagePanel )
248 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:216

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

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

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

Parameters
cmdline= received command from socket

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 274 of file eda_draw_frame.h.

274 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint &  aPos,
bool  aCenterView = false 
)
inherited

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

Parameters
aPosis the point to go to.
aCenterViewis true if the new cursor position should be centered on canvas.

Definition at line 727 of file eda_draw_frame.cpp.

728 {
729  if( aCenterView )
730  {
731  wxWindow* dialog = findDialog( GetChildren() );
732 
733  // If a dialog partly obscures the window, then center on the uncovered area.
734  if( dialog )
735  {
736  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
737  dialog->GetSize() );
738  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
739  }
740  else
741  GetCanvas()->GetView()->SetCenter( aPos );
742  }
743 
745 }
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:604
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.

References findDialog(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().

Referenced by DIALOG_DRC_CONTROL::doSelectionMenu(), SELECTION_TOOL::findCallback(), SCH_EDITOR_CONTROL::FindNext(), DIALOG_DRC_CONTROL::focusOnItem(), DIALOG_FIND::onButtonFindItemClick(), DIALOG_FIND::onButtonFindMarkerClick(), DIALOG_ERC::OnLeftClickMarkersList(), DIALOG_ERC::OnLeftDblClickMarkersList(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), and DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem().

◆ Get3DViewerFrame()

EDA_3D_VIEWER * PCB_BASE_FRAME::Get3DViewerFrame ( )
inherited
Returns
a reference to the child 3D viewer frame, when exists, or NULL

Definition at line 112 of file pcb_base_frame.cpp.

113 {
114  return dynamic_cast<EDA_3D_VIEWER*>( FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) ) );
115 }
#define QUALIFIED_VIEWER3D_FRAMENAME(parent)
Definition: eda_3d_viewer.h:50

References QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by PCB_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::Update3DView(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 467 of file eda_base_frame.h.

467 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetActiveLayer()

◆ GetAutoSaveFilePrefix()

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

Definition at line 166 of file eda_base_frame.h.

167  {
168  return wxT( "_autosave-" );
169  }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 282 of file eda_base_frame.h.

282 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAutoZoom()

bool FOOTPRINT_VIEWER_FRAME::GetAutoZoom ( ) const
inline

Definition at line 60 of file footprint_viewer_frame.h.

References m_autoZoom.

Referenced by DIALOG_FP_BROWSER_DISPLAY_OPTIONS::initDialog().

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const
overridevirtualinherited

Return the origin of the axis used for plotting and various exports.

Implements EDA_DRAW_FRAME.

Definition at line 231 of file pcb_base_frame.cpp.

232 {
233  wxASSERT( m_Pcb );
234  return m_Pcb->GetAuxOrigin();
235 }
const wxPoint & GetAuxOrigin() const
Definition: class_board.h:363

References BOARD::GetAuxOrigin(), and PCB_BASE_FRAME::m_Pcb.

Referenced by PCB_EDIT_FRAME::ExportToGenCAD(), EDIT_TOOL::MoveExact(), and DIALOG_GENDRILL::UpdateDrillParams().

◆ GetBackupSuffix()

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

Definition at line 158 of file eda_base_frame.h.

159  {
160  return wxT( "-bak" );
161  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::createBackupFile(), PCB_EDIT_FRAME::Files_io_from_id(), and SCH_EDIT_FRAME::SaveEEFile().

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 192 of file pcb_base_frame.h.

193  {
194  wxASSERT( m_Pcb );
195  return m_Pcb;
196  }

References PCB_BASE_FRAME::m_Pcb.

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), AddFootprintToPCB(), PCB_BASE_FRAME::AddModuleToBoard(), DIALOG_PLOT::applyPlotSettings(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_COPPER_ZONE::buildAvailableListOfNets(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), ClickOnFootprintList(), PCB_BASE_FRAME::Compile_Ratsnest(), DIALOG_GEN_FOOTPRINT_POSITION::CreateFiles(), CreateHeaderInfoData(), PCB_BASE_FRAME::CreateNewModule(), DIALOG_PRINT_PCBNEW::createPrintout(), MODULE_EDITOR_TOOLS::CutCopyFootprint(), PCBNEW_CONTROL::DeleteItemCursor(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), DIALOG_DRC_CONTROL::doSelectionMenu(), ROUTER_TOOL::DpDimensionsDialog(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::Exchange_Module(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), MODULE_EDITOR_TOOLS::ExportFootprint(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), PCB_EDITOR_CONTROL::ExportSpecctraDSN(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::fixEagleNets(), FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::GenD356File(), PCB_EDIT_FRAME::GenFootprintsReport(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), GetBoard(), EDA_3D_VIEWER::GetBoard(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), PCB_LAYER_SELECTOR::GetLayerName(), PCB_LAYER_BOX_SELECTOR::GetLayerName(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), FOOTPRINT_EDIT_FRAME::GetModel(), PCB_EDIT_FRAME::GetProjectFileParameters(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GRID_CELL_LAYER_SELECTOR::GetValue(), FOOTPRINT_EDIT_FRAME::Import_Module(), PCB_EDIT_FRAME::importFile(), MODULE_EDITOR_TOOLS::ImportFootprint(), PCB_EDITOR_CONTROL::ImportSpecctraSession(), DIALOG_PLOT::init_Dialog(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), ARRAY_CREATOR::Invoke(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), FOOTPRINT_EDIT_FRAME::IsElementVisible(), PCB_LAYER_SELECTOR::IsLayerEnabled(), PCB_LAYER_BOX_SELECTOR::IsLayerEnabled(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), DIALOG_NETLIST::loadNetlist(), DIALOG_DRC_CONTROL::OnActivateDlg(), DIALOG_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_FIND::onButtonFindItemClick(), DIALOG_FIND::onButtonFindMarkerClick(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), DIALOG_NETLIST::OnCompileRatsnestClick(), DIALOG_EXPORT_STEP::onExportButton(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), PCB_LAYER_WIDGET::OnLayerVisible(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnRightUpItem(), DIALOG_NETLIST::OnTestFootprintsClick(), PCB_BASE_FRAME::OnTogglePadDrawMode(), OnUpdateFootprintButton(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateModuleSelected(), DIALOG_NETLIST::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), PANEL_SETUP_FEATURE_CONSTRAINTS::PANEL_SETUP_FEATURE_CONSTRAINTS(), PANEL_SETUP_LAYERS::PANEL_SETUP_LAYERS(), PANEL_SETUP_MASK_AND_PASTE::PANEL_SETUP_MASK_AND_PASTE(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SETUP_TEXT_AND_GRAPHICS::PANEL_SETUP_TEXT_AND_GRAPHICS(), PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS(), DIALOG_UPDATE_PCB::PerformUpdate(), MODULE_EDITOR_TOOLS::PlacePad(), DIALOG_PLOT::Plot(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), MODULE_EDITOR_TOOLS::Properties(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PCB_LAYER_WIDGET::ReFill(), PCB_LAYER_WIDGET::ReFillRender(), Refresh(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), DRC::Reset(), DRC::RunTests(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), FOOTPRINT_EDIT_FRAME::SetDesignSettings(), DIALOG_DRC_CONTROL::SetDRCParameters(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), ZONE_SETTINGS::SetupLayersList(), FOOTPRINT_EDIT_FRAME::setupTools(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_EDIT_FRAME::SwitchLayer(), PCB_LAYER_WIDGET::SyncLayerVisibilities(), FOOTPRINT_EDIT_FRAME::SyncToolbars(), DRC::testDisabledLayers(), DRC::TestZoneToZoneOutline(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), PCBNEW_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), DRC::updatePointers(), FOOTPRINT_EDIT_FRAME::updateTitle(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), updateView(), FOOTPRINT_EDIT_FRAME::updateView(), DIALOG_DRC_CONTROL::writeReport(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetBoardBoundingBox()

EDA_RECT PCB_BASE_FRAME::GetBoardBoundingBox ( bool  aBoardEdgesOnly = false) const
inherited

Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge segments).

Parameters
aBoardEdgesOnlyis true if we are interested in board edge segments only.
Returns
EDA_RECT - the board's bounding box

Definition at line 322 of file pcb_base_frame.cpp.

323 {
324  wxASSERT( m_Pcb );
325 
326  EDA_RECT area = aBoardEdgesOnly ? m_Pcb->GetBoardEdgesBoundingBox() : m_Pcb->GetBoundingBox();
327 
328  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
329  {
330  wxSize pageSize = GetPageSizeIU();
331 
333  {
334  area.SetOrigin( 0, 0 );
335  area.SetEnd( pageSize.x, pageSize.y );
336  }
337  else
338  {
339  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
340  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
341  }
342  }
343 
344  return area;
345 }
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: class_board.h:792
const EDA_RECT GetBoardEdgesBoundingBox() const
Function GetBoardEdgesBoundingBox Returns the board bounding box calculated using exclusively the boa...
Definition: class_board.h:804
int GetWidth() const
Definition: eda_rect.h:119
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
bool m_showBorderAndTitleBlock
void SetEnd(int x, int y)
Definition: eda_rect.h:192
int GetHeight() const
Definition: eda_rect.h:120
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...

References BOARD::GetBoardEdgesBoundingBox(), BOARD::GetBoundingBox(), EDA_RECT::GetHeight(), PCB_BASE_FRAME::GetPageSizeIU(), EDA_RECT::GetWidth(), PCB_BASE_FRAME::m_Pcb, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), and PCB_BASE_FRAME::GetDocumentExtents().

◆ GetCanvas()

PCB_DRAW_PANEL_GAL * PCB_BASE_FRAME::GetCanvas ( ) const
overridevirtualinherited

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

Returns
Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 835 of file pcb_base_frame.cpp.

836 {
837  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
838 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), AddFootprintToPCB(), ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), GRID_HELPER::BestDragOrigin(), GRID_HELPER::BestSnapAnchor(), ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), DIALOG_PRINT_PCBNEW::createPrintout(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_DRC_CONTROL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EnumeratePads(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SELECTION_TOOL::findCallback(), DIALOG_DRC_CONTROL::focusOnItem(), FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), GRID_HELPER::GRID_HELPER(), FOOTPRINT_EDIT_FRAME::HardRedraw(), DIALOG_SELECT_NET_FROM_LIST::HighlightNet(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), ROUTER_TOOL::InlineDrag(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PCBNEW_PICKER_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Move(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_EXCHANGE_FOOTPRINTS::OnApplyClicked(), DIALOG_FIND::onButtonFindItemClick(), DIALOG_FIND::onButtonFindMarkerClick(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), OnCloseWindow(), PCB_BASE_EDIT_FRAME::OnGridSettings(), PCB_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerSelect(), PCB_LAYER_WIDGET::OnLayerVisible(), PCB_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnRightUpItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), PCB_BASE_FRAME::OnToggleEdgeDrawMode(), PCB_BASE_FRAME::OnToggleGraphicDrawMode(), PCB_BASE_FRAME::OnTogglePadDrawMode(), PCB_BASE_FRAME::OnToggleTextDrawMode(), PCB_BASE_FRAME::OnUpdateSelectZoom(), FOOTPRINT_TREE_PANE::onUpdateUI(), PCB_EDIT_FRAME::OpenProjectFiles(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_EDIT_FRAME::Process_Special_Functions(), MODULE_EDITOR_TOOLS::Properties(), BOARD_COMMIT::Push(), GRID_HELPER::queryVisible(), PCB_INSPECTION_TOOL::ratsnestTimer(), ReCreateLibraryList(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), DIALOG_DRC_CONTROL::RedrawDrawPanel(), Refresh(), refreshCallback(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SELECTION_TOOL::RequestSelection(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), SaveSettings(), SelectAndViewFootprint(), DRAWING_TOOL::SetAnchor(), GRID_HELPER::SetAuxAxes(), PCB_BASE_EDIT_FRAME::SetBoard(), POINT_EDITOR::setEditedPoint(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::setupTools(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PCB_BASE_FRAME::UpdateStatusBar(), FOOTPRINT_EDIT_FRAME::UpdateUserInterface(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), updateView(), FOOTPRINT_EDIT_FRAME::updateView(), SELECTION_TOOL::zoomFitSelection(), DIALOG_NETLIST::~DIALOG_NETLIST(), DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), ~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME(), and PCB_BASE_FRAME::~PCB_BASE_FRAME().

◆ GetCanvasTypeKey()

virtual wxString EDA_DRAW_FRAME::GetCanvasTypeKey ( )
inlineprotectedvirtualinherited
Returns
the key in KifaceSettings to store the canvas type. the base version returns only CanvasTypeKeyBase. Can be overriden to return a key specific of a frame name

Definition at line 170 of file eda_draw_frame.h.

170 { return CanvasTypeKeyBase; }
#define CanvasTypeKeyBase
The key to store the canvas type in config.

References CanvasTypeKeyBase.

Referenced by EDA_DRAW_FRAME::LoadCanvasTypeSetting(), and EDA_DRAW_FRAME::saveCanvasTypeSetting().

◆ GetCollectorsGuide()

GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide ( )
inherited

Function GetCollectorsGuide.

Returns
GENERAL_COLLECTORS_GUIDE - that considers the global configuration options.

Definition at line 524 of file pcb_base_frame.cpp.

525 {
527  GetCanvas()->GetView() );
528 
529  // account for the globals
531  guide.SetIgnoreMTextsOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_BK ) );
532  guide.SetIgnoreMTextsOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_FR ) );
533  guide.SetIgnoreModulesOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_BK ) );
534  guide.SetIgnoreModulesOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_FR ) );
535  guide.SetIgnorePadsOnBack( ! m_Pcb->IsElementVisible( LAYER_PAD_BK ) );
536  guide.SetIgnorePadsOnFront( ! m_Pcb->IsElementVisible( LAYER_PAD_FR ) );
537  guide.SetIgnoreThroughHolePads( ! m_Pcb->IsElementVisible( LAYER_PADS_TH ) );
538  guide.SetIgnoreModulesVals( ! m_Pcb->IsElementVisible( LAYER_MOD_VALUES ) );
539  guide.SetIgnoreModulesRefs( ! m_Pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
540  guide.SetIgnoreThroughVias( ! m_Pcb->IsElementVisible( LAYER_VIA_THROUGH ) );
541  guide.SetIgnoreBlindBuriedVias( ! m_Pcb->IsElementVisible( LAYER_VIA_BBLIND ) );
542  guide.SetIgnoreMicroVias( ! m_Pcb->IsElementVisible( LAYER_VIA_MICROVIA ) );
543  guide.SetIgnoreTracks( ! m_Pcb->IsElementVisible( LAYER_TRACKS ) );
544 
545  return guide;
546 }
to draw blind/buried vias
multilayer pads, usually with holes
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
show modules values (when texts are visibles)
show modules on front
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
to draw usual through hole vias
void SetIgnoreMTextsMarkedNoShow(bool ignore)
Definition: collectors.h:541
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
smd pads, front layer
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:385
show modules references (when texts are visibles)

References PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), LAYER_MOD_BK, LAYER_MOD_FR, LAYER_MOD_REFERENCES, LAYER_MOD_TEXT_BK, LAYER_MOD_TEXT_FR, LAYER_MOD_TEXT_INVISIBLE, LAYER_MOD_VALUES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_TRACKS, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, PCB_BASE_FRAME::m_Pcb, and GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsMarkedNoShow().

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), and PCB_INSPECTION_TOOL::highlightNet().

◆ GetConfigSettings()

PCB_GENERAL_SETTINGS& FOOTPRINT_VIEWER_FRAME::GetConfigSettings ( )
inline

Definition at line 53 of file footprint_viewer_frame.h.

53 { return m_configSettings; }
PCB_GENERAL_SETTINGS m_configSettings

References PCB_BASE_FRAME::m_configSettings.

◆ getCurFootprintName()

const wxString FOOTPRINT_VIEWER_FRAME::getCurFootprintName ( )
private

Definition at line 742 of file footprint_viewer_frame.cpp.

743 {
745 }
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:186

References PROJECT::GetRString(), PROJECT::PCB_FOOTPRINT_VIEWER_FPNAME, and KIWAY_HOLDER::Prj().

Referenced by ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME(), ReCreateFootprintList(), SelectAndViewFootprint(), and Update3DView().

◆ getCurNickname()

const wxString FOOTPRINT_VIEWER_FRAME::getCurNickname ( )
private

Definition at line 730 of file footprint_viewer_frame.cpp.

731 {
733 }
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:186

References PROJECT::GetRString(), PROJECT::PCB_FOOTPRINT_VIEWER_NICKNAME, and KIWAY_HOLDER::Prj().

Referenced by AddFootprintToPCB(), ClickOnFootprintList(), ClickOnLibList(), FOOTPRINT_VIEWER_FRAME(), ReCreateFootprintList(), ReCreateLibraryList(), SelectAndViewFootprint(), and UpdateTitle().

◆ GetDesignSettings()

◆ GetDisplayOptions()

void* PCB_BASE_FRAME::GetDisplayOptions ( )
inlineoverridevirtualinherited

Function GetDisplayOptions returns the display options current in use Display options are relative to the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode) Must be overloaded in frames which have display options (board editor and footprint editor)

Reimplemented from EDA_DRAW_FRAME.

Definition at line 171 of file pcb_base_frame.h.

171 { return &m_DisplayOptions; }
PCB_DISPLAY_OPTIONS m_DisplayOptions

References PCB_BASE_FRAME::m_DisplayOptions.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), PCB_EDIT_FRAME::GetConfigurationSettings(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::initDialog(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::initDialog(), PCB_LAYER_WIDGET::OnLayerSelect(), PCB_LAYER_WIDGET::OnRenderEnable(), PCB_DRAW_PANEL_GAL::OnShow(), PCB_BASE_FRAME::OnToggleEdgeDrawMode(), PCB_BASE_FRAME::OnToggleGraphicDrawMode(), PCB_BASE_FRAME::OnTogglePadDrawMode(), PCB_BASE_FRAME::OnToggleTextDrawMode(), TEXTE_PCB::Print(), PCB_TARGET::Print(), ZONE_CONTAINER::Print(), EDGE_MODULE::Print(), TRACK::Print(), TEXTE_MODULE::Print(), DIMENSION::Print(), DRAWSEGMENT::Print(), VIA::Print(), D_PAD::Print(), ZONE_CONTAINER::PrintFilledArea(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), PCB_LAYER_WIDGET::ReFillRender(), SELECTION_TOOL::selectPoint(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), FOOTPRINT_EDIT_FRAME::SyncToolbars(), PCB_EDIT_FRAME::SyncToolbars(), Trace_Pads_Only(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_PCBNEW_SETTINGS::TransferDataToWindow(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::UpdateObjectSettings(), and DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::UpdateObjectSettings().

◆ GetDocumentExtents()

const BOX2I PCB_BASE_FRAME::GetDocumentExtents ( ) const
inlineoverridevirtualinherited

Reimplemented from EDA_DRAW_FRAME.

Definition at line 135 of file pcb_base_frame.h.

136  {
137  return GetBoardBoundingBox( false );
138  }
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge se...

References PCB_BASE_FRAME::GetBoardBoundingBox().

◆ GetDoImmediateActions()

bool EDA_BASE_FRAME::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 243 of file eda_base_frame.h.

243 { return m_immediateActions; }

References EDA_BASE_FRAME::m_immediateActions.

◆ GetDragSelects()

bool EDA_BASE_FRAME::GetDragSelects ( ) const
inlineinherited

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

Definition at line 249 of file eda_base_frame.h.

249 { return m_dragSelects; }

References EDA_BASE_FRAME::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
wxFileHistory *  aFileHistory = NULL 
)
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 wxFileHistory::UseMenu was called at init time

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

Definition at line 575 of file eda_base_frame.cpp.

577 {
578  wxFileHistory* fileHistory = aFileHistory;
579 
580  if( !fileHistory )
581  fileHistory = &Kiface().GetFileHistory();
582 
583  int baseId = fileHistory->GetBaseId();
584 
585  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) fileHistory->GetCount() );
586 
587  unsigned i = cmdId - baseId;
588 
589  if( i < fileHistory->GetCount() )
590  {
591  wxString fn = fileHistory->GetHistoryFile( i );
592 
593  if( wxFileName::FileExists( fn ) )
594  return fn;
595  else
596  {
597  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
598  wxMessageBox( msg );
599 
600  fileHistory->RemoveFileFromHistory( i );
601  }
602  }
603 
604  return wxEmptyString;
605 }
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
FILE_HISTORY & GetFileHistory()
Definition: kiface_i.h:123
size_t i
Definition: json11.cpp:597

References _, Format(), KIFACE_I::GetFileHistory(), i, and Kiface().

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

◆ GetFootprintFromBoardByReference()

MODULE * PCB_BASE_FRAME::GetFootprintFromBoardByReference ( )
inherited

Function GetFootprintFromBoardByReference.

Returns
a reference to the footprint found by its refence on the curent board. the reference is entered by the user from a dialog (by awxTextCtlr, or a list of available references)

Definition at line 438 of file load_select_footprint.cpp.

439 {
440  wxString moduleName;
441  wxArrayString fplist;
442 
443  // Build list of available fp references, to display them in dialog
444  for( auto fp : GetBoard()->Modules() )
445  fplist.Add( fp->GetReference() + wxT(" ( ") + fp->GetValue() + wxT(" )") );
446 
447  fplist.Sort();
448 
449  DIALOG_GET_FOOTPRINT_BY_NAME dlg( this, fplist );
450 
451  if( dlg.ShowModal() != wxID_OK ) //Aborted by user
452  return NULL;
453 
454  moduleName = dlg.GetValue();
455  moduleName.Trim( true );
456  moduleName.Trim( false );
457 
458  if( !moduleName.IsEmpty() )
459  {
460  for( auto mod : GetBoard()->Modules() )
461  {
462  if( mod->GetReference().CmpNoCase( moduleName ) == 0 )
463  return mod;
464  }
465  }
466 
467  return nullptr;
468 }
DIALOG_GET_FOOTPRINT_BY_NAME is a helper dialog to select a footprint by its reference One can enter ...
MODULES & Modules()
Definition: class_board.h:236
BOARD * GetBoard() const
#define mod(a, n)
Definition: greymap.cpp:24

References MODULE::Add(), GetBoard(), DIALOG_GET_FOOTPRINT_BY_NAME::GetValue(), mod, and BOARD::Modules().

◆ GetGalDisplayOptions()

◆ GetGridColor()

COLOR4D FOOTPRINT_VIEWER_FRAME::GetGridColor ( )
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 849 of file footprint_viewer_frame.cpp.

850 {
851  return Settings().Colors().GetItemColor( LAYER_GRID );
852 }
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
PCB_GENERAL_SETTINGS & Settings()
COLORS_DESIGN_SETTINGS & Colors()

References PCB_GENERAL_SETTINGS::Colors(), COLORS_DESIGN_SETTINGS::GetItemColor(), LAYER_GRID, and PCB_BASE_FRAME::Settings().

◆ GetGridOrigin()

const wxPoint & PCB_BASE_FRAME::GetGridOrigin ( ) const
overridevirtualinherited

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

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

Implements EDA_DRAW_FRAME.

Definition at line 245 of file pcb_base_frame.cpp.

246 {
247  wxASSERT( m_Pcb );
248  return m_Pcb->GetGridOrigin();
249 }
const wxPoint & GetGridOrigin() const
Definition: class_board.h:370

References BOARD::GetGridOrigin(), and PCB_BASE_FRAME::m_Pcb.

Referenced by GRID_HELPER::GetOrigin(), DIALOG_SET_GRID::TransferDataFromWindow(), and DIALOG_SET_GRID::TransferDataToWindow().

◆ GetLastGridSizeId()

int EDA_DRAW_FRAME::GetLastGridSizeId ( ) const
inlineinherited

Definition at line 227 of file eda_draw_frame.h.

227 { return m_LastGridSizeId; }

References EDA_DRAW_FRAME::m_LastGridSizeId.

◆ GetMoveWarpsCursor()

bool EDA_BASE_FRAME::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 255 of file eda_base_frame.h.

255 { return m_moveWarpsCursor; }

References EDA_BASE_FRAME::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const
inlineinherited

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 690 of file eda_draw_frame.cpp.

691 {
692  return GetScreen()->getNearestGridPosition( aPosition, GetGridOrigin() );
693 }
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
wxPoint getNearestGridPosition(const wxPoint &aPosition, const wxPoint &aGridOrigin) const
Function getNearestGridPosition returns the nearest aGridSize location to aPosition.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References EDA_DRAW_FRAME::GetGridOrigin(), BASE_SCREEN::getNearestGridPosition(), and EDA_DRAW_FRAME::GetScreen().

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

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 213 of file pcb_base_frame.cpp.

214 {
215  wxASSERT( m_Pcb );
216  return m_Pcb->GetPageSettings();
217 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:555

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_Pcb.

Referenced by PCBNEW_CONTROL::Print().

◆ GetPageSizeIU()

const wxSize PCB_BASE_FRAME::GetPageSizeIU ( ) const
overridevirtualinherited

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

Implements EDA_DRAW_FRAME.

Definition at line 220 of file pcb_base_frame.cpp.

221 {
222  wxASSERT( m_Pcb );
223 
224  // this function is only needed because EDA_DRAW_FRAME is not compiled
225  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
226  // into an application specific source file.
227  return m_Pcb->GetPageSettings().GetSizeIU();
228 }
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:555

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_Pcb.

Referenced by PCBNEW_CONTROL::AppendBoard(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetBoardBoundingBox(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & PCB_BASE_FRAME::GetPlotSettings ( ) const
virtualinherited

Function GetPlotSettings returns the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 308 of file pcb_base_frame.cpp.

309 {
310  wxASSERT( m_Pcb );
311  return m_Pcb->GetPlotOptions();
312 }
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:558

References BOARD::GetPlotOptions(), and PCB_BASE_FRAME::m_Pcb.

Referenced by DIALOG_PLOT::CreateDrillFile(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_PLOT::DIALOG_PLOT(), and FOOTPRINT_EDIT_FRAME::GetPlotSettings().

◆ GetScreen()

PCB_SCREEN* PCB_BASE_FRAME::GetScreen ( ) const
inlineoverridevirtualinherited

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

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 205 of file pcb_base_frame.h.

205 { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References EDA_DRAW_FRAME::GetScreen().

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), PCB_BASE_FRAME::DisplayGridMsg(), PCB_EDIT_FRAME::doAutoSave(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Files_io_from_id(), FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetActiveLayer(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), GRID_HELPER::GetGrid(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), MODULE_EDITOR_TOOLS::ImportFootprint(), PCBNEW_CONTROL::LayerToggle(), EDIT_TOOL::MoveExact(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_FIND::onButtonFindItemClick(), DIALOG_FIND::onButtonFindMarkerClick(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_BASE_FRAME::OnModify(), PCB_BASE_FRAME::OnUpdateSelectZoom(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), ROUTER_TOOL::onViaCommand(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), VIA::Print(), D_PAD::Print(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_BASE_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetFastGrid1(), PCB_BASE_FRAME::SetFastGrid2(), PCB_BASE_FRAME::SetPageSettings(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), FOOTPRINT_EDIT_FRAME::SyncToolbars(), PCB_EDIT_FRAME::SyncToolbars(), DIALOG_SET_GRID::TransferDataFromWindow(), PCBNEW_CONTROL::updateGrid(), PCB_BASE_FRAME::UpdateGridSelectBox(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::updateZoomSelectBox(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 801 of file eda_draw_frame.cpp.

802 {
803  // Virtual function. Base class implementation returns an empty string.
804  return wxEmptyString;
805 }

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

◆ GetShowPolarCoords()

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 259 of file pcb_base_frame.cpp.

260 {
261  wxASSERT( m_Pcb );
262  return m_Pcb->GetTitleBlock();
263 }
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:561

References BOARD::GetTitleBlock(), and PCB_BASE_FRAME::m_Pcb.

Referenced by CreateHeaderInfoData().

◆ GetToolManager()

TOOL_MANAGER* EDA_BASE_FRAME::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 222 of file eda_base_frame.h.

222 { return m_toolManager; }
TOOL_MANAGER * m_toolManager

References EDA_BASE_FRAME::m_toolManager.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), TREEPROJECT_ITEM::Activate(), AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), BOARD_COMMIT::BOARD_COMMIT(), ClickOnFootprintList(), EDA_BASE_FRAME::CommonSettingsChanged(), DIALOG_DRC_CONTROL::DelDRCMarkers(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), SCH_EDIT_FRAME::DisplayCurrentSheet(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_DRC_CONTROL::doSelectionMenu(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), DIALOG_DRC_CONTROL::focusOnItem(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), LIB_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_FIND::onButtonFindItemClick(), DIALOG_FIND::onButtonFindMarkerClick(), DIALOG_INSPECTOR::onCellClicked(), SIM_PLOT_FRAME::onClose(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_DRC_CONTROL::OnDeleteOneClick(), DIALOG_ERC::OnLeftClickMarkersList(), FOOTPRINTS_LISTBOX::OnLeftDClick(), SIM_PLOT_FRAME::onProbe(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnRightUpItem(), DIALOG_PLOT::onRunDRC(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), DIALOG_PLOT::Plot(), EDA_BASE_FRAME::PopTool(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_BASE_FRAME::SetFastGrid1(), PCB_BASE_FRAME::SetFastGrid2(), CVPCB_MAINFRAME::setupEventHandlers(), PCB_LAYER_WIDGET::SyncLayerAlphaIndicators(), DIALOG_SET_GRID::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

EDA_UNITS_T EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 210 of file eda_base_frame.h.

210 { return m_userUnits; }
EDA_UNITS_T m_userUnits

References EDA_BASE_FRAME::m_userUnits.

Referenced by PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), PCB_EDIT_FRAME::Create_MuWaveComponent(), MWAVE::CreateMicrowaveInductor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), GERBER_FILE_IMAGE::DisplayImageInfo(), MARKER_BASE::DisplayMarkerInfo(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_PIN_TOOL::EditPinProperties(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_MODEDIT_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), PANEL_SETUP_NETCLASSES::getNetclassValue(), GetUserUnits(), GRID_MENU::GRID_MENU(), PCB_INSPECTION_TOOL::highlightNet(), GERBVIEW_FRAME::Liste_D_Codes(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PANEL_PREV_3D::PANEL_PREV_3D(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), DRC::Reset(), CONNECTION_SUBGRAPH::ResolveDrivers(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), FOOTPRINT_EDIT_FRAME::SyncToolbars(), LIB_EDIT_FRAME::SyncToolbars(), GERBVIEW_FRAME::SyncToolbars(), PCB_EDIT_FRAME::SyncToolbars(), SCH_EDIT_FRAME::SyncToolbars(), DRC::testDrilledHoles(), DRC::testUnconnected(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), PANEL_MODEDIT_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_SETTINGS::TransferDataToWindow(), PANEL_PCBNEW_SETTINGS::TransferDataToWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), GRID_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), GERBVIEW_FRAME::updateDCodeSelectBox(), GERBVIEW_FRAME::updateGridSelectBox(), PCB_BASE_FRAME::UpdateGridSelectBox(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCBNEW_CONTROL::UpdateMessagePanel(), DRC::updatePointers(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateTrackWidthSelectBox(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), PANEL_SETUP_TRACKS_AND_VIAS::validateData(), and PANEL_SETUP_NETCLASSES::validateData().

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const
inherited

Definition at line 294 of file pcb_base_frame.cpp.

295 {
296  wxASSERT( m_Pcb );
297  return m_Pcb->GetZoneSettings();
298 }
const ZONE_SETTINGS & GetZoneSettings() const
Definition: class_board.h:564

References BOARD::GetZoneSettings(), and PCB_BASE_FRAME::m_Pcb.

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params().

◆ GetZoom()

double EDA_DRAW_FRAME::GetZoom ( )
inherited
Returns
The current zoom level.

Definition at line 343 of file eda_draw_frame.cpp.

344 {
345  return GetScreen()->GetZoom();
346 }
double GetZoom() const
Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device ...
Definition: base_screen.h:240
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References EDA_DRAW_FRAME::GetScreen(), and BASE_SCREEN::GetZoom().

Referenced by FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::updateZoomSelectBox(), and GERBVIEW_FRAME::updateZoomSelectBox().

◆ GetZoomLevelCoeff()

double EDA_DRAW_FRAME::GetZoomLevelCoeff ( ) const
inlineinherited

Return the coefficient to convert internal display scale factor to zoom level.

Definition at line 289 of file eda_draw_frame.h.

289 { return m_zoomLevelCoeff; }
double m_zoomLevelCoeff

References EDA_DRAW_FRAME::m_zoomLevelCoeff.

Referenced by COMMON_TOOLS::doZoomToPreset(), FOOTPRINT_VIEWER_FRAME(), EDA_DRAW_PANEL_GAL::GetLegacyZoom(), and ZOOM_MENU::ZOOM_MENU().

◆ GetZoomLevelIndicator()

const wxString PCB_BASE_FRAME::GetZoomLevelIndicator ( ) const
overridevirtualinherited

Function GetZoomLevelIndicator returns a human readable value which can be displayed as zoom level indicator in dialogs.

Virtual from the base class

Reimplemented from EDA_DRAW_FRAME.

Definition at line 756 of file pcb_base_frame.cpp.

757 {
759 }
virtual const wxString GetZoomLevelIndicator() const
Return a human readable value which can be displayed as zoom level indicator in dialogs.

References EDA_DRAW_FRAME::GetZoomLevelIndicator().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )
virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

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

Definition at line 703 of file eda_draw_frame.cpp.

704 {
705  // To be implemented by subclasses.
706 }

Referenced by COMMON_TOOLS::ZoomRedraw().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 551 of file eda_base_frame.cpp.

552 {
553  return Kiface().GetHelpFileName();
554 }
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
const wxString & GetHelpFileName() const
Function GetHelpFileName returns just the basename portion of the current help file.
Definition: kiface_i.h:121

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

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

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

◆ InitExitKey()

void EDA_DRAW_FRAME::InitExitKey ( )
protectedinherited

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

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

Definition at line 316 of file eda_draw_frame.cpp.

317 {
318  wxAcceleratorEntry entries[1];
319  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
320  wxAcceleratorTable accel( 1, entries );
321  SetAcceleratorTable( accel );
322 }

Referenced by FOOTPRINT_VIEWER_FRAME().

◆ InstallDisplayOptions()

void FOOTPRINT_VIEWER_FRAME::InstallDisplayOptions ( wxCommandEvent &  aEvent)
private

Definition at line 30 of file dialog_fp_browser_display_options.cpp.

31 {
33 
34  dlg.ShowModal();
35 }

◆ InstallPadOptionsFrame()

void PCB_BASE_FRAME::InstallPadOptionsFrame ( D_PAD pad)
inherited

Definition at line 96 of file dialog_pad_properties.cpp.

97 {
98  DIALOG_PAD_PROPERTIES dlg( this, aPad );
99  dlg.ShowQuasiModal(); // QuasiModal required for NET_SELECTOR
100 }
class DIALOG_PAD_PROPERTIES, derived from DIALOG_PAD_PROPERTIES_BASE, created by wxFormBuilder

References DIALOG_SHIM::ShowQuasiModal().

Referenced by PCB_EDIT_FRAME::OnEditItemRequest().

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

Definition at line 311 of file eda_base_frame.h.

311 { }

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

181 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsCurrentTool()

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

Definition at line 229 of file eda_base_frame.cpp.

230 {
231  if( m_toolStack.empty() )
232  return &aAction == &ACTIONS::selectionTool;
233  else
234  return m_toolStack.back() == aAction.GetName();
235 }
std::vector< std::string > m_toolStack
static TOOL_ACTION selectionTool
Definition: actions.h:143
const std::string & GetName() const
Function GetName() Returns name of the action.
Definition: tool_action.h:78

References TOOL_ACTION::GetName(), EDA_BASE_FRAME::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(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), and LIB_EDIT_FRAME::SyncToolbars().

◆ 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 154 of file kiway_player.cpp.

155 {
156  return !m_modal_loop;
157 }
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:189

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridVisible()

◆ IsModal()

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 284 of file eda_base_frame.h.

284 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), LIB_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), LIB_CONTROL::CutCopyDelete(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_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(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PICKER_TOOL::Main(), LIB_CONTROL::OnDeMorgan(), PCB_LAYER_WIDGET::OnRenderEnable(), PCBNEW_CONTROL::Paste(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), PCBNEW_CONTROL::Show3DViewer(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), and COMMON_TOOLS::ZoomFitScreen().

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

645 {
646  wxString msg;
647  wxFileName fn = aFileName;
648 
649  // Check for absence of a file path with a file name. Unfortunately KiCad
650  // uses paths relative to the current project path without the ./ part which
651  // confuses wxFileName. Making the file name path absolute may be less than
652  // elegant but it solves the problem.
653  if( fn.GetPath().IsEmpty() && fn.HasName() )
654  fn.MakeAbsolute();
655 
656  wxCHECK_MSG( fn.IsOk(), false,
657  wxT( "File name object is invalid. Bad programmer!" ) );
658  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
659  wxT( "File name object path <" ) + fn.GetFullPath() +
660  wxT( "> is not set. Bad programmer!" ) );
661 
662  if( fn.IsDir() && !fn.IsDirWritable() )
663  {
664  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
665  GetChars( fn.GetPath() ) );
666  }
667  else if( !fn.FileExists() && !fn.IsDirWritable() )
668  {
669  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
670  GetChars( fn.GetFullName() ), GetChars( fn.GetPath() ) );
671  }
672  else if( fn.FileExists() && !fn.IsFileWritable() )
673  {
674  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
675  GetChars( fn.GetFullPath() ) );
676  }
677 
678  if( !msg.IsEmpty() )
679  {
680  wxMessageBox( msg );
681  return false;
682  }
683 
684  return true;
685 }
#define _(s)
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101

References _, and GetChars().

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), LIB_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), CVPCB_MAINFRAME::SaveProjectFile(), 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(), AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), 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(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), 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 175 of file kiway_player.cpp.

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

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

Merely override it in derived classes.

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

Definition at line 69 of file kiway_player.cpp.

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

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 182 of file kiway_player.cpp.

183 {
184  int id = event.GetId();
185 
186  // tell all the KIWAY_PLAYERs about the language change.
187  Kiway().SetLanguage( id );
188 }
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:415

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 
)
protectedinherited
Parameters
doOpenif true runs an Open Library browser, otherwise New Library
aFilenamefor New may contain a default name; in both cases return the chosen filename.
wildcarda wildcard to filter the displayed files
extthe library file extension
isDirectoryindicates the library files are directories
Returns
true for OK; false for Cancel.

Definition at line 807 of file eda_draw_frame.cpp.

810 {
811  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
812  aFilename.SetExt( ext );
813 
814  if( isDirectory && doOpen )
815  {
816  wxDirDialog dlg( this, prompt, Prj().GetProjectPath(),
817  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
818 
819  if( dlg.ShowModal() == wxID_CANCEL )
820  return false;
821 
822  aFilename = dlg.GetPath();
823  aFilename.SetExt( ext );
824  }
825  else
826  {
827  wxFileDialog dlg( this, prompt, Prj().GetProjectPath(), aFilename.GetFullName() ,
828  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
829  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
830 
831  if( dlg.ShowModal() == wxID_CANCEL )
832  return false;
833 
834  aFilename = dlg.GetPath();
835  aFilename.SetExt( ext );
836  }
837 
838  return true;
839 }
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)

References _, and KIWAY_HOLDER::Prj().

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

◆ LoadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::LoadCanvasTypeSetting ( )
inherited

Returns the canvas type stored in the application settings.

Definition at line 613 of file eda_draw_frame.cpp.

614 {
616  wxConfigBase* cfg = Kiface().KifaceSettings();
617 
618  if( cfg )
619  {
620  canvasType = (EDA_DRAW_PANEL_GAL::GAL_TYPE)
622  }
623 
624  if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
625  || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
626  {
627  wxASSERT( false );
629  }
630 
631  // Legacy canvas no longer supported. Switch to Cairo, and on the first instantiation
632  // the user will be prompted to switch to OpenGL
633  if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
634  {
635 #ifdef __WXMAC__
636  // Cairo renderer doesn't handle Retina displays
638 #else
640 #endif
641  }
642 
643  return canvasType;
644 }
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
virtual wxString GetCanvasTypeKey()
Sentinel, do not use as a parameter.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
GAL not used (the legacy wxDC engine is used)

References EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST, EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, EDA_DRAW_FRAME::GetCanvasTypeKey(), Kiface(), and KIFACE_I::KifaceSettings().

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

◆ loadFootprint()

MODULE * PCB_BASE_FRAME::loadFootprint ( const LIB_ID aFootprintId)
protectedinherited

Function loadFootprint attempts to load aFootprintId from the footprint library table.

Parameters
aFootprintIdis the LIB_ID of component footprint to load.
Returns
the MODULE if found or NULL if aFootprintId not found in any of the libraries in the table returned from Prj().PcbFootprintLibs().
Exceptions
IO_ERRORif an I/O error occurs or a PARSE_ERROR if a file parsing error occurs while reading footprint library files.

Definition at line 308 of file load_select_footprint.cpp.

309 {
310  FP_LIB_TABLE* fptbl = Prj().PcbFootprintLibs();
311 
312  wxCHECK_MSG( fptbl, NULL, wxT( "Cannot look up LIB_ID in NULL FP_LIB_TABLE." ) );
313 
314  MODULE *module = nullptr;
315  try
316  {
317  module = fptbl->FootprintLoadWithOptionalNickname( aFootprintId );
318  }
319  catch( const IO_ERROR& ioe )
320  {
321  wxLogDebug( wxT( "An error occurred attemping to load footprint '%s'.\n\nError: %s" ),
322  aFootprintId.Format().c_str(), GetChars( ioe.What() ) );
323  }
324 
325  // If the module is found, clear all net info,
326  // to be sure there is no broken links
327  // to any netinfo list (should be not needed, but it can be edited from
328  // the footprint editor )
329  if( module )
330  module->ClearAllNets();
331 
332  return module;
333 }
const char * c_str() const
Definition: utf8.h:107
void ClearAllNets()
Function ClearAllNets Clear (i.e.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
UTF8 Format() const
Definition: lib_id.cpp:237
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
MODULE * FootprintLoadWithOptionalNickname(const LIB_ID &aFootprintId)
Function FootprintLoadWithOptionalNickname loads a footprint having aFootprintId with possibly an emp...
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References UTF8::c_str(), MODULE::ClearAllNets(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), LIB_ID::Format(), GetChars(), PROJECT::PcbFootprintLibs(), Prj(), and IO_ERROR::What().

Referenced by ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::LoadFootprints(), and FOOTPRINT_EDIT_FRAME::restoreLastFootprint().

◆ LoadFootprint()

MODULE * PCB_BASE_FRAME::LoadFootprint ( const LIB_ID aFootprintId)
inherited

Function LoadFootprint attempts to load aFootprintId from the footprint library table.

Parameters
aFootprintIdis the LIB_ID of component footprint to load.
Returns
the MODULE if found or NULL if aFootprintId not found in any of the libraries in table returned from Prj().PcbFootprintLibs().

Definition at line 290 of file load_select_footprint.cpp.

291 {
292  MODULE* module = NULL;
293 
294  try
295  {
296  module = loadFootprint( aFootprintId );
297  }
298  catch( const IO_ERROR& ioe )
299  {
300  wxLogDebug( wxT( "An error occurred attemping to load footprint '%s'.\n\nError: %s" ),
301  aFootprintId.Format().c_str(), GetChars( ioe.What() ) );
302  }
303 
304  return module;
305 }
const char * c_str() const
Definition: utf8.h:107
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
UTF8 Format() const
Definition: lib_id.cpp:237
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
MODULE * loadFootprint(const LIB_ID &aFootprintId)
Function loadFootprint attempts to load aFootprintId from the footprint library table.

References UTF8::c_str(), LIB_ID::Format(), GetChars(), and IO_ERROR::What().

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), MODULE_EDITOR_TOOLS::CutCopyFootprint(), MODULE_EDITOR_TOOLS::ExportFootprint(), DIALOG_EXCHANGE_FOOTPRINTS::processModule(), and BOARD_NETLIST_UPDATER::replaceComponent().

◆ LoadSettings()

void FOOTPRINT_VIEWER_FRAME::LoadSettings ( wxConfigBase *  aCfg)
overrideprivatevirtual

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.

Definition at line 686 of file footprint_viewer_frame.cpp.

687 {
689 
690  // Fetch grid settings from Footprint Editor
691  wxString footprintEditor = FOOTPRINT_EDIT_FRAME_NAME;
692  bool btmp;
693  COLOR4D wtmp;
694 
695  if( aCfg->Read( footprintEditor + ShowGridEntryKeyword, &btmp ) )
696  SetGridVisibility( btmp );
697 
698  if( wtmp.SetFromWxString( aCfg->Read( footprintEditor + GridColorEntryKeyword,
699  wxT( "NONE" ) ) ) )
700  SetGridColor( wtmp );
701 
702  // Grid shape, etc.
703  GetGalDisplayOptions().ReadAppConfig( *aCfg, footprintEditor );
704 
705  m_configSettings.Load( aCfg ); // mainly, load the color config
706 
707  aCfg->Read( ConfigBaseName() + AUTO_ZOOM_KEY, &m_autoZoom, true );
708  aCfg->Read( ConfigBaseName() + ZOOM_KEY, &m_lastZoom, 10.0 );
709 }
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
void Load(wxConfigBase *aCfg) override
wxString ConfigBaseName()
virtual void SetGridColor(COLOR4D aColor)
static const wxChar AUTO_ZOOM_KEY[]
Key in KifaceSettings to store the canvas type.
#define FOOTPRINT_EDIT_FRAME_NAME
PCB_GENERAL_SETTINGS m_configSettings
void ReadAppConfig(wxConfigBase &aCfg, const wxString &aBaseName)
Read GAL config options from applicaton-level config.
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
#define ShowGridEntryKeyword
Nonzero to show grid (suffix)
virtual void SetGridVisibility(bool aVisible)
#define GridColorEntryKeyword
Grid color ID (suffix)
static const wxChar ZOOM_KEY[]
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References PCB_BASE_FRAME::AUTO_ZOOM_KEY, EDA_BASE_FRAME::ConfigBaseName(), FOOTPRINT_EDIT_FRAME_NAME, EDA_DRAW_FRAME::GetGalDisplayOptions(), GridColorEntryKeyword, PCB_GENERAL_SETTINGS::Load(), PCB_BASE_FRAME::LoadSettings(), m_autoZoom, PCB_BASE_FRAME::m_configSettings, m_lastZoom, KIGFX::GAL_DISPLAY_OPTIONS::ReadAppConfig(), EDA_DRAW_FRAME::SetGridColor(), EDA_DRAW_FRAME::SetGridVisibility(), ShowGridEntryKeyword, and PCB_BASE_FRAME::ZOOM_KEY.

Referenced by FOOTPRINT_VIEWER_FRAME().

◆ LockFile()

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

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

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

Definition at line 200 of file eda_draw_frame.cpp.

201 {
202  m_file_checker = ::LockFile( aFileName );
203 
204  return bool( m_file_checker );
205 }
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
prevents opening same file multiple times.
bool LockFile(const wxString &aFileName)
Mark a schematic file as being in use.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ OnActivate()

void FOOTPRINT_VIEWER_FRAME::OnActivate ( wxActivateEvent &  event)
private

Function OnActivate is called when the frame frame is activate to reload the libraries and component lists that can be changed by the schematic editor or the library editor.

Definition at line 754 of file footprint_viewer_frame.cpp.

755 {
756  if( event.GetActive() )
757  {
758  // Ensure we have the right library list:
759  std::vector< wxString > libNicknames = Prj().PcbFootprintLibs()->GetLogicalLibs();
760  bool stale = false;
761 
762  if( libNicknames.size() != m_libList->GetCount() )
763  stale = true;
764  else
765  {
766  for( unsigned ii = 0; ii < libNicknames.size(); ii++ )
767  {
768  if( libNicknames[ii] != m_libList->GetString( ii ) )
769  {
770  stale = true;
771  break;
772  }
773  }
774  }
775 
776  if( stale )
777  {
779  UpdateTitle();
780  }
781  }
782 
783  event.Skip(); // required under wxMAC
784 }
void UpdateTitle()
Function UpdateTitle updates the window title with current library information.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
void ReCreateLibraryList()
Function ReCreateLibraryList.
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References LIB_TABLE::GetLogicalLibs(), m_libList, PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), ReCreateLibraryList(), and UpdateTitle().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 296 of file eda_base_frame.cpp.

297 {
298  if( !doAutoSave() )
299  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
300 }
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 FOOTPRINT_VIEWER_FRAME::OnCharHook ( wxKeyEvent &  event)
overrideprivatevirtual

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 from EDA_BASE_FRAME.

Definition at line 467 of file footprint_viewer_frame.cpp.

468 {
469  if( aEvent.GetKeyCode() == WXK_UP )
470  {
471  wxWindow* focused = FindFocus();
472 
473  if( m_libFilter->HasFocus() || m_libList->HasFocus() )
475  else
476  selectPrev( m_fpList );
477 
478  // Need to reset the focus after selection due to GTK mouse-refresh
479  // that captures the mouse into the canvas to update scrollbars
480  if( focused )
481  focused->SetFocus();
482  }
483  else if( aEvent.GetKeyCode() == WXK_DOWN )
484  {
485  wxWindow* focused = FindFocus();
486 
487  if( m_libFilter->HasFocus() || m_libList->HasFocus() )
489  else
490  selectNext( m_fpList );
491 
492  // Need to reset the focus after selection due to GTK mouse-refresh
493  // that captures the mouse into the canvas to update scrollbars
494  if( focused )
495  focused->SetFocus();
496  }
497  else if( aEvent.GetKeyCode() == WXK_TAB && m_libFilter->HasFocus() )
498  {
499  if( !aEvent.ShiftDown() )
500  m_fpFilter->SetFocus();
501  else
502  aEvent.Skip();
503  }
504  else if( aEvent.GetKeyCode() == WXK_TAB && m_fpFilter->HasFocus() )
505  {
506  if( aEvent.ShiftDown() )
507  m_libFilter->SetFocus();
508  else
509  aEvent.Skip();
510  }
511  else if( aEvent.GetKeyCode() == WXK_RETURN && m_fpList->GetSelection() >= 0 )
512  {
513  wxCommandEvent dummy;
515  }
516  else
517  aEvent.Skip();
518 }
void selectNext(wxListBox *aListBox)
void selectPrev(wxListBox *aListBox)
void AddFootprintToPCB(wxCommandEvent &aEvent)
Function AddFootprintToPCB exports the current footprint name and close the library browser.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.

References AddFootprintToPCB(), dummy(), m_fpFilter, m_fpList, m_libFilter, m_libList, selectNext(), and selectPrev().

◆ OnCloseWindow()

void FOOTPRINT_VIEWER_FRAME::OnCloseWindow ( wxCloseEvent &  Event)
overrideprivatevirtual

Implements PCB_BASE_FRAME.

Definition at line 275 of file footprint_viewer_frame.cpp.

276 {
277  // A workaround to avoid flicker, in modal mode when modview frame is destroyed,
278  // when the aui toolbar is not docked (i.e. shown in a miniframe)
279  // (usefull on windows only)
280  m_mainToolBar->SetFocus();
281 
282  GetCanvas()->StopDrawing();
283 
284  if( IsModal() )
285  {
286  // Only dismiss a modal frame once, so that the return values set by
287  // the prior DismissModal() are not bashed for ShowModal().
288  if( !IsDismissed() )
289  DismissModal( false );
290 
291  // window to be destroyed by the caller of KIWAY_PLAYER::ShowModal()
292  }
293  else
294  Destroy();
295 }
bool IsDismissed()
Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
ACTION_TOOLBAR * m_mainToolBar
bool IsModal()
Definition: kiway_player.h:163
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...

References KIWAY_PLAYER::Destroy(), KIWAY_PLAYER::DismissModal(), PCB_BASE_FRAME::GetCanvas(), KIWAY_PLAYER::IsDismissed(), KIWAY_PLAYER::IsModal(), EDA_DRAW_FRAME::m_mainToolBar, and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ OnExitKiCad()

void FOOTPRINT_VIEWER_FRAME::OnExitKiCad ( wxCommandEvent &  event)
private

Definition at line 969 of file footprint_viewer_frame.cpp.

970 {
971  Kiway().OnKiCadExit();
972 }
void OnKiCadExit()
Definition: kiway.cpp:502
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

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

◆ OnFPFilter()

void FOOTPRINT_VIEWER_FRAME::OnFPFilter ( wxCommandEvent &  aEvent)
private

Definition at line 457 of file footprint_viewer_frame.cpp.

458 {
460 
461  // Required to avoid interaction with SetHint()
462  // See documentation for wxTextEntry::SetHint
463  aEvent.Skip();
464 }

References ReCreateFootprintList().

◆ OnGridSettings()

virtual void EDA_DRAW_FRAME::OnGridSettings ( wxCommandEvent &  event)
inlinevirtualinherited

Reimplemented in PCB_BASE_EDIT_FRAME, and SCH_BASE_FRAME.

Definition at line 321 of file eda_draw_frame.h.

321 { };

Referenced by EDA_DRAW_FRAME::OnSelectGrid().

◆ OnIterateFootprintList()

void FOOTPRINT_VIEWER_FRAME::OnIterateFootprintList ( wxCommandEvent &  event)
private

Definition at line 855 of file footprint_viewer_frame.cpp.

856 {
857  switch( event.GetId() )
858  {
859  case ID_MODVIEW_NEXT:
861  break;
862 
863  case ID_MODVIEW_PREVIOUS:
865  break;
866 
867  default:
868  wxString id = wxString::Format( "%i", event.GetId() );
869  wxFAIL_MSG( "FOOTPRINT_VIEWER_FRAME::OnIterateFootprintList error: id = " + id );
870  }
871 }
#define PREVIOUS_PART
void SelectAndViewFootprint(int aMode)
Function SelectAndViewFootprint Select and load the next or the previous footprint if no current foot...
#define NEXT_PART
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), ID_MODVIEW_NEXT, ID_MODVIEW_PREVIOUS, NEXT_PART, PREVIOUS_PART, and SelectAndViewFootprint().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 608 of file eda_base_frame.cpp.

609 {
610  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
611  ShowAboutDialog( this );
612 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnLibFilter()

void FOOTPRINT_VIEWER_FRAME::OnLibFilter ( wxCommandEvent &  aEvent)
private

Definition at line 447 of file footprint_viewer_frame.cpp.

448 {
450 
451  // Required to avoid interaction with SetHint()
452  // See documentation for wxTextEntry::SetHint
453  aEvent.Skip();
454 }
void ReCreateLibraryList()
Function ReCreateLibraryList.

References ReCreateLibraryList().

◆ OnMenuOpen()

void EDA_BASE_FRAME::OnMenuOpen ( wxMenuEvent &  event)
inherited

Workaround some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 318 of file eda_base_frame.cpp.

319 {
320  //
321  // wxWidgets has several issues that we have to work around:
322  //
323  // 1) wxWidgets 3.0.x Windows has a bug where wxEVT_MENU_OPEN and wxEVT_MENU_HIGHLIGHT
324  // events are not captured by the ACTON_MENU menus. So we forward them here.
325  // (FWIW, this one is fixed in wxWidgets 3.1.x.)
326  //
327  // 2) wxWidgets doesn't pass the menu pointer for wxEVT_MENU_HIGHLIGHT events. So we
328  // store the menu pointer from the wxEVT_MENU_OPEN call.
329  //
330  // 3) wxWidgets has no way to tell whether a command is from a menu selection or a
331  // hotkey. So we keep track of menu highlighting so we can differentiate.
332  //
333 
334  static ACTION_MENU* currentMenu;
335 
336  if( event.GetEventType() == wxEVT_MENU_OPEN )
337  {
338  currentMenu = dynamic_cast<ACTION_MENU*>( event.GetMenu() );
339 
340  if( currentMenu )
341  currentMenu->OnMenuEvent( event );
342  }
343  else if( event.GetEventType() == wxEVT_MENU_HIGHLIGHT )
344  {
345  if( currentMenu )
346  currentMenu->OnMenuEvent( event );
347  }
348  else if( event.GetEventType() == wxEVT_MENU_CLOSE )
349  {
350  if( currentMenu )
351  currentMenu->OnMenuEvent( event );
352 
353  currentMenu = nullptr;
354  }
355 
356  event.Skip();
357 }
Class ACTION_MENU.
Definition: action_menu.h:43
void OnMenuEvent(wxMenuEvent &aEvent)

References ACTION_MENU::OnMenuEvent().

◆ OnModify()

void PCB_BASE_FRAME::OnModify ( )
virtualinherited

Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the current screen and update the date in frame reference do not forget to call this basic OnModify function to update info in derived OnModify functions.

Reimplemented in PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 746 of file pcb_base_frame.cpp.

747 {
748  GetScreen()->SetModify();
749  GetScreen()->SetSave();
750 
751  UpdateStatusBar();
752  UpdateMsgPanel();
753 }
void SetSave()
Definition: base_screen.h:226
virtual void UpdateStatusBar() override
Update the status bar information.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SetModify()
Definition: base_screen.h:224
virtual void UpdateMsgPanel()
Redraw the message panel.

References PCB_BASE_FRAME::GetScreen(), BASE_SCREEN::SetModify(), BASE_SCREEN::SetSave(), EDA_DRAW_FRAME::UpdateMsgPanel(), and PCB_BASE_FRAME::UpdateStatusBar().

Referenced by PCB_EDITOR_CONTROL::DoSetDrillOrigin(), PCBNEW_CONTROL::DoSetGridOrigin(), EDIT_TOOL::EditFpInFpEditor(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), PCB_LAYER_WIDGET::OnLayerVisible(), FOOTPRINT_EDIT_FRAME::OnModify(), PCB_EDIT_FRAME::OnModify(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), BOARD_COMMIT::Push(), GLOBAL_EDIT_TOOL::SwapLayers(), and DIALOG_SET_GRID::TransferDataFromWindow().

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )
inlinevirtualinherited

Called when modifying the page settings.

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

Reimplemented in SCH_EDIT_FRAME.

Definition at line 395 of file eda_draw_frame.h.

395 {}

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 615 of file eda_base_frame.cpp.

616 {
617  PAGED_DIALOG dlg( this, _( "Preferences" ) );
618  wxTreebook* book = dlg.GetTreebook();
619 
620  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
621 
622  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
623  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
624 
625  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
626  {
627  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
628 
629  if( frame )
630  frame->InstallPreferences( &dlg, hotkeysPanel );
631  }
632 
633  // The Kicad manager frame is not a player so we have to add it by hand
634  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
635 
636  if( manager )
637  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
638 
639  if( dlg.ShowModal() == wxID_OK )
640  dlg.Kiway().CommonSettingsChanged( false );
641 }
Class KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a porti...
Definition: kiway_player.h:59
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
FRAME_T
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:321
#define _(s)
#define KICAD_MANAGER_FRAME_NAME
size_t i
Definition: json11.cpp:597
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(), i, EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, and KIWAY::Player().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent &  event)
virtualinherited

Command event handler for selecting grid sizes.

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

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

Definition at line 283 of file eda_draw_frame.cpp.

284 {
285  wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );
286 
287  int id = m_gridSelectBox->GetCurrentSelection() + ID_POPUP_GRID_FIRST;
288 
289  if( id == ID_POPUP_GRID_SEPARATOR )
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( id == ID_POPUP_GRID_SETTINGS )
297  {
298  // wxWidgets will check the Grid Settings... entry, which we don't want.
299  // R-check the current grid.
300  wxUpdateUIEvent dummy;
302  // Now run the Grid Settings... dialog
303  wxCommandEvent dummy2;
304  OnGridSettings( dummy2 );
305  }
306  else if( id >= ID_POPUP_GRID_FIRST && id < ID_POPUP_GRID_SEPARATOR )
307  {
309  }
310 
311  UpdateStatusBar();
312  m_canvas->Refresh();
313 }
virtual void OnGridSettings(wxCommandEvent &event)
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
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:131
void OnUpdateSelectGrid(wxUpdateUIEvent &aEvent)
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...
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
TOOL_MANAGER * m_toolManager
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent &  event)
virtualinherited

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

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

Definition at line 328 of file eda_draw_frame.cpp.

329 {
330  wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );
331 
332  int id = m_zoomSelectBox->GetCurrentSelection();
333 
334  if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
335  return;
336 
337  m_toolManager->RunAction( "common.Control.zoomPreset", true, id );
338  UpdateStatusBar();
339  m_canvas->Refresh();
340 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
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
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnSize()

void FOOTPRINT_VIEWER_FRAME::OnSize ( wxSizeEvent &  event)
overrideprivatevirtual

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

Reimplemented from EDA_DRAW_FRAME.

Definition at line 298 of file footprint_viewer_frame.cpp.

299 {
300  if( m_auimgr.GetManagedWindow() )
301  m_auimgr.Update();
302 
303  SizeEv.Skip();
304 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ OnSockRequest()

void EDA_DRAW_FRAME::OnSockRequest ( wxSocketEvent &  evt)
inherited

Definition at line 71 of file eda_dde.cpp.

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

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

◆ OnSockRequestServer()

void EDA_DRAW_FRAME::OnSockRequestServer ( wxSocketEvent &  evt)
inherited

Definition at line 103 of file eda_dde.cpp.

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

References ID_EDA_SOCKET_EVENT, and EDA_DRAW_FRAME::m_sockets.

◆ OnToggleEdgeDrawMode()

void PCB_BASE_FRAME::OnToggleEdgeDrawMode ( wxCommandEvent &  aEvent)
inherited

Definition at line 466 of file pcb_base_frame.cpp.

467 {
468  auto displ_opts = (PCB_DISPLAY_OPTIONS*)GetDisplayOptions();
469  displ_opts->m_DisplayModEdgeFill = !displ_opts->m_DisplayModEdgeFill;
470 
471  if( GetCanvas() )
472  {
473  // Apply new display options to the GAL canvas
474  auto view = static_cast<KIGFX::PCB_VIEW*>( GetCanvas()->GetView() );
475  view->UpdateDisplayOptions( displ_opts );
476  view->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
477  }
478 
479  GetCanvas()->Refresh();
480 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Auxiliary rendering target (noncached)
Definition: definitions.h:49
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
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 PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::TARGET_NONCACHED.

◆ OnToggleGraphicDrawMode()

void PCB_BASE_FRAME::OnToggleGraphicDrawMode ( wxCommandEvent &  aEvent)
inherited

Definition at line 458 of file pcb_base_frame.cpp.

459 {
460  auto displ_opts = (PCB_DISPLAY_OPTIONS*)GetDisplayOptions();
461  displ_opts->m_DisplayDrawItemsFill = !displ_opts->m_DisplayDrawItemsFill;
462  GetCanvas()->Refresh();
463 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
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 PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), and EDA_DRAW_PANEL_GAL::Refresh().

◆ OnTogglePadDrawMode()

void PCB_BASE_FRAME::OnTogglePadDrawMode ( wxCommandEvent &  aEvent)
inherited

Definition at line 433 of file pcb_base_frame.cpp.

434 {
435  auto displ_opts = (PCB_DISPLAY_OPTIONS*)GetDisplayOptions();
436 
437  displ_opts->m_DisplayPadFill = !displ_opts->m_DisplayPadFill;
438 
439  if( GetCanvas() )
440  {
441  // Apply new display options to the GAL canvas
442  auto view = static_cast<KIGFX::PCB_VIEW*>( GetCanvas()->GetView() );
443  view->UpdateDisplayOptions( displ_opts );
444 
445  // Update pads
446  BOARD* board = GetBoard();
447  for( auto module : board->Modules() )
448  {
449  for( auto pad : module->Pads() )
450  view->Update( pad, KIGFX::GEOMETRY );
451  }
452  }
453 
454  GetCanvas()->Refresh();
455 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
MODULES & Modules()
Definition: class_board.h:236
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...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
BOARD * GetBoard() const
Color has changed.
Definition: view_item.h:57

References KIGFX::GEOMETRY, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), BOARD::Modules(), and EDA_DRAW_PANEL_GAL::Refresh().

◆ OnToggleTextDrawMode()

void PCB_BASE_FRAME::OnToggleTextDrawMode ( wxCommandEvent &  aEvent)
inherited

Definition at line 483 of file pcb_base_frame.cpp.

484 {
485  auto displ_opts = (PCB_DISPLAY_OPTIONS*) GetDisplayOptions();
486  displ_opts->m_DisplayModTextFill = !displ_opts->m_DisplayModTextFill;
487 
488  if( GetCanvas() )
489  {
490  // Apply new display options to the canvas
491  auto view = static_cast<KIGFX::PCB_VIEW*>( GetCanvas()->GetView() );
492  view->UpdateDisplayOptions( displ_opts );
493  view->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
494  }
495 
496  GetCanvas()->Refresh();
497 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Auxiliary rendering target (noncached)
Definition: definitions.h:49
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
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 PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetDisplayOptions(), EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::TARGET_NONCACHED.

◆ OnUpdateFootprintButton()

void FOOTPRINT_VIEWER_FRAME::OnUpdateFootprintButton ( wxUpdateUIEvent &  aEvent)

Update the ID_ADD_FOOTPRINT_TO_BOARD tool state in main toolbar.

Definition at line 787 of file footprint_viewer_frame.cpp.

788 {
789  aEvent.Enable( GetBoard()->GetFirstModule() != nullptr );
790 }
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard().

◆ OnUpdateLayerAlpha()

virtual void PCB_BASE_FRAME::OnUpdateLayerAlpha ( wxUpdateUIEvent &  aEvent)
inlinevirtualinherited

Reimplemented in PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 395 of file pcb_base_frame.h.

395 {}

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent)
inherited

Definition at line 251 of file eda_draw_frame.cpp.

252 {
253  // No need to update the grid select box if it doesn't exist or the grid setting change
254  // was made using the select box.
255  if( m_gridSelectBox == NULL )
256  return;
257 
258  int select = wxNOT_FOUND;
259 
260  for( size_t i = 0; i < GetScreen()->GetGridCount(); i++ )
261  {
262  if( GetScreen()->GetGridCmdId() == GetScreen()->GetGrid( i ).m_CmdId )
263  {
264  select = (int) i;
265  break;
266  }
267  }
268 
269  if( select != m_gridSelectBox->GetSelection() )
270  m_gridSelectBox->SetSelection( select );
271 }
const GRID_TYPE & GetGrid() const
Return the grid object of the currently selected grid.
Definition: base_screen.h:286
wxChoice * m_gridSelectBox
size_t i
Definition: json11.cpp:597
size_t GetGridCount() const
Function GetGridCount().
Definition: base_screen.h:324
int m_CmdId
Definition: base_screen.h:46
int GetGridCmdId() const
Return the command ID of the currently selected grid.
Definition: base_screen.h:272
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References BASE_SCREEN::GetGrid(), BASE_SCREEN::GetGridCmdId(), BASE_SCREEN::GetGridCount(), EDA_DRAW_FRAME::GetScreen(), i, GRID_TYPE::m_CmdId, and EDA_DRAW_FRAME::m_gridSelectBox.

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

◆ OnUpdateSelectZoom()

void PCB_BASE_FRAME::OnUpdateSelectZoom ( wxUpdateUIEvent &  aEvent)
inherited

Definition at line 500 of file pcb_base_frame.cpp.

501 {
502  if( m_zoomSelectBox == NULL || m_zoomSelectBox->GetParent() == NULL )
503  return;
504 
505  int current = 0; // display Auto if no match found
506 
507  // check for a match within 1%
508  double zoom = GetCanvas()->GetLegacyZoom();
509 
510  for( unsigned i = 0; i < GetScreen()->m_ZoomList.size(); i++ )
511  {
512  if( std::fabs( zoom - GetScreen()->m_ZoomList[i] ) < ( zoom / 100.0 ) )
513  {
514  current = i + 1;
515  break;
516  }
517  }
518 
519  if( current != m_zoomSelectBox->GetSelection() )
520  m_zoomSelectBox->SetSelection( current );
521 }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
wxChoice * m_zoomSelectBox
double GetLegacyZoom() const
Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas...
size_t i
Definition: json11.cpp:597
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:138

References PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetLegacyZoom(), PCB_BASE_FRAME::GetScreen(), i, BASE_SCREEN::m_ZoomList, and EDA_DRAW_FRAME::m_zoomSelectBox.

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

Definition at line 118 of file kiway_player.h.

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

Referenced by PCB_EDIT_FRAME::FetchNetlistFromSchematic(), PGM_SINGLE_TOP::MacOpenFile(), SCH_EDIT_FRAME::OnOpenPcbnew(), PGM_SINGLE_TOP::OnPgmInit(), SCH_EDIT_FRAME::OnUpdatePCB(), and PCB_EDIT_FRAME::RunEeschema().

◆ PlaceModule()

void PCB_BASE_FRAME::PlaceModule ( MODULE aModule,
bool  aRecreateRatsnest = true 
)
inherited

Function PlaceModule places aModule at the current cursor position and updates module coordinates with the new position.

Parameters
aModuleA MODULE object point of the module to be placed.
aRecreateRatsnestA bool true redraws the module rats nest.

Definition at line 471 of file load_select_footprint.cpp.

472 {
473  if( aModule == 0 )
474  return;
475 
476  OnModify();
477 
478  if( aModule->IsNew() )
479  {
480  SaveCopyInUndoList( aModule, UR_NEW );
481  }
482  else if( aModule->IsMoving() )
483  {
484  ITEM_PICKER picker( aModule, UR_CHANGED );
485  picker.SetLink( s_ModuleInitialCopy );
486  s_PickedList.PushItem( picker );
487  s_ModuleInitialCopy = NULL; // the picker is now owner of s_ModuleInitialCopy.
488  }
489 
490  if( s_PickedList.GetCount() )
491  {
493 
494  // Clear list, but DO NOT delete items, because they are owned by the saved undo
495  // list and they therefore in use
497  }
498 
499  aModule->SetPosition( (wxPoint) GetCanvas()->GetViewControls()->GetCursorPosition() );
500  aModule->ClearFlags();
501 
502  delete s_ModuleInitialCopy;
503  s_ModuleInitialCopy = NULL;
504 
505  if( aRecreateRatsnest )
506  m_Pcb->GetConnectivity()->Update( aModule );
507 
508  if( aRecreateRatsnest )
509  Compile_Ratsnest( true );
510 
511  SetMsgPanel( aModule );
512 }
void Compile_Ratsnest(bool aDisplayStatus)
Function Compile_Ratsnest Create the entire board ratsnest.
Definition: ratsnest.cpp:44
static PICKED_ITEMS_LIST s_PickedList
bool IsMoving() const
Definition: base_struct.h:230
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
unsigned GetCount() const
Function GetCount.
bool IsNew() const
Definition: base_struct.h:228
static MODULE * s_ModuleInitialCopy
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:310
void SetPosition(const wxPoint &aPos) override
virtual void OnModify()
Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the curr...
virtual void SaveCopyInUndoList(BOARD_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))=0
Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands.
void ClearItemsList()
Function ClearItemsList deletes only the list of pickers, NOT the picked data itself.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266

References EDA_ITEM::ClearFlags(), PICKED_ITEMS_LIST::ClearItemsList(), PICKED_ITEMS_LIST::GetCount(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), PICKED_ITEMS_LIST::PushItem(), s_ModuleInitialCopy, s_PickedList, ITEM_PICKER::SetLink(), MODULE::SetPosition(), UR_CHANGED, UR_NEW, and UR_UNSPECIFIED.

Referenced by AddFootprintToPCB(), PCB_EDIT_FRAME::Exchange_Module(), FOOTPRINT_EDIT_FRAME::Import_Module(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ PopTool()

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

Definition at line 182 of file eda_base_frame.cpp.

183 {
184  // Push/pop events can get out of order (such as when they're generated by the Simulator
185  // frame but not processed until the mouse is back in the Schematic frame), so make sure
186  // we're popping the right stack frame.
187 
188  for( int i = m_toolStack.size() - 1; i >= 0; --i )
189  {
190  if( m_toolStack[ i ] == actionName )
191  {
192  m_toolStack.erase(