Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard. More...

#include <eda_3d_viewer_frame.h>

Inheritance diagram for EDA_3D_VIEWER_FRAME:

Public Types
enum	UNDO_REDO_LIST { UNDO_LIST , REDO_LIST }
	Specifies whether we are interacting with the undo or redo stacks. More...

enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	EDA_3D_VIEWER_FRAME (KIWAY aKiway, PCB_BASE_FRAME aParent, const wxString &aTitle, long style=KICAD_DEFAULT_3D_DRAWFRAME_STYLE)

	~EDA_3D_VIEWER_FRAME ()

PCB_BASE_FRAME *	Parent () const

BOARD *	GetBoard ()

wxWindow *	GetToolCanvas () const override
	Canvas access. More...

void	ReloadRequest ()
	Request reloading the 3D view. More...

void	NewDisplay (bool aForceImmediateRedraw=false)
	Reload and refresh (rebuild) the 3D scene. More...

void	Redraw ()

BOARD_ADAPTER &	GetAdapter () override

CAMERA &	GetCurrentCamera () override

EDA_3D_CANVAS *	GetCanvas ()

std::vector< VIEWPORT3D >	GetUserViewports () const

void	SetUserViewports (std::vector< VIEWPORT3D > &aViewportList)

void	SaveSettings (APP_SETTINGS_BASE *aCfg) override
	Save common frame parameters to a configuration data file. More...

void	LoadSettings (APP_SETTINGS_BASE *aCfg) override
	Load common frame parameters from a configuration file. More...

void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
	Notification that common settings are updated. More...

virtual bool	OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
	Open a project or set of files given by aFileList. More...

virtual bool	ShowModal (wxString aResult=nullptr, wxWindow aResultantFocusWindow=nullptr)
	Show 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)
	Receive KIWAY_EXPRESS messages from other players. More...

bool	Destroy () override
	Our version of Destroy() which is virtual from wxWidgets. More...

bool	IsModal () const override
	Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...

void	SetModal (bool aIsModal)

bool	IsDismissed ()

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

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

virtual void	ExecuteRemoteCommand (const char *cmdline)
	Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...

void	ChangeUserUnits (EDA_UNITS aUnits)

virtual void	ToggleUserUnits ()

ORIGIN_TRANSFORMS &	GetOriginTransforms () override
	Return a reference to the default ORIGIN_TRANSFORMS object. More...

SETTINGS_MANAGER *	GetSettingsManager () const

virtual SEVERITY	GetSeverity (int aErrorCode) const

bool	ProcessEvent (wxEvent &aEvent) override
	Override the default process event handler to implement the auto save feature. More...

virtual void	OnCharHook (wxKeyEvent &aKeyEvent)
	Capture the key event before it is sent to the GUI. More...

void	OnMenuEvent (wxMenuEvent &event)
	The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...

virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
	Register a UI update handler for the control with ID `aID`. More...

virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...

virtual void	UnregisterUIUpdateHandler (int aID) override
	Unregister a UI handler for a given ID that was registered using `RegisterUIUpdateHandler`. More...

virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using `RegisterUIUpdateHandler`. More...

virtual void	OnMove (wxMoveEvent &aEvent)

virtual void	OnSize (wxSizeEvent &aEvent)

void	OnMaximize (wxMaximizeEvent &aEvent)

int	GetAutoSaveInterval () const

bool	IsType (FRAME_T aType) const

FRAME_T	GetFrameType () const

virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program. More...

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)
	Displays the preferences and settings of all opened editors paged dialog. More...

void	ShowPreferences (wxString aStartPage, wxString aStartParentPage)
	Displays the preferences and settings of all opened editors paged dialog, starting with a particular page. More...

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...

void	ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...

void	ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
	Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...

virtual APP_SETTINGS_BASE *	config () const
	Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...

void	LoadWindowState (const wxString &aFileName)

virtual void	LoadWindowState (const WINDOW_STATE &aState)
	Load frame state info from a configuration file. More...

void	LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
	Load window settings from the given settings object. More...

void	SaveWindowSettings (WINDOW_SETTINGS *aCfg)
	Save window settings to the given settings object. More...

virtual WINDOW_SETTINGS *	GetWindowSettings (APP_SETTINGS_BASE *aCfg)
	Return a pointer to the window settings for this frame. More...

wxString	ConfigBaseName () override
	Get the configuration base name. More...

virtual void	SaveProjectSettings ()
	Save changes to the project settings to the project (.pro) file. More...

void	ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
	Prompt the user for a hotkey file to read, and read it. More...

wxString	GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
	Fetches the file name from the file history list. More...

void	ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
	Removes all files from the file history. More...

void	UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
	Update the list of recently opened files. More...

FILE_HISTORY &	GetFileHistory ()
	Get the frame's main file history. More...

void	SetMruPath (const wxString &aPath)

wxString	GetMruPath () const

virtual wxString	GetCurrentFileName () const
	Get the full filename + path of the currently opened file in the frame. More...

void	ReCreateMenuBar ()
	Recreates the menu bar. More...

void	AddStandardHelpMenu (wxMenuBar *aMenuBar)
	Adds the standard KiCad help menu to the menubar. More...

bool	IsWritable (const wxFileName &aFileName, bool aVerbose=true)
	Checks if aFileName can be written. More...

virtual 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	UpdateStatusBar ()
	Update the status bar information. More...

void	ShowChangedLanguage () override
	Redraw the menus and what not in current language. More...

virtual void	ThemeChanged ()
	Process light/dark theme change. More...

virtual void	ProjectChanged ()
	Notification event that the project has changed. More...

const wxString &	GetAboutTitle () const

const wxString &	GetUntranslatedAboutTitle () const

virtual bool	IsContentModified () const
	Get if the contents of the frame have been modified since the last save. More...

wxSize	GetWindowSize ()
	Get the undecorated window size that can be used for restoring the window size. More...

virtual void	ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
	Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...

virtual void	ClearUndoRedoList ()
	Clear the undo and redo list using ClearUndoORRedoList() More...

virtual void	PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
	Add a command to undo in the undo list. More...

virtual void	PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
	Add a command to redo in the redo list. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

int	GetMaxUndoItems () const

virtual void	OnModify ()
	Must be called after a model change in order to set the "modify" flag and do other frame-specific processing. More...

bool	NonUserClose (bool aForce)

virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors. More...

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller. More...

virtual SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area. More...

virtual void	PushTool (const TOOL_EVENT &aEvent)
	NB: the definition of "tool" is different at the user level. More...

virtual void	PopTool (const TOOL_EVENT &aEvent)
	Pops a tool from the stack. More...

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

virtual void	DisplayToolMsg (const wxString &msg)

bool	GetDoImmediateActions () const
	Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...

MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...

bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...

virtual void	RefreshCanvas ()

HOLDER_TYPE	GetType () const

KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...

bool	HasKiway () const
	Safety check before asking for the Kiway reference. More...

PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

EDA_UNITS	GetUserUnits () const

void	SetUserUnits (EDA_UNITS aUnits)

const EDA_IU_SCALE &	GetIuScale () const

wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aValue in internal units into a united string. More...

wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false)

wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	A lower-precision version of StringFromValue(). More...

wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true)

int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aTextValue in aUnits to internal units used by the frame. More...

EDA_ANGLE	AngleValueFromString (const wxString &aTextValue)

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

Protected Member Functions
void	setupUIConditions () override
	Setup the UI conditions for the various actions and their controls in this frame. More...

void	handleIconizeEvent (wxIconizeEvent &aEvent) override
	Handle a window iconize event. More...

void	applyViewport (const wxString &aViewportName)
	switch to a given predefined 3D viewport More...

void	kiway_express (KIWAY_EXPRESS &aEvent)
	event handler, routes to derivative specific virtual KiwayMailIn() More...

void	language_change (wxCommandEvent &event)
	An event handler called on a language menu selection. More...

virtual void	doReCreateMenuBar ()

void	onAutoSaveTimer (wxTimerEvent &aEvent)
	Handle the auto save timer event. More...

void	onIconize (wxIconizeEvent &aEvent)

virtual bool	isAutoSaveRequired () const
	Return the auto save status of the application. More...

virtual bool	doAutoSave ()
	This should be overridden by the derived class to handle the auto save feature. More...

virtual bool	canCloseWindow (wxCloseEvent &aCloseEvent)

virtual void	doCloseWindow ()

void	onSystemColorChange (wxSysColourChangedEvent &aEvent)

virtual void	unitsChangeRefresh ()
	Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...

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

void	ensureWindowIsOnScreen ()

virtual void	OnDropFiles (wxDropFilesEvent &aEvent)
	Handles event fired when a file is dropped to the window. More...

virtual void	DoWithAcceptedFiles ()
	Execute action on accepted dropped file. More...

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
bool	m_modal

WX_EVENT_LOOP *	m_modal_loop
	< Points to nested event_loop. NULL means not modal and dismissed. More...

wxWindow *	m_modal_resultant_parent

wxString	m_modal_string

bool	m_modal_ret_val

wxSocketServer *	m_socketServer

std::vector< wxSocketBase * >	m_sockets
	interprocess communication More...

std::vector< wxFileName >	m_AcceptedFiles

FRAME_T	m_ident

wxPoint	m_framePos

wxSize	m_frameSize

bool	m_maximizeByDefault

int	m_displayIndex

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_fileHistory

bool	m_supportsAutoSave

bool	m_autoSavePending

bool	m_autoSaveRequired

wxTimer *	m_autoSaveTimer

int	m_undoRedoCountMax

UNDO_REDO_CONTAINER	m_undoList

UNDO_REDO_CONTAINER	m_redoList

wxString	m_mruPath

ORIGIN_TRANSFORMS	m_originTransforms

std::map< int, UIUpdateHandler >	m_uiUpdateMap
	< Map containing the UI update handlers registered with wx for each action. More...

bool	m_isClosing
	Set by NonUserClose() to indicate that the user did not request the current close. More...

bool	m_isNonUserClose

std::map< const wxString, TOOL_ACTION * >	m_acceptedExts
	Associates files extensions with action to execute. More...

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

Static Protected Attributes
static constexpr int	KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE \| wxAUI_TB_PLAIN_BACKGROUND
	< Default style flags used for wxAUI toolbars. More...

Private Member Functions
void	Exit3DFrame (wxCommandEvent &event)
	Called when user press the File->Exit. More...

void	OnCloseWindow (wxCloseEvent &event)

bool	TryBefore (wxEvent &aEvent) override

void	Process_Special_Functions (wxCommandEvent &event)

void	onRenderEngineSelection (wxCommandEvent &event)

void	onDisableRayTracing (wxCommandEvent &aEvent)

void	onViewportChanged (wxCommandEvent &aEvent)

void	onUpdateViewportsCb (wxUpdateUIEvent &aEvent)

void	OnActivate (wxActivateEvent &event)

void	OnSetFocus (wxFocusEvent &event)

void	passOnFocus ()

void	CreateMenuBar ()

void	ReCreateMainToolbar ()

void	takeScreenshot (wxCommandEvent &event)
	Create a Screenshot of the current 3D view. More...

void	RenderEngineChanged ()
	RenderEngineChanged - Update toolbar icon and call canvas RenderEngineChanged. More...

void	refreshRender ()

void	loadCommonSettings ()
	Load configuration from common settings. More...

void	windowClosing (wxCloseEvent &event)
	(with its unexpected name so it does not collide with the real OnWindowClose() function provided in derived classes) is called just before a window closing, and is used to call a derivation specific SaveSettings(). More...

void	commonInit (FRAME_T aFrameType)
	Collect common initialization functions used in all CTORs. More...

wxWindow *	findQuasiModalDialog ()

Private Attributes
wxFileName	m_defaultSaveScreenshotFileName

ACTION_TOOLBAR *	m_mainToolBar

wxStaticText *	m_viewportsLabel

wxChoice *	m_cbViewports

EDA_3D_CANVAS *	m_canvas

BOARD_ADAPTER	m_boardAdapter

CAMERA &	m_currentCamera

TRACK_BALL	m_trackBallCamera

bool	m_disable_ray_tracing

NL_3D_VIEWER_PLUGIN *	m_spaceMouse

std::map< wxString, VIEWPORT3D >	m_viewports

VIEWPORT3D *	m_lastSelectedViewport

wxArrayString	m_viewportMRU

KIWAY *	m_kiway

HOLDER_TYPE	m_type

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Static Private Attributes
static const wxChar *	m_logTrace = wxT( "KI_TRACE_EDA_3D_VIEWER" )
	Trace mask used to enable or disable the trace output of this class. More...

Detailed Description

Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.

Definition at line 64 of file eda_3d_viewer_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

39{ DIALOG, FRAME, PANEL };

KIWAY_HOLDER::PANEL

@ PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::DIALOG

@ DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::FRAME

@ FRAME

Definition: kiway_holder.h:39

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

Specifies whether we are interacting with the undo or redo stacks.

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 111 of file eda_base_frame.h.

 {
 UNDO_LIST,
 REDO_LIST
 };

Constructor & Destructor Documentation

◆ EDA_3D_VIEWER_FRAME()

EDA_3D_VIEWER_FRAME::EDA_3D_VIEWER_FRAME	(	KIWAY *	aKiway,
		PCB_BASE_FRAME *	aParent,
		const wxString &	aTitle,
		long	style = `KICAD_DEFAULT_3D_DRAWFRAME_STYLE`
	)

◆ ~EDA_3D_VIEWER_FRAME()

EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME ( )

Definition at line 194 of file eda_3d_viewer_frame.cpp.

{
#if defined( KICAD_USE_3DCONNEXION )
 if( m_spaceMouse != nullptr )
 {
 delete m_spaceMouse;
 }
#endif
 
 Prj().GetProjectFile().m_Viewports3D = GetUserViewports();
 
 m_cbViewports->Disconnect( wxEVT_COMMAND_CHOICE_SELECTED,
 wxCommandEventHandler( EDA_3D_VIEWER_FRAME::onViewportChanged ),
 nullptr, this );
 m_cbViewports->Disconnect( wxEVT_UPDATE_UI,
 wxUpdateUIEventHandler( EDA_3D_VIEWER_FRAME::onUpdateViewportsCb ),
 nullptr, this );
 
 m_canvas->SetEventDispatcher( nullptr );
 
 m_auimgr.UnInit();
}

References PROJECT::GetProjectFile(), GetUserViewports(), EDA_BASE_FRAME::m_auimgr, m_canvas, m_cbViewports, m_spaceMouse, PROJECT_FILE::m_Viewports3D, onUpdateViewportsCb(), onViewportChanged(), KIWAY_HOLDER::Prj(), and EDA_3D_CANVAS::SetEventDispatcher().

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar * aMenuBar )

inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 462 of file eda_base_frame.cpp.

{
 COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
 ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
 
 helpMenu->Add( ACTIONS::help );
 helpMenu->Add( ACTIONS::gettingStarted );
 helpMenu->Add( ACTIONS::listHotKeys );
 helpMenu->Add( ACTIONS::getInvolved );
 helpMenu->Add( ACTIONS::donate );
 helpMenu->Add( ACTIONS::reportBug );
 
 helpMenu->AppendSeparator();
 helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
 
 // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
 aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
}

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

Referenced by CreateMenuBar(), CVPCB_MAINFRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_EDIT_FRAME::doReCreateMenuBar(), SYMBOL_VIEWER_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::doReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::doReCreateMenuBar(), and PCB_EDIT_FRAME::doReCreateMenuBar().

◆ AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString & aTextValue )

inlineinherited

Definition at line 116 of file units_provider.h.

 {
 double angle = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), EDA_UNITS::DEGREES,
 aTextValue );
 
 return EDA_ANGLE( angle, DEGREES_T );
 }

References PNS::angle(), DEGREES, DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().

Referenced by FP_TEXT_GRID_TABLE::SetValue().

◆ applyViewport()

void EDA_3D_VIEWER_FRAME::applyViewport ( const wxString & aViewportName )

protected

switch to a given predefined 3D viewport

Parameters

aViewportName is the name of the viewport to switch on

Definition at line 474 of file eda_3d_viewer_frame.cpp.

