KiCad PCB EDA Suite
PL_EDITOR_FRAME Class Reference

Class PL_EDITOR_FRAME is the main window used in the page layout editor. More...

#include <pl_editor_frame.h>

Inheritance diagram for PL_EDITOR_FRAME:
EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 PL_EDITOR_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~PL_EDITOR_FRAME ()
 
PROPERTIES_FRAMEGetPropertiesFrame ()
 
void ShowDesignInspector ()
 Show the dialog displaying the list of WS_DATA_ITEM items in the page layout. More...
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl) override
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
bool LoadPageLayoutDescrFile (const wxString &aFullFileName)
 Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file. More...
 
bool SavePageLayoutDescrFile (const wxString &aFullFileName)
 Function SavePageLayoutDescrFile Save the current layout in a .kicad_wks page layout descr file. More...
 
bool InsertPageLayoutDescrFile (const wxString &aFullFileName)
 Function InsertPageLayoutDescrFile Loads a .kicad_wks page layout descr file, and add items to the current layout list. More...
 
void OnExit (wxCommandEvent &aEvent)
 
void OnCloseWindow (wxCloseEvent &aEvent)
 
void setupTools ()
 
void ReCreateHToolbar () override
 
void SetPageSettings (const PAGE_INFO &) 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 wxString GetZoomLevelIndicator () const override
 Function GetZoomLevelIndicator returns a human readable value which can be displayed in dialogs. More...
 
PL_DRAW_PANEL_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
PL_EDITOR_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
const wxPoint & GetAuxOrigin () const override
 Return the origin of the axis used for plotting and various exports. More...
 
void SetAuxOrigin (const wxPoint &aPosition) override
 
const wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
wxPoint ReturnCoordOriginCorner () const
 calculate the position (in page, in iu) of the corner used as coordinate origin of items More...
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
void DisplayGridMsg ()
 
void UpdateStatusBar () override
 Update the status bar information. More...
 
void OnNewPageLayout ()
 Must be called to initialize parameters when a new page layout description is loaded. More...
 
void ReCreateVToolbar () override
 creates or updates the right vertical toolbar. More...
 
void ReCreateOptToolbar () override
 Create or update the left vertical toolbar (option toolbar. More...
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
void SyncToolbars () override
 Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state. More...
 
const PL_EDITOR_LAYOUTGetPageLayout () const
 
PL_EDITOR_LAYOUTGetPageLayout ()
 
const BOX2I GetDocumentExtents () const override
 
bool GetPageNumberOption () const
 Page layout editor can show the title block using a page number 1 or another number. More...
 
void UpdateTitleAndInfo ()
 Displays the short filename (if exists) loaded file on the caption of the main window. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Function InstallPreferences Allow a frame to load its preference panels (if any) into the preferences dialog. More...
 
PARAM_CFG_ARRAYGetConfigurationSettings ()
 Populates the applicatios settings list. 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 OnSelectPage (wxCommandEvent &event)
 
void OnSelectCoordOriginCorner (wxCommandEvent &event)
 called when the user select one of the 4 page corner as corner reference (or the left top paper corner) More...
 
void OnSelectTitleBlockDisplayMode (wxCommandEvent &event)
 Toggle the display mode between the normal mode and the editor mode: In normal mode, title block texts are shown like they will be shown in other kicad applications: the format symbols in texts are replaced by the actual text. More...
 
void OnUpdateTitleBlockDisplayNormalMode (wxUpdateUIEvent &event)
 
void OnUpdateTitleBlockDisplayEditMode (wxUpdateUIEvent &event)
 
void ToPrinter (bool doPreview)
 Function ToPrinter Open a dialog frame to print layers. More...
 
void Files_io (wxCommandEvent &event)
 
virtual void PrintPage (wxDC *aDC) override
 Virtual function PrintPage used to print a page. More...
 
void OnFileHistory (wxCommandEvent &event)
 
const wxString & GetCurrFileName () const
 
void SetCurrFileName (const wxString &aName)
 Stores the current layout descr file filename. More...
 
void HardRedraw () override
 Refresh the library tree and redraw the window. More...
 
WS_DATA_ITEMAddPageLayoutItem (int aType)
 Function AddPageLayoutItem Add a new item to the page layout item list. More...
 
void OnModify ()
 Must be called after a change in order to set the "modify" flag. More...
 
void SaveCopyInUndoList (bool aSavePageSettingsAndTitleBlock=false)
 Save a copy of the description (in a S expr string) for Undo/redo commands. More...
 
void GetLayoutFromRedoList ()
 Redo the last edit: More...
 
void GetLayoutFromUndoList ()
 Undo the last edit: More...
 
void RollbackFromUndo ()
 Apply the last command in Undo List without stacking a Redo. More...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
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
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
virtual wxString GetScreenDesc () const
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest(). More...
 
double GetZoomLevelCoeff () const
 Return the coefficient to convert internal display scale factor to zoom level. More...
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
virtual bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
virtual COLOR4D GetGridColor ()
 
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 Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos, bool aCenterView=false)
 Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested. More...
 
double GetZoom ()
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (wxDC *aDC, BASE_SCREEN *aScreen, int aLineWidth, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString, COLOR4D aColor=COLOR4D::UNSPECIFIED)
 Prints the page layout with the frame and the basic inscriptions. More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane on the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
virtual void ActivateGalCanvas ()
 Use to start up the GAL drawing canvas. More...
 
virtual void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Changes the current rendering backend. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
virtual void * GetDisplayOptions ()
 A way to pass info to draw functions. More...
 
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 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...
 
wxString ConfigBaseName ()
 
virtual void SaveProjectSettings (bool aAskForSave)
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, wxFileHistory *aFileHistory=NULL)
 Fetches the file name from the file history list. More...
 
void UpdateFileHistory (const wxString &FullFileName, wxFileHistory *aFileHistory=NULL)
 Update the list of recently opened files. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void ShowChangedLanguage ()
 Redraw the menus and what not in current language. 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...
 

Protected Member Functions

bool saveCurrentPageLayout ()
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void unitsChangeRefresh () override
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
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

wxString m_lastFileName
 The last filename chosen to be proposed to the user. More...
 
PROPERTIES_FRAMEm_propertiesPagelayout
 
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

PL_EDITOR_LAYOUT m_pageLayout
 
int m_propertiesFrameWidth
 
wxChoice * m_originSelectBox
 
int m_originSelectChoice
 
wxChoice * m_pageSelectBox
 
wxPoint m_grid_origin
 
PARAM_CFG_ARRAY m_configSettings
 

Detailed Description

Class PL_EDITOR_FRAME is the main window used in the page layout editor.

Definition at line 45 of file pl_editor_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

◆ PL_EDITOR_FRAME()

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

Definition at line 78 of file pl_editor_frame.cpp.

78  :
79  EDA_DRAW_FRAME( aKiway, aParent, FRAME_PL_EDITOR, wxT( "PlEditorFrame" ),
80  wxDefaultPosition, wxDefaultSize,
82 {
84  m_zoomLevelCoeff = 290.0; // Adjusted to roughly displays zoom level = 1
85  // when the screen shows a 1:1 image
86  // obviously depends on the monitor,
87  // but this is an acceptable value
88 
89  m_showBorderAndTitleBlock = true; // true for reference drawings.
91  SetDrawBgColor( WHITE ); // default value, user option (WHITE/BLACK)
93  SetShowPageLimits( true );
94  m_AboutTitle = "PlEditor";
95 
97 
98  // Give an icon
99  wxIcon icon;
100  icon.CopyFromBitmap( KiBitmap( icon_pagelayout_editor_xpm ) );
101  SetIcon( icon );
102 
103  // Create GAL canvas
104 #ifdef __WXMAC__
105  // Cairo renderer doesn't handle Retina displays
107 #else
109 #endif
110 
111  auto* drawPanel = new PL_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_FrameSize,
113  SetCanvas( drawPanel );
114 
115  LoadSettings( config() );
116  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
117 
118  wxSize pageSizeIU = GetPageLayout().GetPageSettings().GetSizeIU();
119  SetScreen( new PL_EDITOR_SCREEN( pageSizeIU ) );
120 
121  setupTools();
122  ReCreateMenuBar();
125 
126  wxWindow* stsbar = GetStatusBar();
127  int dims[] = {
128 
129  // balance of status bar on far left is set to a default or whatever is left over.
130  -1,
131 
132  // When using GetTextSize() remember the width of '1' is not the same
133  // as the width of '0' unless the font is fixed width, and it usually won't be.
134 
135  // zoom:
136  GetTextSize( wxT( "Z 762000" ), stsbar ).x + 10,
137 
138  // cursor coords
139  GetTextSize( wxT( "X 0234.567 Y 0234.567" ), stsbar ).x + 10,
140 
141  // delta distances
142  GetTextSize( wxT( "dx 0234.567 dx 0234.567" ), stsbar ).x + 10,
143 
144  // grid size
145  GetTextSize( wxT( "grid 0234.567" ), stsbar ).x + 10,
146 
147  // Coord origin (use the bigger message)
148  GetTextSize( _( "coord origin: Right Bottom page corner" ), stsbar ).x + 10,
149 
150  // units display, Inches is bigger than mm
151  GetTextSize( _( "Inches" ), stsbar ).x + 20
152  };
153 
154  SetStatusWidths( arrayDim( dims ), dims );
155 
156  m_auimgr.SetManagedWindow( this );
157 
159 
160  // Horizontal items; layers 4 - 6
161  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
162  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
163 
164  // Vertical items; layers 1 - 3
165  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" ).Right().Layer(1) );
166 
167  m_auimgr.AddPane( m_propertiesPagelayout, EDA_PANE().Palette().Name( "Props" ).Right().Layer(2)
168  .Caption( _( "Properties" ) ).MinSize( m_propertiesPagelayout->GetMinSize() )
169  .BestSize( m_propertiesFrameWidth, -1 ) );
170 
171  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
172 
175 
176  m_auimgr.Update();
177 
178  // Add the exit key handler
179  InitExitKey();
180 
181  wxPoint originCoord = ReturnCoordOriginCorner();
182  SetGridOrigin( originCoord );
183 
184  if( !GetScreen()->GridExists( m_LastGridSizeId + ID_POPUP_GRID_LEVEL_1000 ) )
186 
187  GetToolManager()->RunAction( "common.Control.gridPreset", true, m_LastGridSizeId );
188 
189  // Initialize the current page layout
191 #if 0 //start with empty layout
192  pglayout.AllowVoidList( true );
193  pglayout.ClearList();
194 #else // start with the default Kicad layout
195  pglayout.SetPageLayout();
196 #endif
197  OnNewPageLayout();
198 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
virtual void SetScreen(BASE_SCREEN *aScreen)
void ReCreateVToolbar() override
creates or updates the right vertical toolbar.
wxPoint ReturnCoordOriginCorner() const
calculate the position (in page, in iu) of the corner used as coordinate origin of items
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
void ReCreateMenuBar() override
Recreates the menu bar.
Class PROPERTIES_FRAME display properties of the current item.
virtual void SetDrawBgColor(COLOR4D aColor)
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
wxString m_AboutTitle
virtual wxConfigBase * config()
Returns the wxConfigBase used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
#define PL_EDITOR_FRAME_NAME
void SetPageLayout(const wxString &aFullFileName=wxEmptyString, bool Append=false)
Populates the list with a custom layout, or the default layout, if no custom layout available.
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
PAGE_INFO & GetPageSettings()
void ClearList()
erase the list of items
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: common.cpp:115
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
double GetZoomLevelCoeff() const
Return the coefficient to convert internal display scale factor to zoom level.
void AllowVoidList(bool Allow)
In Kicad applications, a page layout description is needed So if the list is empty,...
EDA_MSG_PANEL * m_messagePanel
bool m_showBorderAndTitleBlock
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
wxSize GetMinSize() const override
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
#define KICAD_DEFAULT_DRAWFRAME_STYLE
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void InitExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
#define _(s)
Specialization of the wxAuiPaneInfo class for KiCad panels.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108
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)
double m_zoomLevelCoeff
EDA_UNITS_T m_userUnits
PROPERTIES_FRAME * m_propertiesPagelayout
void SetGridOrigin(const wxPoint &aPoint) override
Definition: colors.h:49
void SetShowPageLimits(bool aShow)
const PL_EDITOR_LAYOUT & GetPageLayout() const
void ReCreateHToolbar() override
ACTION_TOOLBAR * m_drawToolBar
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.

References _, WS_DATA_MODEL::AllowVoidList(), arrayDim(), PCAD2KICAD::Center, WS_DATA_MODEL::ClearList(), EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetTextSize(), WS_DATA_MODEL::GetTheInstance(), ID_POPUP_GRID_LEVEL_1000, ID_POPUP_GRID_LEVEL_1MM, KiBitmap(), WS_DATA_MODEL::m_EditMode, MILLIMETRES, PCAD2KICAD::Right, WS_DATA_MODEL::SetPageLayout(), and WHITE.

◆ ~PL_EDITOR_FRAME()

PL_EDITOR_FRAME::~PL_EDITOR_FRAME ( )
inline

Definition at line 69 of file pl_editor_frame.h.

69 {}

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )
virtualinherited

