KiCad PCB EDA Suite
LIB_EDIT_FRAME Class Reference

The symbol library editor main window. More...

#include <lib_edit_frame.h>

Inheritance diagram for LIB_EDIT_FRAME:
SCH_BASE_FRAME EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME KIWAY_HOLDER

Public Types

typedef std::vector< COMPONENT_SELECTIONHISTORY_LIST
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 LIB_EDIT_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
 ~LIB_EDIT_FRAME () override
 
void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
 switches currently used canvas ( Cairo / OpenGL). More...
 
bool HasLibModifications () const
 Check if any pending libraries have been modified. More...
 
wxString GetCurLib () const
 The nickname of the current library being edited and empty string if none. More...
 
wxString SetCurLib (const wxString &aLibNickname)
 Sets the current library nickname and returns the old library nickname. More...
 
LIB_ID GetTreeLIBID (int *aUnit=nullptr) const
 Return the LIB_ID of the library or symbol selected in the symbol tree. More...
 
LIB_PARTGetCurPart () const
 Return the current part being edited or NULL if none selected. More...
 
void SetCurPart (LIB_PART *aPart)
 Take ownership of aPart and notes that it is the one currently being edited. More...
 
int GetRepeatPinStep () const
 
void SetRepeatPinStep (int aStep)
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
bool SynchronizePins ()
 
void OnImportBody (wxCommandEvent &aEvent)
 
void OnExportBody (wxCommandEvent &aEvent)
 
bool AddLibraryFile (bool aCreateNew)
 Creates or adds an existing library to the symbol library table. More...
 
void CreateNewPart ()
 Creates a new part in the selected library. More...
 
void ImportPart ()
 
void ExportPart ()
 
void Save ()
 Saves the selected part or library. More...
 
void SaveAs ()
 Saves the selected part or library to a new name and/or location. More...
 
void SaveAll ()
 Saves all modified parts and libraries. More...
 
void Revert (bool aConfirm=true)
 Reverts unsaved changes in a part, restoring to the last saved state. More...
 
void RevertAll ()
 
void DeletePartFromLibrary ()
 
void CopyPartToClipboard ()
 
void LoadPart (const wxString &aLibrary, const wxString &aPart, int Unit)
 
void DuplicatePart (bool aFromClipboard)
 Inserts a duplicate part. More...
 
void OnSelectUnit (wxCommandEvent &event)
 
void OnToggleSearchTree (wxCommandEvent &event)
 
bool IsSearchTreeShown ()
 
void FreezeSearchTree ()
 
void ThawSearchTree ()
 
void OnUpdatePartNumber (wxUpdateUIEvent &event)
 
void UpdateAfterSymbolProperties (wxString *aOldName, wxArrayString *aOldAliases)
 
void RebuildSymbolUnitsList ()
 
void OnCloseWindow (wxCloseEvent &Event)
 
void OnExitKiCad (wxCommandEvent &event)
 
void ReCreateHToolbar () override
 
void ReCreateVToolbar () override
 
void ReCreateOptToolbar () override
 
void LoadSettings (wxConfigBase *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (wxConfigBase *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
void CloseWindow (wxCommandEvent &event)
 Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro: More...
 
void OnModify () override
 Must be called after a schematic change in order to set the "modify" flag of the current symbol. More...
 
int GetUnit () const
 
void SetUnit (int aUnit)
 
int GetConvert () const
 
void SetConvert (int aConvert)
 
bool GetShowDeMorgan () const
 
void SetShowDeMorgan (bool show)
 
void ClearMsgPanel () override
 Clear all messages from the message panel. More...
 
void SaveCopyInUndoList (EDA_ITEM *ItemToCopy, UNDO_REDO_T undoType=UR_LIBEDIT, bool aAppend=false)
 Create a copy of the current component, and save it in the undo list. More...
 
void GetComponentFromUndoList ()
 
void GetComponentFromRedoList ()
 
void RollbackPartFromUndo ()
 
bool LoadComponentAndSelectLib (const LIB_ID &aLibId, int aUnit, int aConvert)
 Selects the currently active library and loads the symbol from aLibId. More...
 
void PrintPage (wxDC *aDC) override
 Print a page. More...
 
void SVG_PlotComponent (const wxString &aFullFileName)
 Creates the SVG print file for the current edited component. More...
 
void SyncLibraries (bool aShowProgress)
 Synchronize the library manager to the symbol library table, and then the symbol tree to the library manager. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allows Libedit to install its preferences panel into the preferences dialog. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged) override
 Called after the preferences dialog is run. More...
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
void SyncToolbars () override
 Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state. More...
 
void SetScreen (BASE_SCREEN *aScreen) override
 
const BOX2I GetDocumentExtents () const override
 
void RebuildView ()
 
void HardRedraw () override
 Rebuild the GAL and redraw the screen. More...
 
void KiwayMailIn (KIWAY_EXPRESS &mail) override
 Function KiwayMailIn receives KIWAY_EXPRESS messages from other players. More...
 
void emptyScreen ()
 

Restores the empty editor screen, without any part or library selected.

More...
 
void createCanvas ()
 
SCH_DRAW_PANELGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
SCH_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
KIGFX::SCH_RENDER_SETTINGSGetRenderSettings ()
 
virtual bool GetShowAllPins () const
 Allow some frames to show/hide hidden pins. More...
 
bool GetShowElectricalType ()
 Allow some frames to show/hide pin electrical type names. More...
 
void SetShowElectricalType (bool aShow)
 
const wxPoint GetRepeatStep () const
 
void SetRepeatStep (const wxPoint &aStep)
 Sets the repeat step value for repeat command. More...
 
int GetRepeatDeltaLabel () const
 
void SetRepeatDeltaLabel (int aDelta)
 Sets the repeat delta label value for repeat command. More...
 
const bool GetRepeatComponent ()
 
void SetRepeatComponent (bool aRepeat)
 If true, keep placing new copies of the same symbol on each click. More...
 
const bool GetUseAllUnits ()
 
void SetUseAllUnits (bool aUseAll)
 Sets whether to utilize all units of a component when placing. More...
 
const wxString GetZoomLevelIndicator () const override
 Function GetZoomLevelIndicator returns a human readable value which can be displayed as zoom level indicator in dialogs. More...
 
void SetDragActionIsMove (bool aValue)
 
bool GetDragActionIsMove () const
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPoint & GetAuxOrigin () const override
 Return the origin of the axis used for plotting and various exports. More...
 
void SetAuxOrigin (const wxPoint &aPosition) override
 
const wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
void OnGridSettings (wxCommandEvent &aEvent) override
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
void UpdateStatusBar () override
 Update the status bar information. More...
 
COMPONENT_SELECTION SelectCompFromLibTree (const SCHLIB_FILTER *aFilter, std::vector< COMPONENT_SELECTION > &aHistoryList, bool aUseLibBrowser, int aUnit, int aConvert, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
 Function SelectComponentFromLib Calls the library viewer to select component to import into schematic. More...
 
const TEMPLATE_FIELDNAMESGetTemplateFieldNames () const
 Return a template field names list for read only access. More...
 
const TEMPLATE_FIELDNAMEGetTemplateFieldName (const wxString &aName) const
 Search for aName in the the template field name list. More...
 
LIB_ALIASGetLibAlias (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowError=false)
 Load symbol from symbol library table. More...
 
LIB_PARTGetLibPart (const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
 
COMPONENT_SELECTION SelectComponentFromLibBrowser (wxTopLevelWindow *aParent, const SCHLIB_FILTER *aFilter, const LIB_ID &aPreselectedLibid, int aUnit, int aConvert)
 Function SelectComponentFromLibBrowser Calls the library viewer to select component to import into schematic. More...
 
virtual void RedrawScreen (const wxPoint &aCenterPoint, bool aWarpPointer)
 
virtual void CenterScreen (const wxPoint &aCenterPoint, bool aWarpPointer)
 
void AddToScreen (EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
 Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen. More...
 
void RemoveFromScreen (EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
 Remove an item from the screen (and view) aScreen is the screen the item is located on, if not the current screen. More...
 
void RefreshItem (EDA_ITEM *aItem, bool isAddOrDelete=false)
 Mark an item for refresh. More...
 
void RefreshSelection ()
 Mark selected items for refresh. More...
 
void SyncView ()
 Mark all items for refresh. More...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
int GetLastGridSizeId () const
 
void SetLastGridSizeId (int aId)
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
virtual COLOR4D GetDrawBgColor () const
 
virtual void SetDrawBgColor (COLOR4D aColor)
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
virtual wxString GetScreenDesc () const
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command send via a socket to the application, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) It called by EDA_DRAW_FRAME::OnSockRequest(). More...
 
double GetZoomLevelCoeff () const
 Return the coefficient to convert internal display scale factor to zoom level. More...
 
void EraseMsgBox ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
virtual bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
virtual COLOR4D GetGridColor ()
 
virtual void SetGridColor (COLOR4D aColor)
 
virtual void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 
virtual void OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos, bool aCenterView=false)
 Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested. More...
 
double GetZoom ()
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (wxDC *aDC, BASE_SCREEN *aScreen, int aLineWidth, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString, COLOR4D aColor=COLOR4D::UNSPECIFIED)
 Prints the page layout with the frame and the basic inscriptions. More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane on the status bar. More...
 
void DisplayGridMsg ()
 Display current grid pane on the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
 Append a message to the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
virtual void ActivateGalCanvas ()
 Use to start up the GAL drawing canvas. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 Notification to refresh the drawing canvas (if any). More...
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of ckeck tools. More...
 
virtual bool OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
 Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal ()
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS_T GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS_T aUnits)
 
void ChangeUserUnits (EDA_UNITS_T aUnits)
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuOpen (wxMenuEvent &event)
 Workaround some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
virtual wxConfigBase * config ()
 Returns the wxConfigBase used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
wxString ConfigBaseName ()
 
virtual void SaveProjectSettings (bool aAskForSave)
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, wxFileHistory *aFileHistory=NULL)
 Fetches the file name from the file history list. More...
 
void UpdateFileHistory (const wxString &FullFileName, wxFileHistory *aFileHistory=NULL)
 Update the list of recently opened files. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
const wxString & GetAboutTitle () const
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static int GetPinNumDefaultSize ()
 
static void SetPinNumDefaultSize (int aSize)
 
static int GetPinNameDefaultSize ()
 
static void SetPinNameDefaultSize (int aSize)
 
static int GetDefaultPinLength ()
 
static void SetDefaultPinLength (int aLength)
 

Public Attributes

bool m_SyncPinEdit
 Set to true to synchronize pins at the same position when editing symbols with multiple units or multiple body styles. More...
 
bool m_DrawSpecificConvert
 Convert of the item currently being drawn. More...
 
bool m_DrawSpecificUnit
 Specify which component parts the current draw item applies to. More...
 

Static Public Attributes

static int g_LastTextSize = -1
 
static double g_LastTextAngle = TEXT_ANGLE_HORIZ
 
static FILL_T g_LastFillStyle = NO_FILL
 
static int g_LastLineWidth = 0
 

Protected Member Functions

bool saveSymbolLibTables (bool aGlobal, bool aProject)
 Saves Symbol Library Tables to disk. More...
 
void unitsChangeRefresh () override
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
virtual wxString GetCanvasTypeKey ()
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 Function language_change is an event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. More...
 

Static Protected Member Functions

static wxString GetBackupSuffix ()
 
static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

TEMPLATES m_templateFieldNames
 
wxPoint m_repeatStep
 
int m_repeatDeltaLabel
 
bool m_showPinElectricalTypeName
 
bool m_dragActionIsMove
 
bool m_repeatComponent
 
bool m_useAllUnits
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
 prevents opening same file multiple times. More...
 
int m_LastGridSizeId
 
bool m_drawGrid
 
bool m_showPageLimits
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
double m_zoomLevelCoeff
 
int m_UndoRedoCountMax
 
bool m_PolarCoords
 
TOOL_DISPATCHERm_toolDispatcher
 
bool m_showBorderAndTitleBlock
 
long m_firstRunDialogSetting
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
ACTION_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
wxFindReplaceData * m_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_MsgFrameHeight
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 The current canvas type. More...
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_Ident
 
wxPoint m_FramePos
 
wxSize m_FrameSize
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_configName
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
wxString m_perspective
 
wxString m_mruPath
 
EDA_UNITS_T m_userUnits
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Private Member Functions

void setupTools ()
 
void savePartAs ()
 
bool saveLibrary (const wxString &aLibrary, bool aNewFile)
 Saves the changes to the current library. More...
 
void updateTitle ()
 Updates the main window title bar with the current library name and read only status of the library. More...
 
void SelectActiveLibrary (const wxString &aLibrary=wxEmptyString)
 Set the current active library to aLibrary. More...
 
wxString SelectLibraryFromList ()
 Display a list of loaded libraries in the symbol library and allows the user to select a library. More...
 
bool LoadComponentFromCurrentLib (const wxString &aAliasName, int aUnit=0, int aConvert=0)
 Loads a symbol from the current active library, optionally setting the selected unit and convert. More...
 
bool LoadOneLibraryPartAux (LIB_ALIAS *aLibEntry, const wxString &aLibrary, int aUnit, int aConvert)
 Create a copy of aLibEntry into memory. More...
 
void DisplayCmpDoc ()
 Display the documentation of the selected component. More...
 
void LoadOneSymbol ()
 Read a component symbol file (*.sym ) and add graphic items to the current component. More...
 
void SaveOneSymbol ()
 Saves the current symbol to a symbol file. More...
 
void refreshSchematic ()
 
SYMBOL_LIB_TABLEselectSymLibTable (bool aOptional=false)
 Displays a dialog asking the user to select a symbol library table. More...
 
bool backupFile (const wxFileName &aOriginalFile, const wxString &aBackupExt)
 

Creates a backup copy of a file with requested extension

More...
 
LIB_PARTgetTargetPart () const
 

Returns currently edited part.

More...
 
LIB_ID getTargetLibId () const
 

Returns either the part selected in the component tree, if context menu is active or the currently modified part.

More...
 
wxString getTargetLib () const
 

Returns either the library selected in the component tree, if context menu is active or the library that is currently modified.

More...
 
bool saveAllLibraries (bool aRequireConfirmation)
 
bool saveCurrentPart ()
 

Saves the current part.

More...
 
void storeCurrentPart ()
 

Stores the currently modified part in the library manager buffer.

More...
 
bool isCurrentPart (const LIB_ID &aLibId) const
 

Returns true if aLibId is an alias for the editor screen part.

More...
 
void fixDuplicateAliases (LIB_PART *aPart, const wxString &aLibrary)
 

Renames LIB_PART aliases to avoid conflicts before adding a component to a library

More...
 

Private Attributes

LIB_PARTm_my_part
 
wxComboBox * m_unitSelectBox
 
SYMBOL_TREE_PANEm_treePane
 
LIB_MANAGERm_libMgr
 
int m_unit
 
int m_convert
 
int m_repeatPinStep
 Default repeat offset for pins in repeat place pin. More...
 
int m_defaultLibWidth
 
SCH_SCREENm_dummyScreen
 

Helper screen used when no part is loaded

More...
 

Static Private Attributes

static bool m_showDeMorgan = false
 
static int m_textPinNumDefaultSize = DEFAULTPINNUMSIZE
 
static int m_textPinNameDefaultSize = DEFAULTPINNAMESIZE
 
static int m_defaultPinLength = DEFAULTPINLENGTH
 

Detailed Description

The symbol library editor main window.

Definition at line 51 of file lib_edit_frame.h.

Member Typedef Documentation

◆ HISTORY_LIST

typedef std::vector<COMPONENT_SELECTION> SCH_BASE_FRAME::HISTORY_LIST
inherited

Definition at line 223 of file sch_base_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ LIB_EDIT_FRAME()

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

Definition at line 96 of file lib_edit_frame.cpp.

96  :
97  SCH_BASE_FRAME( aKiway, aParent, FRAME_SCH_LIB_EDITOR, _( "Library Editor" ),
98  wxDefaultPosition, wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, LIB_EDIT_FRAME_NAME )
99 {
100  SetShowDeMorgan( false );
101  m_DrawSpecificConvert = true;
102  m_DrawSpecificUnit = false;
103  m_SyncPinEdit = false;
105  SetShowElectricalType( true );
106  m_FrameSize = ConvertDialogToPixels( wxSize( 500, 350 ) ); // default in case of no prefs
107 
108  m_my_part = nullptr;
109  m_treePane = nullptr;
110  m_libMgr = nullptr;
111  m_unit = 1;
112  m_convert = 1;
113  m_AboutTitle = "LibEdit";
114 
115  // Delayed initialization
116  if( g_LastTextSize == -1 )
118 
119  // Initialize grid id to the default value 50 mils:
121 
122  wxIcon icon;
123  icon.CopyFromBitmap( KiBitmap( icon_libedit_xpm ) );
124  SetIcon( icon );
125 
126  LoadSettings( config() );
127 
128  // Ensure axis are always drawn
130  gal_opts.m_axesEnabled = true;
131 
132  m_dummyScreen = new SCH_SCREEN( aKiway );
134  GetScreen()->m_Center = true;
136 
138  SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y );
139 
140  setupTools();
141 
142  m_libMgr = new LIB_MANAGER( *this );
143  SyncLibraries( true );
144  m_treePane = new SYMBOL_TREE_PANE( this, m_libMgr );
145 
146  ReCreateMenuBar();
150  InitExitKey();
151 
152  updateTitle();
153  DisplayCmpDoc();
155 
156  m_auimgr.SetManagedWindow( this );
157 
158  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) );
159  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
160 
161  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) );
162  m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "ComponentTree" ).Left().Layer(1)
163  .Caption( _( "Libraries" ) ).MinSize( 250, -1 )
164  .BestSize( m_defaultLibWidth, -1 ).Resizable() );
165  m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" ).Right().Layer(1) );
166 
167  m_auimgr.AddPane( GetCanvas(), wxAuiPaneInfo().Name( "DrawFrame" ).CentrePane() );
168 
169  m_auimgr.Update();
170 
171  GetToolManager()->RunAction( "common.Control.gridPreset", true, m_LastGridSizeId );
172 
173  Raise();
174  Show( true );
175 
176  SyncView();
177  GetCanvas()->GetViewControls()->SetSnapping( true );
178  GetCanvas()->GetView()->UseDrawPriority( true );
180  GetCanvas()->GetGAL()->SetAxesEnabled( true );
181 
182  // Set the working/draw area size to display a symbol to a reasonable value:
183  // A 600mm x 600mm with a origin at the area center looks like a large working area
184  double max_size_x = Millimeter2iu( 600 );
185  double max_size_y = Millimeter2iu( 600 );
186  BOX2D bbox;
187  bbox.SetOrigin( -max_size_x /2, -max_size_y/2 );
188  bbox.SetSize( max_size_x, max_size_y );
189  GetCanvas()->GetView()->SetBoundary( bbox );
190 
192 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
bool m_DrawSpecificUnit
Specify which component parts the current draw item applies to.
SCH_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aWindowType, const wxString &aTitle, const wxPoint &aPosition, const wxSize &aSize, long aStyle, const wxString &aFrameName)
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
ACTION_TOOLBAR * m_optionsToolBar
virtual bool IsGridVisible() const
void UseDrawPriority(bool aFlag)
Function UseDrawPriority()
Definition: view.h:656
LIB_MANAGER * m_libMgr
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
virtual void SetSnapping(bool aEnabled)
Function SetSnapping() Enables/disables snapping cursor to grid.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
wxString m_AboutTitle
virtual wxConfigBase * config()
Returns the wxConfigBase used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void SetSize(const Vec &size)
Definition: box2.h:210
void SetShowElectricalType(bool aShow)
#define DEFAULT_REPEAT_OFFSET_PIN
the default value (overwritten by the eeschema config)
Definition: general.h:52
wxAuiManager m_auimgr
ACTION_TOOLBAR * m_mainToolBar
LIB_PART * m_my_part
void SetShowDeMorgan(bool show)
bool m_DrawSpecificConvert
Convert of the item currently being drawn.
bool m_axesEnabled
Whether or not to draw the coordinate system axes
Library Editor pane with component tree and symbol library table selector.
#define LIB_EDIT_FRAME_NAME
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
void ReCreateMenuBar() override
Recreates the menu bar.
bool m_Center
Center on screen.
Definition: base_screen.h:121
void SyncView()
Mark all items for refresh.
EDA_MSG_PANEL * m_messagePanel
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void ReCreateOptToolbar() override
KIGFX::GAL * GetGAL() const
Function GetGAL() Returns a pointer to the GAL instance used in the panel.
#define KICAD_DEFAULT_DRAWFRAME_STYLE
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
void InitExitKey()
Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.
void SetAxesEnabled(bool aAxesEnabled)
Enables drawing the axes.
#define _(s)
Specialization of the wxAuiPaneInfo class for KiCad panels.
void RebuildSymbolUnitsList()
void DisplayCmpDoc()
Display the documentation of the selected component.
Definition: symbedit.cpp:205
void updateTitle()
Updates the main window title bar with the current library name and read only status of the library.
Definition: libedit.cpp:48
Class to handle modifications to the symbol libraries.
Definition: lib_manager.h:99
void SyncLibraries(bool aShowProgress)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
void ReCreateHToolbar() override
bool m_SyncPinEdit
Set to true to synchronize pins at the same position when editing symbols with multiple units or mult...
void SetScreen(BASE_SCREEN *aScreen) override
void SetOrigin(const Vec &pos)
Definition: box2.h:208
static int g_LastTextSize
void SetMaxUndoItems(int aMax)
Definition: base_screen.h:213
void SetGridVisibility(bool aVisibility)
Sets the visibility setting of the grid.
int m_repeatPinStep
Default repeat offset for pins in repeat place pin.
SCH_SCREEN * m_dummyScreen
Helper screen used when no part is loaded
TOOL_MANAGER * m_toolManager
void SetBoundary(const BOX2D &aBoundary)
Function SetBoundary() Sets limits for view area.
Definition: view.h:267
SYMBOL_TREE_PANE * m_treePane
int GetDefaultTextSize()
Default size for text in general.
ACTION_TOOLBAR * m_drawToolBar
void ReCreateVToolbar() override