{
 int idx = m_cbViewports->FindString( aViewportName );
 
 if( idx >= 0 && idx < m_cbViewports->GetCount() - 3 /* separator */ )
 {
 m_cbViewports->SetSelection( idx );
 m_lastSelectedViewport = static_cast<VIEWPORT3D*>( m_cbViewports->GetClientData( idx ) );
 
 m_currentCamera.SetViewMatrix( m_lastSelectedViewport->matrix );
 
 if( m_boardAdapter.m_Cfg->m_Render.engine == RENDER_ENGINE::OPENGL )
 m_canvas->Request_refresh();
 else
 m_canvas->RenderRaytracingRequest();
 
 if( !m_lastSelectedViewport->name.IsEmpty() )
 {
 m_viewportMRU.Remove( m_lastSelectedViewport->name );
 m_viewportMRU.Insert( m_lastSelectedViewport->name, 0 );
 }
 }
 else
 {
 m_cbViewports->SetSelection( -1 ); // separator
 m_lastSelectedViewport = nullptr;
 }
}

References EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, m_boardAdapter, m_canvas, m_cbViewports, BOARD_ADAPTER::m_Cfg, m_currentCamera, m_lastSelectedViewport, EDA_3D_VIEWER_SETTINGS::m_Render, m_viewportMRU, VIEWPORT3D::matrix, VIEWPORT3D::name, OPENGL, EDA_3D_CANVAS::RenderRaytracingRequest(), EDA_3D_CANVAS::Request_refresh(), and CAMERA::SetViewMatrix().

Referenced by onViewportChanged(), and TryBefore().

◆ canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

inlineprotectedvirtualinherited

Reimplemented in CVPCB_MAINFRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PCB_BASE_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, PCB_EDIT_FRAME, SIM_PLOT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 637 of file eda_base_frame.h.

637{ return true; }

Referenced by EDA_BASE_FRAME::windowClosing().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS aUnits )

inherited

Definition at line 1352 of file eda_base_frame.cpp.

{
 SetUserUnits( aUnits );
 unitsChangeRefresh();
 
 wxCommandEvent e( UNITS_CHANGED );
 e.SetClientData( this );
 ProcessEventLocally( e );
}

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

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName & aFileName )

virtualinherited

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

aFileName A wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1231 of file eda_base_frame.cpp.

{
 if( !IsGUI() )
 return;
 
 wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
 
 wxFileName autoSaveFileName = aFileName;
 
 // Check for auto save file.
 autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
 
 wxLogTrace( traceAutoSave,
 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
 
 if( !autoSaveFileName.FileExists() )
 return;
 
 wxString msg = wxString::Format( _( "Well this is potentially embarrassing!\n"
 "It appears that the last time you were editing\n"
 "%s\n"
 "KiCad exited before saving.\n"
 "\n"
 "Do you wish to open the auto-saved file instead?" ),
 aFileName.GetFullName() );
 
 int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
 this );
 
 // Make a backup of the current file, delete the file, and rename the auto save file to
 // the file name.
 if( response == wxYES )
 {
 if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
 {
 wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
 Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
 }
 }
 else
 {
 wxLogTrace( traceAutoSave,
 wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
 
 // Remove the auto save file when using the previous file as is.
 wxRemoveFile( autoSaveFileName.GetFullPath() );
 }
}

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

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

inherited

Removes all files from the file history.

Parameters

aFileHistory The FILE_HISTORY in use. If null, the main application file history is used

Definition at line 969 of file eda_base_frame.cpp.

{
 if( !aFileHistory )
 aFileHistory = m_fileHistory;
 
 wxASSERT( aFileHistory );
 
 aFileHistory->ClearFileHistory();
 
 // Update the menubar to update the file history menu
 if( GetMenuBar() )
 {
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
}

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

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

◆ ClearUndoORRedoList()

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

inlinevirtualinherited

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

Parameters

aList	= the UNDO_REDO_CONTAINER of commands.
aItemCount	number of old commands to delete. -1 to remove all old commands this will empty the list of commands.

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 539 of file eda_base_frame.h.

540 { }

Referenced by EDA_BASE_FRAME::ClearUndoRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), and EDA_BASE_FRAME::PushCommandToUndoList().

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1297 of file eda_base_frame.cpp.

{
 ClearUndoORRedoList( UNDO_LIST );
 ClearUndoORRedoList( REDO_LIST );
}

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), PCB_EDIT_FRAME::ImportSpecctraSession(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_EDIT_FRAME::OnImportProject(), PL_EDITOR_FRAME::OnNewDrawingSheet(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().

◆ commonInit()

void EDA_BASE_FRAME::commonInit ( FRAME_T aFrameType )

privateinherited

Collect common initialization functions used in all CTORs.

Definition at line 117 of file eda_base_frame.cpp.

{
 m_ident = aFrameType;
 m_maximizeByDefault = false;
 m_infoBar = nullptr;
 m_settingsManager = nullptr;
 m_fileHistory = nullptr;
 m_supportsAutoSave = false;
 m_autoSavePending = false;
 m_undoRedoCountMax = DEFAULT_MAX_UNDO_ITEMS;
 m_isClosing = false;
 m_isNonUserClose = false;
 m_autoSaveTimer = new wxTimer( this, ID_AUTO_SAVE_TIMER );
 m_autoSaveRequired = false;
 m_mruPath = PATHS::GetDefaultUserProjectsPath();
 m_frameSize = defaultSize( aFrameType );
 m_displayIndex = -1;
 
 m_auimgr.SetArtProvider( new WX_AUI_DOCK_ART() );
 
 m_settingsManager = &Pgm().GetSettingsManager();
 
 // Set a reasonable minimal size for the frame
 SetSizeHints( minSize( aFrameType ).x, minSize( aFrameType ).y, -1, -1, -1, -1 );
 
 // Store dimensions of the user area of the main window.
 GetClientSize( &m_frameSize.x, &m_frameSize.y );
 
 Connect( ID_AUTO_SAVE_TIMER, wxEVT_TIMER,
 wxTimerEventHandler( EDA_BASE_FRAME::onAutoSaveTimer ) );
 
 // hook wxEVT_CLOSE_WINDOW so we can call SaveSettings(). This function seems
 // to be called before any other hook for wxCloseEvent, which is necessary.
 Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( EDA_BASE_FRAME::windowClosing ) );
 
 initExitKey();
}

References DEFAULT_MAX_UNDO_ITEMS, defaultSize(), PATHS::GetDefaultUserProjectsPath(), ID_AUTO_SAVE_TIMER, minSize(), EDA_BASE_FRAME::onAutoSaveTimer(), Pgm(), and EDA_BASE_FRAME::windowClosing().

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ CommonSettingsChanged()

void EDA_3D_VIEWER_FRAME::CommonSettingsChanged	(	bool	aEnvVarsChanged,
		bool	aTextVarsChanged
	)

overridevirtual

Notification that common settings are updated.

This would be private (and only called by the Kiway), but we need to do this manually from the PCB frame because the 3D viewer isn't updated via the KIWAY.

Reimplemented from TOOLS_HOLDER.

Definition at line 736 of file eda_3d_viewer_frame.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::CommonSettingsChanged" ) );
 
 // Regen menu bars, etc
 EDA_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
 // There is no base class that handles toolbars for this frame
 ReCreateMainToolbar();
 
 loadCommonSettings();
 LoadSettings( Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>() );
 
 NewDisplay( true );
}

References EDA_BASE_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::GetSettingsManager(), loadCommonSettings(), LoadSettings(), m_logTrace, NewDisplay(), Pgm(), and ReCreateMainToolbar().

Referenced by PCB_BASE_FRAME::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const

virtualinherited

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

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 809 of file eda_base_frame.cpp.

{
 // KICAD_MANAGER_FRAME overrides this
 return Kiface().KifaceSettings();
}

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), SIM_PLOT_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_EDIT_FRAME::GetRotationAngle(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), GERBVIEW_FRAME::gvconfig(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_BASE_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), PCB_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )

inlineoverridevirtualinherited

Get the configuration base name.

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 configuration can be used.

Returns: a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 350 of file eda_base_frame.h.

 {
 wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
 return baseCfgName;
 }

References EDA_BASE_FRAME::m_configName.

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )

inherited

Definition at line 834 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
 m_infoBar = new WX_INFOBAR( GetToolCanvas() );
#else
 m_infoBar = new WX_INFOBAR( this, &m_auimgr );
 
 m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( wxS( "InfoBar" ) ).Top().Layer(1) );
#endif
}

References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ CreateMenuBar()

void EDA_3D_VIEWER_FRAME::CreateMenuBar ( )

private

Definition at line 38 of file 3d_menubar.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::CreateMenuBar" ) );
 
 COMMON_CONTROL* tool = m_toolManager->GetTool<COMMON_CONTROL>();
 WX_MENUBAR* menuBar = new WX_MENUBAR();
 
 
 //-- File menu -----------------------------------------------------------
 //
 ACTION_MENU* fileMenu = new ACTION_MENU( false, tool );
 
 fileMenu->Add( _( "Export Current View as PNG..." ),
 wxEmptyString,
 ID_MENU_SCREENCOPY_PNG,
 BITMAPS::export_png );
 
 fileMenu->Add( _( "Export Current View as JPEG..." ),
 wxEmptyString,
 ID_MENU_SCREENCOPY_JPEG,
 BITMAPS::export_file );
 
 fileMenu->AppendSeparator();
 fileMenu->AddClose( _( "3D Viewer" ) );
 
 
 //-- Edit menu -------------------------------------------------------
 // Avoid to translate hotkey modifiers like Ctrl and Shift.
 // The translated modifiers do not always work
 ACTION_MENU* editMenu = new ACTION_MENU( false, tool );
 
 editMenu->Add( _( "Copy 3D Image" ),
 wxEmptyString,
 ID_TOOL_SCREENCOPY_TOCLIBBOARD,
 BITMAPS::copy );
 
 
 //-- View menu -------------------------------------------------------
 //
 ACTION_MENU* viewMenu = new ACTION_MENU( false, tool );
 
 viewMenu->Add( ACTIONS::zoomInCenter );
 viewMenu->Add( ACTIONS::zoomOutCenter );
 viewMenu->Add( ACTIONS::zoomFitScreen );
 viewMenu->Add( ACTIONS::zoomRedraw );
 
 viewMenu->AppendSeparator();
 viewMenu->Add( EDA_3D_ACTIONS::rotateXCW );
 viewMenu->Add( EDA_3D_ACTIONS::rotateXCCW );
 
 viewMenu->AppendSeparator();
 viewMenu->Add( EDA_3D_ACTIONS::rotateYCW );
 viewMenu->Add( EDA_3D_ACTIONS::rotateYCCW );
 
 viewMenu->AppendSeparator();
 viewMenu->Add( EDA_3D_ACTIONS::rotateZCW );
 viewMenu->Add( EDA_3D_ACTIONS::rotateZCCW );
 
 viewMenu->AppendSeparator();
 viewMenu->Add( EDA_3D_ACTIONS::moveLeft );
 viewMenu->Add( EDA_3D_ACTIONS::moveRight );
 viewMenu->Add( EDA_3D_ACTIONS::moveUp );
 viewMenu->Add( EDA_3D_ACTIONS::moveDown );
 
 
 //-- Preferences menu -----------------------------------------------
 //
 ACTION_MENU* prefsMenu = new ACTION_MENU( false, tool );
 
 prefsMenu->Add( _( "Raytracing" ), "",
 ID_RENDER_CURRENT_VIEW,
 BITMAPS::tools,
 ACTION_MENU::CHECK );
 
 prefsMenu->Add( _( "Preferences..." ) + wxT( "\tCtrl+," ),
 _( "Show preferences for all open tools" ),
 wxID_PREFERENCES,
 BITMAPS::preference );
 
 prefsMenu->Add( _( "Reset to Default Settings" ), ID_MENU3D_RESET_DEFAULTS, BITMAPS::tools );
 
 prefsMenu->AppendSeparator();
 
 prefsMenu->Add( EDA_3D_ACTIONS::showTHT, ACTION_MENU::CHECK );
 prefsMenu->Add( EDA_3D_ACTIONS::showSMD, ACTION_MENU::CHECK );
 prefsMenu->Add( EDA_3D_ACTIONS::showVirtual, ACTION_MENU::CHECK );
 prefsMenu->Add( EDA_3D_ACTIONS::showNotInPosFile, ACTION_MENU::CHECK );
 
 prefsMenu->AppendSeparator();
 
 prefsMenu->Add( EDA_3D_ACTIONS::showAxis, ACTION_MENU::CHECK );
 prefsMenu->Add( EDA_3D_ACTIONS::showBBoxes, ACTION_MENU::CHECK );
 
 // Grid submenu
 ACTION_MENU* gridSubmenu = new ACTION_MENU( false, tool );
 gridSubmenu->SetTitle( _( "3D Grid" ) );
 gridSubmenu->SetIcon( BITMAPS::grid );
 
 gridSubmenu->Add( EDA_3D_ACTIONS::noGrid, ACTION_MENU::CHECK);
 gridSubmenu->Add( EDA_3D_ACTIONS::show10mmGrid, ACTION_MENU::CHECK);
 gridSubmenu->Add( EDA_3D_ACTIONS::show5mmGrid, ACTION_MENU::CHECK);
 gridSubmenu->Add( EDA_3D_ACTIONS::show2_5mmGrid, ACTION_MENU::CHECK);
 gridSubmenu->Add( EDA_3D_ACTIONS::show1mmGrid, ACTION_MENU::CHECK);
 
 prefsMenu->Add( gridSubmenu );
 
 //-- Menubar -------------------------------------------------------------
 //
 menuBar->Append( fileMenu, _( "&File" ) );
 menuBar->Append( editMenu, _( "&Edit" ) );
 menuBar->Append( viewMenu, _( "&View" ) );
 menuBar->Append( prefsMenu, _( "&Preferences" ) );
 AddStandardHelpMenu( menuBar );
 
 SetMenuBar( menuBar );
}

◆ CreateServer()

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

inherited

Definition at line 43 of file eda_dde.cpp.

{
 wxIPV4address addr;
 
 // Set the port number
 addr.Service( service );
 
 // Listen on localhost only if requested
 if( local )
 addr.Hostname( HOSTNAME );
 
 if( m_socketServer )
 {
 // this helps prevent any events that could come in during deletion
 m_socketServer->Notify( false );
 delete m_socketServer;
 }
 
 m_socketServer = new wxSocketServer( addr );
 
 m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
 m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
 m_socketServer->Notify( true );
}

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

Referenced by SaveFileAs().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 110 of file tools_holder.cpp.

{
 if( m_toolStack.empty() )
 return ACTIONS::selectionTool.GetName();
 else
 return m_toolStack.back();
}

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

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

Our version of Destroy() which is virtual from wxWidgets.

Definition at line 170 of file kiway_player.cpp.

{
 return EDA_BASE_FRAME::Destroy();
}

◆ DismissModal()

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

inherited

Definition at line 182 of file kiway_player.cpp.

{
 m_modal_ret_val = aRetVal;
 m_modal_string = aResult;
 
 if( m_modal_loop )
 {
 m_modal_loop->Exit();
 m_modal_loop = nullptr; // this marks it as dismissed.
 }
 
 Show( false );
}

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

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

◆ DisplayToolMsg()

virtual void TOOLS_HOLDER::DisplayToolMsg ( const wxString & msg )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 133 of file tools_holder.h.

133{};

Referenced by TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), and TOOLS_HOLDER::ShowChangedLanguage().

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

Definition at line 318 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

virtual void EDA_BASE_FRAME::doCloseWindow ( )

inlineprotectedvirtualinherited

Reimplemented in CVPCB_MAINFRAME, DISPLAY_FOOTPRINTS_FRAME, SCH_EDIT_FRAME, SIM_PLOT_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, GERBVIEW_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, FOOTPRINT_WIZARD_FRAME, PCB_BASE_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 638 of file eda_base_frame.h.

638{ }

Referenced by EDA_BASE_FRAME::windowClosing().

◆ doReCreateMenuBar()

virtual void EDA_BASE_FRAME::doReCreateMenuBar ( )

inlineprotectedvirtualinherited

Reimplemented in BM2CMP_FRAME, CVPCB_MAINFRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, GERBVIEW_FRAME, EDA_DRAW_FRAME, PCB_BASE_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.

Definition at line 607 of file eda_base_frame.h.

607{}