Use to start up the GAL drawing canvas.

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

Definition at line 597 of file eda_draw_frame.cpp.

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

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

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

◆ AddPageLayoutItem()

WS_DATA_ITEM * PL_EDITOR_FRAME::AddPageLayoutItem ( int  aType)

Function AddPageLayoutItem Add a new item to the page layout item list.

Parameters
aType= the type of item: WS_TEXT, WS_SEGMENT, WS_RECT, WS_POLYPOLYGON
aIdx= the position in list to insert the new item.
Returns
a reference to the new item

Definition at line 684 of file pl_editor_frame.cpp.

685 {
686  WS_DATA_ITEM * item = NULL;
687 
688  switch( aType )
689  {
691  item = new WS_DATA_ITEM_TEXT( wxT( "Text") );
692  break;
693 
696  break;
697 
699  item = new WS_DATA_ITEM( WS_DATA_ITEM::WS_RECT );
700  break;
701 
703  item = new WS_DATA_ITEM_POLYGONS();
704  break;
705 
707  {
708  wxFileDialog fileDlg( this, _( "Choose Image" ), wxEmptyString, wxEmptyString,
709  _( "Image Files " ) + wxImage::GetImageExtWildcard(), wxFD_OPEN );
710 
711  if( fileDlg.ShowModal() != wxID_OK )
712  return NULL;
713 
714  wxString fullFilename = fileDlg.GetPath();
715 
716  if( !wxFileExists( fullFilename ) )
717  {
718  wxMessageBox( _( "Couldn't load image from \"%s\"" ), fullFilename );
719  break;
720  }
721 
722  BITMAP_BASE* image = new BITMAP_BASE();
723 
724  if( !image->ReadImageFile( fullFilename ) )
725  {
726  wxMessageBox( _( "Couldn't load image from \"%s\"" ), fullFilename );
727  delete image;
728  break;
729  }
730 
731  item = new WS_DATA_ITEM_BITMAP( image );
732  }
733  break;
734  }
735 
736  if( item == NULL )
737  return NULL;
738 
740  item->SyncDrawItems( nullptr, GetCanvas()->GetView() );
741 
742  return item;
743 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Work sheet structure type definitions.
Definition: ws_data_item.h:93
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:51
#define _(s)
virtual void SyncDrawItems(WS_DRAW_ITEM_LIST *aCollector, KIGFX::VIEW *aView)
void Append(WS_DATA_ITEM *aItem)
bool ReadImageFile(const wxString &aFullFilename)
Reads and stores in memory an image file.

References _, WS_DATA_MODEL::Append(), GetCanvas(), WS_DATA_MODEL::GetTheInstance(), BITMAP_BASE::ReadImageFile(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM::WS_BITMAP, WS_DATA_ITEM::WS_POLYPOLYGON, WS_DATA_ITEM::WS_RECT, WS_DATA_ITEM::WS_SEGMENT, and WS_DATA_ITEM::WS_TEXT.

Referenced by PL_DRAWING_TOOLS::DrawShape(), and PL_DRAWING_TOOLS::PlaceItem().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 365 of file eda_base_frame.cpp.

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

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

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

Definition at line 349 of file eda_draw_frame.cpp.

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

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

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

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 554 of file eda_draw_frame.cpp.

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

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

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

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS_T  aUnits)
inlineinherited

Definition at line 213 of file eda_base_frame.h.

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

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 688 of file eda_base_frame.cpp.

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

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

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

◆ ClearMsgPanel()

◆ CommonSettingsChanged()

void EDA_DRAW_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged)
overrideprotectedvirtualinherited

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

Update menus, toolbars, local variables, etc.

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_BASE_FRAME.

Definition at line 215 of file eda_draw_frame.cpp.

