KiCad PCB EDA Suite
DISPLAY_FOOTPRINTS_FRAME Class Reference

Class DISPLAY_FOOTPRINTS_FRAME is used to display footprints. More...

#include <display_footprints_frame.h>

Inheritance diagram for DISPLAY_FOOTPRINTS_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

 DISPLAY_FOOTPRINTS_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~DISPLAY_FOOTPRINTS_FRAME () override
 
void OnCloseWindow (wxCloseEvent &Event) override
 
void ReCreateHToolbar () override
 
void ReCreateVToolbar () override
 
void ReCreateOptToolbar () override
 
void InitDisplay ()
 Function InitDisplay Refresh the full display for this frame: Set the title, the status line and redraw the canvas Must be called after the footprint to display is modifed. More...
 
void updateView ()
 update the gal canvas (view, colors ...) More...
 
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 ApplyDisplaySettingsToGAL ()
 Updates the GAL with display settings changes. More...
 
void UpdateMsgPanel () override
 

More...
 
bool GetAutoZoom () const
 
void SetAutoZoom (bool aEnable)
 
bool IsGridVisible () const override
 Function IsGridVisible() , virtual. More...
 
void SetGridVisibility (bool aVisible) override
 Function SetGridVisibility() , virtual It may be overloaded by derived classes if you want to store/retrieve the grid visibility in configuration. More...
 
COLOR4D GetGridColor () override
 Function GetGridColor() , virtual. More...
 
void InstallOptionsDisplay (wxCommandEvent &event)
 
MODULEGet_Module (const wxString &CmpName)
 
void SaveCopyInUndoList (BOARD_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand=UR_UNSPECIFIED, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
 Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO_T aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
 Function SaveCopyInUndoList (overloaded). More...
 
void SyncToolbars () override
 Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state. More...
 
EDA_3D_VIEWERGet3DViewerFrame ()
 
virtual void Update3DView (bool aForceReload, const wxString *aTitle=nullptr)
 Update the 3D view, if the viewer is opened by this frame. More...
 
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 ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
virtual void ReCreateMenuBar () override
 Recreates the menu bar. 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 ()
 
virtual double BestZoom () override
 Function BestZoom. More...
 
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(), bool aAllowBroswer=true)
 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 CommonSettingsChanged (bool aEnvVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. 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 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 OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
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 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 bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
virtual void KiwayMailIn (KIWAY_EXPRESS &aEvent)
 Function KiwayMailIn receives KIWAY_EXPRESS messages from other players. More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal ()
 
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...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. 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...
 
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

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)
 
double bestZoom (double sizeX, double sizeY, double scaleFactor, wxPoint centre)
 
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 Attributes

bool m_autoZoom
 
double m_lastZoom
 

Detailed Description

Class DISPLAY_FOOTPRINTS_FRAME is used to display footprints.

Definition at line 41 of file display_footprints_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

◆ DISPLAY_FOOTPRINTS_FRAME()

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

Definition at line 63 of file display_footprints_frame.cpp.

63  :
64  PCB_BASE_FRAME( aKiway, aParent, FRAME_CVPCB_DISPLAY, _( "Footprint Viewer" ),
65  wxDefaultPosition, wxDefaultSize,
67 {
68  // Give an icon
69  wxIcon icon;
70  icon.CopyFromBitmap( KiBitmap( icon_cvpcb_xpm ) );
71  SetIcon( icon );
72 
73  SetBoard( new BOARD() );
75 
76  // Don't show the default board solder mask clearance. Only the
77  // footprint or pad clearance setting should be shown if it is not 0.
79 
80  LoadSettings( config() );
81 
82  // Initialize grid id to a default value if not found in config or incorrect:
83  if( !( GetScreen()->GridExists( m_LastGridSizeId + ID_POPUP_GRID_LEVEL_1000 ) ) )
85 
87 
88  // Initialize some display options
89  auto displ_opts = (PCB_DISPLAY_OPTIONS*)GetDisplayOptions();
90  displ_opts->m_DisplayPadIsol = false; // Pad clearance has no meaning here
91 
92  // Track and via clearance has no meaning here.
93  displ_opts->m_ShowTrackClearanceMode = PCB_DISPLAY_OPTIONS::DO_NOT_SHOW_CLEARANCE;
94 
95  // Create GAL canvas
96 #ifdef __WXMAC__
97  // Cairo renderer doesn't handle Retina displays
99 #else
101 #endif
102  auto* gal_drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_FrameSize,
103  GetGalDisplayOptions(), backend );
104  SetCanvas( gal_drawPanel );
105 
106  // Now all panels are created, set the window size to the latest saved in config:
107  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
108 
109  // Create the manager and dispatcher & route draw panel events to the dispatcher
111  m_toolManager->SetEnvironment( GetBoard(), gal_drawPanel->GetView(),
112  gal_drawPanel->GetViewControls(), this );
113  m_actions = new CVPCB_ACTIONS();
115  gal_drawPanel->SetEventDispatcher( m_toolDispatcher );
116 
122 
123  // Run the control tool, it is supposed to be always active
124  m_toolManager->InvokeTool( "cvpcb.InteractiveSelection" );
125 
129 
130  m_auimgr.SetManagedWindow( this );
131  m_auimgr.SetArtProvider( new EDA_DOCKART() );
132 
133  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
134  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) );
135  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
136  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
137  m_auimgr.Update();
138 
139  auto& galOpts = GetGalDisplayOptions();
140  galOpts.m_axesEnabled = true;
141 
143 
145 
146  // Restore last zoom. (If auto-zooming we'll adjust when we load the footprint.)
148 
149  updateView();
150 
151  Show( true );
152 }
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.
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
TOOL_DISPATCHER * m_toolDispatcher
ACTION_TOOLBAR * m_optionsToolBar
virtual void SetScreen(BASE_SCREEN *aScreen)
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
ACTIONS * m_actions
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
wxAuiManager m_auimgr
#define FOOTPRINTVIEWER_FRAME_NAME
ACTION_TOOLBAR * m_mainToolBar
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.
void updateView()
update the gal canvas (view, colors ...)
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Class CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL.
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
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
double GetZoomLevelCoeff() const
Return the coefficient to convert internal display scale factor to zoom level.
virtual void ActivateGalCanvas() override
EDA_MSG_PANEL * m_messagePanel
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
#define KICAD_DEFAULT_DRAWFRAME_STYLE
Class CVPCB_ACTIONS.
Definition: cvpcb_actions.h:40
#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.
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 BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
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...
Class CVPCB_FOOTPRINT_VIEWER_CONTROL.
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.
void RegisterTool(TOOL_BASE *aTool)
Function RegisterTool() Adds a tool to the manager set and sets it up.

References PCAD2KICAD::Center, PCB_DISPLAY_OPTIONS::DO_NOT_SHOW_CLEARANCE, EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetBoard(), BOARD::GetDesignSettings(), ID_POPUP_GRID_LEVEL_1000, ID_POPUP_GRID_LEVEL_500, KiBitmap(), PCAD2KICAD::Left, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, and TOOL_MANAGER::SetEnvironment().