Referenced by EDA_BASE_FRAME::ReCreateMenuBar().

◆ DoWithAcceptedFiles()

void EDA_BASE_FRAME::DoWithAcceptedFiles ( )

protectedvirtualinherited

Execute action on accepted dropped file.

Called in OnDropFiles and should be populated with the action to execute in inherited classes.

Reimplemented in GERBVIEW_FRAME, KICAD_MANAGER_FRAME, and PL_EDITOR_FRAME.

Definition at line 1178 of file eda_base_frame.cpp.

{
 for( const wxFileName& file : m_AcceptedFiles )
 {
 wxString fn = file.GetFullPath();
 m_toolManager->RunAction( *m_acceptedExts.at( file.GetExt() ), true, &fn );
 }
}

References EDA_BASE_FRAME::m_acceptedExts, EDA_BASE_FRAME::m_AcceptedFiles, TOOLS_HOLDER::m_toolManager, and TOOL_MANAGER::RunAction().

Referenced by EDA_BASE_FRAME::OnDropFiles().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 659 of file eda_base_frame.cpp.

{
 wxDisplay display( wxDisplay::GetFromWindow( this ) );
 wxRect clientSize = display.GetClientArea();
 wxPoint pos = GetPosition();
 wxSize size = GetWindowSize();
 
 wxLogTrace( traceDisplayLocation,
 wxS( "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ), clientSize.x, clientSize.y,
 clientSize.width, clientSize.height );
 
 if( pos.y < clientSize.y )
 {
 wxLogTrace( traceDisplayLocation,
 wxS( "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
 clientSize.y );
 pos.y = clientSize.y;
 }
 
 if( pos.x < clientSize.x )
 {
 wxLogTrace( traceDisplayLocation,
 wxS( "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d" ), pos.x,
 clientSize.x );
 pos.x = clientSize.x;
 }
 
 if( pos.x + size.x - clientSize.x > clientSize.width )
 {
 int newWidth = clientSize.width - ( pos.x - clientSize.x );
 wxLogTrace( traceDisplayLocation,
 wxS( "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d" ),
 pos.x + size.x, clientSize.width, newWidth );
 size.x = newWidth;
 }
 
 if( pos.y + size.y - clientSize.y > clientSize.height )
 {
 int newHeight = clientSize.height - ( pos.y - clientSize.y );
 wxLogTrace( traceDisplayLocation,
 wxS( "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d" ),
 pos.y + size.y, clientSize.height, newHeight );
 size.y = newHeight;
 }
 
 wxLogTrace( traceDisplayLocation, wxS( "Updating window position (%d, %d) with size (%d, %d)" ),
 pos.x, pos.y, size.x, size.y );
 
 SetSize( pos.x, pos.y, size.x, size.y );
}

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ ExecuteRemoteCommand()

virtual void KIWAY_PLAYER::ExecuteRemoteCommand ( const char * cmdline )

inlinevirtualinherited

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

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 182 of file kiway_player.h.

182{}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ Exit3DFrame()

void EDA_3D_VIEWER_FRAME::Exit3DFrame ( wxCommandEvent & event )

private

Called when user press the File->Exit.

Definition at line 382 of file eda_3d_viewer_frame.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::Exit3DFrame" ) );
 
 Close( true );
}

References m_logTrace.

◆ findQuasiModalDialog()

wxWindow * EDA_BASE_FRAME::findQuasiModalDialog ( )

privateinherited

Definition at line 169 of file eda_base_frame.cpp.

{
 for( wxWindow* iter : GetChildren() )
 {
 DIALOG_SHIM* dlg = dynamic_cast<DIALOG_SHIM*>( iter );
 
 if( dlg && dlg->IsQuasiModal() )
 return dlg;
 }
 
 // FIXME: CvPcb is currently implemented on top of KIWAY_PLAYER rather than DIALOG_SHIM,
 // so we have to look for it separately.
 if( m_ident == FRAME_SCH )
 {
 wxWindow* cvpcb = wxWindow::FindWindowByName( wxS( "CvpcbFrame" ) );
 
 if( cvpcb )
 return cvpcb;
 }
 
 return nullptr;
}

References FRAME_SCH, DIALOG_SHIM::IsQuasiModal(), and EDA_BASE_FRAME::m_ident.

Referenced by EDA_BASE_FRAME::ProcessEvent(), and EDA_BASE_FRAME::windowClosing().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 846 of file eda_base_frame.cpp.

{
#if defined( __WXOSX_MAC__ )
 m_auimgr.Update();
#else
 // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
 // hiding it.
 m_auimgr.Update();
 
 // We don't want the infobar displayed right away
 m_auimgr.GetPane( wxS( "InfoBar" ) ).Hide();
 m_auimgr.Update();
#endif
}

References EDA_BASE_FRAME::m_auimgr.

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ GetAboutTitle()

const wxString & EDA_BASE_FRAME::GetAboutTitle ( ) const

inlineinherited

Definition at line 506 of file eda_base_frame.h.

506{ return wxGetTranslation( m_aboutTitle ); }

EDA_BASE_FRAME::m_aboutTitle

wxString m_aboutTitle

Definition: eda_base_frame.h:730

References EDA_BASE_FRAME::m_aboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), PGM_SINGLE_TOP::OnPgmInit(), and PGM_KICAD::OnPgmInit().

◆ GetAdapter()

BOARD_ADAPTER & EDA_3D_VIEWER_FRAME::GetAdapter ( )

inlineoverridevirtual

Implements EDA_3D_BOARD_HOLDER.

Definition at line 104 of file eda_3d_viewer_frame.h.

104{ return m_boardAdapter; }

References m_boardAdapter.

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )

inlinestaticprotectedinherited

Returns: the string to prepend to a file name for automatic save.

Definition at line 602 of file eda_base_frame.h.

 {
 return wxT( "_autosave-" );
 }

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const

inherited

Definition at line 298 of file eda_base_frame.cpp.

{
 return Pgm().GetCommonSettings()->m_System.autosave_interval;
}

References Pgm().

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::onAutoSaveTimer(), and EDA_BASE_FRAME::ProcessEvent().

◆ GetBoard()

BOARD * EDA_3D_VIEWER_FRAME::GetBoard ( )

inline

Definition at line 74 of file eda_3d_viewer_frame.h.

74{ return Parent()->GetBoard(); }

EDA_3D_VIEWER_FRAME::Parent

PCB_BASE_FRAME * Parent() const

Definition: eda_3d_viewer_frame.h:72

PCB_BASE_FRAME::GetBoard

BOARD * GetBoard() const

Definition: pcb_base_frame.h:191

References PCB_BASE_FRAME::GetBoard(), and Parent().

Referenced by ReloadRequest().

◆ GetCanvas()

EDA_3D_CANVAS * EDA_3D_VIEWER_FRAME::GetCanvas ( )

inline

Definition at line 107 of file eda_3d_viewer_frame.h.

107{ return m_canvas; }

References m_canvas.

◆ GetCurrentCamera()

CAMERA & EDA_3D_VIEWER_FRAME::GetCurrentCamera ( )

inlineoverridevirtual

Implements EDA_3D_BOARD_HOLDER.

Definition at line 105 of file eda_3d_viewer_frame.h.

105{ return m_currentCamera; }

References m_currentCamera.

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const

inlinevirtualinherited

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns: the filename and full path to the open file

Reimplemented in SCH_EDIT_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, and PCB_EDIT_FRAME.

Definition at line 431 of file eda_base_frame.h.

431{ return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION & TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, GERBVIEW_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.

Definition at line 101 of file tools_holder.h.

 {
 return m_dummySelection;
 }

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), ACTION_MANAGER::RunHotKey(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), and NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

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

141{ return m_immediateActions; }

TOOLS_HOLDER::m_immediateActions

bool m_immediateActions

Definition: tools_holder.h:183

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 147 of file tools_holder.h.

147{ return m_dragAction; }

TOOLS_HOLDER::m_dragAction

MOUSE_DRAG_ACTION m_dragAction

Definition: tools_holder.h:187

References TOOLS_HOLDER::m_dragAction.

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

◆ GetFileFromHistory()

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

inherited

Fetches the file name from the file history list.

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

Parameters

cmdId	The command ID associated with the aFileHistory object.
type	Please document me!
aFileHistory	The FILE_HISTORY in use. If null, the main application file history is used

Returns: a wxString containing the selected filename

Definition at line 929 of file eda_base_frame.cpp.

{
 if( !aFileHistory )
 aFileHistory = m_fileHistory;
 
 wxASSERT( aFileHistory );
 
 int baseId = aFileHistory->GetBaseId();
 
 wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
 
 unsigned i = cmdId - baseId;
 
 if( i < aFileHistory->GetCount() )
 {
 wxString fn = aFileHistory->GetHistoryFile( i );
 
 if( wxFileName::FileExists( fn ) )
 {
 return fn;
 }
 else
 {
 DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
 aFileHistory->RemoveFileFromHistory( i );
 }
 }
 
 // Update the menubar to update the file history menu
 if( GetMenuBar() )
 {
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
 
 return wxEmptyString;
}

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

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY & EDA_BASE_FRAME::GetFileHistory ( )

inlineinherited

Get the frame's main file history.

Returns: the main file history

Definition at line 415 of file eda_base_frame.h.

 {
 return *m_fileHistory;
 }

References EDA_BASE_FRAME::m_fileHistory.

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

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const

inlineinherited

Definition at line 201 of file eda_base_frame.h.

201{ return m_ident; }

References EDA_BASE_FRAME::m_ident.

Referenced by PCB_BASE_FRAME::GetViewerSettingsBase(), and EDA_BASE_FRAME::ShowPreferences().

◆ GetInfoBar()

WX_INFOBAR * EDA_BASE_FRAME::GetInfoBar ( )

inlineinherited

Returns: the WX_INFOBAR that can be displayed on the top of the canvas.

Definition at line 234 of file eda_base_frame.h.

234{ return m_infoBar; }

References EDA_BASE_FRAME::m_infoBar.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AUTOPLACE_TOOL::autoplace(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), PCB_EDIT_FRAME::CommonSettingsChanged(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EditPad(), ZONE_FILLER_TOOL::FillAllZones(), ROUTER_TOOL::handleLayerSwitch(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), APPEARANCE_CONTROLS::onReadOnlySwatch(), EDA_DRAW_PANEL_GAL::onSize(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), PAD_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::SetCurSymbol(), EDA_BASE_FRAME::ShowInfoBarError(), EDA_BASE_FRAME::ShowInfoBarMsg(), EDA_BASE_FRAME::ShowInfoBarWarning(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PCB_CONTROL::unfilledZoneCheck(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

45{ return m_iuScale; }

UNITS_PROVIDER::m_iuScale

const EDA_IU_SCALE & m_iuScale

Definition: units_provider.h:125

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const

inlineinherited

Definition at line 576 of file eda_base_frame.h.

576{ return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

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

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

Definition at line 153 of file tools_holder.h.

153{ return m_moveWarpsCursor; }

TOOLS_HOLDER::m_moveWarpsCursor

bool m_moveWarpsCursor

Definition: tools_holder.h:189

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), SCH_MOVE_TOOL::Main(), and SYMBOL_EDITOR_MOVE_TOOL::Main().

◆ GetMruPath()

wxString EDA_BASE_FRAME::GetMruPath ( ) const

inlineinherited

Definition at line 422 of file eda_base_frame.h.

422{ return m_mruPath; }

References EDA_BASE_FRAME::m_mruPath.

Referenced by AskLoadBoardFileName(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), GERBVIEW_CONTROL::ExportToPcbnew(), PCB_EDIT_FRAME::Files_io_from_id(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), EDA_DRAW_FRAME::LibraryFileBrowser(), KICAD_MANAGER_CONTROL::NewProject(), KICAD_MANAGER_CONTROL::OpenProject(), SCH_EDIT_FRAME::SaveProject(), and KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & EDA_BASE_FRAME::GetOriginTransforms ( )

inlineoverridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from UNITS_PROVIDER.

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

 {
 return m_originTransforms;
 }

References EDA_BASE_FRAME::m_originTransforms.

Referenced by PROPERTIES_PANEL::extractValueAndWritability(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PROPERTIES_PANEL::rebuildProperties(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 574 of file eda_base_frame.h.

574{ return m_redoList.m_CommandsList.size(); }

EDA_BASE_FRAME::m_redoList

UNDO_REDO_CONTAINER m_redoList

Definition: eda_base_frame.h:752

UNDO_REDO_CONTAINER::m_CommandsList

std::vector< PICKED_ITEMS_LIST * > m_CommandsList

Definition: undo_redo_container.h:309

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_redoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), SCH_EDITOR_CONTROL::Redo(), EDITOR_CONDITIONS::redoFunc(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList().

◆ GetSettingsManager()

SETTINGS_MANAGER * EDA_BASE_FRAME::GetSettingsManager ( ) const

inlineinherited

Definition at line 136 of file eda_base_frame.h.

136{ return m_settingsManager; }

References EDA_BASE_FRAME::m_settingsManager.

Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CreateNewProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), EESCHEMA_HELPERS::GetSettingsManager(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int aErrorCode ) const

inlinevirtualinherited

Reimplemented in SCH_EDIT_FRAME, and PCB_BASE_FRAME.

Definition at line 138 of file eda_base_frame.h.

138{ return RPT_SEVERITY_UNDEFINED; }

RPT_SEVERITY_UNDEFINED

@ RPT_SEVERITY_UNDEFINED

Definition: report_severity.h:27

References RPT_SEVERITY_UNDEFINED.

Referenced by ERC_TREE_MODEL::GetValue(), and RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow * EDA_3D_VIEWER_FRAME::GetToolCanvas ( ) const

inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 76 of file eda_3d_viewer_frame.h.

76{ return m_canvas; }

References m_canvas.

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54{ return m_toolManager; }

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), PCB_PROPERTIES_PANEL::AfterCommit(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), BOARD_COMMIT::BOARD_COMMIT(), SCH_NAVIGATE_TOOL::changeSheet(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), GERBER_LAYER_WIDGET::onPopupSelection(), SIM_PLOT_FRAME::onProbe(), PCB_EDIT_FRAME::OnRemoveTeardropTool(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), PCB_EDIT_FRAME::OnRunTeardropTool(), HIERARCHY_PANE::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), DIALOG_FIND::search(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), CVPCB_MAINFRAME::setupEventHandlers(), TOOLS_HOLDER::ShowChangedLanguage(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), PCB_PROPERTIES_PANEL::valueChanged(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

46{ return m_type; }

KIWAY_HOLDER::m_type

HOLDER_TYPE m_type

Definition: kiway_holder.h:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const

inlinevirtualinherited

Reimplemented in CVPCB_MAINFRAME.

Definition at line 573 of file eda_base_frame.h.

573{ return m_undoList.m_CommandsList.size(); }

EDA_BASE_FRAME::m_undoList

UNDO_REDO_CONTAINER m_undoList

Definition: eda_base_frame.h:751

References UNDO_REDO_CONTAINER::m_CommandsList, and EDA_BASE_FRAME::m_undoList.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EDA_BASE_FRAME::PushCommandToUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDITOR_CONTROL::Undo(), and EDITOR_CONDITIONS::undoFunc().

◆ GetUntranslatedAboutTitle()

const wxString & EDA_BASE_FRAME::GetUntranslatedAboutTitle ( ) const

inlineinherited

Definition at line 508 of file eda_base_frame.h.

508{ return m_aboutTitle; }

References EDA_BASE_FRAME::m_aboutTitle.

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

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 42 of file units_provider.h.

42{ return m_userUnits; }

UNITS_PROVIDER::m_userUnits

EDA_UNITS m_userUnits

Definition: units_provider.h:126

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PG_UNIT_EDITOR::CreateControls(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PROPERTIES_PANEL::extractValueAndWritability(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), PCB_EDIT_FRAME::GenFootprintsReport(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), PROPERTIES_PANEL::rebuildProperties(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PG_UNIT_EDITOR::UpdateFrame(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateUserUnits(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

◆ GetUserViewports()

std::vector< VIEWPORT3D > EDA_3D_VIEWER_FRAME::GetUserViewports ( ) const

Definition at line 447 of file eda_3d_viewer_frame.cpp.

{
 std::vector<VIEWPORT3D> ret;
 
 for( const std::pair<const wxString, VIEWPORT3D>& pair : m_viewports )
 ret.emplace_back( pair.second );
 
 return ret;
}

References m_viewports.

Referenced by ~EDA_3D_VIEWER_FRAME().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE * aCfg )

virtualinherited

Return a pointer to the window settings for this frame.

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

Parameters

aCfg	is this frame's config object

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

Definition at line 803 of file eda_base_frame.cpp.

{
 return &aCfg->m_Window;
}

References APP_SETTINGS_BASE::m_Window.

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

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )

inherited

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

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

Returns: the undecorated window size

Definition at line 1387 of file eda_base_frame.cpp.

{
#ifdef __WXGTK__
 wxSize winSize = GetSize();
 
 // GTK includes the window decorations in the normal GetSize call,
 // so we have to use a GTK-specific sizing call that returns the
 // non-decorated window size.
 if( m_ident == KICAD_MAIN_FRAME_T )
 {
 int width = 0;
 int height = 0;
 GTKDoGetSize( &width, &height );
 
 winSize.Set( width, height );
 }
#else
 wxSize winSize = GetSize();
#endif
 
 return winSize;
}

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

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

◆ handleIconizeEvent()

void EDA_3D_VIEWER_FRAME::handleIconizeEvent ( wxIconizeEvent & aEvent )

overrideprotectedvirtual

Handle a window iconize event.

Parameters

aEvent is the data for the event.

Reimplemented from EDA_BASE_FRAME.

Definition at line 333 of file eda_3d_viewer_frame.cpp.

{
 KIWAY_PLAYER::handleIconizeEvent( aEvent );
 
#if defined( KICAD_USE_3DCONNEXION )
 if( m_spaceMouse != nullptr && aEvent.IsIconized() )
 {
 m_spaceMouse->SetFocus( false );
 }
#endif
}

References EDA_BASE_FRAME::handleIconizeEvent(), m_spaceMouse, and NL_3D_VIEWER_PLUGIN::SetFocus().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )

virtualinherited

Update the UI in response to a change in the system colors.

Definition at line 1411 of file eda_base_frame.cpp.

{
 // Update the icon theme when the system theme changes and update the toolbars
 GetBitmapStore()->ThemeChanged();
 ThemeChanged();
 
 // This isn't handled by ThemeChanged()
 if( GetMenuBar() )
 {
 // For icons in menus, icon scaling & hotkeys
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
}

References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

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

staticinherited

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

enabled, checked, etc.).

Parameters

aEvent	is the wxUpdateUIEvent to be processed.
aFrame	is the frame to get the selection from
aCond	are the #UI SELECTION_CONDITIONS used

Definition at line 367 of file eda_base_frame.cpp.

{
 bool checkRes = false;
 bool enableRes = true;
 bool showRes = true;
 bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
 bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
 bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
 SELECTION& selection = aFrame->GetCurrentSelection();
 
 try
 {
 checkRes = aCond.checkCondition( selection );
 enableRes = aCond.enableCondition( selection );
 showRes = aCond.showCondition( selection );
 }
 catch( std::exception& )
 {
 // Something broke with the conditions, just skip the event.
 aEvent.Skip();
 return;
 }
 
 if( isCut || isCopy || isPaste )
 {
 wxWindow* focus = wxWindow::FindFocus();
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );
 
 if( textEntry && isCut && textEntry->CanCut() )
 enableRes = true;
 else if( textEntry && isCopy && textEntry->CanCopy() )
 enableRes = true;
 else if( textEntry && isPaste && textEntry->CanPaste() )
 enableRes = true;
 }
 
 aEvent.Enable( enableRes );
 aEvent.Show( showRes );
 
 // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
 // checked, since wxMenuItems don't want to be checked unless they actually are checkable
#if wxCHECK_VERSION( 3, 1, 5 )
 if( aEvent.IsCheckable() )
 aEvent.Check( checkRes );
#else
 bool canCheck = true;
 
 // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
 // check to see if they can be and can't just universally apply a check in this event.
 if( wxMenu* menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
 canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
 
 if( canCheck )
 aEvent.Check( checkRes );
#endif
}

References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns: true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

 {
 return m_kiway != nullptr;
 }

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )

virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 822 of file eda_base_frame.cpp.

{
 return Kiface().GetHelpFileName();
}

References KIFACE_BASE::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 Eeschema, KiCad...

◆ initExitKey()

void EDA_BASE_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 1288 of file eda_base_frame.cpp.

{
 wxAcceleratorEntry entries[1];
 entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
 wxAcceleratorTable accel( 1, entries );
 SetAcceleratorTable( accel );
}

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

Definition at line 628 of file eda_base_frame.h.

628{ return m_autoSaveRequired; }

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const

virtualinherited

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

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

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

Definition at line 1281 of file eda_base_frame.cpp.

{
 // This function should be overridden in child classes
 return false;
}

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), and EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

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

inherited

Definition at line 119 of file tools_holder.cpp.

{
 if( m_toolStack.empty() )
 return &aAction == &ACTIONS::selectionTool;
 else
 return m_toolStack.back() == aAction.GetName();
}

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

Referenced by SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )

inherited

Returns: false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). True if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 176 of file kiway_player.cpp.

{
 return !m_modal_loop;
}

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const

inlineoverridevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented from EDA_BASE_FRAME.

Definition at line 159 of file kiway_player.h.

159{ return m_modal; }

KIWAY_PLAYER::m_modal

bool m_modal

Definition: kiway_player.h:196

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T aType ) const