216 {
217  EDA_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged );
218 
219  wxConfigBase* settings = Pgm().CommonSettings();
220  KIGFX::VIEW_CONTROLS* viewControls = GetCanvas()->GetViewControls();
221 
222  int autosaveInterval;
223  settings->Read( AUTOSAVE_INTERVAL_KEY, &autosaveInterval );
224  SetAutoSaveInterval( autosaveInterval );
225 
226  int historySize;
227  settings->Read( FILE_HISTORY_SIZE_KEY, &historySize, DEFAULT_FILE_HISTORY_SIZE );
228  Kiface().GetFileHistory().SetMaxFiles( (unsigned) std::max( 0, historySize ) );
229 
230  bool option;
231  settings->Read( ENBL_MOUSEWHEEL_PAN_KEY, &option );
232  viewControls->EnableMousewheelPan( option );
233 
234  settings->Read( ENBL_ZOOM_NO_CENTER_KEY, &option );
235  viewControls->EnableCursorWarping( !option );
236 
237  settings->Read( ENBL_AUTO_PAN_KEY, &option );
238  viewControls->EnableAutoPan( option );
239 
240  m_galDisplayOptions.ReadCommonConfig( *settings, this );
241 }
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
void ReadCommonConfig(wxConfigBase &aCommonConfig, wxWindow *aWindow)
Read GAL config options from the common config store.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void EnableMousewheelPan(bool aEnable)
Function EnableMousewheelPan() Enables or disables mousewheel panning.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
#define ENBL_ZOOM_NO_CENTER_KEY
Definition: pgm_base.h:50
void EnableCursorWarping(bool aEnable)
Function EnableCursorWarping() Enables or disables warping the cursor.
#define ENBL_AUTO_PAN_KEY
Definition: pgm_base.h:53
#define ENBL_MOUSEWHEEL_PAN_KEY
Definition: pgm_base.h:51
#define FILE_HISTORY_SIZE_KEY
Definition: pgm_base.h:54
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
virtual void EnableAutoPan(bool aEnabled)
Function EnableAutoPan Turns on/off auto panning (user setting to disable it entirely).
VTBL_ENTRY wxConfigBase * CommonSettings() const
Definition: pgm_base.h:204
#define AUTOSAVE_INTERVAL_KEY
Definition: pgm_base.h:49
virtual void CommonSettingsChanged(bool aEnvVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.
void SetMaxFiles(size_t aMaxFiles)
Definition: pgm_base.cpp:120
void SetAutoSaveInterval(int aInterval)
#define max(a, b)
Definition: auxiliary.h:86
KIGFX::GAL_DISPLAY_OPTIONS m_galDisplayOptions
#define DEFAULT_FILE_HISTORY_SIZE
IDs range for menuitems file history: The default range file history size is 9 (compatible with defau...
Definition: id.h:69
FILE_HISTORY & GetFileHistory()
Definition: kiface_i.h:123

References AUTOSAVE_INTERVAL_KEY, PGM_BASE::CommonSettings(), EDA_BASE_FRAME::CommonSettingsChanged(), DEFAULT_FILE_HISTORY_SIZE, KIGFX::VIEW_CONTROLS::EnableAutoPan(), KIGFX::VIEW_CONTROLS::EnableCursorWarping(), KIGFX::VIEW_CONTROLS::EnableMousewheelPan(), ENBL_AUTO_PAN_KEY, ENBL_MOUSEWHEEL_PAN_KEY, ENBL_ZOOM_NO_CENTER_KEY, FILE_HISTORY_SIZE_KEY, EDA_DRAW_FRAME::GetCanvas(), KIFACE_I::GetFileHistory(), EDA_DRAW_PANEL_GAL::GetViewControls(), Kiface(), EDA_DRAW_FRAME::m_galDisplayOptions, max, Pgm(), KIGFX::GAL_DISPLAY_OPTIONS::ReadCommonConfig(), EDA_BASE_FRAME::SetAutoSaveInterval(), and FILE_HISTORY::SetMaxFiles().

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

◆ config()

wxConfigBase * EDA_BASE_FRAME::config ( )
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 536 of file eda_base_frame.cpp.

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

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

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

◆ ConfigBaseName()

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

Definition at line 337 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

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

◆ CreateServer()

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

Definition at line 49 of file eda_dde.cpp.

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

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

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

◆ CurrentToolName()

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

Definition at line 220 of file eda_base_frame.cpp.

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

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

◆ 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 PL_EDITOR_FRAME::DisplayGridMsg ( )

Definition at line 543 of file pl_editor_frame.cpp.

544 {
545  wxString line;
546  wxString gridformatter;
547 
548  switch( m_userUnits )
549  {
550  case INCHES: gridformatter = "grid %.3f"; break;
551  case MILLIMETRES: gridformatter = "grid %.4f"; break;
552  default: gridformatter = "grid %f"; break;
553  }
554 
555  wxRealPoint curr_grid_size = GetScreen()->GetGridSize();
556  double grid = To_User_Unit( m_userUnits, curr_grid_size.x );
557  line.Printf( gridformatter, grid );
558 
559  SetStatusText( line, 4 );
560 }
const wxRealPoint & GetGridSize() const
Return the grid size of the currently selected grid.
Definition: base_screen.h:279
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
Definition: common.h:134
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
EDA_UNITS_T m_userUnits

References BASE_SCREEN::GetGridSize(), GetScreen(), INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and To_User_Unit().

Referenced by UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 375 of file eda_draw_frame.cpp.

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

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane on the status bar.

Definition at line 412 of file eda_draw_frame.cpp.

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

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

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 303 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 244 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

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

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

Parameters
cmdline= received command from socket

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 274 of file eda_draw_frame.h.

274 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ Files_io()

void PL_EDITOR_FRAME::Files_io ( wxCommandEvent &  event)

Definition at line 83 of file pagelayout_editor/files.cpp.

84 {
85  wxString msg;
86  int id = event.GetId();
87  wxString filename = GetCurrFileName();
89 
90  if( filename.IsEmpty() && id == wxID_SAVE )
91  id = wxID_SAVEAS;
92 
93  if( ( id == wxID_NEW || id == wxID_OPEN ) && GetScreen()->IsModify() )
94  {
95  if( !HandleUnsavedChanges( this, _( "The current page layout has been modified. "
96  "Save changes?" ),
97  [&]()->bool { return saveCurrentPageLayout(); } ) )
98  {
99  return;
100  }
101  }
102 
103  switch( id )
104  {
105  case wxID_NEW:
106  pglayout.AllowVoidList( true );
107  SetCurrFileName( wxEmptyString );
108  pglayout.ClearList();
109  OnNewPageLayout();
110  break;
111 
113  {
114  wxFileDialog openFileDialog( this, _( "Append Existing Page Layout File" ),
115  wxEmptyString, wxEmptyString,
116  PageLayoutDescrFileWildcard(), wxFD_OPEN );
117 
118  if( openFileDialog.ShowModal() == wxID_CANCEL )
119  return;
120 
121  filename = openFileDialog.GetPath();
122 
123  if( ! InsertPageLayoutDescrFile( filename ) )
124  {
125  msg.Printf( _( "Unable to load %s file" ), GetChars( filename ) );
126  wxMessageBox( msg );
127  }
128  else
129  {
130  GetScreen()->SetModify();
131  HardRedraw();
132  msg.Printf( _( "File \"%s\" inserted" ), GetChars( filename ) );
133  SetStatusText( msg );
134  }
135  }
136  break;
137 
138  case wxID_OPEN:
139  {
140  wxFileDialog openFileDialog( this, _( "Open" ), wxEmptyString, wxEmptyString,
141  PageLayoutDescrFileWildcard(), wxFD_OPEN );
142 
143  if( openFileDialog.ShowModal() == wxID_CANCEL )
144  return;
145 
146  filename = openFileDialog.GetPath();
147 
148  if( ! LoadPageLayoutDescrFile( filename ) )
149  {
150  msg.Printf( _( "Unable to load %s file" ), GetChars( filename ) );
151  wxMessageBox( msg );
152  }
153  else
154  {
155  OnNewPageLayout();
156  msg.Printf( _( "File \"%s\" loaded" ), GetChars( filename ) );
157  SetStatusText( msg );
158  }
159  }
160  break;
161 
162  case wxID_SAVE:
163  if( !SavePageLayoutDescrFile( filename ) )
164  {
165  msg.Printf( _( "Unable to write \"%s\"" ), GetChars( filename ) );
166  wxMessageBox( msg );
167  }
168  else
169  {
170  msg.Printf( _("File \"%s\" written"), GetChars( filename ) );
171  SetStatusText( msg );
172  }
173  break;
174 
175  case wxID_SAVEAS:
176  {
177  wxFileDialog openFileDialog( this, _( "Save As" ), wxEmptyString, wxEmptyString,
178  PageLayoutDescrFileWildcard(), wxFD_SAVE );
179 
180  if( openFileDialog.ShowModal() == wxID_CANCEL )
181  return;
182 
183  filename = openFileDialog.GetPath();
184  // Ensure the file has the right extension:
185  // because a name like name.subname.subsubname is legal,
186  // add the right extension without replacing the wxFileName
187  // extension
188  wxFileName fn(filename);
189 
190  if( fn.GetExt() != PageLayoutDescrFileExtension )
191  filename << wxT(".") << PageLayoutDescrFileExtension;
192 
193  if( !SavePageLayoutDescrFile( filename ) )
194  {
195  msg.Printf( _("Unable to create \"%s\""), GetChars( filename ) );
196  wxMessageBox( msg );
197  }
198 
199  else
200  {
201  msg.Printf( _("File \"%s\" written"), GetChars( filename ) );
202  SetStatusText( msg );
203 
204  if( GetCurrFileName().IsEmpty() )
205  SetCurrFileName( filename );
206  }
207  }
208  break;
209 
210  default:
211  wxMessageBox( wxT( "File_io: unexpected command id" ) );
212  break;
213  }
214 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
wxString PageLayoutDescrFileWildcard()
void HardRedraw() override
Refresh the library tree and redraw the window.
const wxString & GetCurrFileName() const
void ClearList()
erase the list of items
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
void AllowVoidList(bool Allow)
In Kicad applications, a page layout description is needed So if the list is empty,...
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool SavePageLayoutDescrFile(const wxString &aFullFileName)
Function SavePageLayoutDescrFile Save the current layout in a .kicad_wks page layout descr file.
bool IsModify() const
Definition: base_screen.h:228
#define _(s)
const std::string PageLayoutDescrFileExtension
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 SetCurrFileName(const wxString &aName)
Stores the current layout descr file filename.
bool InsertPageLayoutDescrFile(const wxString &aFullFileName)
Function InsertPageLayoutDescrFile Loads a .kicad_wks page layout descr file, and add items to the cu...
bool LoadPageLayoutDescrFile(const wxString &aFullFileName)
Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.
void SetModify()
Definition: base_screen.h:224

References _, WS_DATA_MODEL::AllowVoidList(), WS_DATA_MODEL::ClearList(), GetChars(), GetCurrFileName(), GetScreen(), WS_DATA_MODEL::GetTheInstance(), HandleUnsavedChanges(), HardRedraw(), ID_APPEND_DESCR_FILE, InsertPageLayoutDescrFile(), BASE_SCREEN::IsModify(), LoadPageLayoutDescrFile(), OnNewPageLayout(), PageLayoutDescrFileExtension, PageLayoutDescrFileWildcard(), saveCurrentPageLayout(), SavePageLayoutDescrFile(), SetCurrFileName(), and BASE_SCREEN::SetModify().

Referenced by PL_EDIT_TOOL::ImportWorksheetContent(), PL_EDITOR_CONTROL::New(), PL_EDITOR_CONTROL::Open(), PL_EDITOR_CONTROL::Save(), PL_EDITOR_CONTROL::SaveAs(), and saveCurrentPageLayout().

◆ FocusOnLocation()

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

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

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

Definition at line 727 of file eda_draw_frame.cpp.

728 {
729  if( aCenterView )
730  {
731  wxWindow* dialog = findDialog( GetChildren() );
732 
733  // If a dialog partly obscures the window, then center on the uncovered area.
734  if( dialog )
735  {
736  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
737  dialog->GetSize() );
738  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
739  }
740  else
741  GetCanvas()->GetView()->SetCenter( aPos );
742  }
743 
745 }
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:604
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.

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

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

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

◆ 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.

◆ GetAuxOrigin()

const wxPoint& PL_EDITOR_FRAME::GetAuxOrigin ( ) const
inlineoverridevirtual

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

Implements EDA_DRAW_FRAME.

Definition at line 137 of file pl_editor_frame.h.

138  {
139  static wxPoint dummy; // ( 0,0 );
140  return dummy;
141  }
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.

References dummy().

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

◆ GetCanvas()

PL_DRAW_PANEL_GAL * PL_EDITOR_FRAME::GetCanvas ( ) const
overridevirtual

◆ GetCanvasTypeKey()

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

Definition at line 170 of file eda_draw_frame.h.

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

References CanvasTypeKeyBase.

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

◆ GetConfigurationSettings()

PARAM_CFG_ARRAY& PL_EDITOR_FRAME::GetConfigurationSettings ( void  )
inline

Populates the applicatios settings list.

(list of parameters that must be saved in project parameters) Currently, only the settings that are needed at start up by the main window are defined here. There are other locally used settings scattered throughout the source code (mainly in dialogs). If you need to define a configuration setting that need to be loaded at run time, this is the place to define it.

Definition at line 218 of file pl_editor_frame.h.

218 { return m_configSettings; }
PARAM_CFG_ARRAY m_configSettings

References m_configSettings.

Referenced by SaveSettings().

◆ GetCurrFileName()

const wxString & PL_EDITOR_FRAME::GetCurrFileName ( ) const
Returns
the filename of the current layout descr file If this is the default (no loaded file) returns a emtpy name or a new design.

Definition at line 452 of file pl_editor_frame.cpp.

453 {
455 }
static wxString m_PageLayoutDescrFileName
the name of the page layout descr file, or emty to used the default pagelayout
Definition: base_screen.h:109

References BASE_SCREEN::m_PageLayoutDescrFileName.

Referenced by Files_io(), OnCloseWindow(), PL_EDITOR_CONTROL::PageSetup(), and UpdateTitleAndInfo().

◆ GetDisplayOptions()

virtual void* EDA_DRAW_FRAME::GetDisplayOptions ( )
inlinevirtualinherited

A way to pass info to draw functions.

the base class has no knowledge about these options. It is virtual because this function must be overloaded to pass usefull info.

Reimplemented in PCB_BASE_FRAME.

Definition at line 494 of file eda_draw_frame.h.

494 { return NULL; }

Referenced by GERBVIEW_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), and PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow().

◆ GetDocumentExtents()

const BOX2I PL_EDITOR_FRAME::GetDocumentExtents ( ) const
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 370 of file pl_editor_frame.cpp.

371 {
372  BOX2I rv( VECTOR2I( 0, 0 ), GetPageLayout().GetPageSettings().GetSizeIU() );
373  return rv;
374 }
const PAGE_INFO & GetPageSettings() const override
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
Class BOX2 handles a 2-D bounding box, built on top of an origin point and size vector,...
Definition: box2.h:41
const PL_EDITOR_LAYOUT & GetPageLayout() const

References GetPageLayout(), and GetPageSettings().

◆ GetDoImmediateActions()

bool EDA_BASE_FRAME::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 243 of file eda_base_frame.h.

243 { return m_immediateActions; }

References EDA_BASE_FRAME::m_immediateActions.

◆ GetDragSelects()

bool EDA_BASE_FRAME::GetDragSelects ( ) const
inlineinherited

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

Definition at line 249 of file eda_base_frame.h.

249 { return m_dragSelects; }

References EDA_BASE_FRAME::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
wxFileHistory *  aFileHistory = NULL 
)
inherited

Fetches the file name from the file history list.

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

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

Definition at line 575 of file eda_base_frame.cpp.

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

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

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), 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

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const wxPoint& PL_EDITOR_FRAME::GetGridOrigin ( ) const
inlineoverridevirtual

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

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

Implements EDA_DRAW_FRAME.

Definition at line 144 of file pl_editor_frame.h.

145  {
146  return m_grid_origin;
147  }

References m_grid_origin.

◆ GetLastGridSizeId()

int EDA_DRAW_FRAME::GetLastGridSizeId ( ) const
inlineinherited

Definition at line 227 of file eda_draw_frame.h.

227 { return m_LastGridSizeId; }

References EDA_DRAW_FRAME::m_LastGridSizeId.

◆ GetLayoutFromRedoList()

void PL_EDITOR_FRAME::GetLayoutFromRedoList ( )

Redo the last edit:

  • Place the current edited layout in undo list
  • Get the previous version of the current edited layput

Definition at line 55 of file pl_editor_undo_redo.cpp.

56 {
58 
59  if ( GetScreen()->GetRedoCommandCount() <= 0 )
60  return;
61 
63  WS_PROXY_UNDO_ITEM* redoItem = static_cast<WS_PROXY_UNDO_ITEM*>( redoWrapper.GetItem() );
64  bool pageSettingsAndTitleBlock = redoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
65 
66  PICKED_ITEMS_LIST* undoCmd = new PICKED_ITEMS_LIST();
67 
68  undoCmd->PushItem( new WS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr ) );
69  GetScreen()->PushCommandToUndoList( undoCmd );
70 
71  selTool->ClearSelection();
72  redoItem->Restore( this, GetCanvas()->GetView() );
73  selTool->RebuildSelection();
74 
75  delete redoItem;
76 
77  if( pageSettingsAndTitleBlock )
78  HardRedraw(); // items based off of corners will need re-calculating
79  else
80  GetCanvas()->Refresh();
81 
82  OnModify();
83 }
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
virtual void PushCommandToUndoList(PICKED_ITEMS_LIST *aItem)
Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when t...
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
void RebuildSelection()
Rebuild the selection from the flags in the view items.
void HardRedraw() override
Refresh the library tree and redraw the window.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_ITEM * GetItem() const
int ClearSelection(const TOOL_EVENT &aEvent)
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
void OnModify()
Must be called after a change in order to set the "modify" flag.
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted.
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
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...
ITEM_PICKER PopItem()
Function PopItem.
int GetRedoCommandCount() const
Definition: base_screen.h:206
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), BASE_SCREEN::GetRedoCommandCount(), GetScreen(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetToolManager(), HardRedraw(), OnModify(), BASE_SCREEN::PopCommandFromRedoList(), PICKED_ITEMS_LIST::PopItem(), BASE_SCREEN::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), WS_PROXY_UNDO_ITEM::Restore(), EDA_ITEM::Type(), and WS_PROXY_UNDO_ITEM_PLUS_T.

Referenced by PL_EDIT_TOOL::Redo().

◆ GetLayoutFromUndoList()

