SYMBOL_EDITOR_CONTEXT Class Reference

#include <symbol_editor_context.h>

Inheritance diagram for SYMBOL_EDITOR_CONTEXT:

Public Member Functions
virtual	~SYMBOL_EDITOR_CONTEXT ()=default
virtual LIB_SYMBOL *	GetCurSymbol () const =0
virtual SCH_SCREEN *	GetScreen () const =0
virtual LIB_ID	GetLoadedLibId () const =0
virtual bool	IsContentModified () const =0
virtual void	SetContentModified (bool aModified=true)=0
virtual PROJECT &	Prj () const =0
virtual TOOL_MANAGER *	GetToolManager () const =0
virtual KIWAY *	GetKiway () const =0
virtual bool	CanAcceptApiCommands () const =0
virtual bool	SaveSymbol ()=0
	Save the current symbol to its library, without any user interaction.
virtual bool	SaveSymbolCopy (const wxString &aFileName, bool aOverwrite)=0
	Save a copy of the current symbol to the given library file, without user interaction.
virtual bool	RevertSymbol ()=0
	Reload the current symbol from its library, discarding unsaved changes.
virtual bool	LoadSymbol (const LIB_ID &aLibId)=0
	Load a symbol into the editor (activating it for editing); false if not found.

Detailed Description

Definition at line 36 of file symbol_editor_context.h.

Constructor & Destructor Documentation

~SYMBOL_EDITOR_CONTEXT()

virtual SYMBOL_EDITOR_CONTEXT::~SYMBOL_EDITOR_CONTEXT ( )

virtualdefault

Member Function Documentation

CanAcceptApiCommands()

virtual bool SYMBOL_EDITOR_CONTEXT::CanAcceptApiCommands ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

GetCurSymbol()

virtual LIB_SYMBOL * SYMBOL_EDITOR_CONTEXT::GetCurSymbol ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_SYMBOL::deleteItemsInternal(), API_HANDLER_SYMBOL::getItemFromDocument(), API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal(), API_HANDLER_SYMBOL::handleGetItems(), API_HANDLER_SYMBOL::handleGetItemsById(), API_HANDLER_SYMBOL::handleGetOpenDocuments(), and API_HANDLER_SYMBOL::symbol().

GetKiway()

virtual KIWAY * SYMBOL_EDITOR_CONTEXT::GetKiway ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

GetLoadedLibId()

virtual LIB_ID SYMBOL_EDITOR_CONTEXT::GetLoadedLibId ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_SYMBOL::validateDocumentInternal().

GetScreen()

virtual SCH_SCREEN * SYMBOL_EDITOR_CONTEXT::GetScreen ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_SYMBOL::deleteItemsInternal(), and API_HANDLER_SYMBOL::handleCreateUpdateItemsInternal().

GetToolManager()

virtual TOOL_MANAGER * SYMBOL_EDITOR_CONTEXT::GetToolManager ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

IsContentModified()

virtual bool SYMBOL_EDITOR_CONTEXT::IsContentModified ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

LoadSymbol()

virtual bool SYMBOL_EDITOR_CONTEXT::LoadSymbol ( const LIB_ID & aLibId )

pure virtual

Load a symbol into the editor (activating it for editing); false if not found.

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

Prj()

virtual PROJECT & SYMBOL_EDITOR_CONTEXT::Prj ( ) const

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_SYMBOL::handleGetOpenDocuments(), and API_HANDLER_SYMBOL::validateDocumentInternal().

RevertSymbol()

virtual bool SYMBOL_EDITOR_CONTEXT::RevertSymbol ( )

pure virtual

Reload the current symbol from its library, discarding unsaved changes.

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

SaveSymbol()

virtual bool SYMBOL_EDITOR_CONTEXT::SaveSymbol ( )

pure virtual

Save the current symbol to its library, without any user interaction.

Returns

false if there is no symbol, the library is read-only, or the save failed

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

SaveSymbolCopy()

virtual bool SYMBOL_EDITOR_CONTEXT::SaveSymbolCopy ( const wxString & aFileName, bool aOverwrite )

pure virtual

Save a copy of the current symbol to the given library file, without user interaction.

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

SetContentModified()

virtual void SYMBOL_EDITOR_CONTEXT::SetContentModified ( bool aModified = true )

pure virtual

Implemented in HEADLESS_SYMBOL_EDITOR_CONTEXT, and SYMBOL_EDIT_FRAME_CONTEXT.

Referenced by API_HANDLER_SYMBOL::onModified().

---

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

• symbol_editor_context.h