◆ ~DISPLAY_FOOTPRINTS_FRAME()

DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME ( )
override

Definition at line 155 of file display_footprints_frame.cpp.

156 {
158  GetCanvas()->StopDrawing();
159  GetCanvas()->GetView()->Clear();
160  // Be sure any event cannot be fired after frame deletion:
161  GetCanvas()->SetEvtHandlerEnabled( false );
162 
163  // Be sure a active tool (if exists) is deactivated:
164  if( m_toolManager )
166 
167  delete GetScreen();
168  SetScreen( NULL ); // Be sure there is no double deletion
169 }
virtual void SetScreen(BASE_SCREEN *aScreen)
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void DeactivateTool()
Function DeactivateTool() Deactivates the currently active tool.
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.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void DeleteAllModules()
Removes all modules from the deque and frees the memory associated with them.
Definition: class_board.h:293
TOOL_MANAGER * m_toolManager
BOARD * GetBoard() const
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...

References KIGFX::VIEW::Clear(), TOOL_MANAGER::DeactivateTool(), BOARD::DeleteAllModules(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetScreen(), PCB_DRAW_PANEL_GAL::GetView(), EDA_BASE_FRAME::m_toolManager, EDA_DRAW_FRAME::SetScreen(), 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 857 of file pcb_base_frame.cpp.

858 {
860 
861  EDA_DRAW_PANEL_GAL* canvas = GetCanvas();
862 
863  if( m_toolManager )
864  {
866  GetCanvas()->GetViewControls(), this );
867  }
868 
869  SetBoard( m_Pcb );
870 
871  if( m_toolManager )
873 
874  // Transfer latest current display options from legacy to GAL canvas:
875  auto painter = static_cast<KIGFX::PCB_PAINTER*>( canvas->GetView()->GetPainter() );
876  auto settings = painter->GetSettings();
877  auto displ_opts = (PCB_DISPLAY_OPTIONS*) GetDisplayOptions();
878  settings->LoadDisplayOptions( displ_opts, ShowPageLimits() );
879 
880  canvas->GetView()->RecacheAllItems();
882  canvas->StartDrawing();
883 }
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::FOOTPRINT_VIEWER_FRAME(), and PCB_DRAW_PANEL_GAL::OnShow().

◆ 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 at the moment
188 
189  module->SetTimeStamp( GetNewTimeStamp() );
190 
191  // Put it on FRONT layer,
192  // (Can be stored flipped if the lib is an archive built from a board)
193  if( module->IsFlipped() )
194  module->Flip( module->GetPosition(), m_configSettings.m_FlipLeftRight );
195 
196  // Place it in orientation 0,
197  // even if it is not saved with orientation 0 in lib
198  // (Can happen if the lib is an archive built from a board)
199  module->SetOrientation( 0 );
200  }
201 }
bool IsFlipped() const
function IsFlipped
Definition: class_module.h:263
#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:188
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 364 of file eda_base_frame.cpp.

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

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

349 {
350  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
351  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
352 
353  aMenu.AddSeparator( 1000 );
355  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
356  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
358 
359  aMenu.AddSeparator( 1000 );
360 
361  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
362  zoomMenu->SetTool( commonTools );
363  aToolMenu.AddSubMenu( zoomMenu );
364 
365  auto gridMenu = std::make_shared<GRID_MENU>( this );
366  gridMenu->SetTool( commonTools );
367  aToolMenu.AddSubMenu( gridMenu );
368 
369  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
370  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
371 }
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:92
Class COMMON_TOOLS.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Function AddSeparator()
static TOOL_ACTION zoomCenter
Definition: actions.h:91
static TOOL_ACTION zoomIn
Definition: actions.h:87
static TOOL_ACTION zoomOut
Definition: actions.h:88
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 553 of file eda_draw_frame.cpp.

555 {
556  if( m_messagePanel )
557  m_messagePanel->AppendMessage( textUpper, textLower, color, pad );
558 }
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 DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL ( )

Updates the GAL with display settings changes.

Definition at line 287 of file display_footprints_frame.cpp.

288 {
289  auto painter = static_cast<KIGFX::PCB_PAINTER*>( GetCanvas()->GetView()->GetPainter() );
290 
291  painter->GetSettings()->LoadDisplayOptions( &m_DisplayOptions, false );
292 
294  GetCanvas()->Refresh();
295 }
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
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

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

Referenced by DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::UpdateObjectSettings().

◆ bestZoom()

double EDA_DRAW_FRAME::bestZoom ( double  sizeX,
double  sizeY,
double  scaleFactor,
wxPoint  centre 
)
protectedinherited

◆ BestZoom()

double PCB_BASE_FRAME::BestZoom ( )
overridevirtualinherited

Function BestZoom.

Returns
the "best" zoom to show the entire board or footprint on the screen.

Implements EDA_DRAW_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 349 of file pcb_base_frame.cpp.

350 {
351  EDA_RECT ibbbox = GetBoardBoundingBox();
352 
353  double sizeX = (double) ibbbox.GetWidth();
354  double sizeY = (double) ibbbox.GetHeight();
355  wxPoint centre = ibbbox.Centre();
356 
357  // Reserve a 10% margin around board bounding box.
358  double margin_scale_factor = 1.1;
359 
360  return bestZoom( sizeX, sizeY, margin_scale_factor, centre );
361 }
double bestZoom(double sizeX, double sizeY, double scaleFactor, wxPoint centre)
int GetWidth() const
Definition: eda_rect.h:117
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge se...
int GetHeight() const
Definition: eda_rect.h:118
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint Centre() const
Definition: eda_rect.h:60

References EDA_DRAW_FRAME::bestZoom(), EDA_RECT::Centre(), PCB_BASE_FRAME::GetBoardBoundingBox(), EDA_RECT::GetHeight(), and EDA_RECT::GetWidth().

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