void PL_EDITOR_FRAME::GetLayoutFromUndoList ( )

Undo the last edit:

  • Place the current layout in Redo list
  • Get the previous version of the current edited layout

Definition at line 90 of file pl_editor_undo_redo.cpp.

91 {
93 
94  if ( GetScreen()->GetUndoCommandCount() <= 0 )
95  return;
96 
98  WS_PROXY_UNDO_ITEM* undoItem = static_cast<WS_PROXY_UNDO_ITEM*>( undoWrapper.GetItem() );
99  bool pageSettingsAndTitleBlock = undoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
100 
101  PICKED_ITEMS_LIST* redoCmd = new PICKED_ITEMS_LIST();
102 
103  redoCmd->PushItem( new WS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr ) );
104  GetScreen()->PushCommandToRedoList( redoCmd );
105 
106  selTool->ClearSelection();
107  undoItem->Restore( this, GetCanvas()->GetView() );
108  selTool->RebuildSelection();
109 
110  delete undoItem;
111 
112  if( pageSettingsAndTitleBlock )
113  HardRedraw(); // items based off of corners will need re-calculating
114  else
115  GetCanvas()->Refresh();
116 
117  OnModify();
118 }
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
void RebuildSelection()
Rebuild the selection from the flags in the view items.
void HardRedraw() override
Refresh the library tree and redraw the window.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
int GetUndoCommandCount() const
Definition: base_screen.h:201
EDA_ITEM * GetItem() const
int ClearSelection(const TOOL_EVENT &aEvent)
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
void OnModify()
Must be called after a change in order to set the "modify" flag.
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted.
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
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...
virtual void PushCommandToRedoList(PICKED_ITEMS_LIST *aItem)
Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when t...
ITEM_PICKER PopItem()
Function PopItem.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), GetScreen(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetToolManager(), BASE_SCREEN::GetUndoCommandCount(), HardRedraw(), OnModify(), BASE_SCREEN::PopCommandFromUndoList(), PICKED_ITEMS_LIST::PopItem(), BASE_SCREEN::PushCommandToRedoList(), PICKED_ITEMS_LIST::PushItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), WS_PROXY_UNDO_ITEM::Restore(), EDA_ITEM::Type(), and WS_PROXY_UNDO_ITEM_PLUS_T.

Referenced by PL_EDIT_TOOL::Undo().

◆ GetMoveWarpsCursor()

bool EDA_BASE_FRAME::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 255 of file eda_base_frame.h.

255 { return m_moveWarpsCursor; }

References EDA_BASE_FRAME::m_moveWarpsCursor.

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

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const
inlineinherited

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 690 of file eda_draw_frame.cpp.

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

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

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

◆ GetPageLayout() [1/2]

const PL_EDITOR_LAYOUT& PL_EDITOR_FRAME::GetPageLayout ( ) const
inline

Definition at line 187 of file pl_editor_frame.h.

187 { return m_pageLayout; }
PL_EDITOR_LAYOUT m_pageLayout

References m_pageLayout.

Referenced by GetDocumentExtents(), GetTitleBlock(), and DIALOG_INSPECTOR::ReCreateDesignList().

◆ GetPageLayout() [2/2]

PL_EDITOR_LAYOUT& PL_EDITOR_FRAME::GetPageLayout ( )
inline

Definition at line 188 of file pl_editor_frame.h.

188 { return m_pageLayout; }
PL_EDITOR_LAYOUT m_pageLayout

References m_pageLayout.

◆ GetPageNumberOption()

bool PL_EDITOR_FRAME::GetPageNumberOption ( ) const
inline

Page layout editor can show the title block using a page number 1 or another number.

This is because some items can be shown (or not) only on page 1 (a feature which looks like word processing option "page 1 differs from other pages").

Returns
true if the page 1 is selected, and false if not

Definition at line 198 of file pl_editor_frame.h.

199  {
200  return m_pageSelectBox->GetSelection() == 0;
201  }
wxChoice * m_pageSelectBox

References m_pageSelectBox.

Referenced by PrintPage().

◆ GetPageSettings()

const PAGE_INFO & PL_EDITOR_FRAME::GetPageSettings ( ) const
overridevirtual

◆ GetPageSizeIU()

const wxSize PL_EDITOR_FRAME::GetPageSizeIU ( ) const
overridevirtual

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

Implements EDA_DRAW_FRAME.

Definition at line 479 of file pl_editor_frame.cpp.

480 {
481  // this function is only needed because EDA_DRAW_FRAME is not compiled
482  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
483  // into an application specific source file.
484  return m_pageLayout.GetPageSettings().GetSizeIU();
485 }
PAGE_INFO & GetPageSettings()
PL_EDITOR_LAYOUT m_pageLayout

References PL_EDITOR_LAYOUT::GetPageSettings(), and m_pageLayout.

Referenced by DIALOG_INSPECTOR::ReCreateDesignList().

◆ GetPropertiesFrame()

PROPERTIES_FRAME* PL_EDITOR_FRAME::GetPropertiesFrame ( )
inline

Definition at line 71 of file pl_editor_frame.h.

71 { return m_propertiesPagelayout; }
PROPERTIES_FRAME * m_propertiesPagelayout

References m_propertiesPagelayout.

Referenced by DIALOG_INSPECTOR::onCellClicked(), and PL_EDITOR_CONTROL::UpdateMessagePanel().

◆ GetScreen()

PL_EDITOR_SCREEN* PL_EDITOR_FRAME::GetScreen ( ) const
inlineoverridevirtual

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 132 of file pl_editor_frame.h.

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

References EDA_DRAW_FRAME::GetScreen().

Referenced by DisplayGridMsg(), Files_io(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), LoadPageLayoutDescrFile(), OnCloseWindow(), OnFileHistory(), OnModify(), OnNewPageLayout(), PLEDITOR_PRINTOUT::PrintPage(), PrintPage(), ReCreateMenuBar(), RollbackFromUndo(), SaveCopyInUndoList(), saveCurrentPageLayout(), SavePageLayoutDescrFile(), SetPageSettings(), SyncToolbars(), and UpdateStatusBar().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 801 of file eda_draw_frame.cpp.

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

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

◆ GetShowPolarCoords()

◆ GetTitleBlock()

const TITLE_BLOCK & PL_EDITOR_FRAME::GetTitleBlock ( ) const
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 488 of file pl_editor_frame.cpp.

489 {
490  return GetPageLayout().GetTitleBlock();
491 }
TITLE_BLOCK & GetTitleBlock()
const PL_EDITOR_LAYOUT & GetPageLayout() const

References GetPageLayout(), and PL_EDITOR_LAYOUT::GetTitleBlock().

◆ 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(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), KICAD_MANAGER_FRAME::InstallPreferences(), 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(), 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(), SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

EDA_UNITS_T EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 210 of file eda_base_frame.h.

210 { return m_userUnits; }
EDA_UNITS_T m_userUnits

References EDA_BASE_FRAME::m_userUnits.

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

◆ GetZoom()

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

Definition at line 343 of file eda_draw_frame.cpp.

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

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

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

◆ GetZoomLevelCoeff()

double EDA_DRAW_FRAME::GetZoomLevelCoeff ( ) const
inlineinherited

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

Definition at line 289 of file eda_draw_frame.h.

289 { return m_zoomLevelCoeff; }
double m_zoomLevelCoeff

References EDA_DRAW_FRAME::m_zoomLevelCoeff.

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

◆ GetZoomLevelIndicator()

const wxString PL_EDITOR_FRAME::GetZoomLevelIndicator ( ) const
overridevirtual

Function GetZoomLevelIndicator returns a human readable value which can be displayed in dialogs.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 761 of file pl_editor_frame.cpp.

762 {
764 }
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 PL_EDITOR_FRAME::HardRedraw ( )
overridevirtual

Refresh the library tree and redraw the window.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 667 of file pl_editor_frame.cpp.

668 {
670 
672  PL_SELECTION& selection = selTool->GetSelection();
673  WS_DATA_ITEM* item = nullptr;
674 
675  if( selection.GetSize() == 1 )
676  item = static_cast<WS_DRAW_ITEM_BASE*>( selection.Front() )->GetPeer();
677 
680  GetCanvas()->Refresh();
681 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Work sheet structure type definitions.
Definition: ws_data_item.h:93
void DisplayWorksheet()
Build and update the list of WS_DRAW_ITEM_xxx showing the frame layout.
PL_SELECTION & GetSelection()
Function GetSelection()
void CopyPrmsFromItemToPanel(WS_DATA_ITEM *aItem)
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...
PROPERTIES_FRAME * m_propertiesPagelayout
void CopyPrmsFromGeneralToPanel()
TOOL_MANAGER * m_toolManager

References PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), GetCanvas(), PL_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), m_propertiesPagelayout, EDA_BASE_FRAME::m_toolManager, and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by Files_io(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), OnSelectTitleBlockDisplayMode(), PL_EDITOR_CONTROL::PageSetup(), and RollbackFromUndo().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 551 of file eda_base_frame.cpp.

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

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

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

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

◆ InitExitKey()

void EDA_DRAW_FRAME::InitExitKey ( )
protectedinherited

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

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

Definition at line 316 of file eda_draw_frame.cpp.

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

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME().

◆ InsertPageLayoutDescrFile()

bool PL_EDITOR_FRAME::InsertPageLayoutDescrFile ( const wxString &  aFullFileName)

Function InsertPageLayoutDescrFile Loads a .kicad_wks page layout descr file, and add items to the current layout list.

Parameters
aFullFileName= the filename.

Definition at line 232 of file pagelayout_editor/files.cpp.

233 {
234  if( wxFileExists( aFullFileName ) )
235  {
236  const bool append = true;
238  WS_DATA_MODEL::GetTheInstance().SetPageLayout( aFullFileName, append );
239  return true;
240  }
241 
242  return false;
243 }
void SaveCopyInUndoList(bool aSavePageSettingsAndTitleBlock=false)
Save a copy of the description (in a S expr string) for Undo/redo commands.
void SetPageLayout(const wxString &aFullFileName=wxEmptyString, bool Append=false)
Populates the list with a custom layout, or the default layout, if no custom layout available.
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application

References WS_DATA_MODEL::GetTheInstance(), SaveCopyInUndoList(), and WS_DATA_MODEL::SetPageLayout().

Referenced by Files_io().

◆ InstallPreferences()

void PL_EDITOR_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
overridevirtual

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

Definition at line 377 of file pl_editor_frame.cpp.

379 {
380  wxTreebook* book = aParent->GetTreebook();
381 
382  book->AddPage( new PANEL_DISPLAY_OPTIONS( this, aParent ), _( "Display Options" ) );
383 
384  aHotkeysPanel->AddHotKeys( GetToolManager() );
385 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
#define _(s)

References _, PANEL_HOTKEYS_EDITOR::AddHotKeys(), EDA_BASE_FRAME::GetToolManager(), and PAGED_DIALOG::GetTreebook().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 181 of file eda_base_frame.h.

181 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsCurrentTool()

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

Definition at line 229 of file eda_base_frame.cpp.

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

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

Referenced by PCB_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), DISPLAY_FOOTPRINTS_FRAME::SyncToolbars(), and LIB_EDIT_FRAME::SyncToolbars().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited

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

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

Definition at line 154 of file kiway_player.cpp.

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

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridVisible()

◆ IsModal()

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 284 of file eda_base_frame.h.

284 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

Referenced by LIB_CONTROL::AddLibrary(), PCBNEW_CONTROL::AddLibrary(), LIB_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), LIB_CONTROL::CutCopyDelete(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), LIB_CONTROL::DuplicateSymbol(), LIB_CONTROL::EditSymbol(), LIB_CONTROL::ExportSymbol(), LIB_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), PICKER_TOOL::Main(), LIB_CONTROL::OnDeMorgan(), PCB_LAYER_WIDGET::OnRenderEnable(), PCBNEW_CONTROL::Paste(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), LIB_CONTROL::Revert(), EE_INSPECTION_TOOL::RunERC(), LIB_CONTROL::Save(), PCBNEW_CONTROL::Show3DViewer(), LIB_CONTROL::ShowComponentTree(), EE_INSPECTION_TOOL::ShowDatasheet(), and COMMON_TOOLS::ZoomFitScreen().