inlineinherited

Definition at line 200 of file eda_base_frame.h.

200{ return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable	(	const wxFileName &	aFileName,
		bool	aVerbose = `true`
	)

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

aFileName The full path and/or file name of the file to test.

aVerbose If true will show an error dialog if the file is not writable

Returns
False if aFileName cannot be written.

Definition at line 1188 of file eda_base_frame.cpp.

{
 wxString msg;
 wxFileName fn = aFileName;
 
 // Check for absence of a file path with a file name. Unfortunately KiCad
 // uses paths relative to the current project path without the ./ part which
 // confuses wxFileName. Making the file name path absolute may be less than
 // elegant but it solves the problem.
 if( fn.GetPath().IsEmpty() && fn.HasName() )
 fn.MakeAbsolute();
 
 wxCHECK_MSG( fn.IsOk(), false,
  wxT( "File name object is invalid. Bad programmer!" ) );
 wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
 wxT( "File name object path <" ) + fn.GetFullPath() +
 wxT( "> is not set. Bad programmer!" ) );
 
 if( fn.IsDir() && !fn.IsDirWritable() )
 {
 msg.Printf( _( "Insufficient permissions to folder '%s'." ), fn.GetPath() );
 }
 else if( !fn.FileExists() && !fn.IsDirWritable() )
 {
 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
 }
 else if( fn.FileExists() && !fn.IsFileWritable() )
 {
 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fn.GetFullPath() );
 }
 
 if( !msg.IsEmpty() )
 {
 if( aVerbose )
 DisplayErrorMessage( this, msg );
 
 return false;
 }
 
 return true;
}

References _, and DisplayErrorMessage().

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

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return 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 53 of file kiway_holder.h.

 {
 wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
 return *m_kiway;
 }

References KIWAY_HOLDER::m_kiway.

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS & aEvent )

protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 197 of file kiway_player.cpp.

{
 // logging support
 KiwayMailIn( aEvent ); // call the virtual, override in derived.
}

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS & aEvent )

virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented in CVPCB_MAINFRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 87 of file kiway_player.cpp.

{
 // override this in derived classes.
}

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

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent & event )

protectedinherited

An event handler called on a language menu selection.

Definition at line 204 of file kiway_player.cpp.

{
 int id = event.GetId();
 
 // tell all the KIWAY_PLAYERs about the language change.
 Kiway().SetLanguage( id );
}

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

◆ loadCommonSettings()

void EDA_3D_VIEWER_FRAME::loadCommonSettings ( )

private

Load configuration from common settings.

Definition at line 855 of file eda_3d_viewer_frame.cpp.

{
 wxCHECK_RET( m_canvas, wxT( "Cannot load settings to null canvas" ) );
 
 COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
 
 const DPI_SCALING dpi{ settings, this };
 m_canvas->SetScaleFactor( dpi.GetScaleFactor() );
 
 // TODO(JE) use all control options
 m_boardAdapter.m_MousewheelPanning = settings->m_Input.scroll_modifier_zoom != 0;
}

References m_boardAdapter, m_canvas, COMMON_SETTINGS::m_Input, BOARD_ADAPTER::m_MousewheelPanning, Pgm(), COMMON_SETTINGS::INPUT::scroll_modifier_zoom, and HIDPI_GL_CANVAS::SetScaleFactor().

Referenced by CommonSettingsChanged().

◆ LoadSettings()

void EDA_3D_VIEWER_FRAME::LoadSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 686 of file eda_3d_viewer_frame.cpp.

{
 EDA_BASE_FRAME::LoadSettings( aCfg );
 
 EDA_3D_VIEWER_SETTINGS* cfg = dynamic_cast<EDA_3D_VIEWER_SETTINGS*>( aCfg );
 wxASSERT( cfg );
 
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::LoadSettings" ) );
 
 if( cfg )
 {
 m_boardAdapter.m_Cfg = cfg;
 
 // When opening the 3D viewer, we use the OpenGL mode, never the ray tracing engine
 // because the ray tracing is very time consuming, and can be seen as not working
 // (freeze window) with large boards.
 m_boardAdapter.m_Cfg->m_Render.engine = RENDER_ENGINE::OPENGL;
 
 m_canvas->SetAnimationEnabled( cfg->m_Camera.animation_enabled );
 m_canvas->SetMovingSpeedMultiplier( cfg->m_Camera.moving_speed_multiplier );
 m_canvas->SetProjectionMode( cfg->m_Camera.projection_mode );
 }
}

References EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::animation_enabled, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, EDA_BASE_FRAME::LoadSettings(), m_boardAdapter, EDA_3D_VIEWER_SETTINGS::m_Camera, m_canvas, BOARD_ADAPTER::m_Cfg, m_logTrace, EDA_3D_VIEWER_SETTINGS::m_Render, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::moving_speed_multiplier, OPENGL, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::projection_mode, EDA_3D_CANVAS::SetAnimationEnabled(), EDA_3D_CANVAS::SetMovingSpeedMultiplier(), and EDA_3D_CANVAS::SetProjectionMode().

Referenced by CommonSettingsChanged(), and Process_Special_Functions().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS * aCfg )

inherited

Load window settings from the given settings object.

Normally called by LoadSettings() unless the window in question is a child window that* stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 711 of file eda_base_frame.cpp.

{
 LoadWindowState( aCfg->state );
 
 m_perspective = aCfg->perspective;
 m_mruPath = aCfg->mru_path;
 
 TOOLS_HOLDER::CommonSettingsChanged( false, false );
}

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

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE & aState )

virtualinherited

Load frame state info from a configuration file.

Definition at line 565 of file eda_base_frame.cpp.

{
 bool wasDefault = false;
 
 m_framePos.x = aState.pos_x;
 m_framePos.y = aState.pos_y;
 m_frameSize.x = aState.size_x;
 m_frameSize.y = aState.size_y;
 
 wxLogTrace( traceDisplayLocation, wxS( "Config position (%d, %d) with size (%d, %d)" ),
 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
 // Ensure minimum size is set if the stored config was zero-initialized
 if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
 {
 m_frameSize = defaultSize( m_ident );
 wasDefault = true;
 
 wxLogTrace( traceDisplayLocation, wxS( "Using minimum size (%d, %d)" ),
 m_frameSize.x, m_frameSize.y );
 }
 
 wxLogTrace( traceDisplayLocation, wxS( "Number of displays: %d" ), wxDisplay::GetCount() );
 
 if( aState.display >= wxDisplay::GetCount() )
 {
 wxLogTrace( traceDisplayLocation, wxS( "Previous display not found" ) );
 
 // If it isn't attached, use the first display
 // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
 const unsigned int index = 0;
 wxDisplay display( index );
 wxRect clientSize = display.GetGeometry();
 
 m_framePos = wxDefaultPosition;
 
 // Ensure the window fits on the display, since the other one could have been larger
 if( m_frameSize.x > clientSize.width )
 m_frameSize.x = clientSize.width;
 
 if( m_frameSize.y > clientSize.height )
 m_frameSize.y = clientSize.height;
 }
 else
 {
 wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
 wxPoint upperLeft( m_framePos.x, m_framePos.y );
 
 wxDisplay display( aState.display );
 wxRect clientSize = display.GetClientArea();
 
 int yLimTop = clientSize.y;
 int yLimBottom = clientSize.y + clientSize.height;
 int xLimLeft = clientSize.x;
 int xLimRight = clientSize.x + clientSize.width;
 
 if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
 upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
 upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
 upperLeft.y > yLimBottom )
 {
 m_framePos = wxDefaultPosition;
 wxLogTrace( traceDisplayLocation, wxS( "Resetting to default position" ) );
 }
 }
 
 wxLogTrace( traceDisplayLocation, wxS( "Final window position (%d, %d) with size (%d, %d)" ),
 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
 SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
 // Center the window if we reset to default
 if( m_framePos.x == -1 )
 {
 wxLogTrace( traceDisplayLocation, wxS( "Centering window" ) );
 Center();
 m_framePos = GetPosition();
 }
 
 // Record the frame sizes in an un-maximized state
 m_normalFrameSize = m_frameSize;
 m_normalFramePos = m_framePos;
 
 // Maximize if we were maximized before
 if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
 {
 wxLogTrace( traceDisplayLocation, wxS( "Maximizing window" ) );
 Maximize();
 }
 
 m_displayIndex = wxDisplay::GetFromWindow( this );
}

References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, EDA_BASE_FRAME::m_displayIndex, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString & aFileName )

inherited

Definition at line 551 of file eda_base_frame.cpp.

{
 if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
 return;
 
 const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
 
 if( state != nullptr )
 {
 LoadWindowState( state->window );
 }
}

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

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

◆ MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue	(	const EDA_ANGLE &	aValue,
		bool	aAddUnitLabel = `true`
	)

inlineinherited

Definition at line 94 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

◆ MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue	(	double	aValue,
		bool	aAddUnitLabel = `true`,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)

inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 87 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

◆ NewDisplay()

void EDA_3D_VIEWER_FRAME::NewDisplay ( bool aForceImmediateRedraw = false )

Reload and refresh (rebuild) the 3D scene.

Warning: Rebuilding the 3D scene can take a bit of time, so rebuilding the scene can be immediate, or made later, during the next 3D canvas refresh (on zoom for instance).

Parameters

aForceImmediateRedraw true to immediately rebuild the 3D scene or false to wait refresh later.

Definition at line 354 of file eda_3d_viewer_frame.cpp.

{
 ReloadRequest();
 
 // After the ReloadRequest call, the refresh often takes a bit of time,
 // and it is made here only on request.
 if( aForceImmediateRedraw )
 m_canvas->Refresh();
}

References m_canvas, and ReloadRequest().

Referenced by CommonSettingsChanged(), PCB_EDIT_FRAME::OpenProjectFiles(), Process_Special_Functions(), and refreshRender().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool aForce )

inlineinherited

Definition at line 584 of file eda_base_frame.h.

 {
 m_isNonUserClose = true;
 return Close( aForce );
 }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ OnActivate()

void EDA_3D_VIEWER_FRAME::OnActivate ( wxActivateEvent & event )

private

Definition at line 643 of file eda_3d_viewer_frame.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::OnActivate" ) );
 
 if( aEvent.GetActive() && m_canvas )
 {
 // Reload data if 3D frame shows a board,
 // because it can be changed since last frame activation
 if( m_canvas->IsReloadRequestPending() )
 m_canvas->Request_refresh();
 
 // Activates again the focus of the canvas so it will catch mouse and key events
 m_canvas->SetFocus();
 }
 
#if defined( KICAD_USE_3DCONNEXION )
 if( m_spaceMouse != nullptr )
 {
 m_spaceMouse->SetFocus( aEvent.GetActive() );
 }
#endif
 
 aEvent.Skip(); // required under wxMAC
}