688 {
689  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
690 
691  wxFileName autoSaveFileName = aFileName;
692 
693  // Check for auto save file.
694  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
695 
696  wxLogTrace( traceAutoSave,
697  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
698 
699  if( !autoSaveFileName.FileExists() )
700  return;
701 
702  wxString msg = wxString::Format( _(
703  "Well this is potentially embarrassing!\n"
704  "It appears that the last time you were editing the file\n"
705  "\"%s\"\n"
706  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
707  GetChars( aFileName.GetFullName() )
708  );
709 
710  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
711 
712  // Make a backup of the current file, delete the file, and rename the auto save file to
713  // the file name.
714  if( response == wxYES )
715  {
716  // Get the backup file name.
717  wxFileName backupFileName = aFileName;
718  backupFileName.SetExt( aFileName.GetExt() + GetBackupSuffix() );
719 
720  // If an old backup file exists, delete it. If an old copy of the file exists, rename
721  // it to the backup file name
722  if( aFileName.FileExists() )
723  {
724  // Rename the old file to the backup file name.
725  if( !wxRenameFile( aFileName.GetFullPath(), backupFileName.GetFullPath(), true ) )
726  {
727  msg.Printf( _( "Could not create backup file \"%s\"" ),
728  GetChars( backupFileName.GetFullPath() ) );
729  wxMessageBox( msg );
730  }
731  }
732 
733  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
734  {
735  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
736  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
737  }
738  }
739  else
740  {
741  wxLogTrace( traceAutoSave,
742  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
743 
744  // Remove the auto save file when using the previous file as is.
745  wxRemoveFile( autoSaveFileName.GetFullPath() );
746  }
747 }
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()

◆ CommonSettingsChanged()

void PCB_BASE_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged)
overridevirtualinherited

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

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 748 of file pcb_base_frame.cpp.

749 {
750  EDA_DRAW_FRAME::CommonSettingsChanged( aEnvVarsChanged );
751 
753 
754  // The 3D viewer isn't in the Kiway, so send its update manually
755  EDA_3D_VIEWER* viewer = Get3DViewerFrame();
756 
757  if( viewer )
758  viewer->CommonSettingsChanged( aEnvVarsChanged );
759 }
void CommonSettingsChanged(bool aEnvVarsChanged) override
Notification that common settings are updated.
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of ckeck tools.
void CommonSettingsChanged(bool aEnvVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
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 EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_3D_VIEWER::CommonSettingsChanged(), PCB_BASE_FRAME::Get3DViewerFrame(), and EDA_DRAW_FRAME::RecreateToolbars().

Referenced by FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), and PCB_EDIT_FRAME::CommonSettingsChanged().

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

536 {
537  // KICAD_MANAGER_FRAME overrides this
538  wxConfigBase* ret = Kiface().KifaceSettings();
539  //wxASSERT( ret );
540  return ret;
541 }
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::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 LoadSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), SaveSettings(), FOOTPRINT_VIEWER_FRAME::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 383 of file pcb_base_frame.cpp.

384 {
385  EDA_3D_VIEWER* draw3DFrame = Get3DViewerFrame();
386 
387  if( !draw3DFrame )
388  draw3DFrame = new EDA_3D_VIEWER( &Kiway(), this, _( "3D Viewer" ) );
389 
390  // Raising the window does not show the window on Windows if iconized. This should work
391  // on any platform.
392  if( draw3DFrame->IsIconized() )
393  draw3DFrame->Iconize( false );
394 
395  draw3DFrame->Raise();
396  draw3DFrame->Show( true );
397 
398  // Raising the window does not set the focus on Linux. This should work on any platform.
399  if( wxWindow::FindFocus() != draw3DFrame )
400  draw3DFrame->SetFocus();
401 
402  return draw3DFrame;
403 }
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:448
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:220
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:447
void SetLastEditTime(timestamp_t aTime)
Definition: class_module.h:318
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:417
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:441
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:276
bool m_RefDefaultVisibility
Default ref text visibility on fp creation.
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:198
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 219 of file eda_base_frame.cpp.

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

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

◆ 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 FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), LIB_VIEW_FRAME::FinishModal(), LIB_VIEW_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::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 568 of file pcb_base_frame.cpp.

569 {
570  wxString line;
571  wxString gridformatter;
572 
573  switch( m_userUnits )
574  {
575  case INCHES:
576  gridformatter = "grid X %.6f Y %.6f";
577  break;
578 
579  case MILLIMETRES:
580  gridformatter = "grid X %.6f Y %.6f";
581  break;
582 
583  default:
584  gridformatter = "grid X %f Y %f";
585  break;
586  }
587 
588  BASE_SCREEN* screen = GetScreen();
589  wxArrayString gridsList;
590 
591  int icurr = screen->BuildGridsChoiceList( gridsList, m_userUnits != INCHES );
592  GRID_TYPE& grid = screen->GetGrid( icurr );
593  double grid_x = To_User_Unit( m_userUnits, grid.m_Size.x );
594  double grid_y = To_User_Unit( m_userUnits, grid.m_Size.y );
595  line.Printf( gridformatter, grid_x, grid_y );
596 
597  SetStatusText( line, 4 );
598 }
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:155
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 374 of file eda_draw_frame.cpp.

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

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

412 {
413  wxString msg;
414 
415  switch( m_userUnits )
416  {
417  case INCHES: msg = _( "Inches" ); break;
418  case MILLIMETRES: msg = _( "mm" ); break;
419  default: msg = _( "Units" ); break;
420  }
421 
422  SetStatusText( msg, 5 );
423 }
Definition: common.h:155
#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 302 of file eda_base_frame.cpp.

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

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

244 {
245  if( m_messagePanel )
247 }
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 276 of file eda_draw_frame.h.

276 {}

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

736 {
737  if( aCenterView )
738  {
739  wxWindow* dialog = findDialog( GetChildren() );
740 
741  // If a dialog partly obscures the window, then center on the uncovered area.
742  if( dialog )
743  {
744  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
745  dialog->GetSize() );
746  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
747  }
748  else
749  GetCanvas()->GetView()->SetCenter( aPos );
750  }
751 
753 }
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().

◆ Get_Module()

MODULE * DISPLAY_FOOTPRINTS_FRAME::Get_Module ( const wxString &  CmpName)

Definition at line 327 of file display_footprints_frame.cpp.