◆ IsWritable()

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

Checks if aFileName can be written.

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

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

Definition at line 644 of file eda_base_frame.cpp.

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

References _, and GetChars().

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), LIB_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), CVPCB_MAINFRAME::SaveProjectFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), 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(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), 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 807 of file eda_draw_frame.cpp.

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

References _, and KIWAY_HOLDER::Prj().

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

◆ LoadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::LoadCanvasTypeSetting ( )
inherited

Returns the canvas type stored in the application settings.

Definition at line 613 of file eda_draw_frame.cpp.

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

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

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

◆ LoadPageLayoutDescrFile()

bool PL_EDITOR_FRAME::LoadPageLayoutDescrFile ( const wxString &  aFullFileName)

Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.

Parameters
aFullFileName= the filename.

Definition at line 217 of file pagelayout_editor/files.cpp.

218 {
219  if( wxFileExists( aFullFileName ) )
220  {
221  WS_DATA_MODEL::GetTheInstance().SetPageLayout( aFullFileName );
222  SetCurrFileName( aFullFileName );
223  UpdateFileHistory( aFullFileName );
224  GetScreen()->ClrModify();
225  return true;
226  }
227 
228  return false;
229 }
void SetPageLayout(const wxString &aFullFileName=wxEmptyString, bool Append=false)
Populates the list with a custom layout, or the default layout, if no custom layout available.
void UpdateFileHistory(const wxString &FullFileName, wxFileHistory *aFileHistory=NULL)
Update the list of recently opened files.
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SetCurrFileName(const wxString &aName)
Stores the current layout descr file filename.
void ClrModify()
Definition: base_screen.h:225

References BASE_SCREEN::ClrModify(), GetScreen(), WS_DATA_MODEL::GetTheInstance(), SetCurrFileName(), WS_DATA_MODEL::SetPageLayout(), and EDA_BASE_FRAME::UpdateFileHistory().

Referenced by Files_io(), OnFileHistory(), and OpenProjectFiles().

◆ LoadSettings()

void PL_EDITOR_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 397 of file pl_editor_frame.cpp.

398 {
400 
401  aCfg->Read( propertiesFrameWidthKey, &m_propertiesFrameWidth, 150 );
403 
404  bool flag;
405  aCfg->Read( blackBgColorKey, &flag, false );
406  SetDrawBgColor( flag ? BLACK : WHITE );
407 
408  int i;
409  aCfg->Read( lastUsedCustomWidthKey, &i, 17000 );
411  aCfg->Read( lastUsedCustomHeightKey, &i, 11000 );
413 
414  PAGE_INFO pageInfo = GetPageSettings();
415  wxString msg;
416  aCfg->Read( lastUsedPaperSizeKey, &msg, "A3" );
417  aCfg->Read( lastUsedPortraitKey, &flag, false );
418  pageInfo.SetType( msg, flag );
419  SetPageSettings( pageInfo );
420 }
const PAGE_INFO & GetPageSettings() const override
static const wxChar cornerOriginChoiceKey[]
static void SetCustomWidthMils(int aWidthInMils)
Function SetCustomWidthMils sets the width of Custom page in mils, for any custom page constructed or...
Definition: page_info.cpp:227
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Function SetType sets the name of the page type and also the sizes and margins commonly associated wi...
Definition: page_info.cpp:117
virtual void SetDrawBgColor(COLOR4D aColor)
void SetPageSettings(const PAGE_INFO &) override
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
static const wxChar lastUsedCustomWidthKey[]
static const wxChar lastUsedCustomHeightKey[]
static const wxChar blackBgColorKey[]
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
static const wxChar lastUsedPortraitKey[]
size_t i
Definition: json11.cpp:597
static const wxChar propertiesFrameWidthKey[]
Definition: colors.h:49
static const wxChar lastUsedPaperSizeKey[]
Definition: colors.h:45
static void SetCustomHeightMils(int aHeightInMils)
Function SetCustomHeightMils sets the height of Custom page in mils, for any custom page constructed ...
Definition: page_info.cpp:233

References BLACK, blackBgColorKey, cornerOriginChoiceKey, GetPageSettings(), i, lastUsedCustomHeightKey, lastUsedCustomWidthKey, lastUsedPaperSizeKey, lastUsedPortraitKey, EDA_DRAW_FRAME::LoadSettings(), m_originSelectChoice, m_propertiesFrameWidth, propertiesFrameWidthKey, PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), EDA_DRAW_FRAME::SetDrawBgColor(), SetPageSettings(), PAGE_INFO::SetType(), and WHITE.

◆ LockFile()

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

Mark a schematic file as being in use.

Use ReleaseFile() to undo this.

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

Definition at line 200 of file eda_draw_frame.cpp.

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

References EDA_DRAW_FRAME::m_file_checker.

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

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 296 of file eda_base_frame.cpp.

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

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

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  event)
virtualinherited

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

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

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 309 of file eda_base_frame.cpp.

310 {
311  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( event ) );
312  // Key events can be filtered here.
313  // Currently no filtering is made.
314  event.Skip();
315 }
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 PL_EDITOR_FRAME::OnCloseWindow ( wxCloseEvent &  aEvent)

Definition at line 256 of file pl_editor_frame.cpp.

257 {
258  if( GetScreen()->IsModify() )
259  {
260  wxFileName filename = GetCurrFileName();
261  wxString msg = _( "Save changes to \"%s\" before closing?" );
262 
263  if( !HandleUnsavedChanges( this, wxString::Format( msg, filename.GetFullName() ),
264  [&]()->bool { return saveCurrentPageLayout(); } ) )
265  {
266  aEvent.Veto();
267  return;
268  }
269  }
270 
271  // do not show the window because we do not want any paint event
272  Show( false );
273 
274  wxConfigSaveSetups( Kiface().KifaceSettings(), m_configSettings );
275 
276  // On Linux, m_propertiesPagelayout must be destroyed
277  // before deleting the main frame to avoid a crash when closing
278  m_propertiesPagelayout->Destroy();
279  Destroy();
280 }
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
PARAM_CFG_ARRAY m_configSettings
const wxString & GetCurrFileName() const
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
#define _(s)
void wxConfigSaveSetups(wxConfigBase *aCfg, const PARAM_CFG_ARRAY &aList)
Function wxConfigSaveSetups writes aList of PARAM_CFG_ARRAY elements to save configuration values to ...
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
PROPERTIES_FRAME * m_propertiesPagelayout
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

References _, KIWAY_PLAYER::Destroy(), Format(), GetCurrFileName(), GetScreen(), HandleUnsavedChanges(), Kiface(), m_configSettings, m_propertiesPagelayout, saveCurrentPageLayout(), and wxConfigSaveSetups().

◆ OnExit()

void PL_EDITOR_FRAME::OnExit ( wxCommandEvent &  aEvent)

Definition at line 246 of file pl_editor_frame.cpp.

247 {
248  if( aEvent.GetId() == wxID_EXIT )
249  Kiway().OnKiCadExit();
250 
251  if( aEvent.GetId() == wxID_CLOSE || Kiface().IsSingle() )
252  Close( false );
253 }
void OnKiCadExit()
Definition: kiway.cpp:502
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
bool IsSingle() const
Function IsSingle is this KIFACE_I running under single_top?
Definition: kiface_i.h:115

References KIFACE_I::IsSingle(), Kiface(), KIWAY_HOLDER::Kiway(), and KIWAY::OnKiCadExit().

◆ OnFileHistory()

void PL_EDITOR_FRAME::OnFileHistory ( wxCommandEvent &  event)

Definition at line 50 of file pagelayout_editor/files.cpp.

51 {
52  wxString filename;
53 
54  filename = GetFileFromHistory( event.GetId(), _( "Page Layout Description File" ) );
55 
56  if( filename != wxEmptyString )
57  {
58  if( GetScreen()->IsModify() )
59  {
60  if( !HandleUnsavedChanges( this, _( "The current page layout has been modified. "
61  "Save changes?" ),
62  [&]()->bool { return saveCurrentPageLayout(); } ) )
63  {
64  return;
65  }
66  }
67 
68  ::wxSetWorkingDirectory( ::wxPathOnly( filename ) );
69 
70  if( LoadPageLayoutDescrFile( filename ) )
71  {
72  wxString msg;
73  msg.Printf( _( "File \"%s\" loaded"), GetChars( filename ) );
74  SetStatusText( msg );
75  }
76 
78  }
79 }
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool IsModify() const
Definition: base_screen.h:228
#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
wxString GetFileFromHistory(int cmdId, const wxString &type, wxFileHistory *aFileHistory=NULL)
Fetches the file name from the file history list.
bool LoadPageLayoutDescrFile(const wxString &aFullFileName)
Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.

References _, GetChars(), EDA_BASE_FRAME::GetFileFromHistory(), GetScreen(), HandleUnsavedChanges(), BASE_SCREEN::IsModify(), LoadPageLayoutDescrFile(), OnNewPageLayout(), and saveCurrentPageLayout().

◆ OnGridSettings()

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

Reimplemented in PCB_BASE_EDIT_FRAME, and SCH_BASE_FRAME.

Definition at line 321 of file eda_draw_frame.h.

321 { };

Referenced by EDA_DRAW_FRAME::OnSelectGrid().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 608 of file eda_base_frame.cpp.

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

References ShowAboutDialog().

◆ OnMenuOpen()

void EDA_BASE_FRAME::OnMenuOpen ( wxMenuEvent &  event)
inherited

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

Definition at line 318 of file eda_base_frame.cpp.

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

References ACTION_MENU::OnMenuEvent().

◆ OnModify()

void PL_EDITOR_FRAME::OnModify ( )
inline

Must be called after a change in order to set the "modify" flag.

Definition at line 290 of file pl_editor_frame.h.

291  {
292  GetScreen()->SetModify();
293  }
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SetModify()
Definition: base_screen.h:224

References GetScreen(), and BASE_SCREEN::SetModify().