References EDA_3D_CANVAS::IsReloadRequestPending(), m_canvas, m_logTrace, m_spaceMouse, EDA_3D_CANVAS::Request_refresh(), and NL_3D_VIEWER_PLUGIN::SetFocus().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent & aEvent )

protectedinherited

Handle the auto save timer event.

Definition at line 304 of file eda_base_frame.cpp.

{
 // Don't stomp on someone else's timer event.
 if( aEvent.GetId() != ID_AUTO_SAVE_TIMER )
 {
 aEvent.Skip();
 return;
 }
 
 if( !doAutoSave() )
 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
}

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::GetAutoSaveInterval(), ID_AUTO_SAVE_TIMER, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::commonInit().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent & aKeyEvent )

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 SYMBOL_VIEWER_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 324 of file eda_base_frame.cpp.

{
 wxLogTrace( kicadTraceKeyEvent, wxS( "EDA_BASE_FRAME::OnCharHook %s" ), dump( aKeyEvent ) );
 
 // Key events can be filtered here.
 // Currently no filtering is made.
 aKeyEvent.Skip();
}

References dump(), and kicadTraceKeyEvent.

◆ OnCloseWindow()

void EDA_3D_VIEWER_FRAME::OnCloseWindow ( wxCloseEvent & event )

private

Definition at line 390 of file eda_3d_viewer_frame.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::OnCloseWindow" ) );
 
 if( m_canvas )
 m_canvas->Close();
 
 Destroy();
 event.Skip( true );
}

References KIWAY_PLAYER::Destroy(), m_canvas, and m_logTrace.

◆ onDisableRayTracing()

void EDA_3D_VIEWER_FRAME::onDisableRayTracing ( wxCommandEvent & aEvent )

private

Definition at line 633 of file eda_3d_viewer_frame.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::%s disabling ray tracing." ),
 __WXFUNCTION__ );
 
 m_disable_ray_tracing = true;
 m_boardAdapter.m_Cfg->m_Render.engine = RENDER_ENGINE::OPENGL;
}

References EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, m_boardAdapter, BOARD_ADAPTER::m_Cfg, m_disable_ray_tracing, m_logTrace, EDA_3D_VIEWER_SETTINGS::m_Render, and OPENGL.

◆ OnDropFiles()

void EDA_BASE_FRAME::OnDropFiles ( wxDropFilesEvent & aEvent )

protectedvirtualinherited

Handles event fired when a file is dropped to the window.

In this base class, stores the path of files accepted. Calls DoWithAcceptedFiles() to execute actions on files.

Definition at line 1156 of file eda_base_frame.cpp.

{
 wxString* files = aEvent.GetFiles();
 
 for( int nb = 0; nb < aEvent.GetNumberOfFiles(); nb++ )
 {
 const wxFileName fn = wxFileName( files[nb] );
 wxString ext = fn.GetExt();
 
 // Alias all gerber files as GerberFileExtension
 if( IsGerberFileExtension( ext ) )
 ext = GerberFileExtension;
 
 if( m_acceptedExts.find( ext.ToStdString() ) != m_acceptedExts.end() )
 m_AcceptedFiles.emplace_back( fn );
 }
 
 DoWithAcceptedFiles();
 m_AcceptedFiles.clear();
}

References EDA_BASE_FRAME::DoWithAcceptedFiles(), GerberFileExtension, IsGerberFileExtension(), EDA_BASE_FRAME::m_acceptedExts, and EDA_BASE_FRAME::m_AcceptedFiles.

◆ onIconize()

void EDA_BASE_FRAME::onIconize ( wxIconizeEvent & aEvent )

protectedinherited

Definition at line 1437 of file eda_base_frame.cpp.

{
 // Call the handler
 handleIconizeEvent( aEvent );
 
 // Skip the event.
 aEvent.Skip();
}

References EDA_BASE_FRAME::handleIconizeEvent().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent & event )

inherited

Definition at line 987 of file eda_base_frame.cpp.

{
 void ShowAboutDialog( EDA_BASE_FRAME * aParent ); // See AboutDialog_main.cpp
 ShowAboutDialog( this );
}

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent & aEvent )

inherited

Definition at line 1363 of file eda_base_frame.cpp.

{
 // When we maximize the window, we want to save the old information
 // so that we can add it to the settings on next window load.
 // Contrary to the documentation, this event seems to be generated
 // when the window is also being unmaximized on OSX, so we only
 // capture the size information when we maximize the window when on OSX.
#ifdef __WXOSX__
 if( !IsMaximized() )
#endif
 {
 m_normalFrameSize = GetWindowSize();
 m_normalFramePos = GetPosition();
 wxLogTrace( traceDisplayLocation,
 "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
 m_normalFramePos.x, m_normalFramePos.y,
 m_normalFrameSize.x, m_normalFrameSize.y );
 }
 
 // Skip event to actually maximize the window
 aEvent.Skip();
}

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

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent & event )

inherited

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

Definition at line 334 of file eda_base_frame.cpp.

{
 if( !m_toolDispatcher )
 aEvent.Skip();
 else
 m_toolDispatcher->DispatchWxEvent( aEvent );
}

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

◆ OnModify()

void EDA_BASE_FRAME::OnModify ( )

virtualinherited

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

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PCB_BASE_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 1346 of file eda_base_frame.cpp.

{
 m_autoSaveRequired = true;
}

References EDA_BASE_FRAME::m_autoSaveRequired.

Referenced by EE_POINT_EDITOR::addCorner(), EE_INSPECTION_TOOL::ExcludeMarker(), EE_POINT_EDITOR::Main(), SCH_EDIT_FRAME::OnModify(), SYMBOL_EDIT_FRAME::OnModify(), PCB_BASE_FRAME::OnModify(), PL_EDITOR_FRAME::OnModify(), and EE_POINT_EDITOR::removeCorner().

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent & aEvent )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 189 of file eda_base_frame.h.

 {
 aEvent.Skip();
 }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent & event )

inherited

Displays the preferences and settings of all opened editors paged dialog.

Definition at line 994 of file eda_base_frame.cpp.

{
 ShowPreferences( wxEmptyString, wxEmptyString );
}

References EDA_BASE_FRAME::ShowPreferences().

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch(), and COMMON_CONTROL::OpenPreferences().

◆ onRenderEngineSelection()

void EDA_3D_VIEWER_FRAME::onRenderEngineSelection ( wxCommandEvent & event )

private

Definition at line 615 of file eda_3d_viewer_frame.cpp.

{
 RENDER_ENGINE& engine = m_boardAdapter.m_Cfg->m_Render.engine;
 RENDER_ENGINE old_engine = engine;
 
 if( old_engine == RENDER_ENGINE::OPENGL )
 engine = RENDER_ENGINE::RAYTRACING;
 else
 engine = RENDER_ENGINE::OPENGL;
 
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::OnRenderEngineSelection type %s " ),
 engine == RENDER_ENGINE::RAYTRACING ? wxT( "raytracing" ) : wxT( "realtime" ) );
 
 if( old_engine != engine )
 RenderEngineChanged();
}

References EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, m_boardAdapter, BOARD_ADAPTER::m_Cfg, m_logTrace, EDA_3D_VIEWER_SETTINGS::m_Render, OPENGL, RAYTRACING, and RenderEngineChanged().

◆ OnSetFocus()

void EDA_3D_VIEWER_FRAME::OnSetFocus ( wxFocusEvent & event )

private

Definition at line 669 of file eda_3d_viewer_frame.cpp.

{
 // Activates again the focus of the canvas so it will catch mouse and key events
 if( m_canvas )
 m_canvas->SetFocus();
 
 aEvent.Skip();
}

References m_canvas.

◆ OnSize()

void EDA_BASE_FRAME::OnSize ( wxSizeEvent & aEvent )

virtualinherited

Reimplemented in SYMBOL_VIEWER_FRAME, EDA_DRAW_FRAME, KICAD_MANAGER_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_WIZARD_FRAME.

Definition at line 533 of file eda_base_frame.cpp.

{
#ifdef __WXMAC__
 int currentDisplay = wxDisplay::GetFromWindow( this );
 
 if( m_displayIndex >= 0 && currentDisplay >= 0 && currentDisplay != m_displayIndex )
 {
 wxLogTrace( traceDisplayLocation, wxS( "OnSize: current display changed %d to %d" ),
 m_displayIndex, currentDisplay );
 m_displayIndex = currentDisplay;
 ensureWindowIsOnScreen();
 }
#endif
 
 aEvent.Skip();
}

References EDA_BASE_FRAME::ensureWindowIsOnScreen(), EDA_BASE_FRAME::m_displayIndex, and traceDisplayLocation.

Referenced by EDA_DRAW_FRAME::OnSize().

◆ OnSockRequest()

void KIWAY_PLAYER::OnSockRequest ( wxSocketEvent & evt )

inherited

Definition at line 69 of file eda_dde.cpp.

{
 size_t len;
 wxSocketBase* sock = evt.GetSocket();
 
 switch( evt.GetSocketEvent() )
 {
 case wxSOCKET_INPUT:
 sock->Read( client_ipc_buffer, 1 );
 
 if( sock->LastCount() == 0 )
 break; // No data, occurs on opening connection
 
 sock->Read( client_ipc_buffer + 1, IPC_BUF_SIZE - 2 );
 len = 1 + sock->LastCount();
 client_ipc_buffer[len] = 0;
 ExecuteRemoteCommand( client_ipc_buffer );
 break;
 
 case wxSOCKET_LOST:
 return;
 break;
 
 default:
 wxPrintf( wxT( "EDA_DRAW_FRAME::OnSockRequest() error: Invalid event !" ) );
 break;
 }
}

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

◆ OnSockRequestServer()

void KIWAY_PLAYER::OnSockRequestServer ( wxSocketEvent & evt )

inherited

Definition at line 99 of file eda_dde.cpp.

{
 wxSocketBase* socket;
 wxSocketServer* server = (wxSocketServer*) evt.GetSocket();
 
 socket = server->Accept();
 
 if( socket == nullptr )
 return;
 
 m_sockets.push_back( socket );
 
 socket->Notify( true );
 socket->SetEventHandler( *this, ID_EDA_SOCKET_EVENT );
 socket->SetNotify( wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG );
}

References ID_EDA_SOCKET_EVENT, and KIWAY_PLAYER::m_sockets.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent & aEvent )

protectedinherited

Definition at line 1427 of file eda_base_frame.cpp.

{
 // Call the handler to update the colors used in the frame
 HandleSystemColorChange();
 
 // Skip the change event to ensure the rest of the window controls get it
 aEvent.Skip();
}

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ onUpdateViewportsCb()

void EDA_3D_VIEWER_FRAME::onUpdateViewportsCb ( wxUpdateUIEvent & aEvent )

private

Definition at line 598 of file eda_3d_viewer_frame.cpp.

{
 int count = m_cbViewports->GetCount();
 int index = m_cbViewports->GetSelection();
 
 if( index >= 0 && index < count - 3 )
 {
 VIEWPORT3D* viewport = static_cast<VIEWPORT3D*>( m_cbViewports->GetClientData( index ) );
 
 wxCHECK( viewport, /* void */ );
 
 if( m_currentCamera.GetViewMatrix() != viewport->matrix )
 m_cbViewports->SetSelection( -1 );
 }
}

References CAMERA::GetViewMatrix(), m_cbViewports, m_currentCamera, and VIEWPORT3D::matrix.

Referenced by EVT_TOOL_RANGE(), and ~EDA_3D_VIEWER_FRAME().

◆ onViewportChanged()

void EDA_3D_VIEWER_FRAME::onViewportChanged ( wxCommandEvent & aEvent )

private

Definition at line 504 of file eda_3d_viewer_frame.cpp.

{
 int count = m_cbViewports->GetCount();
 int index = m_cbViewports->GetSelection();
 
 if( index >= 0 && index < count - 3 /* separator */ )
 {
 VIEWPORT3D* viewport = static_cast<VIEWPORT3D*>( m_cbViewports->GetClientData( index ) );
 
 wxCHECK( viewport, /* void */ );
 
 applyViewport( viewport->name );
 }
 else if( index == count - 2 )
 {
 // Save current state to new preset
 wxString name;
 
 wxTextEntryDialog dlg( this, _( "Viewport name:" ), _( "Save Viewport" ), name );
 
 if( dlg.ShowModal() != wxID_OK )
 {
 if( m_lastSelectedViewport )
 m_cbViewports->SetStringSelection( m_lastSelectedViewport->name );
 else
 m_cbViewports->SetSelection( -1 );
 
 return;
 }
 
 name = dlg.GetValue();
 bool exists = m_viewports.count( name );
 
 if( !exists )
 {
 m_viewports[name] = VIEWPORT3D( name, m_currentCamera.GetViewMatrix() );
 
 index = m_cbViewports->Insert( name, index-1, static_cast<void*>( &m_viewports[name] ) );
 }
 else
 {
 index = m_cbViewports->FindString( name );
 m_viewports[name].matrix = m_currentCamera.GetViewMatrix();
 m_viewportMRU.Remove( name );
 }
 
 m_cbViewports->SetSelection( index );
 m_viewportMRU.Insert( name, 0 );
 
 return;
 }
 else if( index == count - 1 )
 {
 // Delete an existing viewport
 wxArrayString headers;
 std::vector<wxArrayString> items;
 
 headers.Add( _( "Viewports" ) );
 
 for( std::pair<const wxString, VIEWPORT3D>& pair : m_viewports )
 {
 wxArrayString item;
 item.Add( pair.first );
 items.emplace_back( item );
 }
 
 EDA_LIST_DIALOG dlg( this, _( "Delete Viewport" ), headers, items );
 dlg.SetListLabel( _( "Select viewport:" ) );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 wxString viewportName = dlg.GetTextSelection();
 int idx = m_cbViewports->FindString( viewportName );
 
 if( idx != wxNOT_FOUND )
 {
 m_viewports.erase( viewportName );
 m_cbViewports->Delete( idx );
 m_viewportMRU.Remove( viewportName );
 }
 }
 
 if( m_lastSelectedViewport )
 m_cbViewports->SetStringSelection( m_lastSelectedViewport->name );
 else
 m_cbViewports->SetSelection( -1 );
 
 return;
 }
 
 passOnFocus();
}

References _, applyViewport(), EDA_LIST_DIALOG::GetTextSelection(), CAMERA::GetViewMatrix(), m_cbViewports, m_currentCamera, m_lastSelectedViewport, m_viewportMRU, m_viewports, name, VIEWPORT3D::name, passOnFocus(), and EDA_LIST_DIALOG::SetListLabel().

Referenced by EVT_TOOL_RANGE(), and ~EDA_3D_VIEWER_FRAME().

◆ OpenProjectFiles()

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

inlinevirtualinherited

Open 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 implementer 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

aFileList	includes 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.
aCtl	is a set of bit flags ORed together from the set of KICTL_* #defined above.

Returns: true if all requested files were opened OK, else false.

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

Definition at line 118 of file kiway_player.h.

 {
 // overload me for your wxFrame type.
 
 // Any overload should probably do this also:
 // Prj().MaybeLoadProjectSettings();
 
 // Then update the window title.
 
 return false;
 }

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

◆ Parent()

PCB_BASE_FRAME * EDA_3D_VIEWER_FRAME::Parent ( ) const

inline

Definition at line 72 of file eda_3d_viewer_frame.h.

72{ return (PCB_BASE_FRAME*)GetParent(); }

PCB_BASE_FRAME

Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

Definition: pcb_base_frame.h:70

Referenced by GetBoard(), and takeScreenshot().

◆ passOnFocus()

void EDA_3D_VIEWER_FRAME::passOnFocus ( )

private

Definition at line 679 of file eda_3d_viewer_frame.cpp.

{
 if( m_canvas )
 m_canvas->SetFocus();
}

References m_canvas.

Referenced by onViewportChanged().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )

virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1340 of file eda_base_frame.cpp.

{
 return m_redoList.PopCommand();
}

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

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), and PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList().

◆ PopCommandFromUndoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromUndoList ( )

virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1334 of file eda_base_frame.cpp.

{
 return m_undoList.PopCommand();
}

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

Referenced by PCB_BASE_EDIT_FRAME::AppendCopyToUndoList(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT & aEvent )

virtualinherited

Pops a tool from the stack.

Parameters

aEvent The event that started the tool that was pushed to the stack.