References _, DEFAULT_REPEAT_OFFSET_PIN, GetDefaultTextSize(), ID_POPUP_GRID_LEVEL_1000, ID_POPUP_GRID_LEVEL_50, KiBitmap(), PCAD2KICAD::Left, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, PCAD2KICAD::Right, BOX2< Vec >::SetOrigin(), BOX2< Vec >::SetSize(), and ACTIONS::zoomFitScreen.

◆ ~LIB_EDIT_FRAME()

LIB_EDIT_FRAME::~LIB_EDIT_FRAME ( )
override

Definition at line 195 of file lib_edit_frame.cpp.

196 {
197  // current screen is destroyed in EDA_DRAW_FRAME
199 
200  delete m_libMgr;
201  delete m_my_part;
202 }
LIB_MANAGER * m_libMgr
LIB_PART * m_my_part
void SetScreen(BASE_SCREEN *aScreen) override
SCH_SCREEN * m_dummyScreen
Helper screen used when no part is loaded

References m_dummyScreen, m_libMgr, m_my_part, and SetScreen().

Member Function Documentation

◆ ActivateGalCanvas()

void EDA_DRAW_FRAME::ActivateGalCanvas ( )
virtualinherited

Use to start up the GAL drawing canvas.

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

Definition at line 597 of file eda_draw_frame.cpp.

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

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

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

◆ AddLibraryFile()

bool LIB_EDIT_FRAME::AddLibraryFile ( bool  aCreateNew)

Creates or adds an existing library to the symbol library table.

Definition at line 452 of file lib_edit_frame.cpp.

