SYMBOL_SAVE_AS_HANDLER Class Reference

This is a class that handles state involved in saving a symbol copy as a new symbol. More...

Public Types
enum class	CONFLICT_STRATEGY { OVERWRITE , RENAME }

Public Member Functions
	SYMBOL_SAVE_AS_HANDLER (LIB_SYMBOL_LIBRARY_MANAGER &aLibMgr, CONFLICT_STRATEGY aStrategy, bool aValueFollowsName)
bool	DoSave (LIB_SYMBOL &symbol, const wxString &aNewSymName, const wxString &aNewLibName)

Private Member Functions
wxString	resolveConflict (const wxString &proposed, const wxString &aNewLibName) const

Private Attributes
LIB_SYMBOL_LIBRARY_MANAGER &	m_libMgr
CONFLICT_STRATEGY	m_strategy
bool	m_valueFollowsName

Detailed Description

This is a class that handles state involved in saving a symbol copy as a new symbol.

This isn't as simple as it sounds, because you also have to copy all the parent symbols (which is a chain affair).

Definition at line 701 of file symbol_editor.cpp.

Member Enumeration Documentation

CONFLICT_STRATEGY

enum class SYMBOL_SAVE_AS_HANDLER::CONFLICT_STRATEGY

strong

Enumerator
OVERWRITE
RENAME

Definition at line 704 of file symbol_editor.cpp.

Constructor & Destructor Documentation

SYMBOL_SAVE_AS_HANDLER()

SYMBOL_SAVE_AS_HANDLER::SYMBOL_SAVE_AS_HANDLER ( LIB_SYMBOL_LIBRARY_MANAGER &  aLibMgr, CONFLICT_STRATEGY  aStrategy, bool  aValueFollowsName  )

inline

Definition at line 715 of file symbol_editor.cpp.

Member Function Documentation

DoSave()

bool SYMBOL_SAVE_AS_HANDLER::DoSave ( LIB_SYMBOL &  symbol, const wxString &  aNewSymName, const wxString &  aNewLibName  )

inline

Definition at line 723 of file symbol_editor.cpp.

References LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), GetParentChain(), SYMBOL_LIBRARY_MANAGER::GetSymbol(), LIB_SYMBOL::GetValueField(), m_libMgr, m_valueFollowsName, resolveConflict(), LIB_SYMBOL::SetName(), LIB_SYMBOL::SetParent(), SCH_FIELD::SetText(), LIB_SYMBOL::SharedPtr(), SYMBOL_LIBRARY_MANAGER::UpdateSymbol(), and UTF8::wx_str().

Referenced by SYMBOL_EDIT_FRAME::ExportSymbol(), and SYMBOL_EDIT_FRAME::saveSymbolCopyAs().

resolveConflict()

wxString SYMBOL_SAVE_AS_HANDLER::resolveConflict ( const wxString &  proposed, const wxString &  aNewLibName  ) const

inlineprivate

Definition at line 783 of file symbol_editor.cpp.

References m_libMgr, m_strategy, OVERWRITE, RENAME, and SYMBOL_LIBRARY_MANAGER::SymbolNameInUse().

Referenced by DoSave().

Member Data Documentation

m_libMgr

LIB_SYMBOL_LIBRARY_MANAGER& SYMBOL_SAVE_AS_HANDLER::m_libMgr

private

Definition at line 815 of file symbol_editor.cpp.

Referenced by DoSave(), and resolveConflict().

m_strategy

CONFLICT_STRATEGY SYMBOL_SAVE_AS_HANDLER::m_strategy

private

Definition at line 816 of file symbol_editor.cpp.

Referenced by resolveConflict().

m_valueFollowsName

bool SYMBOL_SAVE_AS_HANDLER::m_valueFollowsName

private

Definition at line 817 of file symbol_editor.cpp.

Referenced by DoSave().

---

The documentation for this class was generated from the following file:

• symbol_editor.cpp