Definition at line 65 of file tools_holder.cpp.

{
 const std::string& actionName = aEvent.getCommandStr();
 
 wxASSERT_MSG( !aEvent.getCommandStr().empty(), wxS( "Popped Empty Tool Name!" ) );
 
 // Push/pop events can get out of order (such as when they're generated by the Simulator
 // frame but not processed until the mouse is back in the Schematic frame), so make sure
 // we're popping the right stack frame.
 
 for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
 {
 if( m_toolStack[ i ] == actionName )
 {
 m_toolStack.erase( m_toolStack.begin() + i );
 
 // If there's something underneath us, and it's now the top of the stack, then
 // re-activate it
 if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
 {
 std::string back = m_toolStack[ i ];
 TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( back );
 
 if( action )
 {
 // Pop the action as running it will push it back onto the stack
 m_toolStack.pop_back();
 
 TOOL_EVENT evt = action->MakeEvent();
 evt.SetHasPosition( false );
 evt.SetReactivate( true );
 GetToolManager()->PostEvent( evt );
 }
 }
 else
 DisplayToolMsg( ACTIONS::selectionTool.GetLabel() );
 
 return;
 }
 }
 
 wxASSERT_MSG( false, wxS( "Popped a Tool Not on the Tool Stack!" ) );
}

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

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString & text )

inherited

Definition at line 828 of file eda_base_frame.cpp.

{
 SetStatusText( text );
}

References text.

Referenced by KICAD_MANAGER_FRAME::OnUnarchiveFiles().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

{
 return Kiway().Prj();
}

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

◆ Process_Special_Functions()

void EDA_3D_VIEWER_FRAME::Process_Special_Functions ( wxCommandEvent & event )

private

Definition at line 402 of file eda_3d_viewer_frame.cpp.

{
 int id = event.GetId();
 bool isChecked = event.IsChecked();
 
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::Process_Special_Functions id %d "
 "isChecked %d" ),
 id,
 isChecked );
 
 if( m_canvas == nullptr )
 return;
 
 switch( id )
 {
 case ID_RELOAD3D_BOARD:
 NewDisplay( true );
 break;
 
 case ID_TOOL_SCREENCOPY_TOCLIBBOARD:
 case ID_MENU_SCREENCOPY_PNG:
 case ID_MENU_SCREENCOPY_JPEG:
 takeScreenshot( event );
 return;
 
 case ID_MENU3D_RESET_DEFAULTS:
 {
 auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
 cfg->ResetToDefaults();
 LoadSettings( cfg );
 
 // Tell canvas that we (may have) changed the render engine
 RenderEngineChanged();
 
 NewDisplay( true );
 }
 return;
 
 default:
 wxFAIL_MSG( wxT( "Invalid event in EDA_3D_VIEWER_FRAME::Process_Special_Functions()" ) );
 return;
 }
}

References ID_MENU3D_RESET_DEFAULTS, ID_MENU_SCREENCOPY_JPEG, ID_MENU_SCREENCOPY_PNG, ID_RELOAD3D_BOARD, ID_TOOL_SCREENCOPY_TOCLIBBOARD, LoadSettings(), m_canvas, m_logTrace, NewDisplay(), Pgm(), RenderEngineChanged(), JSON_SETTINGS::ResetToDefaults(), and takeScreenshot().

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

{
#ifdef __WXMAC__
 // Apple in its infinite wisdom will raise a disabled window before even passing
 // us the event, so we have no way to stop it. Instead, we have to catch an
 // improperly ordered disabled window and quasi-modal dialog here and reorder
 // them.
 if( !IsEnabled() && IsActive() )
 {
 wxWindow* dlg = findQuasiModalDialog();
 if( dlg )
 dlg->Raise();
 }
#endif
 
 if( !wxFrame::ProcessEvent( aEvent ) )
 return false;
 
 if( Pgm().m_Quitting )
 return true;
 
 if( !m_isClosing && m_supportsAutoSave && IsShown() && IsActive()
 && m_autoSavePending != isAutoSaveRequired()
 && GetAutoSaveInterval() > 0 )
 {
 if( !m_autoSavePending )
 {
 wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
 m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
 m_autoSavePending = true;
 }
 else if( m_autoSaveTimer->IsRunning() )
 {
 wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
 m_autoSaveTimer->Stop();
 m_autoSavePending = false;
 }
 }
 
 return true;
}

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::GetAutoSaveInterval(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSavePending, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_isClosing, EDA_BASE_FRAME::m_supportsAutoSave, Pgm(), and traceAutoSave.

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

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )

inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in KICAD_MANAGER_FRAME, and PCB_EDIT_FRAME.

Definition at line 504 of file eda_base_frame.h.

504{}

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to redo in the redo list.

Delete the very old commands when the max count of redo commands is reached.

Definition at line 1319 of file eda_base_frame.cpp.

{
 m_redoList.PushCommand( aNewitem );
 
 // Delete the extra items, if count max reached
 if( m_undoRedoCountMax > 0 )
 {
 int extraitems = GetRedoCommandCount() - m_undoRedoCountMax;
 
 if( extraitems > 0 )
 ClearUndoORRedoList( REDO_LIST, extraitems );
 }
}

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

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST * aItem )

virtualinherited

Add a command to undo in the undo list.

Delete the very old commands when the max count of undo commands is reached.

Definition at line 1304 of file eda_base_frame.cpp.

{
 m_undoList.PushCommand( aNewitem );
 
 // Delete the extra items, if count max reached
 if( m_undoRedoCountMax > 0 )
 {
 int extraitems = GetUndoCommandCount() - m_undoRedoCountMax;
 
 if( extraitems > 0 )
 ClearUndoORRedoList( UNDO_LIST, extraitems );
 }
}

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

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_EDIT_FRAME::RunActionPlugin(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::StartNewUndo(), and SCH_EDITOR_CONTROL::Undo().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT & aEvent )

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.

Pushes a tool to the stack.

Parameters

aEvent The event that is starting the tool to be pushed to the stack.

Definition at line 44 of file tools_holder.cpp.

{
 const std::string& actionName = aEvent.getCommandStr();
 
 wxASSERT_MSG( !actionName.empty(), wxS( "Pushed Empty Tool Name!" ) );
 
 m_toolStack.push_back( actionName );
 
 // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
 if( m_toolStack.size() > 3 )
 m_toolStack.erase( m_toolStack.begin() );
 
 TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
 
 if( action )
 DisplayToolMsg( action->GetLabel() );
 else
 DisplayToolMsg( actionName );
}

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

Referenced by EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ ReCreateMainToolbar()

void EDA_3D_VIEWER_FRAME::ReCreateMainToolbar ( )

private

Definition at line 38 of file 3d_toolbar.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::ReCreateMainToolbar" ) );
 
 wxWindowUpdateLocker dummy( this );
 
 if( m_mainToolBar )
 {
 m_mainToolBar->ClearToolbar();
 }
 else
 {
 m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
 KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_HORIZONTAL );
 m_mainToolBar->SetAuiManager( &m_auimgr );
 }
 
 // Show the hotkey to open the windows list selector:
 wxString keyName = KeyNameFromKeyCode( VIEWPORT_SWITCH_KEY );
 
 m_viewportsLabel = new wxStaticText( m_mainToolBar, wxID_ANY,
 wxString::Format( _( "Viewports (%s+Tab):" ), keyName ) );
 m_viewportsLabel->Wrap( -1 );
 
 m_cbViewports = new wxChoice( m_mainToolBar, wxID_ANY );
 
 for( std::pair<const wxString, VIEWPORT3D>& pair : m_viewports )
 m_cbViewports->Append( pair.first, static_cast<void*>( &pair.second ) );
 
 m_cbViewports->Append( wxT( "---" ) );
 m_cbViewports->Append( _( "Save viewport..." ) );
 m_cbViewports->Append( _( "Delete viewport..." ) );
 
 m_cbViewports->SetToolTip( wxString::Format( _( "Save and restore view orientation and zoom.\n"
 "Use %s+Tab to activate selector.\n"
 "Successive Tabs while holding %s down will "
 "cycle through viewports in the popup." ),
 keyName, keyName ) );
 
 m_cbViewports->SetSelection( m_cbViewports->GetCount() - 3 );
 
 m_lastSelectedViewport = nullptr;
 
 // Set up toolbar
 m_mainToolBar->AddTool( ID_RELOAD3D_BOARD, wxEmptyString,
 KiScaledBitmap( BITMAPS::import3d, this ), _( "Reload board" ) );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->AddTool( ID_TOOL_SCREENCOPY_TOCLIBBOARD, wxEmptyString,
 KiScaledBitmap( BITMAPS::copy, this ),
 _( "Copy 3D image to clipboard" ) );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->AddTool( ID_RENDER_CURRENT_VIEW, wxEmptyString,
 KiScaledBitmap( BITMAPS::render_mode, this ),
 _( "Render current view using Raytracing" ), wxITEM_CHECK );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( ACTIONS::zoomRedraw );
 m_mainToolBar->Add( ACTIONS::zoomInCenter );
 m_mainToolBar->Add( ACTIONS::zoomOutCenter );
 m_mainToolBar->Add( ACTIONS::zoomFitScreen );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EDA_3D_ACTIONS::rotateXCW );
 m_mainToolBar->Add( EDA_3D_ACTIONS::rotateXCCW );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EDA_3D_ACTIONS::rotateYCW );
 m_mainToolBar->Add( EDA_3D_ACTIONS::rotateYCCW );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EDA_3D_ACTIONS::rotateZCW );
 m_mainToolBar->Add( EDA_3D_ACTIONS::rotateZCCW );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EDA_3D_ACTIONS::flipView );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EDA_3D_ACTIONS::moveLeft );
 m_mainToolBar->Add( EDA_3D_ACTIONS::moveRight );
 m_mainToolBar->Add( EDA_3D_ACTIONS::moveUp );
 m_mainToolBar->Add( EDA_3D_ACTIONS::moveDown );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EDA_3D_ACTIONS::toggleOrtho, ACTION_TOOLBAR::TOGGLE );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->Add( EDA_3D_ACTIONS::showTHT, ACTION_TOOLBAR::TOGGLE );
 m_mainToolBar->Add( EDA_3D_ACTIONS::showSMD, ACTION_TOOLBAR::TOGGLE );
 m_mainToolBar->Add( EDA_3D_ACTIONS::showVirtual, ACTION_TOOLBAR::TOGGLE );
 m_mainToolBar->Add( EDA_3D_ACTIONS::showNotInPosFile, ACTION_TOOLBAR::TOGGLE );
 
 m_mainToolBar->AddScaledSeparator( this );
 m_mainToolBar->AddControl( m_viewportsLabel );
 m_mainToolBar->AddControl( m_cbViewports );
 
 m_mainToolBar->KiRealize();
}

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::ClearToolbar(), copy, dummy, EDA_3D_ACTIONS::flipView, Format(), ID_H_TOOLBAR, ID_RELOAD3D_BOARD, ID_RENDER_CURRENT_VIEW, ID_TOOL_SCREENCOPY_TOCLIBBOARD, import3d, KeyNameFromKeyCode(), EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), KiScaledBitmap(), EDA_BASE_FRAME::m_auimgr, m_cbViewports, m_lastSelectedViewport, m_logTrace, m_mainToolBar, m_viewports, m_viewportsLabel, EDA_3D_ACTIONS::moveDown, EDA_3D_ACTIONS::moveLeft, EDA_3D_ACTIONS::moveRight, EDA_3D_ACTIONS::moveUp, render_mode, EDA_3D_ACTIONS::rotateXCCW, EDA_3D_ACTIONS::rotateXCW, EDA_3D_ACTIONS::rotateYCCW, EDA_3D_ACTIONS::rotateYCW, EDA_3D_ACTIONS::rotateZCCW, EDA_3D_ACTIONS::rotateZCW, ACTION_TOOLBAR::SetAuiManager(), EDA_3D_ACTIONS::showNotInPosFile, EDA_3D_ACTIONS::showSMD, EDA_3D_ACTIONS::showTHT, EDA_3D_ACTIONS::showVirtual, ACTION_TOOLBAR::TOGGLE, EDA_3D_ACTIONS::toggleOrtho, VIEWPORT_SWITCH_KEY, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, and ACTIONS::zoomRedraw.

Referenced by CommonSettingsChanged().

◆ ReCreateMenuBar()

void EDA_BASE_FRAME::ReCreateMenuBar ( )

inherited

Recreates the menu bar.

Needed when the language or icons are changed

As of wxWidgets 3.2, recreating the menubar from within an event handler of that menubar will result in memory corruption on macOS. In order to minimize the chance of programmer error causing regressions here, we always wrap calls to ReCreateMenuBar in a CallAfter to ensure that they do not occur within the same event handling call stack.

Definition at line 446 of file eda_base_frame.cpp.

{
 CallAfter( [=]()
 {
 doReCreateMenuBar();
 } );
}