453 {
454  wxFileName fn = m_libMgr->GetUniqueLibraryName();
455 
456  if( !LibraryFileBrowser( !aCreateNew, fn, SchematicLibraryFileWildcard(),
458  {
459  return false;
460  }
461 
462  wxString libName = fn.GetName();
463 
464  if( libName.IsEmpty() )
465  return false;
466 
467  if( m_libMgr->LibraryExists( libName ) )
468  {
469  DisplayError( this, wxString::Format( _( "Library \"%s\" already exists" ), libName ) );
470  return false;
471  }
472 
473  // Select the target library table (global/project)
474  SYMBOL_LIB_TABLE* libTable = selectSymLibTable();
475 
476  if( !libTable )
477  return false;
478 
479  if( aCreateNew )
480  {
481  if( !m_libMgr->CreateLibrary( fn.GetFullPath(), libTable ) )
482  {
483  DisplayError( this, wxString::Format( _( "Could not create the library file '%s'.\n"
484  "Check write permission." ),
485  fn.GetFullPath() ) );
486  return false;
487  }
488  }
489  else
490  {
491  if( !m_libMgr->AddLibrary( fn.GetFullPath(), libTable ) )
492  {
493  DisplayError( this, _( "Could not open the library file." ) );
494  return false;
495  }
496  }
497 
498  bool globalTable = ( libTable == &SYMBOL_LIB_TABLE::GetGlobalLibTable() );
499  saveSymbolLibTables( globalTable, !globalTable );
500 
501  return true;
502 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
bool CreateLibrary(const wxString &aFilePath, SYMBOL_LIB_TABLE *aTable)
Creates an empty library and adds it to the library table.
Definition: lib_manager.h:138
LIB_MANAGER * m_libMgr
wxString SchematicLibraryFileWildcard()
bool AddLibrary(const wxString &aFilePath, SYMBOL_LIB_TABLE *aTable)
Adds an existing library.
Definition: lib_manager.h:146
wxString GetUniqueLibraryName() const
Returns a library name that is not currently in use.
const std::string SchematicLibraryFileExtension
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
bool saveSymbolLibTables(bool aGlobal, bool aProject)
Saves Symbol Library Tables to disk.
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Returns true if library exists.
SYMBOL_LIB_TABLE * selectSymLibTable(bool aOptional=false)
Displays a dialog asking the user to select a symbol library table.

References _, LIB_MANAGER::AddLibrary(), LIB_MANAGER::CreateLibrary(), DisplayError(), Format(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), LIB_MANAGER::GetUniqueLibraryName(), LIB_MANAGER::LibraryExists(), EDA_DRAW_FRAME::LibraryFileBrowser(), m_libMgr, SCH_BASE_FRAME::saveSymbolLibTables(), SchematicLibraryFileExtension, SchematicLibraryFileWildcard(), and selectSymLibTable().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 365 of file eda_base_frame.cpp.

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

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

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

Definition at line 349 of file eda_draw_frame.cpp.

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

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

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

◆ AddToScreen()

void SCH_BASE_FRAME::AddToScreen ( EDA_ITEM aItem,
SCH_SCREEN aScreen = nullptr 
)
inherited

Add an item to the screen (and view) aScreen is the screen the item is located on, if not the current screen.

Definition at line 418 of file sch_base_frame.cpp.

419 {
420  auto screen = aScreen;
421 
422  if( aScreen == nullptr )
423  screen = GetScreen();
424 
425  screen->Append( (SCH_ITEM*) aItem );
426 
427  if( screen == GetScreen() )
428  {
429  GetCanvas()->GetView()->Add( aItem );
430  RefreshItem( aItem, true ); // handle any additional parent semantics
431  }
432 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void RefreshItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

References KIGFX::VIEW::Add(), SCH_BASE_FRAME::GetCanvas(), SCH_BASE_FRAME::GetScreen(), SCH_DRAW_PANEL::GetView(), and SCH_BASE_FRAME::RefreshItem().

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AddJunction(), SCH_EDIT_FRAME::BreakSegment(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ AppendMsgPanel()

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

Append a message to the message panel.

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

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

Definition at line 554 of file eda_draw_frame.cpp.

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

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

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

◆ backupFile()

bool LIB_EDIT_FRAME::backupFile ( const wxFileName &  aOriginalFile,
const wxString &  aBackupExt 
)
private

Creates a backup copy of a file with requested extension

Definition at line 627 of file lib_edit_frame.cpp.

628 {
629  if( aOriginalFile.FileExists() )
630  {
631  wxFileName backupFileName( aOriginalFile );
632  backupFileName.SetExt( "bck" );
633 
634  if( backupFileName.FileExists() )
635  wxRemoveFile( backupFileName.GetFullPath() );
636 
637  if( !wxCopyFile( aOriginalFile.GetFullPath(), backupFileName.GetFullPath() ) )
638  {
639  DisplayError( this, wxString::Format( _( "Failed to save backup to \"%s\"" ),
640  backupFileName.GetFullPath() ) );
641  return false;
642  }
643  }
644 
645  return true;
646 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References _, DisplayError(), and Format().

Referenced by saveLibrary().

◆ CenterScreen()

void SCH_BASE_FRAME::CenterScreen ( const wxPoint &  aCenterPoint,
bool  aWarpPointer 
)
virtualinherited

Definition at line 332 of file sch_base_frame.cpp.

333 {
334  GetCanvas()->GetView()->SetCenter( aCenterPoint );
335 
336  if( aWarpPointer )
337  GetCanvas()->GetViewControls()->WarpCursor( aCenterPoint, true );
338 
339  GetCanvas()->Refresh();
340 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
Function WarpCursor() If enabled (.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:604
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...

References SCH_BASE_FRAME::GetCanvas(), SCH_DRAW_PANEL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::WarpCursor().

Referenced by SCH_EDITOR_CONTROL::FindComponentAndItem().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS_T  aUnits)
inlineinherited

Definition at line 213 of file eda_base_frame.h.

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

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

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

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 689 of file eda_base_frame.cpp.

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

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

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

◆ ClearMsgPanel()

void LIB_EDIT_FRAME::ClearMsgPanel ( )
inlineoverridevirtual

Clear all messages from the message panel.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 277 of file lib_edit_frame.h.

277 { DisplayCmpDoc(); }
void DisplayCmpDoc()
Display the documentation of the selected component.
Definition: symbedit.cpp:205

References DisplayCmpDoc().

Referenced by saveLibrary().

◆ CloseWindow()

void LIB_EDIT_FRAME::CloseWindow ( wxCommandEvent &  event)
inline

Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro:

EVT_CLOSE( LIB_EDIT_FRAME::OnCloseWindow )

Definition at line 256 of file lib_edit_frame.h.

257  {
258  // Generate a wxCloseEvent
259  Close( false );
260  }

◆ CommonSettingsChanged()

void LIB_EDIT_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged)
overridevirtual

Called after the preferences dialog is run.

Reimplemented from EDA_BASE_FRAME.

Definition at line 677 of file lib_edit_frame.cpp.

678 {
679  SCH_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged );
680 
682 
683  if( aEnvVarsChanged )
684  SyncLibraries( true );
685 
686  Layout();
687  SendSizeEvent();
688 }
void RecreateToolbars()
Rebuild all toolbars, and update the checked state of ckeck tools.
void SyncLibraries(bool aShowProgress)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
void CommonSettingsChanged(bool aEnvVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.

References EDA_DRAW_FRAME::CommonSettingsChanged(), EDA_DRAW_FRAME::RecreateToolbars(), and SyncLibraries().

◆ config()

wxConfigBase * EDA_BASE_FRAME::config ( )
virtualinherited

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

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 537 of file eda_base_frame.cpp.

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

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

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

◆ ConfigBaseName()

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

Definition at line 337 of file eda_base_frame.h.

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

References EDA_BASE_FRAME::m_configName.

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

◆ CopyPartToClipboard()

void LIB_EDIT_FRAME::CopyPartToClipboard ( )

Definition at line 557 of file libedit.cpp.

558 {
559  int dummyUnit;
560  LIB_ID libId = m_treePane->GetLibTree()->GetSelectedLibId( &dummyUnit );
561  LIB_PART* part = m_libMgr->GetBufferedPart( libId.GetLibItemName(), libId.GetLibNickname() );
562 
563  if( !part )
564  return;
565 
566  STRING_FORMATTER formatter;
567  SCH_LEGACY_PLUGIN::FormatPart( part, formatter );
568 
569  auto clipboard = wxTheClipboard;
570  wxClipboardLocker clipboardLock( clipboard );
571 
572  if( !clipboardLock || !clipboard->IsOpened() )
573  return;
574 
575  auto data = new wxTextDataObject( wxString( formatter.GetString().c_str(), wxConvUTF8 ) );
576  clipboard->SetData( data );
577 
578  clipboard->Flush();
579 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
LIB_MANAGER * m_libMgr
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:145
Define a library symbol object.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
const std::string & GetString()
Definition: richio.h:475
static void FormatPart(LIB_PART *aPart, OUTPUTFORMATTER &aFormatter)
LIB_PART * GetBufferedPart(const wxString &aAlias, const wxString &aLibrary)
Returns the part copy from the buffer.
LIB_TREE * GetLibTree() const
SYMBOL_TREE_PANE * m_treePane
Class STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:445

References SCH_LEGACY_PLUGIN::FormatPart(), LIB_MANAGER::GetBufferedPart(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), LIB_TREE::GetSelectedLibId(), STRING_FORMATTER::GetString(), m_libMgr, and m_treePane.

Referenced by LIB_CONTROL::CutCopyDelete().

◆ createCanvas()

void SCH_BASE_FRAME::createCanvas ( )
inherited

Definition at line 363 of file sch_base_frame.cpp.

364 {
366 
367  // Allows only a CAIRO or OPENGL canvas:
370  {
372  }
373 
374  SetCanvas( new SCH_DRAW_PANEL( this, wxID_ANY, wxPoint( 0, 0 ), m_FrameSize,
377 }
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)

References EDA_DRAW_FRAME::ActivateGalCanvas(), EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, EDA_DRAW_FRAME::GetGalDisplayOptions(), EDA_DRAW_FRAME::LoadCanvasTypeSetting(), EDA_DRAW_FRAME::m_canvasType, EDA_BASE_FRAME::m_FrameSize, and EDA_DRAW_FRAME::SetCanvas().

Referenced by SCH_BASE_FRAME::SCH_BASE_FRAME().

◆ CreateNewPart()

void LIB_EDIT_FRAME::CreateNewPart ( )

Creates a new part in the selected library.

Definition at line 274 of file libedit.cpp.

275 {
277  wxString lib = getTargetLib();
278 
279  if( !m_libMgr->LibraryExists( lib ) )
280  {
281  lib = SelectLibraryFromList();
282 
283  if( !m_libMgr->LibraryExists( lib ) )
284  return;
285  }
286 
287  DIALOG_LIB_NEW_COMPONENT dlg( this );
288  dlg.SetMinSize( dlg.GetSize() );
289 
290  if( dlg.ShowModal() == wxID_CANCEL )
291  return;
292 
293  if( dlg.GetName().IsEmpty() )
294  {
295  wxMessageBox( _( "This new symbol has no name and cannot be created." ) );
296  return;
297  }
298 
299  wxString name = dlg.GetName();
300  // Currently, symbol names cannot include a space, that breaks libraries:
301  name.Replace( " ", "_" );
302 
303  // Test if there is a component with this name already.
304  if( !lib.empty() && m_libMgr->PartExists( name, lib ) )
305  {
306  wxString msg = wxString::Format( _( "Symbol \"%s\" already exists in library \"%s\"" ),
307  name, lib );
308  DisplayError( this, msg );
309  return;
310  }
311 
312  LIB_PART new_part( name ); // do not create part on the heap, it will be buffered soon
313  new_part.GetReferenceField().SetText( dlg.GetReference() );
314  new_part.SetUnitCount( dlg.GetUnitCount() );
315 
316  // Initialize new_part.m_TextInside member:
317  // if 0, pin text is outside the body (on the pin)
318  // if > 0, pin text is inside the body
319 
320  if( dlg.GetPinNameInside() )
321  {
322  new_part.SetPinNameOffset( dlg.GetPinTextPosition() );
323 
324  if( new_part.GetPinNameOffset() == 0 )
325  new_part.SetPinNameOffset( 1 );
326  }
327  else
328  {
329  new_part.SetPinNameOffset( 0 );
330  }
331 
332  ( dlg.GetPowerSymbol() ) ? new_part.SetPower() : new_part.SetNormal();
333  new_part.SetShowPinNumbers( dlg.GetShowPinNumber() );
334  new_part.SetShowPinNames( dlg.GetShowPinName() );
335  new_part.LockUnits( dlg.GetLockItems() );
336 
337  if( dlg.GetUnitCount() < 2 )
338  new_part.LockUnits( false );
339 
340  m_libMgr->UpdatePart( &new_part, lib );
341  SyncLibraries( false );
342  LoadPart( name, lib, 1 );
343 
344  new_part.SetConversion( dlg.GetAlternateBodyStyle() );
345  // must be called after loadPart, that calls SetShowDeMorgan, but
346  // because the symbol is empty,it looks like it has no alternate body
347  SetShowDeMorgan( dlg.GetAlternateBodyStyle() );
348 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
void LoadPart(const wxString &aLibrary, const wxString &aPart, int Unit)
Definition: libedit.cpp:729
LIB_MANAGER * m_libMgr
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
wxString SelectLibraryFromList()
Display a list of loaded libraries in the symbol library and allows the user to select a library.
Definition: libedit.cpp:74
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
void SetShowDeMorgan(bool show)
Define a library symbol object.
bool PartExists(const wxString &aAlias, const wxString &aLibrary) const
Returns true if part with a specific alias exists in library (either original one or buffered).
#define _(s)
bool UpdatePart(LIB_PART *aPart, const wxString &aLibrary)
Updates the part buffer with a new version of the part.
void SyncLibraries(bool aShowProgress)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
const char * name
Definition: DXF_plotter.cpp:61
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Returns true if library exists.
Implementing DIALOG_LIB_NEW_COMPONENT.
TOOL_MANAGER * m_toolManager
wxString getTargetLib() const
Returns either the library selected in the component tree, if context menu is active or the library t...

References _, ACTIONS::cancelInteractive, DisplayError(), Format(), DIALOG_LIB_NEW_COMPONENT::GetAlternateBodyStyle(), DIALOG_LIB_NEW_COMPONENT::GetLockItems(), DIALOG_LIB_NEW_COMPONENT::GetName(), DIALOG_LIB_NEW_COMPONENT::GetPinNameInside(), LIB_PART::GetPinNameOffset(), DIALOG_LIB_NEW_COMPONENT::GetPinTextPosition(), DIALOG_LIB_NEW_COMPONENT::GetPowerSymbol(), DIALOG_LIB_NEW_COMPONENT::GetReference(), LIB_PART::GetReferenceField(), DIALOG_LIB_NEW_COMPONENT::GetShowPinName(), DIALOG_LIB_NEW_COMPONENT::GetShowPinNumber(), getTargetLib(), DIALOG_LIB_NEW_COMPONENT::GetUnitCount(), LIB_MANAGER::LibraryExists(), LoadPart(), LIB_PART::LockUnits(), m_libMgr, EDA_BASE_FRAME::m_toolManager, name, LIB_MANAGER::PartExists(), TOOL_MANAGER::RunAction(), SelectLibraryFromList(), LIB_PART::SetConversion(), LIB_PART::SetNormal(), LIB_PART::SetPinNameOffset(), LIB_PART::SetPower(), SetShowDeMorgan(), LIB_PART::SetShowPinNames(), LIB_PART::SetShowPinNumbers(), EDA_TEXT::SetText(), LIB_PART::SetUnitCount(), SyncLibraries(), and LIB_MANAGER::UpdatePart().

Referenced by LIB_CONTROL::AddSymbol().

◆ CreateServer()

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

Definition at line 49 of file eda_dde.cpp.

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

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

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

◆ CurrentToolName()

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

Definition at line 220 of file eda_base_frame.cpp.

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

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

◆ DeletePartFromLibrary()

void LIB_EDIT_FRAME::DeletePartFromLibrary ( )

Definition at line 536 of file libedit.cpp.

537 {
538  LIB_ID libId = getTargetLibId();
539 
540  if( m_libMgr->IsPartModified( libId.GetLibItemName(), libId.GetLibNickname() )
541  && !IsOK( this, _( wxString::Format( "Component %s has been modified\n"
542  "Do you want to remove it from the library?",
543  libId.GetUniStringLibItemName() ) ) ) )
544  {
545  return;
546  }
547 
548  if( isCurrentPart( libId ) )
549  emptyScreen();
550 
551  m_libMgr->RemovePart( libId.GetLibItemName(), libId.GetLibNickname() );
552 
554 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
bool RemovePart(const wxString &aName, const wxString &aLibrary)
Removes the part from the part buffer.
LIB_MANAGER * m_libMgr
bool isCurrentPart(const LIB_ID &aLibId) const
Returns true if aLibId is an alias for the editor screen part.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsPartModified(const wxString &aAlias, const wxString &aLibrary) const
Returns true if part has unsaved modifications.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
#define _(s)
void emptyScreen()
Restores the empty editor screen, without any part or library selected.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
LIB_ID getTargetLibId() const
Returns either the part selected in the component tree, if context menu is active or the currently mo...
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:281
const wxString GetUniStringLibItemName() const
Definition: lib_id.h:121

References _, emptyScreen(), Format(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), getTargetLibId(), LIB_ID::GetUniStringLibItemName(), isCurrentPart(), IsOK(), LIB_MANAGER::IsPartModified(), m_libMgr, refreshSchematic(), and LIB_MANAGER::RemovePart().

Referenced by LIB_CONTROL::CutCopyDelete().

◆ Destroy()

◆ DismissModal()

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

Definition at line 160 of file kiway_player.cpp.

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

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

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

◆ DisplayCmpDoc()

void LIB_EDIT_FRAME::DisplayCmpDoc ( )
private

Display the documentation of the selected component.

Definition at line 205 of file symbedit.cpp.

206 {
207  LIB_PART* part = GetCurPart();
208 
210 
211  if( !part )
212  return;
213 
214  LIB_ALIAS* alias = part->GetAlias( part->GetName() );
215  wxString msg = part->GetName();
216 
217  AppendMsgPanel( _( "Name" ), msg, BLUE, 8 );
218 
219  static wxChar UnitLetter[] = wxT( "?ABCDEFGHIJKLMNOPQRSTUVWXYZ" );
220  msg = UnitLetter[m_unit];
221 
222  AppendMsgPanel( _( "Unit" ), msg, BROWN, 8 );
223 
224  if( m_convert > 1 )
225  msg = _( "Convert" );
226  else
227  msg = _( "Normal" );
228 
229  AppendMsgPanel( _( "Body" ), msg, GREEN, 8 );
230 
231  if( part->IsPower() )
232  msg = _( "Power Symbol" );
233  else
234  msg = _( "Symbol" );
235 
236  AppendMsgPanel( _( "Type" ), msg, MAGENTA, 8 );
237  AppendMsgPanel( _( "Description" ), alias->GetDescription(), CYAN, 8 );
238  AppendMsgPanel( _( "Key words" ), alias->GetKeyWords(), DARKDARKGRAY );
239  AppendMsgPanel( _( "Datasheet" ), alias->GetDocFileName(), DARKDARKGRAY );
240 }
Definition: colors.h:57
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
Part library alias object definition.
Definition: colors.h:61
LIB_ALIAS * GetAlias(size_t aIndex) const
const wxString & GetDocFileName() const
const wxString & GetKeyWords() const
Definition: colors.h:59
Define a library symbol object.
virtual void ClearMsgPanel()
Clear all messages from the message panel.
#define _(s)
const wxString & GetDescription() override
void AppendMsgPanel(const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
Append a message to the message panel.
bool IsPower() const
Definition: colors.h:58
const wxString & GetName() const
Definition: colors.h:62

References _, EDA_DRAW_FRAME::AppendMsgPanel(), BLUE, BROWN, EDA_DRAW_FRAME::ClearMsgPanel(), CYAN, DARKDARKGRAY, LIB_PART::GetAlias(), GetCurPart(), LIB_ALIAS::GetDescription(), LIB_ALIAS::GetDocFileName(), LIB_ALIAS::GetKeyWords(), LIB_PART::GetName(), GREEN, LIB_PART::IsPower(), m_convert, m_unit, and MAGENTA.

Referenced by ClearMsgPanel(), LoadOneLibraryPartAux(), and UpdateAfterSymbolProperties().

◆ DisplayGridMsg()

void EDA_DRAW_FRAME::DisplayGridMsg ( )
inherited

Display current grid pane on the status bar.

Definition at line 384 of file eda_draw_frame.cpp.

385 {
386  wxString line;
387  wxString gridformatter;
388 
389  switch( m_userUnits )
390  {
391  case INCHES:
392  gridformatter = "grid %.3f";
393  break;
394 
395  case MILLIMETRES:
396  gridformatter = "grid %.4f";
397  break;
398 
399  default:
400  gridformatter = "grid %f";
401  break;
402  }
403 
404  wxRealPoint curr_grid_size = GetScreen()->GetGridSize();
405  double grid = To_User_Unit( m_userUnits, curr_grid_size.x );
406  line.Printf( gridformatter, grid );
407 
408  SetStatusText( line, 4 );
409 }
const wxRealPoint & GetGridSize() const
Return the grid size of the currently selected grid.
Definition: base_screen.h:279
double To_User_Unit(EDA_UNITS_T aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:93
Definition: common.h:134
EDA_UNITS_T m_userUnits
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

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

Referenced by SCH_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 375 of file eda_draw_frame.cpp.

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

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane on the status bar.

Definition at line 412 of file eda_draw_frame.cpp.

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

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

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

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

Returns
true if the auto save was successful otherwise false.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 303 of file eda_base_frame.cpp.

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

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ DuplicatePart()

void LIB_EDIT_FRAME::DuplicatePart ( bool  aFromClipboard)

Inserts a duplicate part.

If aFromClipboard is true then action is a paste.

Definition at line 582 of file libedit.cpp.

583 {
584  int dummyUnit;
585  LIB_ID libId = m_treePane->GetLibTree()->GetSelectedLibId( &dummyUnit );
586  wxString lib = libId.GetLibNickname();
587 
588  if( !m_libMgr->LibraryExists( lib ) )
589  return;
590 
591  LIB_PART* srcPart = nullptr;
592  LIB_PART* newPart = nullptr;
593 
594  if( aFromClipboard )
595  {
596  auto clipboard = wxTheClipboard;
597  wxClipboardLocker clipboardLock( clipboard );
598 
599  if( !clipboardLock || ! clipboard->IsSupported( wxDF_TEXT ) )
600  return;
601 
602  wxTextDataObject data;
603  clipboard->GetData( data );
604  wxString partSource = data.GetText();
605 
606  STRING_LINE_READER reader( TO_UTF8( partSource ), "Clipboard" );
607 
608  try
609  {
610  reader.ReadLine();
611  newPart = SCH_LEGACY_PLUGIN::ParsePart( reader );
612  }
613  catch( IO_ERROR& e )
614  {
615  wxLogMessage( "Can not paste: %s", GetChars( e.Problem() ) );
616  return;
617  }
618  }
619  else
620  {
621  srcPart = m_libMgr->GetBufferedPart( libId.GetLibItemName(), lib );
622  newPart = new LIB_PART( *srcPart );
623  }
624 
625  if( !newPart )
626  return;
627 
628  fixDuplicateAliases( newPart, lib );
629  m_libMgr->UpdatePart( newPart, lib );
630  SyncLibraries( false );
631  m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, newPart->GetName() ) );
632 
633  delete newPart;
634 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
LIB_MANAGER * m_libMgr
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
static LIB_PART * ParsePart(LINE_READER &aReader, int majorVersion=0, int minorVersion=0)
void fixDuplicateAliases(LIB_PART *aPart, const wxString &aLibrary)
Renames LIB_PART aliases to avoid conflicts before adding a component to a library
Definition: libedit.cpp:637
virtual const wxString Problem() const
what was the problem?
Definition: exceptions.cpp:49
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:145
Define a library symbol object.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
bool UpdatePart(LIB_PART *aPart, const wxString &aLibrary)
Updates the part buffer with a new version of the part.
void SyncLibraries(bool aShowProgress)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
LIB_PART * GetBufferedPart(const wxString &aAlias, const wxString &aLibrary)
Returns the part copy from the buffer.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
const wxString & GetName() const
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Returns true if library exists.
LIB_TREE * GetLibTree() const
SYMBOL_TREE_PANE * m_treePane
Class STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:254
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:163

References fixDuplicateAliases(), LIB_MANAGER::GetBufferedPart(), GetChars(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_TREE_PANE::GetLibTree(), LIB_PART::GetName(), LIB_TREE::GetSelectedLibId(), LIB_MANAGER::LibraryExists(), m_libMgr, m_treePane, SCH_LEGACY_PLUGIN::ParsePart(), IO_ERROR::Problem(), STRING_LINE_READER::ReadLine(), LIB_TREE::SelectLibId(), SyncLibraries(), TO_UTF8, and LIB_MANAGER::UpdatePart().

Referenced by LIB_CONTROL::DuplicateSymbol().

◆ emptyScreen()

void LIB_EDIT_FRAME::emptyScreen ( )

Restores the empty editor screen, without any part or library selected.

Definition at line 665 of file lib_edit_frame.cpp.

666 {
668  SetCurLib( wxEmptyString );
669  SetCurPart( nullptr );
673  Refresh();
674 }
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
Definition: lib_tree.cpp:175
void SetCurPart(LIB_PART *aPart)
Take ownership of aPart and notes that it is the one currently being edited.
void SetScreen(BASE_SCREEN *aScreen) override
SCH_SCREEN * m_dummyScreen
Helper screen used when no part is loaded
wxString SetCurLib(const wxString &aLibNickname)
Sets the current library nickname and returns the old library nickname.
TOOL_MANAGER * m_toolManager
LIB_TREE * GetLibTree() const
SYMBOL_TREE_PANE * m_treePane

References BASE_SCREEN::ClearUndoRedoList(), SYMBOL_TREE_PANE::GetLibTree(), m_dummyScreen, EDA_BASE_FRAME::m_toolManager, m_treePane, Refresh(), TOOL_MANAGER::RunAction(), SetCurLib(), SetCurPart(), SetScreen(), LIB_TREE::Unselect(), and ACTIONS::zoomFitScreen.

Referenced by DeletePartFromLibrary(), InvokeSchEditSymbolLibTable(), and Revert().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 244 of file eda_draw_frame.cpp.

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

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

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

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

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

Parameters
cmdline= received command from socket

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 274 of file eda_draw_frame.h.

274 {}

Referenced by EDA_DRAW_FRAME::OnSockRequest().

◆ ExportPart()

void LIB_EDIT_FRAME::ExportPart ( )

Definition at line 96 of file lib_export.cpp.

97 {
98  wxString msg, title;
99  LIB_PART* part = getTargetPart();
100 
101  if( !part )
102  {
103  DisplayError( this, _( "There is no symbol selected to save." ) );
104  return;
105  }
106 
107  wxFileName fn;
108 
109  fn.SetName( part->GetName().Lower() );
110  fn.SetExt( SchematicLibraryFileExtension );
111 
112  wxFileDialog dlg( this, _( "Export Symbol" ), m_mruPath, fn.GetFullName(),
113  SchematicLibraryFileWildcard(), wxFD_SAVE );
114 
115  if( dlg.ShowModal() == wxID_CANCEL )
116  return;
117 
118  fn = dlg.GetPath();
119  fn.MakeAbsolute();
120 
121  LIB_PART* old_part = NULL;
122 
123  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
124 
125  if( fn.FileExists() )
126  {
127  try
128  {
129  LIB_ALIAS* alias = pi->LoadSymbol( fn.GetFullPath(), part->GetName() );
130 
131  if( alias )
132  old_part = alias->GetPart();
133  }
134  catch( const IO_ERROR& ioe )
135  {
136  msg.Printf( _( "Error occurred attempting to load symbol library file \"%s\"" ),
137  fn.GetFullPath() );
138  DisplayErrorMessage( this, msg, ioe.What() );
139  return;
140  }
141 
142  if( old_part )
143  {
144  msg.Printf( _( "Symbol \"%s\" already exists in \"%s\"." ),
145  part->GetName(),
146  fn.GetFullName() );
147 
148  KIDIALOG errorDlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
149  errorDlg.SetOKLabel( _( "Overwrite" ) );
150  errorDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
151 
152  if( errorDlg.ShowModal() == wxID_CANCEL )
153  return;
154  }
155  }
156 
157  if( fn.Exists() && !fn.IsDirWritable() )
158  {
159  msg.Printf( _( "Write permissions are required to save library \"%s\"." ),
160  fn.GetFullPath() );
161  DisplayError( this, msg );
162  return;
163  }
164 
165  try
166  {
167  if( !fn.FileExists() )
168  pi->CreateSymbolLib( fn.GetFullPath() );
169 
170  pi->SaveSymbol( fn.GetFullPath(), new LIB_PART( *part ) );
171  }
172  catch( const IO_ERROR& ioe )
173  {
174  msg.Printf( _( "Failed to create symbol library file \"%s\"" ), fn.GetFullPath() );
175  DisplayErrorMessage( this, msg, ioe.What() );
176  msg.Printf( _( "Error creating symbol library \"%s\"" ), fn.GetFullName() );
177  SetStatusText( msg );
178  return;
179  }
180 
181  m_mruPath = fn.GetPath();
182 
183  msg.Printf( _( "Symbol \"%s\" saved in library \"%s\"" ), part->GetName(), fn.GetFullPath() );
184  SetStatusText( msg );
185 
186  // See if the user wants it added to a library table (global or project)
187  SYMBOL_LIB_TABLE* libTable = selectSymLibTable( true );
188 
189  if( libTable )
190  {
191  if( !m_libMgr->AddLibrary( fn.GetFullPath(), libTable ) )
192  {
193  DisplayError( this, _( "Could not open the library file." ) );
194  return;
195  }
196 
197  bool globalTable = ( libTable == &SYMBOL_LIB_TABLE::GetGlobalLibTable() );
198  saveSymbolLibTables( globalTable, !globalTable );
199  }
200 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
Part library alias object definition.
wxString m_mruPath
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:44
LIB_MANAGER * m_libMgr
wxString SchematicLibraryFileWildcard()
bool AddLibrary(const wxString &aFilePath, SYMBOL_LIB_TABLE *aTable)
Adds an existing library.
Definition: lib_manager.h:146
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
const std::string SchematicLibraryFileExtension
Define a library symbol object.
bool saveSymbolLibTables(bool aGlobal, bool aProject)
Saves Symbol Library Tables to disk.
LIB_PART * GetPart() const
Get the shared LIB_PART.
#define _(s)
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:520
const wxString & GetName() const
LIB_PART * getTargetPart() const
Returns currently edited part.
SYMBOL_LIB_TABLE * selectSymLibTable(bool aOptional=false)
Displays a dialog asking the user to select a symbol library table.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References _, LIB_MANAGER::AddLibrary(), DisplayError(), DisplayErrorMessage(), KIDIALOG::DoNotShowCheckbox(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), LIB_PART::GetName(), LIB_ALIAS::GetPart(), getTargetPart(), m_libMgr, EDA_BASE_FRAME::m_mruPath, SCH_BASE_FRAME::saveSymbolLibTables(), SchematicLibraryFileExtension, SchematicLibraryFileWildcard(), selectSymLibTable(), KIDIALOG::ShowModal(), and IO_ERROR::What().

◆ fixDuplicateAliases()

void LIB_EDIT_FRAME::fixDuplicateAliases ( LIB_PART aPart,
const wxString &  aLibrary 
)
private

Renames LIB_PART aliases to avoid conflicts before adding a component to a library

Definition at line 637 of file libedit.cpp.

638 {
639  wxString newName;
640 
641  for( unsigned int i = 0; i < aPart->GetAliasCount(); ++i )
642  {
643  LIB_ALIAS* alias = aPart->GetAlias( i );
644  int sfx = 0;
645  newName = alias->GetName();
646 
647  while( m_libMgr->PartExists( newName, aLibrary ) )
648  {
649  if( sfx == 0 )
650  newName = wxString::Format( "%s_copy", alias->GetName() );
651  else
652  newName = wxString::Format( "%s_copy%d", alias->GetName(), sfx );
653  ++sfx;
654  }
655 
656  if( i == 0 )
657  aPart->SetName( newName );
658  else
659  alias->SetName( newName );
660  }
661 }
Part library alias object definition.
LIB_MANAGER * m_libMgr
LIB_ALIAS * GetAlias(size_t aIndex) const
void SetName(const wxString &aName)
bool PartExists(const wxString &aAlias, const wxString &aLibrary) const
Returns true if part with a specific alias exists in library (either original one or buffered).
const wxString & GetName() const override
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
size_t i
Definition: json11.cpp:649
virtual void SetName(const wxString &aName)
size_t GetAliasCount() const

References Format(), LIB_PART::GetAlias(), LIB_PART::GetAliasCount(), LIB_ALIAS::GetName(), i, m_libMgr, LIB_MANAGER::PartExists(), LIB_ALIAS::SetName(), and LIB_PART::SetName().

Referenced by DuplicatePart(), and savePartAs().

◆ FocusOnLocation()

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

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

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

Definition at line 727 of file eda_draw_frame.cpp.

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

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

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

◆ FreezeSearchTree()

void LIB_EDIT_FRAME::FreezeSearchTree ( )

Definition at line 292 of file lib_edit_frame.cpp.

293 {
294  m_libMgr->GetAdapter()->Freeze();
295 }
LIB_MANAGER * m_libMgr
LIB_TREE_MODEL_ADAPTER::PTR & GetAdapter()
Returns the adapter object that provides the stored data.
Definition: lib_manager.h:269

References LIB_MANAGER::GetAdapter(), and m_libMgr.

Referenced by InvokeSchEditSymbolLibTable().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 467 of file eda_base_frame.h.

467 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetAutoSaveFilePrefix()

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

Definition at line 166 of file eda_base_frame.h.

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

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

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 282 of file eda_base_frame.h.

282 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAuxOrigin()

const wxPoint & SCH_BASE_FRAME::GetAuxOrigin ( ) const
overridevirtualinherited

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

Implements EDA_DRAW_FRAME.

Definition at line 153 of file sch_base_frame.cpp.

154 {
155  wxASSERT( GetScreen() );
156  return GetScreen()->GetAuxOrigin();
157 }
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const wxPoint & GetAuxOrigin() const
Definition: sch_screen.h:125

References SCH_SCREEN::GetAuxOrigin(), and SCH_BASE_FRAME::GetScreen().

◆ GetBackupSuffix()

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

Definition at line 158 of file eda_base_frame.h.

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

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

◆ GetCanvas()

SCH_DRAW_PANEL * SCH_BASE_FRAME::GetCanvas ( ) const
overridevirtualinherited

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

Returns
Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 350 of file sch_base_frame.cpp.

351 {
352  return static_cast<SCH_DRAW_PANEL*>( EDA_DRAW_FRAME::GetCanvas() );
353 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AddJunction(), SCH_BASE_FRAME::AddToScreen(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), SCH_EDIT_TOOL::BreakWire(), SCH_BASE_FRAME::CenterScreen(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::CreateNewText(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EE_SELECTION_TOOL::doSelectionMenu(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editGraphicProperties(), SCH_EDIT_FRAME::EditSheet(), LIB_EDIT_TOOL::editTextProperties(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), SCH_BASE_FRAME::GetRenderSettings(), SCH_BASE_FRAME::HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), SCH_EDITOR_CONTROL::ImportFPAssignments(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), DIALOG_EDIT_COMPONENTS_LIBID::onApplyButton(), DIALOG_ANNOTATE::OnApplyClick(), LIB_VIEW_FRAME::OnCloseWindow(), DIALOG_ERC::OnEraseDrcMarkersClick(), SCH_BASE_FRAME::OnGridSettings(), DIALOG_MIGRATE_BUSES::onItemSelected(), SCH_EDIT_FRAME::OnModify(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRemapSymbols(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), RebuildView(), LIB_VIEW_FRAME::ReCreateListLib(), ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), SCH_EDITOR_CONTROL::Redo(), DIALOG_ERC::RedrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), SCH_BASE_FRAME::RemoveFromScreen(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::rescueProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SCH_EDIT_FRAME::SetCurrentSheet(), EE_POINT_EDITOR::setEditedPoint(), SCH_BASE_FRAME::SetScreen(), SCH_EDIT_FRAME::SetScreen(), LIB_VIEW_FRAME::SetSelectedLibrary(), LIB_VIEW_FRAME::setupTools(), setupTools(), SCH_EDIT_FRAME::setupTools(), LIB_CONTROL::ShowElectricalTypes(), SCH_DRAWING_TOOLS::SingleClickPlace(), SwitchCanvas(), SCH_BASE_FRAME::SyncView(), SCH_EDIT_FRAME::TestDanglingEnds(), DIALOG_ERC::TestErc(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PANEL_LIBEDIT_SETTINGS::TransferDataFromWindow(), DIALOG_EDIT_LINE_STYLE::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SCH_EDIT_TOOL::UpdateFields(), SCH_EDITOR_CONTROL::UpdateFind(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), LIB_VIEW_FRAME::updatePreviewSymbol(), SCH_BASE_FRAME::UpdateStatusBar(), DIALOG_FIELDS_EDITOR_GLOBAL::~DIALOG_FIELDS_EDITOR_GLOBAL(), and LIB_VIEW_FRAME::~LIB_VIEW_FRAME().

◆ GetCanvasTypeKey()

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

Definition at line 170 of file eda_draw_frame.h.

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

References CanvasTypeKeyBase.

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

◆ GetComponentFromRedoList()

void LIB_EDIT_FRAME::GetComponentFromRedoList ( )

Definition at line 60 of file libedit_undo_redo.cpp.

61 {
62  if( GetScreen()->GetRedoCommandCount() <= 0 )
63  return;
64 
66 
67  // Load the last redo entry
69  ITEM_PICKER redoWrapper = redoCommand->PopItem();
70  delete redoCommand;
71  LIB_PART* part = (LIB_PART*) redoWrapper.GetItem();
72  wxCHECK( part, /* void */ );
73  part->ClearFlags( UR_TRANSIENT );
74  UNDO_REDO_T undoRedoType = redoWrapper.GetStatus();
75 
76  // Store the current part in the undo buffer
77  PICKED_ITEMS_LIST* undoCommand = new PICKED_ITEMS_LIST();
78  LIB_PART* oldPart = GetCurPart();
79  oldPart->SetFlags( UR_TRANSIENT );
80  ITEM_PICKER undoWrapper( oldPart, undoRedoType );
81  undoCommand->PushItem( undoWrapper );
82  GetScreen()->PushCommandToUndoList( undoCommand );
83 
84  // Do not delete the previous part by calling SetCurPart( part )
85  // which calls delete <previous part>.
86  // <previous part> is now put in undo list and is owned by this list
87  // Just set the current part to the part which come from the redo list
88  m_my_part = part;
89 
90  if( undoRedoType == UR_LIB_RENAME )
91  {
92  wxString lib = GetCurLib();
93  m_libMgr->UpdatePartAfterRename( part, oldPart->GetName(), lib );
94 
95  // Reselect the renamed part
96  m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, part->GetName() ) );
97  }
98 
100  SetShowDeMorgan( part->HasConversion() );
101  updateTitle();
102 
103  RebuildView();
104  OnModify();
105 }
virtual void PushCommandToUndoList(PICKED_ITEMS_LIST *aItem)
Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when t...
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
UNDO_REDO_T GetStatus() const
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
EDA_ITEM * GetItem() const
LIB_MANAGER * m_libMgr
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
LIB_PART * m_my_part
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
void SetShowDeMorgan(bool show)
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:265
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted.
Define a library symbol object.
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:58
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
void RebuildSymbolUnitsList()
void updateTitle()
Updates the main window title bar with the current library name and read only status of the library.
Definition: libedit.cpp:48
const wxString & GetName() const
ITEM_PICKER PopItem()
Function PopItem.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current symbol.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266
#define UR_TRANSIENT
indicates the item is owned by the undo/redo stack
Definition: base_struct.h:147
TOOL_MANAGER * m_toolManager
LIB_TREE * GetLibTree() const
SYMBOL_TREE_PANE * m_treePane
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:163
bool UpdatePartAfterRename(LIB_PART *aPart, const wxString &oldAlias, const wxString &aLibrary)
Updates the part buffer with a new version of the part when the name has changed.

References EDA_ITEM::ClearFlags(), EE_ACTIONS::clearSelection, GetCurLib(), GetCurPart(), ITEM_PICKER::GetItem(), SYMBOL_TREE_PANE::GetLibTree(), LIB_PART::GetName(), SCH_BASE_FRAME::GetScreen(), ITEM_PICKER::GetStatus(), LIB_PART::HasConversion(), m_libMgr, m_my_part, EDA_BASE_FRAME::m_toolManager, m_treePane, OnModify(), BASE_SCREEN::PopCommandFromRedoList(), PICKED_ITEMS_LIST::PopItem(), BASE_SCREEN::PushCommandToUndoList(), PICKED_ITEMS_LIST::PushItem(), RebuildSymbolUnitsList(), RebuildView(), TOOL_MANAGER::RunAction(), LIB_TREE::SelectLibId(), EDA_ITEM::SetFlags(), SetShowDeMorgan(), LIB_MANAGER::UpdatePartAfterRename(), updateTitle(), UR_LIB_RENAME, and UR_TRANSIENT.

Referenced by LIB_EDIT_TOOL::Redo().

◆ GetComponentFromUndoList()

void LIB_EDIT_FRAME::GetComponentFromUndoList ( )

Definition at line 108 of file libedit_undo_redo.cpp.

109 {
110  if( GetScreen()->GetUndoCommandCount() <= 0 )
111  return;
112 
114 
115  // Load the last undo entry
117  ITEM_PICKER undoWrapper = undoCommand->PopItem();
118  delete undoCommand;
119  LIB_PART* part = (LIB_PART*) undoWrapper.GetItem();
120  wxCHECK( part, /* void */ );
121  part->ClearFlags( UR_TRANSIENT );
122  UNDO_REDO_T undoRedoType = undoWrapper.GetStatus();
123 
124  // Store the current part in the redo buffer
125  PICKED_ITEMS_LIST* redoCommand = new PICKED_ITEMS_LIST();
126  LIB_PART* oldPart = GetCurPart();
127  oldPart->SetFlags( UR_TRANSIENT );
128  ITEM_PICKER redoWrapper( oldPart, undoRedoType );
129  redoCommand->PushItem( redoWrapper );
130  GetScreen()->PushCommandToRedoList( redoCommand );
131 
132  // Do not delete the previous part by calling SetCurPart( part ),
133  // which calls delete <previous part>.
134  // <previous part> is now put in redo list and is owned by this list.
135  // Just set the current part to the part which come from the undo list
136  m_my_part = part;
137 
138  if( undoRedoType == UR_LIB_RENAME )
139  {
140  wxString lib = GetCurLib();
141  m_libMgr->UpdatePartAfterRename( part, oldPart->GetName(), lib );
142 
143  // Reselect the renamed part
144  m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, part->GetName() ) );
145  }
146 
148  SetShowDeMorgan( part->HasConversion() );
149  updateTitle();
150 
151  RebuildView();
152  OnModify();
153 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
UNDO_REDO_T GetStatus() const
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
EDA_ITEM * GetItem() const
LIB_MANAGER * m_libMgr
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
LIB_PART * m_my_part
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
void SetShowDeMorgan(bool show)
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted.
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:265
Define a library symbol object.
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:58
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
void RebuildSymbolUnitsList()
void updateTitle()
Updates the main window title bar with the current library name and read only status of the library.
Definition: libedit.cpp:48
const wxString & GetName() const
virtual void PushCommandToRedoList(PICKED_ITEMS_LIST *aItem)
Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when t...
ITEM_PICKER PopItem()
Function PopItem.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current symbol.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266
#define UR_TRANSIENT
indicates the item is owned by the undo/redo stack
Definition: base_struct.h:147
TOOL_MANAGER * m_toolManager
LIB_TREE * GetLibTree() const
SYMBOL_TREE_PANE * m_treePane
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:163
bool UpdatePartAfterRename(LIB_PART *aPart, const wxString &oldAlias, const wxString &aLibrary)
Updates the part buffer with a new version of the part when the name has changed.

References EDA_ITEM::ClearFlags(), EE_ACTIONS::clearSelection, GetCurLib(), GetCurPart(), ITEM_PICKER::GetItem(), SYMBOL_TREE_PANE::GetLibTree(), LIB_PART::GetName(), SCH_BASE_FRAME::GetScreen(), ITEM_PICKER::GetStatus(), LIB_PART::HasConversion(), m_libMgr, m_my_part, EDA_BASE_FRAME::m_toolManager, m_treePane, OnModify(), BASE_SCREEN::PopCommandFromUndoList(), PICKED_ITEMS_LIST::PopItem(), BASE_SCREEN::PushCommandToRedoList(), PICKED_ITEMS_LIST::PushItem(), RebuildSymbolUnitsList(), RebuildView(), TOOL_MANAGER::RunAction(), LIB_TREE::SelectLibId(), EDA_ITEM::SetFlags(), SetShowDeMorgan(), LIB_MANAGER::UpdatePartAfterRename(), updateTitle(), UR_LIB_RENAME, and UR_TRANSIENT.

Referenced by LIB_EDIT_TOOL::Undo().

◆ GetConvert()

◆ GetCurLib()

wxString LIB_EDIT_FRAME::GetCurLib ( ) const

The nickname of the current library being edited and empty string if none.

Definition at line 340 of file lib_edit_frame.cpp.

341 {
342  wxString libNickname = Prj().GetRString( PROJECT::SCH_LIBEDIT_CUR_LIB );
343 
344  if( !libNickname.empty() )
345  {
346  if( !Prj().SchSymbolLibTable()->HasLibrary( libNickname ) )
347  {
348  Prj().SetRString( PROJECT::SCH_LIBEDIT_CUR_LIB, wxEmptyString );
349  libNickname = wxEmptyString;
350  }
351  }
352 
353  return libNickname;
354 }
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
VTBL_ENTRY void SetRString(RSTRING_T aStringId, const wxString &aString)
Function SetRString stores a "retained string", which is any session and project specific string iden...
Definition: project.cpp:171
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:186

References PROJECT::GetRString(), KIWAY_HOLDER::Prj(), PROJECT::SCH_LIBEDIT_CUR_LIB, and PROJECT::SetRString().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), GetComponentFromRedoList(), GetComponentFromUndoList(), InvokeSchEditSymbolLibTable(), LoadComponentFromCurrentLib(), SetCurLib(), storeCurrentPart(), SyncLibraries(), UpdateAfterSymbolProperties(), and updateTitle().

◆ GetCurPart()

LIB_PART* LIB_EDIT_FRAME::GetCurPart ( ) const
inline

Return the current part being edited or NULL if none selected.

This is a LIB_PART that I own, it is at best a copy of one in a library.

Definition at line 153 of file lib_edit_frame.h.

153 { return m_my_part; }
LIB_PART * m_my_part

References m_my_part.

Referenced by LIB_CONTROL::AddSymbolToSchematic(), LIB_EDIT_TOOL::Copy(), LIB_EDIT_TOOL::DeleteItemCursor(), DisplayCmpDoc(), LIB_EDIT_TOOL::DoDelete(), LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::Duplicate(), LIB_EDIT_TOOL::editSymbolProperties(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), GetComponentFromRedoList(), GetComponentFromUndoList(), GetDocumentExtents(), getTargetLibId(), getTargetPart(), isCurrentPart(), LoadComponentAndSelectLib(), LoadComponentFromCurrentLib(), LoadOneLibraryPartAux(), LoadOneSymbol(), LIB_MOVE_TOOL::Main(), LIB_EDIT_TOOL::Mirror(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAddFootprintFilter(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), OnUpdatePartNumber(), LIB_EDIT_TOOL::Paste(), LIB_EDIT_TOOL::PinTable(), LIB_DRAWING_TOOLS::PlaceAnchor(), LIB_PIN_TOOL::PlacePin(), PrintPage(), LIB_EDIT_TOOL::Properties(), LIB_PIN_TOOL::PushPinProperties(), RebuildSymbolUnitsList(), ReCreateMenuBar(), LIB_DRAWING_TOOLS::RepeatDrawItem(), Revert(), LIB_EDIT_TOOL::Rotate(), saveCurrentPart(), SaveOneSymbol(), SVG_PlotComponent(), SynchronizePins(), SyncLibraries(), SyncToolbars(), LIB_DRAWING_TOOLS::TwoClickPlace(), UpdateAfterSymbolProperties(), and updateTitle().

◆ GetDefaultPinLength()

static int LIB_EDIT_FRAME::GetDefaultPinLength ( )
inlinestatic

◆ GetDocumentExtents()

const BOX2I LIB_EDIT_FRAME::GetDocumentExtents ( ) const
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 730 of file lib_edit_frame.cpp.

731 {
732  LIB_PART* part = GetCurPart();
733 
734  if( !part )
735  {
736  return BOX2I( VECTOR2I(-100, -100), VECTOR2I( 200, 200 ) );
737  }
738  else
739  {
742  }
743 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
BOX2I boundingBox(T aObject)
boundingBox template method
Definition: shape_index.h:59
coord_type GetWidth() const
Definition: box2.h:195
Define a library symbol object.
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
coord_type GetHeight() const
Definition: box2.h:196
const Vec & GetOrigin() const
Definition: box2.h:191

References boundingBox(), GetCurPart(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetOrigin(), LIB_PART::GetUnitBoundingBox(), BOX2< Vec >::GetWidth(), m_convert, and m_unit.

◆ GetDoImmediateActions()

bool EDA_BASE_FRAME::GetDoImmediateActions ( ) const
inlineinherited

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

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

Definition at line 243 of file eda_base_frame.h.

243 { return m_immediateActions; }

References EDA_BASE_FRAME::m_immediateActions.

◆ GetDragActionIsMove()

bool SCH_BASE_FRAME::GetDragActionIsMove ( ) const
inlineinherited

◆ GetDragSelects()

bool EDA_BASE_FRAME::GetDragSelects ( ) const
inlineinherited

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

Definition at line 249 of file eda_base_frame.h.

249 { return m_dragSelects; }

References EDA_BASE_FRAME::m_dragSelects.

Referenced by EE_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

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

Fetches the file name from the file history list.

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

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

Definition at line 576 of file eda_base_frame.cpp.

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

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

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

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

◆ GetGalDisplayOptions()

◆ GetGridColor()

virtual COLOR4D EDA_DRAW_FRAME::GetGridColor ( )
inlinevirtualinherited

◆ GetGridOrigin()

const wxPoint& SCH_BASE_FRAME::GetGridOrigin ( ) const
inlineoverridevirtualinherited

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

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

Implements EDA_DRAW_FRAME.

Definition at line 194 of file sch_base_frame.h.

195  {
196  static wxPoint zero;
197  return zero;
198  }

◆ GetLastGridSizeId()

int EDA_DRAW_FRAME::GetLastGridSizeId ( ) const
inlineinherited

Definition at line 227 of file eda_draw_frame.h.

227 { return m_LastGridSizeId; }

References EDA_DRAW_FRAME::m_LastGridSizeId.

◆ GetLibAlias()

LIB_ALIAS * SCH_BASE_FRAME::GetLibAlias ( const LIB_ID aLibId,
bool  aUseCacheLib = false,
bool  aShowError = false 
)
inherited

Load symbol from symbol library table.

Parameters
aLibIdis the symbol library identifier to load.
aUseCacheLibset to true to fall back to cache library if symbol is not found in symbol library table.
aShowErrorMessageset to true to show any error messages.
Returns
The symbol found in the library or NULL if the symbol was not found.

Definition at line 255 of file sch_base_frame.cpp.

256 {
257  PART_LIB* cache = ( aUseCacheLib ) ? Prj().SchLibs()->GetCacheLibrary() : NULL;
258 
259  return SchGetLibAlias( aLibId, Prj().SchSymbolLibTable(), cache, this, aShowError );
260 }
static S3D_CACHE * cache
Definition: export_vrml.cpp:64
LIB_ALIAS * SchGetLibAlias(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, PART_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Load symbol from symbol library table.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Object used to load, save, search, and otherwise manipulate symbol library files.

References cache, KIWAY_HOLDER::Prj(), and SchGetLibAlias().

Referenced by SCH_BASE_FRAME::SelectCompFromLibTree(), and DIALOG_UPDATE_FIELDS::updateFields().

◆ GetLibPart()

LIB_PART * SCH_BASE_FRAME::GetLibPart ( const LIB_ID aLibId,
bool  aUseCacheLib = false,
bool  aShowErrorMsg = false 
)
inherited

Definition at line 263 of file sch_base_frame.cpp.

264 {
265  PART_LIB* cache = ( aUseCacheLib ) ? Prj().SchLibs()->GetCacheLibrary() : NULL;
266 
267  return SchGetLibPart( aLibId, Prj().SchSymbolLibTable(), cache, this, aShowErrorMsg );
268 }
static S3D_CACHE * cache
Definition: export_vrml.cpp:64
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
LIB_PART * SchGetLibPart(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, PART_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Object used to load, save, search, and otherwise manipulate symbol library files.

References cache, KIWAY_HOLDER::Prj(), and SchGetLibPart().

Referenced by SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::CreateArchiveLibrary(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnBrowseLibrary(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ GetMoveWarpsCursor()

bool EDA_BASE_FRAME::GetMoveWarpsCursor ( ) const
inlineinherited

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

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

Definition at line 255 of file eda_base_frame.h.

255 { return m_moveWarpsCursor; }

References EDA_BASE_FRAME::m_moveWarpsCursor.

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

◆ GetMruPath()

◆ GetNearestGridPosition()

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

Return the nearest aGridSize location to aPosition.

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

Definition at line 690 of file eda_draw_frame.cpp.

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

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

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

◆ GetPageSettings()

const PAGE_INFO & SCH_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 140 of file sch_base_frame.cpp.

141 {
142  return GetScreen()->GetPageSettings();
143 }
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:118

References SCH_SCREEN::GetPageSettings(), and SCH_BASE_FRAME::GetScreen().

Referenced by DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetPS().

◆ GetPageSizeIU()

const wxSize SCH_BASE_FRAME::GetPageSizeIU ( ) const
overridevirtualinherited

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

Implements EDA_DRAW_FRAME.

Definition at line 146 of file sch_base_frame.cpp.

147 {
148  // GetSizeIU is compile time dependent:
149  return GetScreen()->GetPageSettings().GetSizeIU();
150 }
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:118

References SCH_SCREEN::GetPageSettings(), and SCH_BASE_FRAME::GetScreen().

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard().

◆ GetPinNameDefaultSize()

static int LIB_EDIT_FRAME::GetPinNameDefaultSize ( )
inlinestatic

◆ GetPinNumDefaultSize()

static int LIB_EDIT_FRAME::GetPinNumDefaultSize ( )
inlinestatic

◆ GetRenderSettings()

KIGFX::SCH_RENDER_SETTINGS * SCH_BASE_FRAME::GetRenderSettings ( )
inherited

Definition at line 356 of file sch_base_frame.cpp.

357 {
358  KIGFX::PAINTER* painter = GetCanvas()->GetView()->GetPainter();
359  return static_cast<KIGFX::SCH_RENDER_SETTINGS*>( painter->GetSettings() );
360 }
KIGFX::SCH_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
Class PAINTER contains all the knowledge about how to draw graphical object onto any particular outpu...
Definition: painter.h:313
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...

References SCH_BASE_FRAME::GetCanvas(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), and SCH_DRAW_PANEL::GetView().

Referenced by DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), RebuildView(), LIB_CONTROL::ShowElectricalTypes(), PANEL_LIBEDIT_SETTINGS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), and LIB_VIEW_FRAME::updatePreviewSymbol().

◆ GetRepeatComponent()

const bool SCH_BASE_FRAME::GetRepeatComponent ( )
inlineinherited
Returns
the current setting of placing copies of the same symbol for each click

Definition at line 156 of file sch_base_frame.h.

156 { return m_repeatComponent; }

References SCH_BASE_FRAME::m_repeatComponent.

Referenced by SCH_DRAWING_TOOLS::PlaceComponent().

◆ GetRepeatDeltaLabel()

int SCH_BASE_FRAME::GetRepeatDeltaLabel ( ) const
inlineinherited
Returns
the increment value of labels like bus members for the repeat command

Definition at line 144 of file sch_base_frame.h.

144 { return m_repeatDeltaLabel; }

References SCH_BASE_FRAME::m_repeatDeltaLabel.

Referenced by SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), SaveSettings(), PANEL_EESCHEMA_SETTINGS::TransferDataToWindow(), and PANEL_LIBEDIT_SETTINGS::TransferDataToWindow().

◆ GetRepeatPinStep()

int LIB_EDIT_FRAME::GetRepeatPinStep ( ) const
inline
Returns
the increment value of the position of a pin for the pin repeat command

Definition at line 172 of file lib_edit_frame.h.

172 { return m_repeatPinStep; }
int m_repeatPinStep
Default repeat offset for pins in repeat place pin.

References m_repeatPinStep.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), LIB_PIN_TOOL::RepeatPin(), SaveSettings(), and PANEL_LIBEDIT_SETTINGS::TransferDataToWindow().

◆ GetRepeatStep()

const wxPoint SCH_BASE_FRAME::GetRepeatStep ( ) const
inlineinherited
Returns
the increment value of the position of an item for the repeat command

Definition at line 131 of file sch_base_frame.h.

131 { return m_repeatStep; }
wxPoint m_repeatStep

References SCH_BASE_FRAME::m_repeatStep.

Referenced by SCH_EDIT_TOOL::RepeatDrawItem(), SaveSettings(), PANEL_LIBEDIT_SETTINGS::TransferDataToWindow(), and PANEL_EESCHEMA_SETTINGS::TransferDataToWindow().

◆ GetScreen()

SCH_SCREEN * SCH_BASE_FRAME::GetScreen ( ) const
overridevirtualinherited

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

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

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 110 of file sch_base_frame.cpp.

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

References EDA_DRAW_FRAME::GetScreen().

Referenced by SCH_BASE_FRAME::AddToScreen(), EE_INSPECTION_TOOL::checkPart(), LIB_CONTROL::ExportSymbolAsSVG(), SCH_BASE_FRAME::GetAuxOrigin(), GetComponentFromRedoList(), GetComponentFromUndoList(), EE_SELECTION_TOOL::GetNode(), SCH_BASE_FRAME::GetPageSettings(), SCH_BASE_FRAME::GetPageSizeIU(), SCH_BASE_FRAME::GetTitleBlock(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LoadComponentAndSelectLib(), LoadComponentFromCurrentLib(), LoadOneLibraryPartAux(), EDIT_POINTS_FACTORY::Make(), OnModify(), PrintPage(), EE_SELECTION_TOOL::RebuildSelection(), ReCreateMenuBar(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RemoveFromScreen(), RollbackPartFromUndo(), SaveCopyInUndoList(), EE_SELECTION_TOOL::SelectConnection(), EE_SELECTION_TOOL::SelectPoint(), SCH_BASE_FRAME::SetAuxOrigin(), SCH_BASE_FRAME::SetPageSettings(), SCH_BASE_FRAME::SetTitleBlock(), LIB_VIEW_FRAME::setupTools(), setupTools(), storeCurrentPart(), SVG_PlotComponent(), SyncToolbars(), SCH_BASE_FRAME::SyncView(), and SCH_BASE_FRAME::UpdateStatusBar().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 801 of file eda_draw_frame.cpp.

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

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

◆ GetShowAllPins()

virtual bool SCH_BASE_FRAME::GetShowAllPins ( ) const
inlinevirtualinherited

Allow some frames to show/hide hidden pins.

The default impl shows all pins.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 119 of file sch_base_frame.h.

119 { return true; }

Referenced by EE_SELECTION_TOOL::Selectable().

◆ GetShowDeMorgan()

bool LIB_EDIT_FRAME::GetShowDeMorgan ( ) const
inline

Definition at line 274 of file lib_edit_frame.h.

274 { return m_showDeMorgan; }
static bool m_showDeMorgan

References m_showDeMorgan.

Referenced by SyncToolbars(), and DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

◆ GetShowElectricalType()

bool SCH_BASE_FRAME::GetShowElectricalType ( )
inlineinherited

◆ GetShowPolarCoords()

◆ getTargetLib()

wxString LIB_EDIT_FRAME::getTargetLib ( ) const
private

Returns either the library selected in the component tree, if context menu is active or the library that is currently modified.

Definition at line 536 of file lib_edit_frame.cpp.

537 {
538  return getTargetLibId().GetLibNickname();
539 }
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
LIB_ID getTargetLibId() const
Returns either the part selected in the component tree, if context menu is active or the currently mo...

References LIB_ID::GetLibNickname(), and getTargetLibId().

Referenced by CreateNewPart(), and ImportPart().

◆ getTargetLibId()

LIB_ID LIB_EDIT_FRAME::getTargetLibId ( ) const
private

Returns either the part selected in the component tree, if context menu is active or the currently modified part.

Definition at line 525 of file lib_edit_frame.cpp.

526 {
527  LIB_ID id = GetTreeLIBID();
528 
529  if( id.GetLibNickname().empty() && GetCurPart() )
530  id = GetCurPart()->GetLibId();
531 
532  return id;
533 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
LIB_ID GetTreeLIBID(int *aUnit=nullptr) const
Return the LIB_ID of the library or symbol selected in the symbol tree.
const LIB_ID & GetLibId() const
static bool empty(const wxTextEntryBase *aCtrl)

References empty(), GetCurPart(), LIB_PART::GetLibId(), and GetTreeLIBID().

Referenced by DeletePartFromLibrary(), getTargetLib(), ReCreateMenuBar(), Revert(), Save(), SaveAs(), savePartAs(), and SyncToolbars().

◆ getTargetPart()

LIB_PART * LIB_EDIT_FRAME::getTargetPart ( ) const
private

Returns currently edited part.

Definition at line 511 of file lib_edit_frame.cpp.

512 {
513  LIB_ID libId = GetTreeLIBID();
514 
515  if( libId.IsValid() )
516  {
517  LIB_ALIAS* alias = m_libMgr->GetAlias( libId.GetLibItemName(), libId.GetLibNickname() );
518  return alias ? alias->GetPart() : nullptr;
519  }
520 
521  return GetCurPart();
522 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
Part library alias object definition.
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
LIB_MANAGER * m_libMgr
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Definition: lib_id.h:171
LIB_ALIAS * GetAlias(const wxString &aAlias, const wxString &aLibrary) const
Returns either an alias of a working LIB_PART copy, or alias of the original part if there is no work...
LIB_ID GetTreeLIBID(int *aUnit=nullptr) const
Return the LIB_ID of the library or symbol selected in the symbol tree.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
LIB_PART * GetPart() const
Get the shared LIB_PART.

References LIB_MANAGER::GetAlias(), GetCurPart(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), GetTreeLIBID(), LIB_ID::IsValid(), and m_libMgr.

Referenced by ExportPart().

◆ GetTemplateFieldName()

const TEMPLATE_FIELDNAME* SCH_BASE_FRAME::GetTemplateFieldName ( const wxString &  aName) const
inlineinherited

Search for aName in the the template field name list.

Parameters
aNameA wxString object containing the field name to search for.
Returns
the template fieldname if found; NULL otherwise.

Definition at line 273 of file sch_base_frame.h.

274  {
275  return m_templateFieldNames.GetFieldName( aName );
276  }
TEMPLATES m_templateFieldNames
const TEMPLATE_FIELDNAME * GetFieldName(const wxString &aName) const
Function GetFieldName searches for aName in the the template field name list.

References TEMPLATES::GetFieldName(), and SCH_BASE_FRAME::m_templateFieldNames.

◆ GetTemplateFieldNames()

const TEMPLATE_FIELDNAMES& SCH_BASE_FRAME::GetTemplateFieldNames ( ) const
inlineinherited

Return a template field names list for read only access.

Definition at line 262 of file sch_base_frame.h.

263  {
265  }
TEMPLATES m_templateFieldNames
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames() const
Function GetTemplateFieldName returns a template fieldnames list for read only access.

References TEMPLATES::GetTemplateFieldNames(), and SCH_BASE_FRAME::m_templateFieldNames.

Referenced by DIALOG_FIELDS_EDITOR_GLOBAL::LoadFieldNames(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), PANEL_EESCHEMA_TEMPLATE_FIELDNAMES::TransferDataToWindow(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().

◆ GetTitleBlock()

const TITLE_BLOCK & SCH_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 167 of file sch_base_frame.cpp.

168 {
169  wxASSERT( GetScreen() );
170  return GetScreen()->GetTitleBlock();
171 }
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:128

References SCH_BASE_FRAME::GetScreen(), and SCH_SCREEN::GetTitleBlock().

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetPS().

◆ GetToolManager()

TOOL_MANAGER* EDA_BASE_FRAME::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 222 of file eda_base_frame.h.

222 { return m_toolManager; }
TOOL_MANAGER * m_toolManager

References EDA_BASE_FRAME::m_toolManager.

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

◆ GetTreeLIBID()

LIB_ID LIB_EDIT_FRAME::GetTreeLIBID ( int *  aUnit = nullptr) const

Return the LIB_ID of the library or symbol selected in the symbol tree.

Definition at line 505 of file lib_edit_frame.cpp.

506 {
507  return m_treePane->GetLibTree()->GetSelectedLibId( aUnit );
508 }
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:145
LIB_TREE * GetLibTree() const
SYMBOL_TREE_PANE * m_treePane

References SYMBOL_TREE_PANE::GetLibTree(), LIB_TREE::GetSelectedLibId(), and m_treePane.

Referenced by LIB_CONTROL::EditSymbol(), getTargetLibId(), getTargetPart(), and LIB_CONTROL::Init().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

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

◆ GetUnit()

◆ GetUseAllUnits()

const bool SCH_BASE_FRAME::GetUseAllUnits ( )
inlineinherited
Returns
the current setting to use all units when placing a component

Definition at line 167 of file sch_base_frame.h.

167 { return m_useAllUnits; }

References SCH_BASE_FRAME::m_useAllUnits.

Referenced by SCH_DRAWING_TOOLS::PlaceComponent().

◆ GetUserUnits()

EDA_UNITS_T EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 210 of file eda_base_frame.h.

210 { return m_userUnits; }
EDA_UNITS_T m_userUnits

References EDA_BASE_FRAME::m_userUnits.

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

◆ GetZoom()

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

Definition at line 343 of file eda_draw_frame.cpp.

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

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

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

◆ GetZoomLevelCoeff()

double EDA_DRAW_FRAME::GetZoomLevelCoeff ( ) const
inlineinherited

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

Definition at line 289 of file eda_draw_frame.h.

289 { return m_zoomLevelCoeff; }
double m_zoomLevelCoeff

References EDA_DRAW_FRAME::m_zoomLevelCoeff.

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

◆ GetZoomLevelIndicator()

const wxString SCH_BASE_FRAME::GetZoomLevelIndicator ( ) const
overridevirtualinherited

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

Virtual from the base class

Reimplemented from EDA_DRAW_FRAME.

Definition at line 128 of file sch_base_frame.cpp.

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

References EDA_DRAW_FRAME::GetZoomLevelIndicator().

◆ HardRedraw()

void LIB_EDIT_FRAME::HardRedraw ( )
overridevirtual

Rebuild the GAL and redraw the screen.

Call when something went wrong.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 723 of file lib_edit_frame.cpp.

724 {
725  SyncLibraries( true );
726  RebuildView();
727 }
void SyncLibraries(bool aShowProgress)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...

References RebuildView(), and SyncLibraries().

◆ HasLibModifications()

bool LIB_EDIT_FRAME::HasLibModifications ( ) const

Check if any pending libraries have been modified.

This only checks for modified libraries. If a new symbol was created and modified and no libraries have been modified, the return value will be false.

Returns
True if there are any pending library modifications.

Definition at line 810 of file lib_edit_frame.cpp.

811 {
812  wxCHECK( m_libMgr, false );
813 
814  return m_libMgr->HasModifications();
815 }
LIB_MANAGER * m_libMgr
bool HasModifications() const
Definition: lib_manager.cpp:65

References LIB_MANAGER::HasModifications(), and m_libMgr.

Referenced by InvokeSchEditSymbolLibTable().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 552 of file eda_base_frame.cpp.

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

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

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

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

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

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

◆ ImportPart()

void LIB_EDIT_FRAME::ImportPart ( )

Definition at line 36 of file lib_export.cpp.

37 {
38  wxString msg;
39  wxString libName = getTargetLib();
40 
41  if( !m_libMgr->LibraryExists( libName ) )
42  {
43  libName = SelectLibraryFromList();
44 
45  if( !m_libMgr->LibraryExists( libName ) )
46  return;
47  }
48 
49  wxFileDialog dlg( this, _( "Import Symbol" ), m_mruPath, wxEmptyString,
50  SchematicLibraryFileWildcard(), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
51 
52  if( dlg.ShowModal() == wxID_CANCEL )
53  return;
54 
55  wxFileName fn = dlg.GetPath();
56  m_mruPath = fn.GetPath();
57 
58  wxArrayString symbols;
59  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
60 
61  // TODO dialog to select the part to be imported if there is more than one
62  try
63  {
64  pi->EnumerateSymbolLib( symbols, fn.GetFullPath() );
65  }
66  catch( const IO_ERROR& ioe )
67  {
68  msg.Printf( _( "Cannot import symbol library \"%s\"." ), fn.GetFullPath() );
69  DisplayErrorMessage( this, msg, ioe.What() );
70  return;
71  }
72 
73  if( symbols.empty() )
74  {
75  msg.Printf( _( "Symbol library file \"%s\" is empty." ), fn.GetFullPath() );
76  DisplayError( this, msg );
77  return;
78  }
79 
80  wxString symbolName = symbols[0];
81  LIB_ALIAS* entry = pi->LoadSymbol( fn.GetFullPath(), symbolName );
82 
83  if( m_libMgr->PartExists( symbols[0], libName ) )
84  {
85  msg.Printf( _( "Symbol \"%s\" already exists in library \"%s\"." ), symbolName, libName );
86  DisplayError( this, msg );
87  return;
88  }
89 
90  m_libMgr->UpdatePart( entry->GetPart(), libName );
91  SyncLibraries( false );
92  LoadPart( symbolName, libName, 1 );
93 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
Part library alias object definition.
wxString m_mruPath
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
void LoadPart(const wxString &aLibrary, const wxString &aPart, int Unit)
Definition: libedit.cpp:729
LIB_MANAGER * m_libMgr
wxString SelectLibraryFromList()
Display a list of loaded libraries in the symbol library and allows the user to select a library.
Definition: libedit.cpp:74
wxString SchematicLibraryFileWildcard()
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
LIB_PART * GetPart() const
Get the shared LIB_PART.
bool PartExists(const wxString &aAlias, const wxString &aLibrary) const
Returns true if part with a specific alias exists in library (either original one or buffered).
#define _(s)
bool UpdatePart(LIB_PART *aPart, const wxString &aLibrary)
Updates the part buffer with a new version of the part.
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:520
void SyncLibraries(bool aShowProgress)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Returns true if library exists.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
wxString getTargetLib() const
Returns either the library selected in the component tree, if context menu is active or the library t...

References _, DisplayError(), DisplayErrorMessage(), LIB_ALIAS::GetPart(), getTargetLib(), LIB_MANAGER::LibraryExists(), LoadPart(), m_libMgr, EDA_BASE_FRAME::m_mruPath, LIB_MANAGER::PartExists(), SchematicLibraryFileWildcard(), SelectLibraryFromList(), SyncLibraries(), LIB_MANAGER::UpdatePart(), and IO_ERROR::What().

Referenced by LIB_CONTROL::AddSymbol().

◆ InitExitKey()

void EDA_DRAW_FRAME::InitExitKey ( )
protectedinherited

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

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

Definition at line 316 of file eda_draw_frame.cpp.

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

Referenced by FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME().

◆ InstallPreferences()

void LIB_EDIT_FRAME::InstallPreferences ( PAGED_DIALOG aParent,
PANEL_HOTKEYS_EDITOR aHotkeysPanel 
)
overridevirtual

Allows Libedit to install its preferences panel into the preferences dialog.

Reimplemented from EDA_BASE_FRAME.

Definition at line 477 of file eeschema_config.cpp.

479 {
480  wxTreebook* book = aParent->GetTreebook();
481 
482  book->AddPage( new wxPanel( book ), _( "Symbol Editor" ) );
483  book->AddSubPage( new PANEL_DISPLAY_OPTIONS( this, aParent ), _( "Display Options" ) );
484  book->AddSubPage( new PANEL_LIBEDIT_SETTINGS( this, book ), _( "Defaults" ) );
485 
486  aHotkeysPanel->AddHotKeys( GetToolManager() );
487 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
void AddHotKeys(TOOL_MANAGER *aToolMgr)
wxTreebook * GetTreebook()
Definition: paged_dialog.h:43
#define _(s)

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

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

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

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 181 of file eda_base_frame.h.

181 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ isCurrentPart()

bool LIB_EDIT_FRAME::isCurrentPart ( const LIB_ID aLibId) const
private

Returns true if aLibId is an alias for the editor screen part.

Definition at line 656 of file lib_edit_frame.cpp.

657 {
658  // This will return the root part of any alias
659  LIB_PART* part = m_libMgr->GetBufferedPart( aLibId.GetLibItemName(), aLibId.GetLibNickname() );
660  // Now we can compare the libId of the current part and the root part
661  return ( part && GetCurPart() && part->GetLibId() == GetCurPart()->GetLibId() );
662 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
LIB_MANAGER * m_libMgr
const LIB_ID & GetLibId() const
Define a library symbol object.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
LIB_PART * GetBufferedPart(const wxString &aAlias, const wxString &aLibrary)
Returns the part copy from the buffer.

References LIB_MANAGER::GetBufferedPart(), GetCurPart(), LIB_PART::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and m_libMgr.

Referenced by DeletePartFromLibrary(), Revert(), and savePartAs().

◆ IsCurrentTool()

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

Definition at line 229 of file eda_base_frame.cpp.

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

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

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

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited

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

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

Definition at line 154 of file kiway_player.cpp.

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

References KIWAY_PLAYER::m_modal_loop.

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

◆ IsGridVisible()

◆ IsModal()

◆ IsSearchTreeShown()

bool LIB_EDIT_FRAME::IsSearchTreeShown ( )

Definition at line 286 of file lib_edit_frame.cpp.

287 {
288  return m_auimgr.GetPane( m_treePane ).IsShown();
289 }
wxAuiManager m_auimgr
SYMBOL_TREE_PANE * m_treePane

References EDA_BASE_FRAME::m_auimgr, and m_treePane.

Referenced by OnToggleSearchTree(), ReCreateMenuBar(), and SyncToolbars().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 284 of file eda_base_frame.h.

284 { return m_Ident == aType; }

References EDA_BASE_FRAME::m_Ident.

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

◆ IsWritable()

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

Checks if aFileName can be written.

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

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

Definition at line 645 of file eda_base_frame.cpp.

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

References _, and GetChars().

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 175 of file kiway_player.cpp.

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

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void LIB_EDIT_FRAME::KiwayMailIn ( KIWAY_EXPRESS aEvent)
overridevirtual

Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.

Merely override it in derived classes.

Reimplemented from KIWAY_PLAYER.

Definition at line 746 of file lib_edit_frame.cpp.

747 {
748  const std::string& payload = mail.GetPayload();
749 
750  switch( mail.Command() )
751  {
752  case MAIL_LIB_EDIT:
753  if( !payload.empty() )
754  {
755  wxString libFileName( payload );
756  wxString libNickname;
757  wxString msg;
758 
759  SYMBOL_LIB_TABLE* libTable = Prj().SchSymbolLibTable();
760  const LIB_TABLE_ROW* libTableRow = libTable->FindRowByURI( libFileName );
761 
762  if( !libTableRow )
763  {
764  msg.Printf( _( "The current configuration does not include the symbol library\n"
765  "\"%s\".\nUse Manage Symbol Libraries to edit the configuration." ),
766  libFileName );
767  DisplayErrorMessage( this, _( "Library not found in symbol library table." ), msg );
768  break;
769  }
770 
771  libNickname = libTableRow->GetNickName();
772 
773  if( !libTable->HasLibrary( libNickname, true ) )
774  {
775  msg.Printf( _( "The library with the nickname \"%s\" is not enabled\n"
776  "in the current configuration. Use Manage Symbol Libraries to\n"
777  "edit the configuration." ), libNickname );
778  DisplayErrorMessage( this, _( "Symbol library not enabled." ), msg );
779  break;
780  }
781 
782  SetCurLib( libNickname );
783 
784  if( m_treePane )
785  {
786  LIB_ID id( libNickname, wxEmptyString );
789  }
790  }
791 
792  break;
793 
794  default:
795  ;
796  }
797 }
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const wxString & GetNickName() const
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const LIB_TABLE_ROW * FindRowByURI(const wxString &aURI)
#define _(s)
void ExpandLibId(const LIB_ID &aLibId)
Expand and item i the tree widget.
Definition: lib_tree.cpp:180
wxString SetCurLib(const wxString &aLibNickname)
Sets the current library nickname and returns the old library nickname.
LIB_TREE * GetLibTree() const
SYMBOL_TREE_PANE * m_treePane
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferrably centered).
Definition: lib_tree.cpp:169

References _, LIB_TREE::CenterLibId(), KIWAY_EXPRESS::Command(), DisplayErrorMessage(), LIB_TREE::ExpandLibId(), LIB_TABLE::FindRowByURI(), SYMBOL_TREE_PANE::GetLibTree(), LIB_TABLE_ROW::GetNickName(), KIWAY_EXPRESS::GetPayload(), LIB_TABLE::HasLibrary(), m_treePane, MAIL_LIB_EDIT, KIWAY_HOLDER::Prj(), and SetCurLib().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

Function language_change is an event handler called on a language menu selection.

Definition at line 182 of file kiway_player.cpp.

183 {
184  int id = event.GetId();
185 
186  // tell all the KIWAY_PLAYERs about the language change.
187  Kiway().SetLanguage( id );
188 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY void SetLanguage(int aLanguage)
Function SetLanguage changes the language and then calls ShowChangedLanguage() on all KIWAY_PLAYERs.
Definition: kiway.cpp:422

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

◆ LibraryFileBrowser()

bool EDA_DRAW_FRAME::LibraryFileBrowser ( bool  doOpen,
wxFileName &  aFilename,
const wxString &  wildcard,
const wxString &  ext,
bool  isDirectory = false 
)
protectedinherited
Parameters
doOpenif true runs an Open Library browser, otherwise New Library
aFilenamefor New may contain a default name; in both cases return the chosen filename.
wildcarda wildcard to filter the displayed files
extthe library file extension
isDirectoryindicates the library files are directories
Returns
true for OK; false for Cancel.

Definition at line 807 of file eda_draw_frame.cpp.

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

References _, and KIWAY_HOLDER::Prj().

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

◆ LoadCanvasTypeSetting()

EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::LoadCanvasTypeSetting ( )
inherited

Returns the canvas type stored in the application settings.

Definition at line 613 of file eda_draw_frame.cpp.

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

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

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

◆ LoadComponentAndSelectLib()

bool LIB_EDIT_FRAME::LoadComponentAndSelectLib ( const LIB_ID aLibId,
int  aUnit,
int  aConvert 
)

Selects the currently active library and loads the symbol from aLibId.

Parameters
aLibIdis the LIB_ID of the symbol to select.
aUnitthe unit to show
aConvertthe DeMorgan variant to show
Returns
true if the symbol defined by aLibId was loaded.

Definition at line 141 of file libedit.cpp.

142 {
143  if( GetCurPart() && GetCurPart()->GetLibId() == aLibId
144  && GetUnit() == aUnit && GetConvert() == aConvert )
145  {
146  return true;
147  }
148 
149  if( GetScreen()->IsModify() && GetCurPart() )
150  {
151  if( !HandleUnsavedChanges( this, _( "The current symbol has been modified. "
152  "Save changes?" ),
153  [&]()->bool { return saveCurrentPart(); } ) )
154  {
155  return false;
156  }
157  }
158 
160  return LoadComponentFromCurrentLib( aLibId.GetLibItemName(), aUnit, aConvert );
161 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
bool LoadComponentFromCurrentLib(const wxString &aAliasName, int aUnit=0, int aConvert=0)
Loads a symbol from the current active library, optionally setting the selected unit and convert.
Definition: libedit.cpp:164
int GetConvert() const
void SelectActiveLibrary(const wxString &aLibrary=wxEmptyString)
Set the current active library to aLibrary.
Definition: libedit.cpp:60
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
int GetUnit() const
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
#define _(s)
bool saveCurrentPart()
Saves the current part.
Definition: libedit.cpp:122

References _, GetConvert(), GetCurPart(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SCH_BASE_FRAME::GetScreen(), GetUnit(), HandleUnsavedChanges(), LoadComponentFromCurrentLib(), saveCurrentPart(), and SelectActiveLibrary().

Referenced by SCH_EDITOR_CONTROL::EditWithLibEdit().

◆ LoadComponentFromCurrentLib()

bool LIB_EDIT_FRAME::LoadComponentFromCurrentLib ( const wxString &  aAliasName,
int  aUnit = 0,
int  aConvert = 0 
)
private

Loads a symbol from the current active library, optionally setting the selected unit and convert.

Parameters
aAliasNameThe symbol alias name to load from the current library.
aUnitUnit to be selected
aConvertConvert to be selected
Returns
true if the symbol loaded correctly.

Definition at line 164 of file libedit.cpp.

166 {
167  LIB_ALIAS* alias = nullptr;
168 
169  try
170  {
171  alias = Prj().SchSymbolLibTable()->LoadSymbol( GetCurLib(), aAliasName );
172  }
173  catch( const IO_ERROR& ioe )
174  {
175  wxString msg;
176 
177  msg.Printf( _( "Error occurred loading symbol \"%s\" from library \"%s\"." ),
178  aAliasName, GetCurLib() );
179  DisplayErrorMessage( this, msg, ioe.What() );
180  return false;
181  }
182 
183  if( !alias || !LoadOneLibraryPartAux( alias, GetCurLib(), aUnit, aConvert ) )
184  return false;
185 
186  // Enable synchronized pin edit mode for symbols with interchangeable units
188 
191  SetShowDeMorgan( GetCurPart()->HasConversion() );
192 
193  if( aUnit > 0 )
195 
196  return true;
197 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
Part library alias object definition.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
void SetShowDeMorgan(bool show)
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...
bool LoadOneLibraryPartAux(LIB_ALIAS *aLibEntry, const wxString &aLibrary, int aUnit, int aConvert)
Create a copy of aLibEntry into memory.
Definition: libedit.cpp:216
#define _(s)
void RebuildSymbolUnitsList()
bool m_SyncPinEdit
Set to true to synchronize pins at the same position when editing symbols with multiple units or mult...
TOOL_MANAGER * m_toolManager
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
bool UnitsLocked() const
Check whether part units are interchangeable.

References _, BASE_SCREEN::ClearUndoRedoList(), DisplayErrorMessage(), GetCurLib(), GetCurPart(), SCH_BASE_FRAME::GetScreen(), LoadOneLibraryPartAux(), m_SyncPinEdit, EDA_BASE_FRAME::m_toolManager, KIWAY_HOLDER::Prj(), RebuildSymbolUnitsList(), TOOL_MANAGER::RunAction(), SetShowDeMorgan(), LIB_PART::UnitsLocked(), IO_ERROR::What(), and ACTIONS::zoomFitScreen.

Referenced by LoadComponentAndSelectLib().

◆ LoadOneLibraryPartAux()

bool LIB_EDIT_FRAME::LoadOneLibraryPartAux ( LIB_ALIAS aLibEntry,
const wxString &  aLibrary,
int  aUnit,
int  aConvert 
)
private

Create a copy of aLibEntry into memory.

Parameters
aLibEntryA pointer to the LIB_ALIAS object to an already loaded.
aLibrarythe path to the library file that aLibEntry was loaded from. This is for error messaging purposes only.
aUnitthe initial unit to show.
aConvertthe initial DeMorgan variant to show.
Returns
True if a copy of aLibEntry was successfully copied.

Definition at line 216 of file libedit.cpp.

218 {
219  wxString msg, rootName;
220 
221  if( !aEntry || aLibrary.empty() )
222  return false;
223 
224  if( aEntry->GetName().IsEmpty() )
225  {
226  wxLogWarning( "Symbol in library \"%s\" has empty name field.", aLibrary );
227  return false;
228  }
229 
230  LIB_PART* lib_part = m_libMgr->GetBufferedPart( aEntry->GetName(), aLibrary );
231  wxASSERT( lib_part );
232 
233  m_unit = aUnit > 0 ? aUnit : 1;
234  m_convert = aConvert > 0 ? aConvert : 1;
235 
236  // The buffered screen for the part
237  SCH_SCREEN* part_screen = m_libMgr->GetScreen( lib_part->GetName(), aLibrary );
238 
239  const SCH_SCREEN* curr_screen = GetScreen();
240 
241  // Before we set the frame screen, transfer any settings from the current
242  // screen that we want to keep to the incoming (buffered) part's screen
243  // which could be out of date relative to the current screen.
244  if( curr_screen )
245  synchronizeLibEditScreenSettings( *curr_screen, *part_screen );
246 
247  SetScreen( part_screen );
248  SetCurPart( new LIB_PART( *lib_part ) );
249  SetCurLib( aLibrary );
250 
252  updateTitle();
254  SetShowDeMorgan( GetCurPart()->HasConversion() );
255  SyncToolbars();
256 
257  // Display the document information based on the entry selected just in
258  // case the entry is an alias.
259  DisplayCmpDoc();
260  Refresh();
261 
262  return true;
263 }
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
static void synchronizeLibEditScreenSettings(const SCH_SCREEN &aCurrentScreen, SCH_SCREEN &aIncomingScreen)
Synchronize screen settings from a current screen into another screen.
Definition: libedit.cpp:209
LIB_MANAGER * m_libMgr
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:93
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
void SetShowDeMorgan(bool show)
void SyncToolbars() override
Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
SCH_SCREEN * GetScreen(const wxString &aAlias, const wxString &aLibrary)
Returns the screen used to edit a specific part.
Define a library symbol object.
void RebuildSymbolUnitsList()
void DisplayCmpDoc()
Display the documentation of the selected component.
Definition: symbedit.cpp:205
void updateTitle()
Updates the main window title bar with the current library name and read only status of the library.
Definition: libedit.cpp:48
LIB_PART * GetBufferedPart(const wxString &aAlias, const wxString &aLibrary)
Returns the part copy from the buffer.
void SetCurPart(LIB_PART *aPart)
Take ownership of aPart and notes that it is the one currently being edited.
const wxString & GetName() const
void SetScreen(BASE_SCREEN *aScreen) override
wxString SetCurLib(const wxString &aLibNickname)
Sets the current library nickname and returns the old library nickname.
TOOL_MANAGER * m_toolManager

References DisplayCmpDoc(), LIB_MANAGER::GetBufferedPart(), GetCurPart(), LIB_ALIAS::GetName(), LIB_PART::GetName(), SCH_BASE_FRAME::GetScreen(), LIB_MANAGER::GetScreen(), m_convert, m_libMgr, EDA_BASE_FRAME::m_toolManager, m_unit, RebuildSymbolUnitsList(), Refresh(), TOOL_MANAGER::RunAction(), SetCurLib(), SetCurPart(), SetScreen(), SetShowDeMorgan(), synchronizeLibEditScreenSettings(), SyncToolbars(), updateTitle(), and ACTIONS::zoomFitScreen.

Referenced by LoadComponentFromCurrentLib(), and LoadPart().

◆ LoadOneSymbol()

void LIB_EDIT_FRAME::LoadOneSymbol ( )
private

Read a component symbol file (*.sym ) and add graphic items to the current component.

A symbol file *.sym has the same format as a library, and contains only one symbol.

Definition at line 43 of file symbedit.cpp.

44 {
46  LIB_PART* part = GetCurPart();
47 
48  // Exit if no library entry is selected or a command is in progress.
49  if( !part || !EE_CONDITIONS::Idle( selTool->GetSelection() ) )
50  return;
51 
52  PROJECT& prj = Prj();
53  SEARCH_STACK* search = prj.SchSearchS();
54 
55  wxString default_path = prj.GetRString( PROJECT::SCH_LIB_PATH );
56 
57  if( !default_path )
58  default_path = search->LastVisitedPath();
59 
60  wxFileDialog dlg( this, _( "Import Symbol" ), default_path,
61  wxEmptyString, SchematicSymbolFileWildcard(),
62  wxFD_OPEN | wxFD_FILE_MUST_EXIST );
63 
64  if( dlg.ShowModal() == wxID_CANCEL )
65  return;
66 
67  wxString filename = dlg.GetPath();
68 
69  prj.SetRString( PROJECT::SCH_LIB_PATH, filename );
70 
71  wxArrayString symbols;
72  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
73 
74  wxString msg;
75 
76  try
77  {
78  pi->EnumerateSymbolLib( symbols, filename );
79  }
80  catch( const IO_ERROR& ioe )
81  {
82  msg.Printf( _( "Cannot import symbol library \"%s\"." ), filename );
83  DisplayErrorMessage( this, msg, ioe.What() );
84  return;
85  }
86 
87  if( symbols.empty() )
88  {
89  msg.Printf( _( "Symbol library file \"%s\" is empty." ), filename );
90  DisplayError( this, msg );
91  return;
92  }
93 
94  if( symbols.GetCount() > 1 )
95  {
96  msg.Printf( _( "More than one symbol found in symbol file \"%s\"." ), filename );
97  wxMessageBox( msg, _( "Warning" ), wxOK | wxICON_EXCLAMATION, this );
98  }
99 
100  LIB_ALIAS* alias = nullptr;
101 
102  try
103  {
104  alias = pi->LoadSymbol( filename, symbols[0] );
105  }
106  catch( const IO_ERROR& )
107  {
108  return;
109  }
110 
111  wxCHECK_RET( alias && alias->GetPart(), "Invalid symbol." );
112 
113  SaveCopyInUndoList( part );
114 
115  LIB_PART* first = alias->GetPart();
116  LIB_ITEMS_CONTAINER& drawList = first->GetDrawItems();
117 
118  for( LIB_ITEM& item : drawList )
119  {
120  if( item.Type() == LIB_FIELD_T )
121  continue;
122 
123  if( item.GetUnit() )
124  item.SetUnit( m_unit );
125 
126  if( item.GetConvert() )
127  item.SetConvert( m_convert );
128 
129  item.SetFlags( IS_NEW | SELECTED );
130 
131  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
132 
133  newItem->SetParent( part );
134  part->AddDrawItem( newItem );
135  item.ClearSelected();
136  }
137 
138  part->RemoveDuplicateDrawItems();
139 
140  OnModify();
141 }
wxString SchematicSymbolFileWildcard()
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
LIB_PART * GetCurPart() const
Return the current part being edited or NULL if none selected.
Part library alias object definition.
Class PROJECT holds project specific data.
Definition: project.h:58
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
Class SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
static SELECTION_CONDITION Idle
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
EE_SELECTION & GetSelection()
Function GetSelection()
#define IS_NEW
New item, just created.
Definition: base_struct.h:120
#define SELECTED
Definition: base_struct.h:127
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:225
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Define a library symbol object.
LIB_PART * GetPart() const
Get the shared LIB_PART.
#define _(s)
VTBL_ENTRY void SetRString(RSTRING_T aStringId, const wxString &aString)
Function SetRString stores a "retained string", which is any session and project specific string iden...
Definition: project.cpp:171
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:520
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:186
const wxString LastVisitedPath(const wxString &aSubPathToSearch=wxEmptyString)
Function LastVisitedPath is a quirky function inherited from old code that seems to serve particular ...
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current symbol.
TOOL_MANAGER * m_toolManager
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
void SaveCopyInUndoList(EDA_ITEM *ItemToCopy, UNDO_REDO_T undoType=UR_LIBEDIT, bool aAppend=false)
Create a copy of the current component, and save it in the undo list.

References _, EDA_ITEM::Clone(), DisplayError(), DisplayErrorMessage(), GetCurPart(), LIB_PART::GetDrawItems(), LIB_ALIAS::GetPart(), PROJECT::GetRString(), EE_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), EE_CONDITIONS::Idle, IS_NEW, SEARCH_STACK::LastVisitedPath(), LIB_FIELD_T, m_convert, EDA_BASE_FRAME::m_toolManager, m_unit, OnModify(), KIWAY_HOLDER::Prj(), SaveCopyInUndoList(), PROJECT::SCH_LIB_PATH, SchematicSymbolFileWildcard(), SELECTED, EDA_ITEM::SetParent(), PROJECT::SetRString(), and IO_ERROR::What().

Referenced by OnImportBody().

◆ LoadPart()

void LIB_EDIT_FRAME::LoadPart ( const wxString &  aLibrary,
const wxString &  aPart,
int  Unit 
)

Definition at line 729 of file libedit.cpp.

730 {
731  wxCHECK( m_libMgr->PartExists( aAlias, aLibrary ), /* void */ );
732  LIB_PART* part = m_libMgr->GetBufferedPart( aAlias, aLibrary );
733  LIB_ALIAS* alias = part ? part->GetAlias( aAlias ) : nullptr;
734 
735  if( !alias )
736  {
737  wxString msg = wxString::Format( _( "Symbol name \"%s\" not found in library \"%s\"" ),
738  GetChars( aAlias ),
739  GetChars( aLibrary ) );
740  DisplayError( this, msg );
741  return;
742  }
743 
744  // Optimize default edit options for this symbol
745  // Usually if units are locked, graphic items are specific to each unit
746  // and if units are interchangeable, graphic items are common to units
747  m_DrawSpecificUnit = part->UnitsLocked();
748 
749  LoadOneLibraryPartAux( alias, aLibrary, aUnit, 0 );
750 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
bool m_DrawSpecificUnit
Specify which component parts the current draw item applies to.
Part library alias object definition.
LIB_MANAGER * m_libMgr
Define a library symbol object.
bool LoadOneLibraryPartAux(LIB_ALIAS *aLibEntry, const wxString &aLibrary, int aUnit, int aConvert)
Create a copy of aLibEntry into memory.
Definition: libedit.cpp:216
bool PartExists(const wxString &aAlias, const wxString &aLibrary) const
Returns true if part with a specific alias exists in library (either original one or buffered).
#define _(s)
LIB_PART * GetBufferedPart(const wxString &aAlias, const wxString &aLibrary)
Returns the part copy from the buffer.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References _, DisplayError(), Format(), LIB_MANAGER::GetBufferedPart(), GetChars(), LoadOneLibraryPartAux(), m_DrawSpecificUnit, m_libMgr, and LIB_MANAGER::PartExists().

Referenced by CreateNewPart(), LIB_CONTROL::EditSymbol(), ImportPart(), Revert(), and savePartAs().

◆ LoadSettings()

void LIB_EDIT_FRAME::LoadSettings ( wxConfigBase *  aCfg)
overridevirtual

Load common frame parameters from a configuration file.

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

Reimplemented from EDA_BASE_FRAME.

Definition at line 413 of file eeschema_config.cpp.

414 {
416 
424 
425  wxPoint step;
426  aCfg->Read( repeatLibStepXEntry, &step.x, DEFAULT_REPEAT_OFFSET_X );
427  aCfg->Read( repeatLibStepYEntry, &step.y, DEFAULT_REPEAT_OFFSET_Y );
428  SetRepeatStep( step );
429  m_showPinElectricalTypeName = aCfg->ReadBool( showPinElectricalType, true );
431 
432  wxString templateFieldNames = aCfg->Read( FieldNamesEntry, wxEmptyString );
433 
434  if( !templateFieldNames.IsEmpty() )
435  {
436  TEMPLATE_FIELDNAMES_LEXER lexer( TO_UTF8( templateFieldNames ) );
437 
438