Referenced by PL_EDIT_TOOL::DoDelete(), PL_DRAWING_TOOLS::DrawShape(), GetLayoutFromRedoList(), GetLayoutFromUndoList(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PROPERTIES_FRAME::OnAcceptPrms(), and PL_DRAWING_TOOLS::PlaceItem().

◆ OnNewPageLayout()

void PL_EDITOR_FRAME::OnNewPageLayout ( )

Must be called to initialize parameters when a new page layout description is loaded.

Definition at line 746 of file pl_editor_frame.cpp.

747 {
749  GetScreen()->ClrModify();
751 
754 
756 
758 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
void DisplayWorksheet()
Build and update the list of WS_DRAW_ITEM_xxx showing the frame layout.
void CopyPrmsFromItemToPanel(WS_DATA_ITEM *aItem)
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void UpdateTitleAndInfo()
Displays the short filename (if exists) loaded file on the caption of the main window.
PROPERTIES_FRAME * m_propertiesPagelayout
void ClrModify()
Definition: base_screen.h:225
void CopyPrmsFromGeneralToPanel()
TOOL_MANAGER * m_toolManager

References BASE_SCREEN::ClearUndoRedoList(), BASE_SCREEN::ClrModify(), PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), GetCanvas(), GetScreen(), m_propertiesPagelayout, EDA_BASE_FRAME::m_toolManager, TOOL_MANAGER::RunAction(), UpdateTitleAndInfo(), and ACTIONS::zoomFitScreen.

Referenced by Files_io(), OnFileHistory(), and OpenProjectFiles().

◆ OnPageSettingsChange()

virtual void EDA_DRAW_FRAME::OnPageSettingsChange ( )
inlinevirtualinherited

Called when modifying the page settings.

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

Reimplemented in SCH_EDIT_FRAME.

Definition at line 395 of file eda_draw_frame.h.

395 {}

Referenced by DIALOG_PAGES_SETTINGS::OnOkClick().

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 615 of file eda_base_frame.cpp.

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

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

◆ OnSelectCoordOriginCorner()

void PL_EDITOR_FRAME::OnSelectCoordOriginCorner ( wxCommandEvent &  event)

called when the user select one of the 4 page corner as corner reference (or the left top paper corner)

Definition at line 297 of file pl_editor_frame.cpp.

298 {
299  m_originSelectChoice = m_originSelectBox->GetSelection();
300  UpdateStatusBar(); // Update grid origin
302  GetCanvas()->Refresh();
303 }
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateStatusBar() override
Update the status bar information.
void DisplayWorksheet()
Build and update the list of WS_DRAW_ITEM_xxx showing the frame layout.
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...
wxChoice * m_originSelectBox

References PL_DRAW_PANEL_GAL::DisplayWorksheet(), GetCanvas(), m_originSelectBox, m_originSelectChoice, EDA_DRAW_PANEL_GAL::Refresh(), and UpdateStatusBar().

◆ OnSelectGrid()

void EDA_DRAW_FRAME::OnSelectGrid ( wxCommandEvent &  event)
virtualinherited

Command event handler for selecting grid sizes.

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

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

Definition at line 283 of file eda_draw_frame.cpp.

284 {
285  wxCHECK_RET( m_gridSelectBox, "m_gridSelectBox uninitialized" );
286 
287  int id = m_gridSelectBox->GetCurrentSelection() + ID_POPUP_GRID_FIRST;
288 
289  if( id == ID_POPUP_GRID_SEPARATOR )
290  {
291  // wxWidgets will check the separator, which we don't want.
292  // Re-check the current grid.
293  wxUpdateUIEvent dummy;
295  }
296  else if( id == ID_POPUP_GRID_SETTINGS )
297  {
298  // wxWidgets will check the Grid Settings... entry, which we don't want.
299  // R-check the current grid.
300  wxUpdateUIEvent dummy;
302  // Now run the Grid Settings... dialog
303  wxCommandEvent dummy2;
304  OnGridSettings( dummy2 );
305  }
306  else if( id >= ID_POPUP_GRID_FIRST && id < ID_POPUP_GRID_SEPARATOR )
307  {
309  }
310 
311  UpdateStatusBar();
312  m_canvas->Refresh();
313 }
virtual void OnGridSettings(wxCommandEvent &event)
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
wxChoice * m_gridSelectBox
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
static TOOL_ACTION gridPreset
Definition: actions.h:131
void OnUpdateSelectGrid(wxUpdateUIEvent &aEvent)
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
TOOL_MANAGER * m_toolManager
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnSelectPage()

void PL_EDITOR_FRAME::OnSelectPage ( wxCommandEvent &  event)

Definition at line 285 of file pl_editor_frame.cpp.

286 {
287  KIGFX::VIEW* view = GetCanvas()->GetView();
288  view->SetLayerVisible( LAYER_WORKSHEET_PAGE1, m_pageSelectBox->GetSelection() == 0 );
289  view->SetLayerVisible( LAYER_WORKSHEET_PAGEn, m_pageSelectBox->GetSelection() == 1 );
290  GetCanvas()->Refresh();
291 }
for pageLayout editor previewing
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void SetLayerVisible(int aLayer, bool aVisible=true)
Function SetLayerVisible() Controls the visibility of a particular layer.
Definition: view.h:399
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...
wxChoice * m_pageSelectBox
Class VIEW.
Definition: view.h:61
for pageLayout editor previewing

References GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), LAYER_WORKSHEET_PAGE1, LAYER_WORKSHEET_PAGEn, m_pageSelectBox, EDA_DRAW_PANEL_GAL::Refresh(), and KIGFX::VIEW::SetLayerVisible().

◆ OnSelectTitleBlockDisplayMode()

void PL_EDITOR_FRAME::OnSelectTitleBlockDisplayMode ( wxCommandEvent &  event)

Toggle the display mode between the normal mode and the editor mode: In normal mode, title block texts are shown like they will be shown in other kicad applications: the format symbols in texts are replaced by the actual text.

In editor mode, the format symbols in texts are not replaced by the actual text, and therefore format symbols are displayed.

Definition at line 306 of file pl_editor_frame.cpp.

307 {
309  HardRedraw();
310 }
void HardRedraw() override
Refresh the library tree and redraw the window.
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application

References WS_DATA_MODEL::GetTheInstance(), HardRedraw(), ID_SHOW_PL_EDITOR_MODE, and WS_DATA_MODEL::m_EditMode.

◆ OnSelectZoom()

void EDA_DRAW_FRAME::OnSelectZoom ( wxCommandEvent &  event)
virtualinherited

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

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

Definition at line 328 of file eda_draw_frame.cpp.

329 {
330  wxCHECK_RET( m_zoomSelectBox, "m_zoomSelectBox uninitialized" );
331 
332  int id = m_zoomSelectBox->GetCurrentSelection();
333 
334  if( id < 0 || !( id < (int)m_zoomSelectBox->GetCount() ) )
335  return;
336 
337  m_toolManager->RunAction( "common.Control.zoomPreset", true, id );
338  UpdateStatusBar();
339  m_canvas->Refresh();
340 }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
EDA_DRAW_PANEL_GAL * m_canvas
GAL display options - this is the frame's interface to setting GAL display options.
wxChoice * m_zoomSelectBox
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
TOOL_MANAGER * m_toolManager
void UpdateStatusBar() override
Update the status bar information.

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

◆ OnSize()

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

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

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.

◆ OnUpdateSelectGrid()

void EDA_DRAW_FRAME::OnUpdateSelectGrid ( wxUpdateUIEvent &  aEvent)
inherited

Definition at line 251 of file eda_draw_frame.cpp.

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

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

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

◆ OnUpdateTitleBlockDisplayEditMode()

void PL_EDITOR_FRAME::OnUpdateTitleBlockDisplayEditMode ( wxUpdateUIEvent &  event)

Definition at line 364 of file pl_editor_frame.cpp.

365 {
366  event.Check( WS_DATA_MODEL::GetTheInstance().m_EditMode == true );
367 }
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application

References WS_DATA_MODEL::GetTheInstance().

◆ OnUpdateTitleBlockDisplayNormalMode()

void PL_EDITOR_FRAME::OnUpdateTitleBlockDisplayNormalMode ( wxUpdateUIEvent &  event)

Definition at line 358 of file pl_editor_frame.cpp.

359 {
360  event.Check( WS_DATA_MODEL::GetTheInstance().m_EditMode == false );
361 }
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application

References WS_DATA_MODEL::GetTheInstance().

◆ OpenProjectFiles()

bool PL_EDITOR_FRAME::OpenProjectFiles ( const std::vector< wxString > &  aFileList,
int  aCtl 
)
overridevirtual

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

Definition at line 229 of file pl_editor_frame.cpp.

230 {
231  wxString fn = aFileSet[0];
232 
233  if( !LoadPageLayoutDescrFile( fn ) )
234  {
235  wxMessageBox( wxString::Format( _( "Error when loading file \"%s\"" ), fn ) );
236  return false;
237  }
238  else
239  {
240  OnNewPageLayout();
241  return true;
242  }
243 }
void OnNewPageLayout()
Must be called to initialize parameters when a new page layout description is loaded.
#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
bool LoadPageLayoutDescrFile(const wxString &aFullFileName)
Function LoadPageLayoutDescrFile Loads a .kicad_wks page layout descr file.

References _, Format(), LoadPageLayoutDescrFile(), and OnNewPageLayout().

◆ PopTool()

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

Definition at line 182 of file eda_base_frame.cpp.

183 {
184  // Push/pop events can get out of order (such as when they're generated by the Simulator
185  // frame but not processed until the mouse is back in the Schematic frame), so make sure
186  // we're popping the right stack frame.
187 
188  for( int i = m_toolStack.size() - 1; i >= 0; --i )
189  {
190  if( m_toolStack[ i ] == actionName )
191  {
192  m_toolStack.erase( m_toolStack.begin() + i );
193 
194  // If there's something underneath us, and it's now the top of the stack, then
195  // re-activate it
196  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
197  {
198  std::string back = m_toolStack[ i ];
200 
201  if( action )
202  {
203  // Pop the action as running it will push it back onto the stack
204  m_toolStack.pop_back();
205 
206  TOOL_EVENT evt = action->MakeEvent();
207  evt.SetHasPosition( false );
208  GetToolManager()->PostEvent( evt );
209  }
210  }
211  else
213 
214  return;
215  }
216  }
217 }
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:143
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 557 of file eda_base_frame.cpp.

558 {
559  SetStatusText( text );
560 }

◆ PrintPage()

void PL_EDITOR_FRAME::PrintPage ( wxDC *  aDC)
overridevirtual

Virtual function PrintPage used to print a page.

Parameters
aDC= wxDC given by the calling print function

Reimplemented from EDA_DRAW_FRAME.

Definition at line 654 of file pl_editor_frame.cpp.

655 {
657  PrintWorkSheet( aDC, GetScreen(), 0, IU_PER_MILS, wxEmptyString );
658 }
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.
int m_ScreenNumber
Definition: base_screen.h:135
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool GetPageNumberOption() const
Page layout editor can show the title block using a page number 1 or another number.
#define IU_PER_MILS
Definition: plotter.cpp:135

References GetPageNumberOption(), GetScreen(), IU_PER_MILS, BASE_SCREEN::m_ScreenNumber, and EDA_DRAW_FRAME::PrintWorkSheet().

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

775 {
777  return;
778 
779  COLOR4D color = ( aColor != COLOR4D::UNSPECIFIED ) ? aColor : COLOR4D( RED );
780 
781  wxPoint origin = aDC->GetDeviceOrigin();
782 
783  if( origin.y > 0 )
784  {
785  aDC->SetDeviceOrigin( 0, 0 );
786  aDC->SetAxisOrientation( true, false );
787  }
788 
790  aScreen->m_NumberOfScreens, aScreen->m_ScreenNumber, aLineWidth, aScalar,
791  color, aSheetLayer );
792 
793  if( origin.y > 0 )
794  {
795  aDC->SetDeviceOrigin( origin.x, origin.y );
796  aDC->SetAxisOrientation( true, true );
797  }
798 }
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(), 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(), 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(), DISPLAY_FOOTPRINTS_FRAME::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(), DIALOG_SCH_SHEET_PROPS::OnBrowseClicked(), 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 238 of file eda_base_frame.cpp.

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

166 {
167  m_toolStack.push_back( actionName );
168 
169  // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
170  if( m_toolStack.size() > 3 )
171  m_toolStack.erase( m_toolStack.begin() );
172 
173  TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
174 
175  if( action )
176  DisplayToolMsg( action->GetLabel() );
177  else
178  DisplayToolMsg( actionName );
179 }
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 297 of file eda_draw_frame.h.

297 { }

Referenced by PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

◆ ReCreateHToolbar()

void PL_EDITOR_FRAME::ReCreateHToolbar ( void  )
overridevirtual

Implements EDA_DRAW_FRAME.

Definition at line 31 of file toolbars_pl_editor.cpp.