References EDA_BASE_FRAME::doReCreateMenuBar().

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), EDA_BASE_FRAME::ClearFileHistory(), EDA_BASE_FRAME::CommonSettingsChanged(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::GetFileFromHistory(), EDA_BASE_FRAME::HandleSystemColorChange(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCRIPTING_TOOL::reloadPlugins(), EDA_BASE_FRAME::ShowChangedLanguage(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and EDA_BASE_FRAME::UpdateFileHistory().

◆ Redraw()

void EDA_3D_VIEWER_FRAME::Redraw ( )

Definition at line 365 of file eda_3d_viewer_frame.cpp.

{
 // Only update in OpenGL for an interactive interaction
 if( m_boardAdapter.m_Cfg->m_Render.engine == RENDER_ENGINE::OPENGL )
 m_canvas->Request_refresh( true );
}

References EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, m_boardAdapter, m_canvas, BOARD_ADAPTER::m_Cfg, EDA_3D_VIEWER_SETTINGS::m_Render, OPENGL, and EDA_3D_CANVAS::Request_refresh().

Referenced by PCB_BASE_FRAME::Update3DView().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 165 of file tools_holder.h.

165{ }

Referenced by ACTION_TOOLBAR::onPaletteEvent(), ACTION_TOOLBAR::onToolEvent(), and TOOL_MANAGER::ProcessEvent().

◆ refreshRender()

void EDA_3D_VIEWER_FRAME::refreshRender ( )

private

Definition at line 373 of file eda_3d_viewer_frame.cpp.

{
 if( m_boardAdapter.m_Cfg->m_Render.engine == RENDER_ENGINE::OPENGL )
 m_canvas->Request_refresh();
 else
 NewDisplay( true );
}

References EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, m_boardAdapter, m_canvas, BOARD_ADAPTER::m_Cfg, EDA_3D_VIEWER_SETTINGS::m_Render, NewDisplay(), OPENGL, and EDA_3D_CANVAS::Request_refresh().

◆ RegisterUIUpdateHandler() [1/2]

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

inlinevirtualinherited

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

Parameters

aAction	is the action to register.
aConditions	are the UI conditions to use for the control states.

Definition at line 63 of file tools_holder.h.

 {
 RegisterUIUpdateHandler( aAction.GetUIId(), aConditions );
 }

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::RegisterUIUpdateHandler().

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

◆ RegisterUIUpdateHandler() [2/2]

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

overridevirtualinherited

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

Parameters

aID	is the control ID to register the handler for
aConditions	are the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 343 of file eda_base_frame.cpp.

{
 UIUpdateHandler evtFunc = std::bind( &EDA_BASE_FRAME::HandleUpdateUIEvent,
 std::placeholders::_1,
 this,
 aConditions );
 
 m_uiUpdateMap[aID] = evtFunc;
 
 Bind( wxEVT_UPDATE_UI, evtFunc, aID );
}

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

Referenced by SCH_EDIT_FRAME::doReCreateMenuBar(), GERBVIEW_FRAME::doReCreateMenuBar(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PL_EDITOR_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), EDA_BASE_FRAME::setupUIConditions(), setupUIConditions(), and KICAD_MANAGER_FRAME::setupUIConditions().

◆ ReloadRequest()

void EDA_3D_VIEWER_FRAME::ReloadRequest ( )

Request reloading the 3D view.

However the request will be executed only when the 3D canvas is refreshed. It allows one to prepare changes and request for 3D rebuild only when all changes are committed. This is made because the 3D rebuild can take a long time, and this rebuild cannot always made after each change, for calculation time reason.

Definition at line 346 of file eda_3d_viewer_frame.cpp.

{
 // This will schedule a request to load later
 if( m_canvas )
 m_canvas->ReloadRequest( GetBoard(), Prj().Get3DCacheManager() );
}

References GetBoard(), m_canvas, KIWAY_HOLDER::Prj(), and EDA_3D_CANVAS::ReloadRequest().

Referenced by NewDisplay(), and PCB_BASE_FRAME::Update3DView().

◆ RenderEngineChanged()

void EDA_3D_VIEWER_FRAME::RenderEngineChanged ( )

private

RenderEngineChanged - Update toolbar icon and call canvas RenderEngineChanged.

Definition at line 846 of file eda_3d_viewer_frame.cpp.

{
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::RenderEngineChanged()" ) );
 
 if( m_canvas )
 m_canvas->RenderEngineChanged();
}

References m_canvas, m_logTrace, and EDA_3D_CANVAS::RenderEngineChanged().

Referenced by onRenderEngineSelection(), and Process_Special_Functions().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )

inlinevirtualinherited

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

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

Parameters

aAskForSave true to open a dialog before saving the settings.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 364 of file eda_base_frame.h.

364{};

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ SaveSettings()

void EDA_3D_VIEWER_FRAME::SaveSettings ( APP_SETTINGS_BASE * aCfg )

overridevirtual

Save common frame parameters to a configuration data file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 711 of file eda_3d_viewer_frame.cpp.

{
 auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
 
 EDA_BASE_FRAME::SaveSettings( cfg );
 
 wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::SaveSettings" ) );
 
 wxLogTrace( m_logTrace, m_boardAdapter.m_Cfg->m_Render.engine == RENDER_ENGINE::RAYTRACING ?
 wxT( "EDA_3D_VIEWER_FRAME::SaveSettings render setting Ray Trace" )
 :
 wxT( "EDA_3D_VIEWER_FRAME::SaveSettings render setting OpenGL" ) );
 
 if( cfg )
 {
 cfg->m_Camera.animation_enabled = m_canvas->GetAnimationEnabled();
 cfg->m_Camera.moving_speed_multiplier = m_canvas->GetMovingSpeedMultiplier();
 cfg->m_Camera.projection_mode = m_canvas->GetProjectionMode();
 
 if( EDA_3D_CONTROLLER* ctrlTool = GetToolManager()->GetTool<EDA_3D_CONTROLLER>() )
 cfg->m_Camera.rotation_increment = ctrlTool->GetRotationIncrement();
 }
}

References EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, EDA_3D_CANVAS::GetAnimationEnabled(), EDA_3D_CANVAS::GetMovingSpeedMultiplier(), EDA_3D_CANVAS::GetProjectionMode(), TOOLS_HOLDER::GetToolManager(), m_boardAdapter, m_canvas, BOARD_ADAPTER::m_Cfg, m_logTrace, EDA_3D_VIEWER_SETTINGS::m_Render, Pgm(), RAYTRACING, and EDA_BASE_FRAME::SaveSettings().

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS * aCfg )

inherited

Save window settings to the given settings object.

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

Definition at line 722 of file eda_base_frame.cpp.

{
 if( IsIconized() )
 return;
 
 // If the window is maximized, we use the saved window size from before it was maximized
 if( IsMaximized() )
 {
 m_framePos = m_normalFramePos;
 m_frameSize = m_normalFrameSize;
 }
 else
 {
 m_frameSize = GetWindowSize();
 m_framePos = GetPosition();
 }
 
 aCfg->state.pos_x = m_framePos.x;
 aCfg->state.pos_y = m_framePos.y;
 aCfg->state.size_x = m_frameSize.x;
 aCfg->state.size_y = m_frameSize.y;
 aCfg->state.maximized = IsMaximized();
 aCfg->state.display = wxDisplay::GetFromWindow( this );
 
 wxLogTrace( traceDisplayLocation, wxS( "Saving window maximized: %s" ),
 IsMaximized() ? wxS( "true" ) : wxS( "false" ) );
 wxLogTrace( traceDisplayLocation, wxS( "Saving config position (%d, %d) with size (%d, %d)" ),
 m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
 
 // Once this is fully implemented, wxAuiManager will be used to maintain
 // the persistence of the main frame and all it's managed windows and
 // all of the legacy frame persistence position code can be removed.
 aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
 
 aCfg->mru_path = m_mruPath;
}

References WINDOW_STATE::display, EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SetKiway()

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

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from #KIFACE::CreateWindow().

Definition at line 43 of file kiway_holder.cpp.

{
#if defined(DEBUG)
 // offer a trap point for debugging most any window
 wxASSERT( aDest );
 if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
 {
  int breakhere=1;
 ignore_unused( breakhere );
 }
#endif
 
 ignore_unused( aDest );
 
 m_kiway = aKiway;
}

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetModal()

void KIWAY_PLAYER::SetModal ( bool aIsModal )

inlineinherited

Definition at line 160 of file kiway_player.h.

160{ m_modal = aIsModal; }

References KIWAY_PLAYER::m_modal.

Referenced by SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ SetMruPath()

void EDA_BASE_FRAME::SetMruPath ( const wxString & aPath )

inlineinherited

Definition at line 420 of file eda_base_frame.h.

420{ m_mruPath = aPath; }

References EDA_BASE_FRAME::m_mruPath.

Referenced by AskLoadBoardFileName(), GERBVIEW_CONTROL::ExportToPcbnew(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), EDA_DRAW_FRAME::LibraryFileBrowser(), and KICAD_MANAGER_FRAME::LoadProject().

◆ setupUIConditions()

void EDA_3D_VIEWER_FRAME::setupUIConditions ( )

overrideprotectedvirtual

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 218 of file eda_3d_viewer_frame.cpp.

{
 EDA_BASE_FRAME::setupUIConditions();
 
 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
 EDA_3D_CONDITIONS cond( &m_boardAdapter );
 
// Helper to define check conditions
#define GridSizeCheck( x ) ACTION_CONDITIONS().Check( cond.GridSize( x ) )
 
 auto raytracing =
 [this]( const SELECTION& aSel )
 {
 return m_boardAdapter.m_Cfg->m_Render.engine != RENDER_ENGINE::OPENGL;
 };
 auto showTH =
 [this]( const SELECTION& aSel )
 {
 return m_boardAdapter.m_Cfg->m_Render.show_footprints_normal;
 };
 auto showSMD =
 [this]( const SELECTION& aSel )
 {
 return m_boardAdapter.m_Cfg->m_Render.show_footprints_insert;
 };
 auto showVirtual =
 [this]( const SELECTION& aSel )
 {
 return m_boardAdapter.m_Cfg->m_Render.show_footprints_virtual;
 };
 auto show_NotInPosfile =
 [this]( const SELECTION& aSel )
 {
 return m_boardAdapter.m_Cfg->m_Render.show_footprints_not_in_posfile;
 };
 auto showBBoxes =
 [this]( const SELECTION& aSel )
 {
 return m_boardAdapter.m_Cfg->m_Render.opengl_show_model_bbox;
 };
 auto showAxes =
 [this]( const SELECTION& aSel )
 {
 return m_boardAdapter.m_Cfg->m_Render.show_axis;
 };
 auto ortho =
 [this]( const SELECTION& )
 {
 return m_currentCamera.GetProjection() == PROJECTION_TYPE::ORTHO;
 };
 
 RegisterUIUpdateHandler( ID_RENDER_CURRENT_VIEW, ACTION_CONDITIONS().Check( raytracing ) );
 
 mgr->SetConditions( EDA_3D_ACTIONS::showTHT, ACTION_CONDITIONS().Check( showTH ) );
 mgr->SetConditions( EDA_3D_ACTIONS::showSMD, ACTION_CONDITIONS().Check( showSMD ) );
 mgr->SetConditions( EDA_3D_ACTIONS::showVirtual, ACTION_CONDITIONS().Check( showVirtual ) );
 mgr->SetConditions( EDA_3D_ACTIONS::showNotInPosFile, ACTION_CONDITIONS().Check( show_NotInPosfile ) );
 
 
 mgr->SetConditions( EDA_3D_ACTIONS::showBBoxes, ACTION_CONDITIONS().Check( showBBoxes ) );
 mgr->SetConditions( EDA_3D_ACTIONS::showAxis, ACTION_CONDITIONS().Check( showAxes ) );
 
 mgr->SetConditions( EDA_3D_ACTIONS::noGrid, GridSizeCheck( GRID3D_TYPE::NONE ) );
 mgr->SetConditions( EDA_3D_ACTIONS::show10mmGrid, GridSizeCheck( GRID3D_TYPE::GRID_10MM ) );
 mgr->SetConditions( EDA_3D_ACTIONS::show5mmGrid, GridSizeCheck( GRID3D_TYPE::GRID_5MM ) );
 mgr->SetConditions( EDA_3D_ACTIONS::show2_5mmGrid, GridSizeCheck( GRID3D_TYPE::GRID_2P5MM ) );
 mgr->SetConditions( EDA_3D_ACTIONS::show1mmGrid, GridSizeCheck( GRID3D_TYPE::GRID_1MM ) );
 mgr->SetConditions( EDA_3D_ACTIONS::toggleOrtho, ACTION_CONDITIONS().Check( ortho ) );
 
#undef GridSizeCheck
}

◆ SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 43 of file units_provider.h.

43{ m_userUnits = aUnits; }

References UNITS_PROVIDER::m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), EDA_DRAW_FRAME::LoadSettings(), DRC_TEST_PROVIDER::RunTests(), DRC_ENGINE::RunTests(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ SetUserViewports()

void EDA_3D_VIEWER_FRAME::SetUserViewports ( std::vector< VIEWPORT3D > & aViewportList )

Definition at line 458 of file eda_3d_viewer_frame.cpp.

{
 m_viewports.clear();
 
 for( const VIEWPORT3D& viewport : aViewportList )
 {
 if( m_viewports.count( viewport.name ) )
 continue;
 
 m_viewports[viewport.name] = viewport;
 
 m_viewportMRU.Add( viewport.name );
 }
}

References m_viewportMRU, and m_viewports.

◆ ShowChangedLanguage()

void EDA_BASE_FRAME::ShowChangedLanguage ( )

overridevirtualinherited

Redraw the menus and what not in current language.

Reimplemented from TOOLS_HOLDER.

Reimplemented in EDA_DRAW_FRAME, PCB_BASE_FRAME, KICAD_MANAGER_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 482 of file eda_base_frame.cpp.

{
 TOOLS_HOLDER::ShowChangedLanguage();
 
 if( GetMenuBar() )
 {
 ReCreateMenuBar();
 GetMenuBar()->Refresh();
 }
}

References EDA_BASE_FRAME::ReCreateMenuBar(), and TOOLS_HOLDER::ShowChangedLanguage().

Referenced by KIWAY::SetLanguage(), CVPCB_MAINFRAME::ShowChangedLanguage(), EDA_DRAW_FRAME::ShowChangedLanguage(), and KICAD_MANAGER_FRAME::ShowChangedLanguage().

◆ ShowInfoBarError() [1/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton,
		std::function< void(void)>	aCallback
	)

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

This version accepts a callback which will be called when the infobar is dismissed (either as a result of user action or a timeout). This can be useful when the caller wants to make other decorations in the canvas to highlight the error.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.
aCallback	a callback to be called when the infobar is dismissed.

Definition at line 874 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();
 
 if( aShowCloseButton )
 m_infoBar->AddCloseButton();
 
 if( aCallback )
 m_infoBar->SetCallback( aCallback );
 
 GetInfoBar()->ShowMessageFor( aErrorMsg, 6000, wxICON_ERROR );
}

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), WX_INFOBAR::SetCallback(), and WX_INFOBAR::ShowMessageFor().

◆ ShowInfoBarError() [2/2]