328 {
329  MODULE* footprint = NULL;
330 
331  try
332  {
333  LIB_ID fpid;
334 
335  if( fpid.Parse( aFootprintName, LIB_ID::ID_PCB ) >= 0 )
336  {
337  DisplayInfoMessage( this, wxString::Format( _( "Footprint ID \"%s\" is not valid." ),
338  GetChars( aFootprintName ) ) );
339  return NULL;
340  }
341 
342  std::string nickname = fpid.GetLibNickname();
343  std::string fpname = fpid.GetLibItemName();
344 
345  wxLogDebug( wxT( "Load footprint \"%s\" from library \"%s\"." ),
346  fpname.c_str(), nickname.c_str() );
347 
348  footprint = Prj().PcbFootprintLibs( Kiway() )->FootprintLoad(
349  FROM_UTF8( nickname.c_str() ), FROM_UTF8( fpname.c_str() ) );
350  }
351  catch( const IO_ERROR& ioe )
352  {
353  DisplayError( this, ioe.What() );
354  return NULL;
355  }
356 
357  if( footprint )
358  {
359  footprint->SetParent( (EDA_ITEM*) GetBoard() );
360  footprint->SetPosition( wxPoint( 0, 0 ) );
361  return footprint;
362  }
363 
364  wxString msg = wxString::Format( _( "Footprint \"%s\" not found" ), aFootprintName.GetData() );
365  DisplayError( this, msg );
366  return NULL;
367 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
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
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:62
MODULE * FootprintLoad(const wxString &aNickname, const wxString &aFootprintName)
Function FootprintLoad.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
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.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
#define _(s)
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
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
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
BOARD * GetBoard() const
int Parse(const UTF8 &aId, LIB_ID_TYPE aType, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:276
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:243
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 _, DisplayError(), DisplayInfoMessage(), FP_LIB_TABLE::FootprintLoad(), Format(), FROM_UTF8(), PCB_BASE_FRAME::GetBoard(), GetChars(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::ID_PCB, KIWAY_HOLDER::Kiway(), LIB_ID::Parse(), PROJECT::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), EDA_ITEM::SetParent(), MODULE::SetPosition(), and IO_ERROR::What().

Referenced by InitDisplay().

◆ 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 DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom ( ) const
inline

◆ 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 232 of file pcb_base_frame.cpp.

233 {
234  wxASSERT( m_Pcb );
235  return m_Pcb->GetAuxOrigin();
236 }
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(), FOOTPRINT_VIEWER_FRAME::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(), FOOTPRINT_VIEWER_FRAME::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::FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::GenD356File(), PCB_EDIT_FRAME::GenFootprintsReport(), Get_Module(), GetBoard(), EDA_3D_VIEWER::GetBoard(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), 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(), 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(), FOOTPRINT_VIEWER_FRAME::OnUpdateFootprintButton(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateModuleSelected(), DIALOG_NETLIST::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), 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(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), FOOTPRINT_EDIT_FRAME::SetDesignSettings(), DIALOG_DRC_CONTROL::SetDrcParmeters(), 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(), UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), DRC::updatePointers(), FOOTPRINT_EDIT_FRAME::updateTitle(), updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::updateView(), DIALOG_DRC_CONTROL::writeReport(), and ~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 323 of file pcb_base_frame.cpp.

324 {
325  wxASSERT( m_Pcb );
326 
327  EDA_RECT area = aBoardEdgesOnly ? m_Pcb->GetBoardEdgesBoundingBox() : m_Pcb->GetBoundingBox();
328 
329  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
330  {
331  wxSize pageSize = GetPageSizeIU();
332 
334  {
335  area.SetOrigin( 0, 0 );
336  area.SetEnd( pageSize.x, pageSize.y );
337  }
338  else
339  {
340  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
341  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
342  }
343  }
344 
345  return area;
346 }
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:117
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
bool m_showBorderAndTitleBlock
void SetEnd(int x, int y)
Definition: eda_rect.h:134
int GetHeight() const
Definition: eda_rect.h:118
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::BestZoom(), PCB_BASE_FRAME::BestZoom(), 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 851 of file pcb_base_frame.cpp.

852 {
853  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
854 }
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(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), ApplyDisplaySettingsToGAL(), GRID_HELPER::BestDragOrigin(), GRID_HELPER::BestSnapAnchor(), FOOTPRINT_VIEWER_FRAME::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::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), GRID_HELPER::GRID_HELPER(), FOOTPRINT_EDIT_FRAME::HardRedraw(), DIALOG_SELECT_NET_FROM_LIST::HighlightNet(), 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(), FOOTPRINT_VIEWER_FRAME::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(), FOOTPRINT_VIEWER_FRAME::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(), SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::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(), updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::updateView(), SELECTION_TOOL::zoomFitSelection(), DIALOG_NETLIST::~DIALOG_NETLIST(), DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB(), ~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_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 172 of file eda_draw_frame.h.

172 { 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 540 of file pcb_base_frame.cpp.

541 {
543  GetCanvas()->GetView() );
544 
545  // account for the globals
547  guide.SetIgnoreMTextsOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_BK ) );
548  guide.SetIgnoreMTextsOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_TEXT_FR ) );
549  guide.SetIgnoreModulesOnBack( ! m_Pcb->IsElementVisible( LAYER_MOD_BK ) );
550  guide.SetIgnoreModulesOnFront( ! m_Pcb->IsElementVisible( LAYER_MOD_FR ) );
551  guide.SetIgnorePadsOnBack( ! m_Pcb->IsElementVisible( LAYER_PAD_BK ) );
552  guide.SetIgnorePadsOnFront( ! m_Pcb->IsElementVisible( LAYER_PAD_FR ) );
553  guide.SetIgnoreThroughHolePads( ! m_Pcb->IsElementVisible( LAYER_PADS_TH ) );
554  guide.SetIgnoreModulesVals( ! m_Pcb->IsElementVisible( LAYER_MOD_VALUES ) );
555  guide.SetIgnoreModulesRefs( ! m_Pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
556  guide.SetIgnoreThroughVias( ! m_Pcb->IsElementVisible( LAYER_VIA_THROUGH ) );
557  guide.SetIgnoreBlindBuriedVias( ! m_Pcb->IsElementVisible( LAYER_VIA_BBLIND ) );
558  guide.SetIgnoreMicroVias( ! m_Pcb->IsElementVisible( LAYER_VIA_MICROVIA ) );
559  guide.SetIgnoreTracks( ! m_Pcb->IsElementVisible( LAYER_TRACKS ) );
560 
561  return guide;
562 }
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().

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

576 {
577  wxFileHistory* fileHistory = aFileHistory;
578 
579  if( !fileHistory )
580  fileHistory = &Kiface().GetFileHistory();
581 
582  int baseId = fileHistory->GetBaseId();
583 
584  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) fileHistory->GetCount() );
585 
586  unsigned i = cmdId - baseId;
587 
588  if( i < fileHistory->GetCount() )
589  {
590  wxString fn = fileHistory->GetHistoryFile( i );
591 
592  if( wxFileName::FileExists( fn ) )
593  return fn;
594  else
595  {
596  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
597  wxMessageBox( msg );
598 
599  fileHistory->RemoveFileFromHistory( i );
600  }
601  }
602 
603  return wxEmptyString;
604 }
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 DISPLAY_FOOTPRINTS_FRAME::GetGridColor ( )
overridevirtual

Function GetGridColor() , virtual.

Returns
the color of the grid

Reimplemented from EDA_DRAW_FRAME.

Definition at line 321 of file display_footprints_frame.cpp.

322 {
323  return COLOR4D( DARKGRAY );
324 }
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References DARKGRAY.

◆ 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 246 of file pcb_base_frame.cpp.

247 {
248  wxASSERT( m_Pcb );
249  return m_Pcb->GetGridOrigin();
250 }
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 229 of file eda_draw_frame.h.