32 {
33  if( m_mainToolBar )
34  m_mainToolBar->Clear();
35  else
36  m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
37  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT );
38 
39  wxString msg;
40 
44 
47 
51 
58 
62 
63  // Display mode switch
65  m_mainToolBar->AddTool( ID_SHOW_REAL_MODE, wxEmptyString,
66  KiScaledBitmap( pagelayout_normal_view_mode_xpm, this ),
67  _( "Show title block in preview mode:\n"
68  "text placeholders will be replaced with preview data"),
69  wxITEM_CHECK );
70  m_mainToolBar->AddTool( ID_SHOW_PL_EDITOR_MODE, wxEmptyString,
71  KiScaledBitmap( pagelayout_special_view_mode_xpm, this ),
72  _( "Show title block in edit mode:\n"
73  "text placeholders show as %-tokens"),
74  wxITEM_CHECK );
75 
77 
78  wxString choiceList[5] =
79  {
80  _("Left Top paper corner"),
81  _("Right Bottom page corner"),
82  _("Left Bottom page corner"),
83  _("Right Top page corner"),
84  _("Left Top page corner")
85  };
86 
88  wxDefaultPosition, wxDefaultSize, 5, choiceList );
89  m_mainToolBar->AddControl( m_originSelectBox );
90  m_originSelectBox->SetToolTip( _("Origin of coordinates displayed to the status bar") );
91 
92  int minwidth = 0;
93  for( int ii = 0; ii < 5; ii++ )
94  {
95  int width = GetTextSize( choiceList[ii], m_originSelectBox ).x;
96  minwidth = std::max( minwidth, width );
97  }
98  m_originSelectBox->SetMinSize( wxSize( minwidth, -1 ) );
99  m_originSelectBox->SetSelection( m_originSelectChoice );
100 
101  wxString pageList[5] =
102  {
103  _("Page 1"),
104  _("Other pages")
105  };
106 
108  wxDefaultPosition, wxDefaultSize, 2, pageList );
109  m_mainToolBar->AddControl( m_pageSelectBox );
110  m_pageSelectBox->SetToolTip( _("Simulate page 1 or other pages to show how items\n"\
111  "which are not on all page are displayed") );
112  m_pageSelectBox->SetSelection( 0 );
113 
114 
115  // after adding the buttons to the toolbar, must call Realize() to reflect the changes
116  m_mainToolBar->Realize();
117 }
Class ACTION_TOOLBAR.
static TOOL_ACTION showInspector
Definition: pl_actions.h:76
static TOOL_ACTION zoomInCenter
Definition: actions.h:90
static const bool TOGGLE
static TOOL_ACTION zoomTool
Definition: actions.h:95
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:93
ACTION_TOOLBAR * m_mainToolBar
static TOOL_ACTION print
Definition: actions.h:60
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
static TOOL_ACTION zoomOutCenter
Definition: actions.h:91
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: common.cpp:115
static TOOL_ACTION open
Definition: actions.h:53
static TOOL_ACTION save
Definition: actions.h:54
static TOOL_ACTION doNew
Definition: actions.h:47
static TOOL_ACTION previewSettings
Definition: pl_actions.h:77
#define _(s)
wxChoice * m_pageSelectBox
static TOOL_ACTION redo
Definition: actions.h:68
#define max(a, b)
Definition: auxiliary.h:86
static TOOL_ACTION zoomRedraw
Definition: actions.h:87
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
static TOOL_ACTION undo
Definition: actions.h:67
wxChoice * m_originSelectBox

References _, ACTION_TOOLBAR::Add(), ACTIONS::doNew, GetTextSize(), ID_H_TOOLBAR, ID_SELECT_COORDINATE_ORIGIN, ID_SELECT_PAGE_NUMBER, ID_SHOW_PL_EDITOR_MODE, ID_SHOW_REAL_MODE, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, KiScaledBitmap(), KiScaledSeparator(), EDA_DRAW_FRAME::m_mainToolBar, m_originSelectBox, m_originSelectChoice, m_pageSelectBox, max, ACTIONS::open, PL_ACTIONS::previewSettings, ACTIONS::print, ACTIONS::redo, ACTIONS::save, PL_ACTIONS::showInspector, ACTION_TOOLBAR::TOGGLE, ACTIONS::undo, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ ReCreateMenuBar()

void PL_EDITOR_FRAME::ReCreateMenuBar ( )
overridevirtual

Recreates the menu bar.

Needed when the language is changed

Reimplemented from EDA_BASE_FRAME.

Definition at line 38 of file pagelayout_editor/menubar.cpp.

39 {
41  // wxWidgets handles the Mac Application menu behind the scenes, but that means
42  // we always have to start from scratch with a new wxMenuBar.
43  wxMenuBar* oldMenuBar = GetMenuBar();
44  wxMenuBar* menuBar = new wxMenuBar();
45 
46  auto modifiedDocumentCondition = [ this ] ( const SELECTION& sel ) {
47  return GetScreen() && GetScreen()->IsModify();
48  };
49 
50  static ACTION_MENU* openRecentMenu; // Open Recent submenu, static to remember this menu
51 
52  // Before deleting, remove the menus managed by m_fileHistory
53  // (the file history will be updated when adding/removing files in history
54  if( openRecentMenu )
55  Kiface().GetFileHistory().RemoveMenu( openRecentMenu );
56 
57  //-- File menu -------------------------------------------------------
58  //
59  CONDITIONAL_MENU* fileMenu = new CONDITIONAL_MENU( false, selTool );
60 
61  openRecentMenu = new ACTION_MENU( false );
62  openRecentMenu->SetTool( selTool );
63  openRecentMenu->SetTitle( _( "Open Recent" ) );
64  openRecentMenu->SetIcon( recent_xpm );
65 
66  Kiface().GetFileHistory().UseMenu( openRecentMenu );
67  Kiface().GetFileHistory().AddFilesToMenu();
68 
71  fileMenu->AddMenu( openRecentMenu, SELECTION_CONDITIONS::ShowAlways );
72 
73  fileMenu->AddSeparator();
74  fileMenu->AddItem( ACTIONS::save, modifiedDocumentCondition );
76 
77  fileMenu->AddSeparator();
79 
80  fileMenu->AddSeparator();
81  fileMenu->AddQuitOrClose( &Kiface(), _( "Page Layout Editor" ) );
82 
83  fileMenu->Resolve();
84 
85  //-- Edit menu -------------------------------------------------------
86  //
87  CONDITIONAL_MENU* editMenu = new CONDITIONAL_MENU( false, selTool );
88 
89  auto enableUndoCondition = [ this ] ( const SELECTION& sel ) {
90  return GetScreen() && GetScreen()->GetUndoCommandCount() != 0;
91  };
92  auto enableRedoCondition = [ this ] ( const SELECTION& sel ) {
93  return GetScreen() && GetScreen()->GetRedoCommandCount() != 0;
94  };
95  auto idleCondition = [] ( const SELECTION& sel ) {
96  return !sel.Front() || sel.Front()->GetEditFlags() == 0;
97  };
98 
99  editMenu->AddItem( ACTIONS::undo, enableUndoCondition );
100  editMenu->AddItem( ACTIONS::redo, enableRedoCondition );
101 
102  editMenu->AddSeparator();
105  editMenu->AddItem( ACTIONS::paste, idleCondition );
107 
108  editMenu->Resolve();
109 
110  //-- View menu -------------------------------------------------------
111  //
112  CONDITIONAL_MENU* viewMenu = new CONDITIONAL_MENU( false, selTool );
113 
114  auto whiteBackgroundCondition = [ this ] ( const SELECTION& aSel ) {
115  return GetDrawBgColor() == WHITE;
116  };
117  auto gridShownCondition = [ this ] ( const SELECTION& aSel ) {
118  return IsGridVisible();
119  };
120  auto fullCrosshairCondition = [ this ] ( const SELECTION& aSel ) {
122  };
123 
124  viewMenu->AddSeparator();
130 
131  viewMenu->AddSeparator();
132  viewMenu->AddCheckItem( PL_ACTIONS::toggleBackground, whiteBackgroundCondition );
133  viewMenu->AddCheckItem( ACTIONS::toggleGrid, gridShownCondition );
134  viewMenu->AddCheckItem( ACTIONS::toggleCursorStyle, fullCrosshairCondition );
135 
136  viewMenu->AddSeparator();
138  viewMenu->AddSeparator();
139 
140  viewMenu->Resolve();
141 
142  //-- Place menu -------------------------------------------------------
143  //
144  CONDITIONAL_MENU* placeMenu = new CONDITIONAL_MENU( false, selTool );
145 
150 
151  placeMenu->AddSeparator();
153 
154  placeMenu->Resolve();
155 
156  //-- Inspector menu -------------------------------------------------------
157  //
158  CONDITIONAL_MENU* inspectorMenu = new CONDITIONAL_MENU( false, selTool );
160 
161  inspectorMenu->Resolve();
162 
163  //-- Preferences menu --------------------------------------------------
164  //
165  CONDITIONAL_MENU* preferencesMenu = new CONDITIONAL_MENU( false, selTool );
166 
167  preferencesMenu->AddItem( wxID_PREFERENCES,
168  _( "Preferences...\tCTRL+," ),
169  _( "Show preferences for all open tools" ),
170  preference_xpm, SELECTION_CONDITIONS::ShowAlways );
171 
172  // Language submenu
173  AddMenuLanguageList( preferencesMenu, selTool );
174 
175  preferencesMenu->Resolve();
176 
177  //-- Menubar -----------------------------------------------------------
178  //
179  menuBar->Append( fileMenu, _( "&File" ) );
180  menuBar->Append( editMenu, _( "&Edit" ) );
181  menuBar->Append( viewMenu, _( "&View" ) );
182  menuBar->Append( placeMenu, _( "&Place" ) );
183  menuBar->Append( inspectorMenu, _( "&Inspect" ) );
184  menuBar->Append( preferencesMenu, _( "P&references" ) );
185  AddStandardHelpMenu( menuBar );
186 
187  SetMenuBar( menuBar );
188  delete oldMenuBar;
189 }
static bool ShowAlways(const SELECTION &aSelection)
Function ShowAlways The default condition function (always returns true).
void AddMenu(ACTION_MENU *aMenu, const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
Function AddMenu()
static TOOL_ACTION showInspector
Definition: pl_actions.h:76
static TOOL_ACTION zoomInCenter
Definition: actions.h:90
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
Class ACTION_MENU.
Definition: action_menu.h:43
static TOOL_ACTION doDelete
Definition: actions.h:74
static TOOL_ACTION drawLine
Definition: pl_actions.h:67
static SELECTION_CONDITION MoreThan(int aNumber)
Function MoreThan Creates a functor that tests if the number of selected items is greater than the va...
static TOOL_ACTION zoomTool
Definition: actions.h:95
static TOOL_ACTION placeImage
Definition: pl_actions.h:65
virtual bool IsGridVisible() const
void AddMenuLanguageList(CONDITIONAL_MENU *aMasterMenu, TOOL_INTERACTIVE *aControlTool)
Function AddMenuLanguageList creates a menu list for language choice, and add it as submenu to Master...
int GetUndoCommandCount() const
Definition: base_screen.h:201
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
void AddCheckItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddCheckItem()
static TOOL_ACTION placeText
Definition: pl_actions.h:64
static TOOL_ACTION print
Definition: actions.h:60
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
static TOOL_ACTION zoomOutCenter
Definition: actions.h:91
void SetTool(TOOL_INTERACTIVE *aTool)
Function SetTool() Sets a tool that is the creator of the menu.
static TOOL_ACTION copy
Definition: actions.h:70
static TOOL_ACTION toggleGrid
Definition: actions.h:132
static TOOL_ACTION open
Definition: actions.h:53
static TOOL_ACTION save
Definition: actions.h:54
static TOOL_ACTION doNew
Definition: actions.h:47
void SetIcon(const BITMAP_OPAQUE *aIcon)
Function SetIcon() Assigns an icon for the entry.
Definition: action_menu.cpp:68
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION previewSettings
Definition: pl_actions.h:77
static TOOL_ACTION cut
Definition: actions.h:69
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool IsModify() const
Definition: base_screen.h:228
static TOOL_ACTION drawRectangle
Definition: pl_actions.h:66
#define _(s)
void Resolve()
Function Resolve()
void AddSeparator(int aOrder=ANY_ORDER)
Function AddSeparator()
static TOOL_ACTION toggleBackground
Definition: pl_actions.h:75
void AddQuitOrClose(KIFACE_I *aKiface, wxString aAppname="")
Functions AddQuitOrClose()
static TOOL_ACTION redo
Definition: actions.h:68
void SetTitle(const wxString &aTitle) override
Function SetTitle() Sets title for the menu.
Definition: action_menu.cpp:86
static TOOL_ACTION saveAs
Definition: actions.h:55
static TOOL_ACTION zoomRedraw
Definition: actions.h:87
FILE_HISTORY & GetFileHistory()
Definition: kiface_i.h:123
static TOOL_ACTION appendImportedWorksheet
Definition: pl_actions.h:68
Definition: colors.h:49
virtual COLOR4D GetDrawBgColor() const
static TOOL_ACTION undo
Definition: actions.h:67
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:98
TOOL_MANAGER * m_toolManager
int GetRedoCommandCount() const
Definition: base_screen.h:206
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
bool m_fullscreenCursor
Fullscreen crosshair or small cross
static TOOL_ACTION paste
Definition: actions.h:71

References _, CONDITIONAL_MENU::AddCheckItem(), CONDITIONAL_MENU::AddItem(), CONDITIONAL_MENU::AddMenu(), AddMenuLanguageList(), CONDITIONAL_MENU::AddQuitOrClose(), CONDITIONAL_MENU::AddSeparator(), EDA_BASE_FRAME::AddStandardHelpMenu(), PL_ACTIONS::appendImportedWorksheet, ACTIONS::copy, ACTIONS::cut, ACTIONS::doDelete, ACTIONS::doNew, PL_ACTIONS::drawLine, PL_ACTIONS::drawRectangle, EDA_DRAW_FRAME::GetDrawBgColor(), KIFACE_I::GetFileHistory(), EDA_DRAW_FRAME::GetGalDisplayOptions(), BASE_SCREEN::GetRedoCommandCount(), GetScreen(), TOOL_MANAGER::GetTool(), BASE_SCREEN::GetUndoCommandCount(), EDA_DRAW_FRAME::IsGridVisible(), BASE_SCREEN::IsModify(), Kiface(), KIGFX::GAL_DISPLAY_OPTIONS::m_fullscreenCursor, EDA_BASE_FRAME::m_toolManager, SELECTION_CONDITIONS::MoreThan(), ACTIONS::open, ACTIONS::paste, PL_ACTIONS::placeImage, PL_ACTIONS::placeText, PL_ACTIONS::previewSettings, ACTIONS::print, ACTIONS::redo, CONDITIONAL_MENU::Resolve(), ACTIONS::save, ACTIONS::saveAs, ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), ACTION_MENU::SetTool(), SELECTION_CONDITIONS::ShowAlways(), PL_ACTIONS::showInspector, PL_ACTIONS::toggleBackground, ACTIONS::toggleCursorStyle, ACTIONS::toggleGrid, ACTIONS::undo, WHITE, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, ACTIONS::zoomRedraw, and ACTIONS::zoomTool.