void EDA_BASE_FRAME::ShowInfoBarError	(	const wxString &	aErrorMsg,
		bool	aShowCloseButton = `false`,
		WX_INFOBAR::MESSAGE_TYPE	aType = `WX_INFOBAR::MESSAGE_TYPE::GENERIC`
	)

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 862 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();
 
 if( aShowCloseButton )
 m_infoBar->AddCloseButton();
 
 GetInfoBar()->ShowMessageFor( aErrorMsg, 8000, wxICON_ERROR, aType );
}

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), MICROWAVE_TOOL::createInductorBetween(), PCB_BASE_EDIT_FRAME::createNewLibrary(), MICROWAVE_TOOL::createPolygonShape(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_NAVIGATE_TOOL::HypertextCommand(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), ROUTER_TOOL::prepareInteractive(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields().

◆ ShowInfoBarMsg()

void EDA_BASE_FRAME::ShowInfoBarMsg	(	const wxString &	aMsg,
		bool	aShowCloseButton = `false`
	)

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 900 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();
 
 if( aShowCloseButton )
 m_infoBar->AddCloseButton();
 
 GetInfoBar()->ShowMessageFor( aMsg, 8000, wxICON_INFORMATION );
}

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), EDIT_TOOL::FilletTracks(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), LENGTH_TUNER_TOOL::performTuning(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_FIND::search(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ShowInfoBarWarning()

void EDA_BASE_FRAME::ShowInfoBarWarning	(	const wxString &	aWarningMsg,
		bool	aShowCloseButton = `false`
	)

inherited

Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar.

The infobar will be closed after a timeout.

Parameters

aErrorMsg	is the message to display.
aShowCloseButton	true to show a close button on the right of the WX_INFOBAR.

Definition at line 889 of file eda_base_frame.cpp.

{
 m_infoBar->RemoveAllButtons();
 
 if( aShowCloseButton )
 m_infoBar->AddCloseButton();
 
 GetInfoBar()->ShowMessageFor( aWarningMsg, 6000, wxICON_WARNING );
}

References WX_INFOBAR::AddCloseButton(), EDA_BASE_FRAME::GetInfoBar(), EDA_BASE_FRAME::m_infoBar, WX_INFOBAR::RemoveAllButtons(), and WX_INFOBAR::ShowMessageFor().

Referenced by SCH_EDIT_TOOL::RepeatDrawItem().

◆ ShowModal()

bool KIWAY_PLAYER::ShowModal	(	wxString *	aResult = `nullptr`,
		wxWindow *	aResultantFocusWindow = `nullptr`
	)

virtualinherited

Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal().

This is behavior is similar to a modal dialog window. Not all KIWAY_PLAYERs use this interface, so don't call this unless the implementation knows how to call DismissModal() on a button click or double click or some special event which ends the modal behavior.

Parameters

aResult	if not NULL, indicates a place to put a resultant string.
aResultantFocusWindow	if not NULL, indicates what window to pass focus to on return.

Returns: true if frame implementation called KIWAY_PLAYER::DismissModal() with aRetVal of true.

Reimplemented in FOOTPRINT_VIEWER_FRAME, and SYMBOL_VIEWER_FRAME.

Definition at line 93 of file kiway_player.cpp.

{
 wxASSERT_MSG( IsModal(), wxT( "ShowModal() shouldn't be called on non-modal frame" ) );
 
 /*
 This function has a nice interface but a necessarily unsightly implementation.
 Now the implementation is encapsulated, localizing future changes.
 
 It works in tandem with DismissModal(). But only ShowModal() is in the
 vtable and therefore cross-module capable.
 */
 
 // This is an exception safe way to zero a pointer before returning.
 // Yes, even though DismissModal() clears this first normally, this is
 // here in case there's an exception before the dialog is dismissed.
 struct NULLER
 {
 void*& m_what;
 NULLER( void*& aPtr ) : m_what( aPtr ) {}
 ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
 } clear_this( (void*&) m_modal_loop );
 
 
 m_modal_resultant_parent = aResultantFocusWindow;
 
 Show( true );
 Raise(); // Needed on some Window managers to always display the frame
 
 SetFocus();
 
 {
 // We have to disable all frames but the modal one.
 // wxWindowDisabler does that, but it also disables all top level windows
 // We do not want to disable top level windows which are child of the modal one,
 // if they are enabled.
 // An example is an aui toolbar which was moved
 // or a dialog or another frame or miniframe opened by the modal one.
 wxWindowList wlist = GetChildren();
 std::vector<wxWindow*> enabledTopLevelWindows;
 
 for( unsigned ii = 0; ii < wlist.size(); ii++ )
 {
 if( wlist[ii]->IsTopLevel() && wlist[ii]->IsEnabled() )
 enabledTopLevelWindows.push_back( wlist[ii] );
 }
 
 // exception safe way to disable all top level windows except the modal one,
 // re-enables only those that were disabled on exit
 wxWindowDisabler toggle( this );
 
 for( unsigned ii = 0; ii < enabledTopLevelWindows.size(); ii++ )
 enabledTopLevelWindows[ii]->Enable( true );
 
 WX_EVENT_LOOP event_loop;
 m_modal_loop = &event_loop;
 event_loop.Run();
 
 } // End of scope for some variables.
 // End nesting before setting focus below.
 
 if( aResult )
 *aResult = m_modal_string;
 
 if( aResultantFocusWindow )
 {
 aResultantFocusWindow->Raise();
 
 // have the final say, after wxWindowDisabler reenables my parent and
 // the events settle down, set the focus
 wxSafeYield();
 aResultantFocusWindow->SetFocus();
 }
 
 return m_modal_ret_val;
}

References KIWAY_PLAYER::IsModal(), KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_resultant_parent, KIWAY_PLAYER::m_modal_ret_val, KIWAY_PLAYER::m_modal_string, and WX_EVENT_LOOP.

Referenced by FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SYMBOL_VIEWER_FRAME::ShowModal(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ ShowPreferences()

void EDA_BASE_FRAME::ShowPreferences	(	wxString	aStartPage,
		wxString	aStartParentPage
	)

inherited

Displays the preferences and settings of all opened editors paged dialog, starting with a particular page.

Definition at line 1000 of file eda_base_frame.cpp.

{
 wxBeginBusyCursor( wxHOURGLASS_CURSOR );
 
 PAGED_DIALOG dlg( this, _( "Preferences" ), true );
 
 dlg.SetEvtHandlerEnabled( false );
 wxTreebook* book = dlg.GetTreebook();
 
 PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
 KIFACE* kiface = nullptr;
 std::vector<int> expand;
 
 Kiway().GetActions( hotkeysPanel->ActionsList() );
 
 book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
 book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
 book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
 
#ifdef KICAD_USE_SENTRY
 book->AddPage( new PANEL_DATA_COLLECTION( &dlg, book ), _( "Data Collection" ) );
#endif
 
#define CREATE_PANEL( key ) kiface->CreateKiWindow( book, key, &Kiway() )
 
 // If a dll is not loaded, the loader will show an error message.
 
 try
 {
 kiface = Kiway().KiFACE( KIWAY::FACE_SCH );
 
 kiface->GetActions( hotkeysPanel->ActionsList() );
 
 if( GetFrameType() == FRAME_SCH_SYMBOL_EDITOR )
 expand.push_back( book->GetPageCount() );
 
 book->AddPage( new wxPanel( book ), _( "Symbol Editor" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SYM_DISP_OPTIONS ), _( "Display Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SYM_EDIT_OPTIONS ), _( "Editing Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SYM_COLORS ), _( "Colors" ) );
 
 if( GetFrameType() == FRAME_SCH )
 expand.push_back( book->GetPageCount() );
 
 book->AddPage( new wxPanel( book ), _( "Schematic Editor" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SCH_DISP_OPTIONS ), _( "Display Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SCH_EDIT_OPTIONS ), _( "Editing Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SCH_ANNO_OPTIONS ), _( "Annotation Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SCH_COLORS ), _( "Colors" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_SCH_FIELD_NAME_TEMPLATES ),
 _( "Field Name Templates" ) );
 }
 catch( ... )
 {
 }
 
 try
 {
 kiface = Kiway().KiFACE( KIWAY::FACE_PCB );
 
 kiface->GetActions( hotkeysPanel->ActionsList() );
 
 if( GetFrameType() == FRAME_FOOTPRINT_EDITOR )
 expand.push_back( book->GetPageCount() );
 
 book->AddPage( new wxPanel( book ), _( "Footprint Editor" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_FP_DISPLAY_OPTIONS ), _( "Display Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_FP_EDIT_OPTIONS ), _( "Editing Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_FP_COLORS ), _( "Colors" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_FP_DEFAULT_VALUES ), _( "Default Values" ) );
 
 if( GetFrameType() == FRAME_PCB_EDITOR )
 expand.push_back( book->GetPageCount() );
 
 book->AddPage( new wxPanel( book ), _( "PCB Editor" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_PCB_DISPLAY_OPTIONS ), _( "Display Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_PCB_EDIT_OPTIONS ), _( "Editing Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_PCB_COLORS ), _( "Colors" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_PCB_ACTION_PLUGINS ), _( "Action Plugins" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_PCB_ORIGINS_AXES ), _( "Origins & Axes" ) );
 
 if( GetFrameType() == FRAME_PCB_DISPLAY3D )
 expand.push_back( book->GetPageCount() );
 
 book->AddPage( new wxPanel( book ), _( "3D Viewer" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_3DV_DISPLAY_OPTIONS ), _( "General" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_3DV_OPENGL ), _( "Realtime Renderer" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_3DV_RAYTRACING ), _( "Raytracing Renderer" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_3DV_COLORS ), _( "Colors" ) );
 }
 catch( ... )
 {
 }
 
 try
 {
 kiface = Kiway().KiFACE( KIWAY::FACE_GERBVIEW );
 
 kiface->GetActions( hotkeysPanel->ActionsList() );
 
 if( GetFrameType() == FRAME_GERBER )
 expand.push_back( book->GetPageCount() );
 
 book->AddPage( new wxPanel( book ), _( "Gerber Viewer" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_GBR_DISPLAY_OPTIONS ), _( "Display Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_GBR_COLORS ), _( "Colors" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_GBR_EXCELLON_OPTIONS ), _( "Excellon Options" ) );
 }
 catch( ... )
 {
 }
 
 try
 {
 kiface = Kiway().KiFACE( KIWAY::FACE_PL_EDITOR );
 kiface->GetActions( hotkeysPanel->ActionsList() );
 
 if( GetFrameType() == FRAME_PL_EDITOR )
 expand.push_back( book->GetPageCount() );
 
 book->AddPage( new wxPanel( book ), _( "Drawing Sheet Editor" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_DS_DISPLAY_OPTIONS ), _( "Display Options" ) );
 book->AddSubPage( CREATE_PANEL( PANEL_DS_COLORS ), _( "Colors" ) );
 
 book->AddPage( new PANEL_PCM_SETTINGS( book ), _( "Plugin and Content Manager" ) );
 }
 catch( ... )
 {
 }
 
 // Update all of the action hotkeys. The process of loading the actions through
 // the KiFACE will only get us the default hotkeys
 ReadHotKeyConfigIntoActions( wxEmptyString, hotkeysPanel->ActionsList() );
 
 for( size_t i = 0; i < book->GetPageCount(); ++i )
 book->GetPage( i )->Layout();
 
 for( int page : expand )
 book->ExpandNode( page );
 
 if( !aStartPage.IsEmpty() )
 dlg.SetInitialPage( aStartPage, aStartParentPage );
 
 dlg.SetEvtHandlerEnabled( true );
 wxEndBusyCursor();
 
 if( dlg.ShowModal() == wxID_OK )
 {
 Pgm().GetSettingsManager().Save();
 dlg.Kiway().CommonSettingsChanged( false, false );
 }
 
#undef CREATE_PANEL
}

References _, PANEL_HOTKEYS_EDITOR::ActionsList(), KIWAY::CommonSettingsChanged(), CREATE_PANEL, KIWAY::FACE_GERBVIEW, KIWAY::FACE_PCB, KIWAY::FACE_PL_EDITOR, KIWAY::FACE_SCH, FRAME_FOOTPRINT_EDITOR, FRAME_GERBER, FRAME_PCB_DISPLAY3D, FRAME_PCB_EDITOR, FRAME_PL_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, KIWAY::GetActions(), EDA_BASE_FRAME::GetFrameType(), PAGED_DIALOG::GetTreebook(), kiface, KIWAY::KiFACE(), KIWAY_HOLDER::Kiway(), PANEL_3DV_COLORS, PANEL_3DV_DISPLAY_OPTIONS, PANEL_3DV_OPENGL, PANEL_3DV_RAYTRACING, PANEL_DS_COLORS, PANEL_DS_DISPLAY_OPTIONS, PANEL_FP_COLORS, PANEL_FP_DEFAULT_VALUES, PANEL_FP_DISPLAY_OPTIONS, PANEL_FP_EDIT_OPTIONS, PANEL_GBR_COLORS, PANEL_GBR_DISPLAY_OPTIONS, PANEL_GBR_EXCELLON_OPTIONS, PANEL_PCB_ACTION_PLUGINS, PANEL_PCB_COLORS, PANEL_PCB_DISPLAY_OPTIONS, PANEL_PCB_EDIT_OPTIONS, PANEL_PCB_ORIGINS_AXES, PANEL_SCH_ANNO_OPTIONS, PANEL_SCH_COLORS, PANEL_SCH_DISP_OPTIONS, PANEL_SCH_EDIT_OPTIONS, PANEL_SCH_FIELD_NAME_TEMPLATES, PANEL_SYM_COLORS, PANEL_SYM_DISP_OPTIONS, PANEL_SYM_EDIT_OPTIONS, Pgm(), ReadHotKeyConfigIntoActions(), and PAGED_DIALOG::SetInitialPage().

Referenced by EDA_BASE_FRAME::OnPreferences().

◆ StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue	(	const EDA_ANGLE &	aValue,
		bool	aAddUnitLabel = `false`
	)

inlineinherited

Definition at line 74 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }

References EDA_ANGLE::AsDegrees(), DEGREES, DISTANCE, EDA_UNIT_UTILS::UI::StringFromValue(), and unityScale.

◆ StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue	(	double	aValue,
		bool	aAddUnitLabel = `false`,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value

Returns: A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 67 of file units_provider.h.

 {
 return EDA_UNIT_UTILS::UI::StringFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetclassesGrid(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PANEL_SETUP_BOARD_STACKUP::createRowData(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawSpecificationStackup(), DRC_TEST_PROVIDER::formatMsg(), PIN_TABLE_DATA_MODEL::GetValue(), FP_TEXT_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), WX_GRID::SetUnitValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ sys_search()

const SEARCH_STACK & EDA_BASE_FRAME::sys_search ( )

virtualinherited

Return a SEARCH_STACK pertaining to entire program.

This is overloaded in KICAD_MANAGER_FRAME

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 816 of file eda_base_frame.cpp.

{
 return Kiface().KifaceSearch();
}

References Kiface(), and KIFACE_BASE::KifaceSearch().

◆ takeScreenshot()

void EDA_3D_VIEWER_FRAME::takeScreenshot ( wxCommandEvent & event )

private

Create a Screenshot of the current 3D view.

Output file format is png or jpeg, or image is copied to the clipboard

Definition at line 753 of file eda_3d_viewer_frame.cpp.

{
 wxString fullFileName;
 bool fmt_is_jpeg = false;
 
 if( event.GetId() == ID_MENU_SCREENCOPY_JPEG )
 fmt_is_jpeg = true;
 
 if( event.GetId() != ID_TOOL_SCREENCOPY_TOCLIBBOARD )
 {
 // Remember path between saves during this session only.
 const wxString wildcard = fmt_is_jpeg ? JpegFileWildcard() : PngFileWildcard();
 const wxString ext = fmt_is_jpeg ? JpegFileExtension : PngFileExtension;
 
 // First time path is set to the project path.
 if( !m_defaultSaveScreenshotFileName.IsOk() )
 m_defaultSaveScreenshotFileName = Parent()->Prj().GetProjectFullName();
 
 m_defaultSaveScreenshotFileName.SetExt( ext );
 
 wxFileDialog dlg( this, _( "3D Image File Name" ),
 m_defaultSaveScreenshotFileName.GetPath(),
 m_defaultSaveScreenshotFileName.GetFullName(), wildcard,
 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return;
 
 m_defaultSaveScreenshotFileName = dlg.GetPath();
 
 if( m_defaultSaveScreenshotFileName.GetExt().IsEmpty() )
 m_defaultSaveScreenshotFileName.SetExt( ext );
 
 fullFileName = m_defaultSaveScreenshotFileName.GetFullPath();
 
 wxFileName fn = fullFileName;
 
 if( !fn.IsDirWritable() )
 {
 wxString msg;
 
 msg.Printf( _( "Insufficient permissions to save file '%s'." ), fullFileName );
 wxMessageBox( msg, _( "Error" ), wxOK | wxICON_ERROR, this );
 return;
 }
 
 // Be sure the screen area destroyed by the file dialog is redrawn
 // before making a screen copy.
 // Without this call, under Linux the screen refresh is made to late.
 wxYield();
 }
 
 // Be sure we have the latest 3D view (remember 3D view is buffered)
 m_canvas->Request_refresh( true );
 wxYield();
 
 // Build image from the 3D buffer
 wxWindowUpdateLocker noUpdates( this );
 
 wxImage screenshotImage;
 
 if( m_canvas )
 m_canvas->GetScreenshot( screenshotImage );
 
 if( event.GetId() == ID_TOOL_SCREENCOPY_TOCLIBBOARD )
 {
 wxBitmap bitmap( screenshotImage );
 
 wxLogNull doNotLog; // disable logging of failed clipboard actions
 
 if( wxTheClipboard->Open() )
 {
 wxBitmapDataObject* dobjBmp = new wxBitmapDataObject( bitmap );
 
 if( !wxTheClipboard->SetData( dobjBmp ) )
 wxMessageBox( _( "Failed to copy image to clipboard" ) );
 
 wxTheClipboard->Flush(); /* the data in clipboard will stay
 * available after the application exits */
 wxTheClipboard->Close();
 }
 }
 else
 {
 if( !screenshotImage.SaveFile( fullFileName,
 fmt_is_jpeg ? wxBITMAP_TYPE_JPEG : wxBITMAP_TYPE_PNG ) )
 wxMessageBox( _( "Can't save file" ) );
 
 screenshotImage.Destroy();
 }
}

References _, PROJECT::GetProjectFullName(), EDA_3D_CANVAS::GetScreenshot(), ID_MENU_SCREENCOPY_JPEG, ID_TOOL_SCREENCOPY_TOCLIBBOARD, JpegFileExtension, JpegFileWildcard(), m_canvas, m_defaultSaveScreenshotFileName, Parent(), PngFileExtension, PngFileWildcard(),

aFileName	The full path and/or file name of the file to test.
aVerbose	If true will show an error dialog if the file is not writable

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ EDA_3D_VIEWER_FRAME()

◆ ~EDA_3D_VIEWER_FRAME()

Member Function Documentation

◆ AddStandardHelpMenu()

◆ AngleValueFromString()

◆ applyViewport()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ ClearFileHistory()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ commonInit()

◆ CommonSettingsChanged()

◆ config()

◆ ConfigBaseName()

◆ CreateInfoBar()

◆ CreateMenuBar()

◆ CreateServer()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayToolMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ doReCreateMenuBar()

◆ DoWithAcceptedFiles()

◆ ensureWindowIsOnScreen()

◆ ExecuteRemoteCommand()

◆ Exit3DFrame()

◆ findQuasiModalDialog()

◆ FinishAUIInitialization()

◆ GetAboutTitle()

◆ GetAdapter()

◆ GetAutoSaveFilePrefix()

◆ GetAutoSaveInterval()

◆ GetBoard()

◆ GetCanvas()

◆ GetCurrentCamera()

◆ GetCurrentFileName()

◆ GetCurrentSelection()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetFileFromHistory()

◆ GetFileHistory()

◆ GetFrameType()

◆ GetInfoBar()

◆ GetIuScale()

◆ GetMaxUndoItems()

◆ GetMoveWarpsCursor()

◆ GetMruPath()

◆ GetOriginTransforms()

◆ GetRedoCommandCount()

◆ GetSettingsManager()

◆ GetSeverity()

◆ GetToolCanvas()

◆ GetToolManager()

◆ GetType()

◆ GetUndoCommandCount()

◆ GetUntranslatedAboutTitle()

◆ GetUserUnits()

◆ GetUserViewports()

◆ GetWindowSettings()

◆ GetWindowSize()

◆ handleIconizeEvent()