229 { 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 687 of file eda_draw_frame.cpp.

688 {
689  return GetScreen()->getNearestGridPosition( aPosition, GetGridOrigin() );
690 }
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 214 of file pcb_base_frame.cpp.

215 {
216  wxASSERT( m_Pcb );
217  return m_Pcb->GetPageSettings();
218 }
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 221 of file pcb_base_frame.cpp.

222 {
223  wxASSERT( m_Pcb );
224 
225  // this function is only needed because EDA_DRAW_FRAME is not compiled
226  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
227  // into an application specific source file.
228  return m_Pcb->GetPageSettings().GetSizeIU();
229 }
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::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 309 of file pcb_base_frame.cpp.

310 {
311  wxASSERT( m_Pcb );
312  return m_Pcb->GetPlotOptions();
313 }
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::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(), ZONE_CONTAINER::Print(), 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(), PCB_BASE_FRAME::SwitchLayer(), 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().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 809 of file eda_draw_frame.cpp.

810 {
811  // Virtual function. Base class implementation returns an empty string.
812  return wxEmptyString;
813 }

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 260 of file pcb_base_frame.cpp.

261 {
262  wxASSERT( m_Pcb );
263  return m_Pcb->GetTitleBlock();
264 }
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(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), LIB_CONTROL::AddSymbolToSchematic(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::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(), 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_PREV_3D::PANEL_PREV_3D(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), DRC::Reset(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_BOARD_STATISTICS::saveReportClicked(), 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(), DIALOG_BOARD_STATISTICS::updateWidets(), PANEL_SETUP_TRACKS_AND_VIAS::validateData(), and PANEL_SETUP_NETCLASSES::validateData().

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const
inherited

Definition at line 295 of file pcb_base_frame.cpp.

296 {
297  wxASSERT( m_Pcb );
298  return m_Pcb->GetZoneSettings();
299 }
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 342 of file eda_draw_frame.cpp.

343 {
344  return GetScreen()->GetZoom();
345 }
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::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 291 of file eda_draw_frame.h.

291 { return m_zoomLevelCoeff; }
double m_zoomLevelCoeff

References EDA_DRAW_FRAME::m_zoomLevelCoeff.

Referenced by COMMON_TOOLS::doZoomToPreset(), FOOTPRINT_VIEWER_FRAME::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 772 of file pcb_base_frame.cpp.

773 {
775 }
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 700 of file eda_draw_frame.cpp.

701 {
702  // To be implemented by subclasses.
703 }

Referenced by COMMON_TOOLS::ZoomRedraw().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 550 of file eda_base_frame.cpp.

551 {
552  return Kiface().GetHelpFileName();
553 }
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...

◆ InitDisplay()

void DISPLAY_FOOTPRINTS_FRAME::InitDisplay ( )

Function InitDisplay Refresh the full display for this frame: Set the title, the status line and redraw the canvas Must be called after the footprint to display is modifed.

Definition at line 370 of file display_footprints_frame.cpp.

371 {
372  CVPCB_MAINFRAME* parentframe = (CVPCB_MAINFRAME *) GetParent();
373  MODULE* module = nullptr;
374  const FOOTPRINT_INFO* module_info = nullptr;
375 
377  GetCanvas()->GetView()->Clear();
378 
379  wxString footprintName = parentframe->GetSelectedFootprint();
380 
381  if( footprintName.IsEmpty() )
382  {
383  COMPONENT* comp = parentframe->GetSelectedComponent();
384 
385  if( comp )
386  footprintName = comp->GetFPID().GetUniStringLibId();
387  }
388 
389  if( !footprintName.IsEmpty() )
390  {
391  SetTitle( wxString::Format( _( "Footprint: %s" ), footprintName ) );
392 
393  module = Get_Module( footprintName );
394 
395  module_info = parentframe->m_FootprintsList->GetModuleInfo( footprintName );
396  }
397 
398  if( module )
399  GetBoard()->Add( module );
400 
401  if( module_info )
402  SetStatusText( wxString::Format( _( "Lib: %s" ), module_info->GetLibNickname() ), 0 );
403  else
404  SetStatusText( wxEmptyString, 0 );
405 
406  updateView();
407 
408  UpdateStatusBar();
409 
410  GetCanvas()->Refresh();
411  Update3DView( true );
412 }
FOOTPRINT_LIST * m_FootprintsList
FOOTPRINT_INFO * GetModuleInfo(const wxString &aFootprintId)
Get info for a module by id.
wxString GetLibNickname() const override
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
MODULE * Get_Module(const wxString &CmpName)
void updateView()
update the gal canvas (view, colors ...)
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:166
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1111
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
#define _(s)
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...
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
wxString GetSelectedFootprint()
virtual void UpdateStatusBar() override
Update the status bar information.
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
COMPONENT * GetSelectedComponent()
Get the selected component from the component listbox.
void DeleteAllModules()
Removes all modules from the deque and frees the memory associated with them.
Definition: class_board.h:293
wxString GetUniStringLibId() const
Definition: lib_id.h:148
BOARD * GetBoard() const
virtual void Update3DView(bool aForceReload, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
The CvPcb application main window.

References _, BOARD::Add(), KIGFX::VIEW::Clear(), BOARD::DeleteAllModules(), Format(), Get_Module(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), COMPONENT::GetFPID(), FOOTPRINT_INFO::GetLibNickname(), FOOTPRINT_LIST::GetModuleInfo(), CVPCB_MAINFRAME::GetSelectedComponent(), CVPCB_MAINFRAME::GetSelectedFootprint(), LIB_ID::GetUniStringLibId(), PCB_DRAW_PANEL_GAL::GetView(), CVPCB_MAINFRAME::m_FootprintsList, EDA_DRAW_PANEL_GAL::Refresh(), PCB_BASE_FRAME::Update3DView(), PCB_BASE_FRAME::UpdateStatusBar(), and updateView().

Referenced by CVPCB_CONTROL::ShowFootprintViewer().

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

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

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME().

◆ InstallOptionsDisplay()

void DISPLAY_FOOTPRINTS_FRAME::InstallOptionsDisplay ( wxCommandEvent &  event)

Definition at line 28 of file dialog_display_options.cpp.

29 {
30  DIALOG_FOOTPRINTS_DISPLAY_OPTIONS OptionWindow( this );
31 
32  OptionWindow.ShowModal();
33 }

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

229 {
230  if( m_toolStack.empty() )
231  return &aAction == &ACTIONS::selectionTool;
232  else
233  return m_toolStack.back() == aAction.GetName();
234 }
std::vector< std::string > m_toolStack
static TOOL_ACTION selectionTool
Definition: actions.h:142
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(), 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(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), and FOOTPRINT_WIZARD_FRAME::OnCloseWindow().

◆ IsGridVisible()

bool DISPLAY_FOOTPRINTS_FRAME::IsGridVisible ( ) const
overridevirtual

Function IsGridVisible() , virtual.

Returns
true if the grid must be shown

Reimplemented from EDA_DRAW_FRAME.

Definition at line 309 of file display_footprints_frame.cpp.

310 {
311  return m_drawGrid;
312 }

References EDA_DRAW_FRAME::m_drawGrid.

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

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

818 {
819  wxString prompt = doOpen ? _( "Select Library" ) : _( "New Library" );
820  aFilename.SetExt( ext );
821 
822  if( isDirectory && doOpen )
823  {
824  wxDirDialog dlg( this, prompt, Prj().GetProjectPath(),
825  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
826 
827  if( dlg.ShowModal() == wxID_CANCEL )
828  return false;
829 
830  aFilename = dlg.GetPath();
831  aFilename.SetExt( ext );
832  }
833  else
834  {
835  wxFileDialog dlg( this, prompt, Prj().GetProjectPath(), aFilename.GetFullName() ,
836  wildcard, doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
837  : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
838 
839  if( dlg.ShowModal() == wxID_CANCEL )
840  return false;
841 
842  aFilename = dlg.GetPath();
843  aFilename.SetExt( ext );
844  }
845 
846  return true;
847 }
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 612 of file eda_draw_frame.cpp.

613 {
615  wxConfigBase* cfg = Kiface().KifaceSettings();
616 
617  if( cfg )
618  {
619  canvasType = (EDA_DRAW_PANEL_GAL::GAL_TYPE)
621  }
622 
623  if( canvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
624  || canvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
625  {
626  wxASSERT( false );
628  }
629 
630  // Legacy canvas no longer supported. Switch to Cairo, and on the first instantiation
631  // the user will be prompted to switch to OpenGL
632  if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE )
633  {
634 #ifdef __WXMAC__
635  // Cairo renderer doesn't handle Retina displays
637 #else
639 #endif
640  }
641 
642  return canvasType;
643 }
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::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 FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME::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 DISPLAY_FOOTPRINTS_FRAME::LoadSettings ( wxConfigBase *  aCfg)
overridevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 267 of file display_footprints_frame.cpp.

268 {
270 
271  m_configSettings.Load( aCfg ); // mainly, load the color config
272 
273  aCfg->Read( ConfigBaseName() + AUTO_ZOOM_KEY, &m_autoZoom, true );
274  aCfg->Read( ConfigBaseName() + ZOOM_KEY, &m_lastZoom, 10.0 );
275 }
void Load(wxConfigBase *aCfg) override
wxString ConfigBaseName()
static const wxChar AUTO_ZOOM_KEY[]
Key in KifaceSettings to store the canvas type.
PCB_GENERAL_SETTINGS m_configSettings
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
static const wxChar ZOOM_KEY[]

References PCB_BASE_FRAME::AUTO_ZOOM_KEY, EDA_BASE_FRAME::ConfigBaseName(), PCB_GENERAL_SETTINGS::Load(), PCB_BASE_FRAME::LoadSettings(), m_autoZoom, PCB_BASE_FRAME::m_configSettings, m_lastZoom, and PCB_BASE_FRAME::ZOOM_KEY.

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

200 {
201  m_file_checker = ::LockFile( aFileName );
202 
203  return bool( m_file_checker );
204 }
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().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 295 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
virtualinherited

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

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

Definition at line 308 of file eda_base_frame.cpp.

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

References dump(), and kicadTraceKeyEvent.

◆ OnCloseWindow()

void DISPLAY_FOOTPRINTS_FRAME::OnCloseWindow ( wxCloseEvent &  Event)
overridevirtual

Implements PCB_BASE_FRAME.

Definition at line 172 of file display_footprints_frame.cpp.

173 {
174  Destroy();
175 }
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

References KIWAY_PLAYER::Destroy().

◆ OnGridSettings()

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

Reimplemented in PCB_BASE_EDIT_FRAME, and SCH_BASE_FRAME.

Definition at line 323 of file eda_draw_frame.h.

323 { };

Referenced by EDA_DRAW_FRAME::OnSelectGrid().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 607 of file eda_base_frame.cpp.

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

References ShowAboutDialog().

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

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

763 {
764  GetScreen()->SetModify();
765  GetScreen()->SetSave();
766 
767  UpdateStatusBar();
768  UpdateMsgPanel();
769 }
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 400 of file eda_draw_frame.h.

400 {}

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 614 of file eda_base_frame.cpp.

615 {
616  PAGED_DIALOG dlg( this, _( "Preferences" ) );
617  wxTreebook* book = dlg.GetTreebook();
618 
619  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
620 
621  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
622  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
623 
624  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
625  {
626  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
627 
628  if( frame )
629  frame->InstallPreferences( &dlg, hotkeysPanel );
630  }
631 
632  // The Kicad manager frame is not a player so we have to add it by hand
633  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
634 
635  if( manager )
636  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
637 
638  if( dlg.ShowModal() == wxID_OK )
639  dlg.Kiway().CommonSettingsChanged( false );
640 }
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 282 of file eda_draw_frame.cpp.

283 {
284  wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );
285 
286  int id = m_gridSelectBox->GetCurrentSelection() + ID_POPUP_GRID_FIRST;
287 
288  if( id == ID_POPUP_GRID_SEPARATOR )
289  {
290  // wxWidgets will check the separator, which we don't want.
291  // Re-check the current grid.
292  wxUpdateUIEvent dummy;
294  }
295  else if( id == ID_POPUP_GRID_SETTINGS )
296  {
297  // wxWidgets will check the Grid Settings... entry, which we don't want.
298  // R-check the current grid.
299  wxUpdateUIEvent dummy;
301  // Now run the Grid Settings... dialog
302  wxCommandEvent dummy2;
303  OnGridSettings( dummy2 );
304  }
305  else if( id >= ID_POPUP_GRID_FIRST && id < ID_POPUP_GRID_SEPARATOR )
306  {
308  }
309 
310  UpdateStatusBar();
311  m_canvas->Refresh();
312 }
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:130
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 327 of file eda_draw_frame.cpp.

328 {
329  wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );
330 
331  int id = m_zoomSelectBox->GetCurrentSelection();
332 
333  if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
334  return;
335 
336  m_toolManager->RunAction( "common.Control.zoomPreset", true, id );
337  UpdateStatusBar();
338  m_canvas->Refresh();
339 }
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 EDA_DRAW_FRAME::OnSize ( wxSizeEvent &  event)
virtualinherited

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

Reimplemented in FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, and LIB_VIEW_FRAME.

Definition at line 426 of file eda_draw_frame.cpp.

427 {
428  m_FrameSize = GetClientSize( );
429 
430  SizeEv.Skip();
431 }

References EDA_BASE_FRAME::m_FrameSize.

◆ 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 482 of file pcb_base_frame.cpp.

483 {
484  auto displ_opts = (PCB_DISPLAY_OPTIONS*)GetDisplayOptions();
485  displ_opts->m_DisplayModEdgeFill = !displ_opts->m_DisplayModEdgeFill;
486 
487  if( GetCanvas() )
488  {
489  // Apply new display options to the GAL canvas
490  auto view = static_cast<KIGFX::PCB_VIEW*>( GetCanvas()->GetView() );
491  view->UpdateDisplayOptions( displ_opts );
492  view->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
493  }
494 
495  GetCanvas()->Refresh();
496 }
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 474 of file pcb_base_frame.cpp.

475 {
476  auto displ_opts = (PCB_DISPLAY_OPTIONS*)GetDisplayOptions();
477  displ_opts->m_DisplayDrawItemsFill = !displ_opts->m_DisplayDrawItemsFill;
478  GetCanvas()->Refresh();
479 }
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 449 of file pcb_base_frame.cpp.

450 {
451  auto displ_opts = (PCB_DISPLAY_OPTIONS*)GetDisplayOptions();
452 
453  displ_opts->m_DisplayPadFill = !displ_opts->m_DisplayPadFill;
454 
455  if( GetCanvas() )
456  {
457  // Apply new display options to the GAL canvas
458  auto view = static_cast<KIGFX::PCB_VIEW*>( GetCanvas()->GetView() );
459  view->UpdateDisplayOptions( displ_opts );
460 
461  // Update pads
462  BOARD* board = GetBoard();
463  for( auto module : board->Modules() )
464  {
465  for( auto pad : module->Pads() )
466  view->Update( pad, KIGFX::GEOMETRY );
467  }
468  }
469 
470  GetCanvas()->Refresh();
471 }
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 499 of file pcb_base_frame.cpp.

500 {
501  auto displ_opts = (PCB_DISPLAY_OPTIONS*) GetDisplayOptions();
502  displ_opts->m_DisplayModTextFill = !displ_opts->m_DisplayModTextFill;
503 
504  if( GetCanvas() )
505  {
506  // Apply new display options to the canvas
507  auto view = static_cast<KIGFX::PCB_VIEW*>( GetCanvas()->GetView() );
508  view->UpdateDisplayOptions( displ_opts );
509  view->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
510  }
511 
512  GetCanvas()->Refresh();
513 }
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.

◆ OnUpdateLayerAlpha()

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

Reimplemented in PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 404 of file pcb_base_frame.h.

404 {}

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent)
inherited

Definition at line 250 of file eda_draw_frame.cpp.

251 {
252  // No need to update the grid select box if it doesn't exist or the grid setting change
253  // was made using the select box.
254  if( m_gridSelectBox == NULL )
255  return;
256 
257  int select = wxNOT_FOUND;
258 
259  for( size_t i = 0; i < GetScreen()->GetGridCount(); i++ )
260  {
261  if( GetScreen()->GetGridCmdId() == GetScreen()->GetGrid( i ).m_CmdId )
262  {
263  select = (int) i;
264  break;
265  }
266  }
267 
268  if( select != m_gridSelectBox->GetSelection() )
269  m_gridSelectBox->SetSelection( select );
270 }
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 516 of file pcb_base_frame.cpp.

517 {
518  if( m_zoomSelectBox == NULL || m_zoomSelectBox->GetParent() == NULL )
519  return;
520 
521  int current = 0; // display Auto if no match found
522 
523  // check for a match within 1%
524  double zoom = GetCanvas()->GetLegacyZoom();
525 
526  for( unsigned i = 0; i < GetScreen()->m_ZoomList.size(); i++ )
527  {
528  if( std::fabs( zoom - GetScreen()->m_ZoomList[i] ) < ( zoom / 100.0 ) )
529  {
530  current = i + 1;
531  break;
532  }
533  }
534 
535  if( current != m_zoomSelectBox->GetSelection() )
536  m_zoomSelectBox->SetSelection( current );
537 }
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 FOOTPRINT_VIEWER_FRAME::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 181 of file eda_base_frame.cpp.

182 {
183  // Push/pop events can get out of order (such as when they're generated by the Simulator
184  // frame but not processed until the mouse is back in the Schematic frame), so make sure
185  // we're popping the right stack frame.
186 
187  for( int i = m_toolStack.size() - 1; i >= 0; --i )
188  {
189  if( m_toolStack[ i ] == actionName )
190  {
191  m_toolStack.erase( m_toolStack.begin() + i );
192 
193  // If there's something underneath us, and it's now the top of the stack, then
194  // re-activate it
195  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
196  {
197  std::string back = m_toolStack[ i ];
199 
200  if( action )
201  {
202  // Pop the action as running it will push it back onto the stack
203  m_toolStack.pop_back();
204 
205  TOOL_EVENT evt = action->MakeEvent();
206  evt.SetHasPosition( false );
207  GetToolManager()->PostEvent( evt );
208  }
209  }
210  else
212 
213  return;
214  }
215  }
216 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
TOOL_ACTION * FindAction(const std::string &aActionName) const
Function FindAction() Finds an action with a given name (if there is one available).
virtual void DisplayToolMsg(const wxString &msg)
Class TOOL_EVENT.
Definition: tool_event.h:168
std::vector< std::string > m_toolStack
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:154
Class TOOL_ACTION.
Definition: tool_action.h:46
size_t i
Definition: json11.cpp:597
TOOL_EVENT MakeEvent() const
Function MakeEvent() Returns the event associated with the action (i.e.
Definition: tool_action.h:107
TOOL_MANAGER * m_toolManager
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:228
static TOOL_ACTION selectionTool
Definition: actions.h:142
void SetHasPosition(bool aHasPosition)
Definition: tool_event.h:258

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

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

◆ PrintMsg()

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

Definition at line 556 of file eda_base_frame.cpp.

557 {
558  SetStatusText( text );
559 }

◆ PrintPage()

void EDA_DRAW_FRAME::PrintPage ( wxDC *  aDC)
virtualinherited

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

Parameters
aDC= wxDC given by the calling print function

Reimplemented in SCH_EDIT_FRAME, LIB_EDIT_FRAME, and PL_EDITOR_FRAME.

Definition at line 273 of file eda_draw_frame.cpp.

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

◆ PrintWorkSheet()

void EDA_DRAW_FRAME::PrintWorkSheet ( wxDC *  aDC,
BASE_SCREEN aScreen,
int  aLineWidth,
double  aScale,
const wxString &  aFilename,
const wxString &  aSheetLayer = wxEmptyString,
COLOR4D  aColor = COLOR4D::UNSPECIFIED 
)
inherited

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

Parameters
aDCThe device context.
aScreenscreen to draw
aLineWidthThe pen width to use to draw the layout.
aScaleThe mils to Iu conversion factor.
aFilenameThe filename to display in basic inscriptions.
aSheetLayerThe layer displayed from pcbnew.

Definition at line 780 of file eda_draw_frame.cpp.

783 {
785  return;
786 
787  COLOR4D color = ( aColor != COLOR4D::UNSPECIFIED ) ? aColor : COLOR4D( RED );
788 
789  wxPoint origin = aDC->GetDeviceOrigin();
790 
791  if( origin.y > 0 )
792  {
793  aDC->SetDeviceOrigin( 0, 0 );
794  aDC->SetAxisOrientation( true, false );
795  }
796 
798  aScreen->m_NumberOfScreens, aScreen->m_ScreenNumber, aLineWidth, aScalar,
799  color, aSheetLayer );
800 
801  if( origin.y > 0 )
802  {
803  aDC->SetDeviceOrigin( origin.x, origin.y );
804  aDC->SetAxisOrientation( true, true );
805  }
806 }
int m_ScreenNumber
Definition: base_screen.h:135
virtual const TITLE_BLOCK & GetTitleBlock() const =0
int color
Definition: DXF_plotter.cpp:62
virtual const PAGE_INFO & GetPageSettings() const =0
bool m_showBorderAndTitleBlock
Definition: colors.h:60
int m_NumberOfScreens
Definition: base_screen.h:136
virtual wxString GetScreenDesc() const
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void PrintPageLayout(wxDC *aDC, const PAGE_INFO &aPageInfo, const wxString &aFullSheetName, const wxString &aFileName, const TITLE_BLOCK &aTitleBlock, int aSheetCount, int aSheetNumber, int aPenWidth, double aScalar, COLOR4D aColor, const wxString &aSheetLayer)
Function PrintPageLayout is a core function to print the page layout with the frame and the basic ins...

References color, EDA_DRAW_FRAME::GetPageSettings(), EDA_DRAW_FRAME::GetScreenDesc(), EDA_DRAW_FRAME::GetTitleBlock(), BASE_SCREEN::m_NumberOfScreens, BASE_SCREEN::m_ScreenNumber, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, PrintPageLayout(), and RED.

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

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent &  aEvent)
overrideinherited

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

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

Definition at line 237 of file eda_base_frame.cpp.

238 {
239 #ifdef __WXMAC__
240  // Apple in its infinite wisdom will raise a disabled window before even passing
241  // us the event, so we have no way to stop it. Instead, we have to catch an
242  // improperly ordered disabled window and quasi-modal dialog here and reorder
243  // them.
244  if( !IsEnabled() && IsActive() )
245  {
246  wxWindow* dlg = findQuasiModalDialog();
247  if( dlg )
248  dlg->Raise();
249  }
250 #endif
251 
252  if( !wxFrame::ProcessEvent( aEvent ) )
253  return false;
254 
255  if( IsShown() && m_hasAutoSave && IsActive() &&
257  {
258  if( !m_autoSaveState )
259  {
260  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
261  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
262  m_autoSaveState = true;
263  }
264  else if( m_autoSaveTimer->IsRunning() )
265  {
266  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
267  m_autoSaveTimer->Stop();
268  m_autoSaveState = false;
269  }
270  }
271 
272  return true;
273 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
virtual bool isAutoSaveRequired() const
Return the auto save status of the application.
wxTimer * m_autoSaveTimer
wxWindow * findQuasiModalDialog()

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

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

◆ PushTool()

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

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

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

Definition at line 164 of file eda_base_frame.cpp.

165 {
166  m_toolStack.push_back( actionName );
167 
168  // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
169  if( m_toolStack.size() > 3 )
170  m_toolStack.erase( m_toolStack.begin() );
171 
172  TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
173 
174  if( action )
175  DisplayToolMsg( action->GetLabel() );
176  else
177  DisplayToolMsg( actionName );
178 }
TOOL_ACTION * FindAction(const std::string &aActionName) const
Function FindAction() Finds an action with a given name (if there is one available).
virtual void DisplayToolMsg(const wxString &msg)
wxString GetLabel() const
Definition: tool_action.cpp:69
std::vector< std::string > m_toolStack
ACTION_MANAGER * GetActionManager()
Definition: tool_manager.h:154
Class TOOL_ACTION.
Definition: tool_action.h:46
TOOL_MANAGER * m_toolManager

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

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

◆ ReCreateAuxiliaryToolbar()

virtual void EDA_DRAW_FRAME::ReCreateAuxiliaryToolbar ( )
inlinevirtualinherited

Reimplemented in PCB_EDIT_FRAME, and GERBVIEW_FRAME.

Definition at line 299 of file eda_draw_frame.h.

299 { }

Referenced by PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ ReCreateHToolbar()

void DISPLAY_FOOTPRINTS_FRAME::ReCreateHToolbar ( void  )
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 224 of file display_footprints_frame.cpp.

225 {
226  if( m_mainToolBar != NULL )
227  return;
228 
229  m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
230  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
231 
232  m_mainToolBar->AddTool( ID_OPTIONS_SETUP, wxEmptyString, KiScaledBitmap( config_xpm, this ),
233  _( "Display options" ) );
234 
235  m_mainToolBar->AddSeparator();
241 
242  m_mainToolBar->AddSeparator();
244 
246 
247  // Grid selection choice box.
249  wxDefaultPosition, wxDefaultSize, 0, NULL );
251  m_mainToolBar->AddControl( m_gridSelectBox );
252 
254 
255  // Zoom selection choice box.
257  wxDefaultPosition, wxDefaultSize, 0, NULL );
259  m_mainToolBar->AddControl( m_zoomSelectBox );
260 
261  // after adding the buttons to the toolbar, must call Realize() to reflect
262  // the changes
263  m_mainToolBar->Realize();
264 }
static TOOL_ACTION show3DViewer
Definition: actions.h:147
Class ACTION_TOOLBAR.
static TOOL_ACTION zoomInCenter
Definition: actions.h:89
static const bool TOGGLE
static TOOL_ACTION zoomTool
Definition: actions.h:94
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false)
Function Add() Adds a TOOL_ACTION-based button to the toolbar.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:92
ACTION_TOOLBAR * m_mainToolBar
wxBitmap KiScaledBitmap(BITMAP_DEF aBitmap, EDA_BASE_FRAME *aWindow)
Construct a wxBitmap from a memory record, scaling it if device DPI demands it.
Definition: bitmap.cpp:116
wxChoice * m_gridSelectBox
static TOOL_ACTION zoomOutCenter
Definition: actions.h:90
wxChoice * m_zoomSelectBox
#define _(s)
void UpdateGridSelectBox()
static TOOL_ACTION zoomRedraw
Definition: actions.h:86
void KiScaledSeparator(wxAuiToolBar *aToolbar, EDA_BASE_FRAME *aWindow)
Add a separator to the given toolbar scaled the same way as KiScaledBitmap.
Definition: bitmap.cpp:167
static constexpr int KICAD_AUI_TB_STYLE
Default style flags used for wxAUI toolbars
void updateZoomSelectBox()

References _, ACTION_TOOLBAR::Add(), ID_H_TOOLBAR, ID_ON_GRID_SELECT, ID_ON_ZOOM_SELECT, ID_OPTIONS_SETUP, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, KiScaledBitmap(), KiScaledSeparator(), EDA_DRAW_FRAME::m_gridSelectBox, EDA_DRAW_FRAME::m_mainToolBar, EDA_DRAW_FRAME::m_zoomSelectBox, ACTIONS::show3DViewer, ACTION_TOOLBAR::TOGGLE, PCB_BASE_FRAME::UpdateGridSelectBox(), PCB_BASE_FRAME::updateZoomSelectBox(), ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ ReCreateMenuBar()

void PCB_BASE_FRAME::ReCreateMenuBar ( )
overridevirtualinherited

Recreates the menu bar.

Needed when the language is changed

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 365 of file pcb_base_frame.cpp.

366 {
367 }

◆ ReCreateOptToolbar()

void DISPLAY_FOOTPRINTS_FRAME::ReCreateOptToolbar ( )
overridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 185 of file display_footprints_frame.cpp.

186 {
187  if( m_optionsToolBar )
188  return;
189 
190  // Create options tool bar.
191  m_optionsToolBar = new ACTION_TOOLBAR( this, ID_OPT_TOOLBAR, wxDefaultPosition, wxDefaultSize,
192  KICAD_AUI_TB_STYLE | wxAUI_TB_VERTICAL );
193 
194  // TODO: these can be moved to the 'proper' right vertical toolbar if and when there are
195  // actual tools to put there. That, or I'll get around to implementing configurable
196  // toolbars.
199 
200  m_optionsToolBar->AddSeparator();
206 
207  m_optionsToolBar->AddSeparator();
208  m_optionsToolBar->AddTool( ID_TB_OPTIONS_SHOW_PADS_SKETCH, wxEmptyString,
209  KiScaledBitmap( pad_sketch_xpm, this ),
210  _( "Show pads in outline mode" ), wxITEM_CHECK );
211 
212  m_optionsToolBar->AddTool(