◆ ReCreateOptToolbar()

void PL_EDITOR_FRAME::ReCreateOptToolbar ( )
overridevirtual

Create or update the left vertical toolbar (option toolbar.

Note
This is currently not used.

Implements EDA_DRAW_FRAME.

Definition at line 144 of file toolbars_pl_editor.cpp.

145 {
146 }

◆ RecreateToolbars()

void EDA_DRAW_FRAME::RecreateToolbars ( )
inherited

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

Definition at line 842 of file eda_draw_frame.cpp.

843 {
844  // Rebuild all toolbars, and update the checked state of check tools
845  if( m_mainToolBar )
847 
848  if( m_drawToolBar ) // Drawing tools (typically on right edge of window)
850 
851  if( m_optionsToolBar ) // Options (typically on left edge of window)
853 
854  if( m_auxiliaryToolBar ) // Additional tools under main toolbar
856 
857  // Update the checked state of tools
858  SyncToolbars();
859 }
virtual void ReCreateVToolbar()=0
ACTION_TOOLBAR * m_auxiliaryToolBar
ACTION_TOOLBAR * m_optionsToolBar
ACTION_TOOLBAR * m_mainToolBar
virtual void SyncToolbars()
Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state.
virtual void ReCreateOptToolbar()=0
virtual void ReCreateHToolbar()=0
ACTION_TOOLBAR * m_drawToolBar

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

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

◆ ReCreateVToolbar()

void PL_EDITOR_FRAME::ReCreateVToolbar ( )
overridevirtual

creates or updates the right vertical toolbar.

Implements EDA_DRAW_FRAME.

Definition at line 120 of file toolbars_pl_editor.cpp.

121 {
122  if( m_drawToolBar )
123  m_drawToolBar->Clear();
124  else
125  m_drawToolBar = new ACTION_TOOLBAR( this, ID_V_TOOLBAR, wxDefaultPosition, wxDefaultSize,
126  KICAD_AUI_TB_STYLE | wxAUI_TB_VERTICAL );
127 
129 
136 
139 
140  m_drawToolBar->Realize();
141 }
Class ACTION_TOOLBAR.
static TOOL_ACTION drawLine
Definition: pl_actions.h:67
static const bool TOGGLE
static TOOL_ACTION placeImage
Definition: pl_actions.h:65
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false)
Function Add() Adds a TOOL_ACTION-based button to the toolbar.
static TOOL_ACTION placeText
Definition: pl_actions.h:64
static TOOL_ACTION drawRectangle
Definition: pl_actions.h:66
static TOOL_ACTION appendImportedWorksheet
Definition: pl_actions.h:68
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
static TOOL_ACTION deleteTool
Definition: actions.h:75
static TOOL_ACTION selectionTool
Definition: actions.h:143
ACTION_TOOLBAR * m_drawToolBar

References ACTION_TOOLBAR::Add(), PL_ACTIONS::appendImportedWorksheet, ACTIONS::deleteTool, PL_ACTIONS::drawLine, PL_ACTIONS::drawRectangle, ID_V_TOOLBAR, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, KiScaledSeparator(), EDA_DRAW_FRAME::m_drawToolBar, PL_ACTIONS::placeImage, PL_ACTIONS::placeText, ACTIONS::selectionTool, and ACTION_TOOLBAR::TOGGLE.

◆ RefreshCanvas()

void EDA_DRAW_FRAME::RefreshCanvas ( )
inlineoverridevirtualinherited

Notification to refresh the drawing canvas (if any).

Reimplemented from EDA_BASE_FRAME.

Definition at line 501 of file eda_draw_frame.h.

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

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

◆ ReleaseFile()

void EDA_DRAW_FRAME::ReleaseFile ( )
inherited

Release the current file marked in use.

See m_file_checker.

Definition at line 194 of file eda_draw_frame.cpp.

195 {
196  m_file_checker = nullptr;
197 }
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
prevents opening same file multiple times.

References EDA_DRAW_FRAME::m_file_checker.

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

◆ ReturnCoordOriginCorner()

wxPoint PL_EDITOR_FRAME::ReturnCoordOriginCorner ( ) const

calculate the position (in page, in iu) of the corner used as coordinate origin of items

Definition at line 500 of file pl_editor_frame.cpp.

501 {
502  // calculate the position (in page, in iu) of the corner used as coordinate origin
503  // coordinate origin can be the paper Top Left corner, or each of 4 page corners
504  wxPoint originCoord;
505 
506  // To avoid duplicate code, we use a dummy segment starting at 0,0 in relative coord
508 
509  switch( m_originSelectChoice )
510  {
511  default:
512  case 0: // Origin = paper Left Top corner
513  break;
514 
515  case 1: // Origin = page Right Bottom corner
516  dummy.SetStart( 0, 0, RB_CORNER );
517  originCoord = dummy.GetStartPosUi();
518  break;
519 
520  case 2: // Origin = page Left Bottom corner
521  dummy.SetStart( 0, 0, LB_CORNER );
522  originCoord = dummy.GetStartPosUi();
523  break;
524 
525  case 3: // Origin = page Right Top corner
526  dummy.SetStart( 0, 0, RT_CORNER );
527  originCoord = dummy.GetStartPosUi();
528  break;
529 
530  case 4: // Origin = page Left Top corner
531  dummy.SetStart( 0, 0, LT_CORNER );
532  originCoord = dummy.GetStartPosUi();
533  break;
534  }
535 
536  return originCoord;
537 }
Work sheet structure type definitions.
Definition: ws_data_item.h:93
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.

References dummy(), LB_CORNER, LT_CORNER, m_originSelectChoice, RB_CORNER, RT_CORNER, and WS_DATA_ITEM::WS_SEGMENT.

Referenced by UpdateStatusBar().

◆ RollbackFromUndo()

void PL_EDITOR_FRAME::RollbackFromUndo ( )

Apply the last command in Undo List without stacking a Redo.

Used to clean the Undo stack after cancelling a command.

Definition at line 124 of file pl_editor_undo_redo.cpp.

125 {
127 
128  if ( GetScreen()->GetUndoCommandCount() <= 0 )
129  return;
130 
131  ITEM_PICKER undoWrapper = GetScreen()->PopCommandFromUndoList()->PopItem();
132  WS_PROXY_UNDO_ITEM* undoItem = static_cast<WS_PROXY_UNDO_ITEM*>( undoWrapper.GetItem() );
133  bool pageSettingsAndTitleBlock = undoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
134 
135  selTool->ClearSelection();
136  undoItem->Restore( this, GetCanvas()->GetView() );
137  selTool->RebuildSelection();
138 
139  delete undoItem;
140 
141  if( pageSettingsAndTitleBlock )
142  {
144  HardRedraw(); // items based off of corners will need re-calculating
145  }
146  else
147  GetCanvas()->Refresh();
148 }
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
void RebuildSelection()
Rebuild the selection from the flags in the view items.
void HardRedraw() override
Refresh the library tree and redraw the window.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
int GetUndoCommandCount() const
Definition: base_screen.h:201
EDA_ITEM * GetItem() const
int ClearSelection(const TOOL_EVENT &aEvent)
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted.
PL_EDITOR_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
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...
ITEM_PICKER PopItem()
Function PopItem.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References PL_SELECTION_TOOL::ClearSelection(), GetCanvas(), ITEM_PICKER::GetItem(), GetScreen(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetToolManager(), BASE_SCREEN::GetUndoCommandCount(), HardRedraw(), BASE_SCREEN::PopCommandFromUndoList(), PICKED_ITEMS_LIST::PopItem(), PL_SELECTION_TOOL::RebuildSelection(), EDA_DRAW_PANEL_GAL::Refresh(), WS_PROXY_UNDO_ITEM::Restore(), TOOL_MANAGER::RunAction(), EDA_ITEM::Type(), WS_PROXY_UNDO_ITEM_PLUS_T, and ACTIONS::zoomFitScreen.

Referenced by PL_DRAWING_TOOLS::DrawShape(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_EDITOR_CONTROL::PageSetup(), and PL_DRAWING_TOOLS::PlaceItem().

◆ saveCanvasTypeSetting()

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

Stores the canvas type in the application settings.

Definition at line 647 of file eda_draw_frame.cpp.

648 {
649  // Not all classes derived from EDA_DRAW_FRAME can save the canvas type, because some
650  // have a fixed type, or do not have a option to set the canvas type (they inherit from
651  // a parent frame)
652  FRAME_T allowed_frames[] =
653  {
654  FRAME_SCH,
657  };
658 
659  bool allow_save = false;
660 
661  for( unsigned ii = 0; ii < arrayDim( allowed_frames ); ii++ )
662  {
663  if( m_Ident == allowed_frames[ii] )
664  {
665  allow_save = true;
666  break;
667  }
668  }
669 
670  if( !allow_save )
671  return false;
672 
673  if( aCanvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE
674  || aCanvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
675  {
676  wxASSERT( false );
677  return false;
678  }
679 
680  wxConfigBase* cfg = Kiface().KifaceSettings();
681 
682  if( cfg )
683  return cfg->Write( GetCanvasTypeKey(), (long) aCanvasType );
684 
685  return false;
686 }
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
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)
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108

References